Both sides previous revision
Poprzednia wersja
Nowa wersja
|
Poprzednia wersja
|
pl:miw:miw08_dokubibtex [2008/03/17 19:53] miw |
pl:miw:miw08_dokubibtex [2019/06/27 15:50] (aktualna) |
====== Opis ====== | ====== Opis ====== |
| __**Projekt zakończony**__ |
| |
Tomasz Huczek, <tomasz.huczek@gmail.com> | Tomasz Huczek, <tomasz.huczek@gmail.com> |
| |
====== Spotkania ====== | ====== Spotkania ====== |
===== 08.03.04 ===== | ===== 08.03.04 ===== |
===== 08.03.18 ===== | |
| ===== 080318 ===== |
* style: standardowe style latex + lncs, aaai | * style: standardowe style latex + lncs, aaai |
* jak działało załączanie? | * 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 ====== | ====== 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 ==== | ==== Specyfikacja Funkcji ==== |
| |
| |
<code> | <code> |
<bibtex type="inline"> | <bibtex mode="text"> |
@Book{BookAmbroise2004, | @Book{BookAmbroise2004, |
author = {G.J. McLachlan and K.A. Do and C. Ambroise}, | author = {G.J. McLachlan and K.A. Do and C. Ambroise}, |
| |
<code> | <code> |
<bibtex type="url">[[http://test.com/file.bib]]</bibtex> | <bibtex mode="url">[[http://test.com/file.bib]]</bibtex> |
</code> | </code> |
| |
<code> | <code> |
<bibtex type="attachement">{{file.bib}}</bibtex> | <bibtex mode="file">{{file.bib}}</bibtex> |
</code> | </code> |
| |
| |
<code> | <code> |
<bibtex type="url" style="standard">[[http://www.test.com/file.bib]]</bibtex> | <bibtex mode="url" style="ieee">[[http://www.test.com/file.bib]]</bibtex> |
</code> | </code> |
\\ | \\ |
| |
* dlaczego projekt z poprzedniego roku nie działał na DokuWiki MiW? (//załączanie plików lokalnych//) | * dlaczego projekt z poprzedniego roku nie działał na DokuWiki MiW? (//załączanie plików lokalnych//) |
| |
| ---- |
| |
==== Jak działało załączanie ==== | ==== Jak działało załączanie ==== |
| |
Więc mogą pojawić się problemy, gdy pliki uploadowane nie trawiają do katalogu /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|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: |
| |
| <code><bibtex style="ieee" mode="file">{{:start:miw:hekate.bib|}}</bibtex></code> |
| <code><bibtex style="chicago" mode="file">{{:start:miw:hekate.bib|}}</bibtex></code> |
| |
| 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: [[http://archiveme.net/dokuwiki/APA.xml|apa.xml]] |
| |
| Niestety nie udało mi się znaleźć żadnego narzędzia do prostej edycji/tworzenia styli w tym formacie. |
| |
| |
| |
| |
====== Sprawozdanie ====== | ====== Sprawozdanie ====== |
| {{:pl:miw:miw-bibtex-sprawozdanie.pdf|miw-bibtex-sprawozdanie.pdf}} |
| |
| |
====== Materiały ====== | ====== Materiały ====== |
| |
| == Plugin wykonany w ramach projektu w roku 2007 == |
* {{:pl:miw:miw07-bibtex.tar.gz|:pl:miw:miw07-bibtex.tar.gz}} | * {{:pl:miw:miw07-bibtex.tar.gz|:pl:miw:miw07-bibtex.tar.gz}} |
| |
| == Obecna wersja pluginu == |
| * {{:pl:miw:bibtex-th-15-06-2008.zip|:pl:miw:bibtex-th-15-06-2008.zip}} |
| |
==== DokuWiki ==== | ==== DokuWiki ==== |
* [[http://wiki.splitbrain.org/wiki:plugins:syntax_skeleton]] - szkielet pluginu | * [[http://wiki.splitbrain.org/wiki:plugins:syntax_skeleton]] - szkielet pluginu |
* [[http://wiki.splitbrain.org/wiki:plugins:file_structure]] - struktura katalogów pluginów | * [[http://wiki.splitbrain.org/wiki:plugins:file_structure]] - struktura katalogów pluginów |
| * [[http://dev.splitbrain.org/reference/dokuwiki/nav.html?inc/io.php.html]] - DokuWiki framework |