Opis

Projekt zakończony

Tomasz Huczek, tomasz.huczek@gmail.com

Bibtexplugin for dokuwiki, urlopen problems, bibtex file stored as an attachment in the wiki

Spotkania

08.03.04

080318

  • style: standardowe style latex + lncs, aaai
  • jak działało załączanie?

080408

  • obsł. przestrz nazw, w swoim wiki
  • próba obsługi styli? jak się mają te style do styli w latexu
  • sposób pobierania plików nie przez url

080422

  • testy → udostepn pluginu
  • możliwośc robienia własnych stylów.

Projekt

Cel Projektu

Celem projektu jest stworzenie pluginu do DokuWiki umożiwiającego wstawianie do dokumentów spisów treści w formacie BibTeX. Plugin ma udostępniać szereg funkcji, w tym załączanie zewnętrznych plików oraz plików załączonych na serwerze DokuWiki. Plugin również ma udostępniać możliwość zmiany stylu wyświetlanej treści BibTeX.

Specyfikacja Funkcji

Plugin powinien udostępniać szereg funkcjonalności takich jak tworzenie spisu na kilka sposobów:

  1. treść BibTeX wpisywana w źródło strony DokuWiki
  2. treść BibTeX jako zewnętrzny plik
  3. treść BibTeX jako plik załącznika do dokumentu DokuWiki


Możliwe formy znaczników:

<bibtex mode="text">
@Book{BookAmbroise2004,
  author = 	 {G.J. McLachlan and  K.A. Do and  C. Ambroise},
  title = 	 {Analyzing microarray gene expression data},
  publisher = 	 {Wiley},
  url={http://www.amazon.com/exec/obidos/tg/detail/-/0471226165/qid=1128710740/sr=8-1/ref=sr_8_xs_ap_i1_xgl14/002-9543089-9105613?v=glance&s=books&n=507846},
  year = 	 2004
}
</bibtex>
<bibtex mode="url">[[http://test.com/file.bib]]</bibtex>
<bibtex mode="file">{{file.bib}}</bibtex>

Plugin powinien udostępniać możliwość zmiany stylu spisu na przykład poprzez

<bibtex mode="url" style="ieee">[[http://www.test.com/file.bib]]</bibtex>


Przykłady różnych styli BibTeX - http://www.cs.stir.ac.uk/~kjt/software/latex/showbst.html

Istniejące rozwiązania

Pluginy obsługujące BibTeX w Doku wiki:

  1. http://stat.genopole.cnrs.fr/~cambroise/doku.php?id=softwares:dokuwikibibtexplugin - wyłącznie kod BibTeX wpisywany w źródło strony DokuWiki
  2. http://perso.ensi-bourges.fr/jfl/doku.php?id=wiki:bibtex - dodatkowe opcje takie jak sortowanie, różne style. przykład działania. Nie tetowane

Błędy istniejących rozwiązań

Przetestowałem projekt z poprzedniego roku. To co funkcjonuje:

  • załączanie kodu BibTeX jako źródło strony
  • załączanie pliku do dokumentu DokuWiki
  • załączanie pliku jako zewnetrznego adresu


Następujących rzeczy brak:

  • brak różnych styli wyświetlania
  • nieprawidłowy format xhtml (definicje wewnątrz tagów akapitów <p></p>)

Rozwiązania podane w odnośnikach z poprzedniego podpunktu nie spełniają w całości założeń projektu wymienionych na wstepie.

Wątpliwości

  • dlaczego projekt z poprzedniego roku nie działał na DokuWiki MiW? (załączanie plików lokalnych)

Jak działało załączanie

Załączanie (dla plików wewnętrznych - na serwerze DokuWiki) działa w ten sposób, że pobierany jest plik z katalogu:

DOKU_INC + 'data/media/'

Więc mogą pojawić się problemy, gdy pliki uploadowane nie trawiają do katalogu /data/media (można zmienić chyba tę ścieżkę przy instalacji DokuWiki)

Testowanie bazy BibTeX

Przetestowałem lokalnie pliki *bib z naszej DokuWki i wszystkie wyświetlają się prawidłowo, beż żadnych błędów.

Prototyp

Zainstalowałem DokuWiki na swoim testowym serwerze. Pod adresem: http://archiveme.net/dokuwiki/start:miw:eng znajduje się przykładowa strona z przestrzeniami nazw (2 poziomy) oraz przykładowe spisy treści wygenerowane pluginem BibTeX.

Udało się osiągnąć:

  • adres pliku pobierany jest wewnętrzną funkcją DokuWiki string mediaFN( $fn ) - brak problemów z przestrzeniami nazw
  • stylowanie wewnetrznymi metodami biblioteki OSBib

Stylowanie działa na zasadzie:

<bibtex style="ieee" mode="file">{{:start:miw:hekate.bib|}}</bibtex>
<bibtex style="chicago" mode="file">{{:start:miw:hekate.bib|}}</bibtex>

Dostępne style oferowane przez bibliotekę OSBib są wymienione na stronie odanej powyżej, a są to: APA, ieee, britishmedicaljournal, chicago, harvard, mla, turabian

TODO

  • usunąć testowe wyświetlanie ścieżek do pliku media powyżej spisu treści

Stylowanie

Stylowanie jest zarządzane przez bibliotekę OSBib, która zawiera kilka gotowych styli opisanych w formacie XML. Przykładowy plik z opisem stylu: apa.xml

Niestety nie udało mi się znaleźć żadnego narzędzia do prostej edycji/tworzenia styli w tym formacie.

Sprawozdanie

Materiały

Plugin wykonany w ramach projektu w roku 2007
Obecna wersja pluginu

DokuWiki

pl/miw/miw08_dokubibtex.txt · ostatnio zmienione: 2017/07/17 08:08 (edycja zewnętrzna)
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0