Both sides previous revision
Poprzednia wersja
Nowa wersja
|
Poprzednia wersja
|
pl:miw:2009:miw09_wiki_papers:howto [2009/05/12 10:59] jsi08 |
pl:miw:2009:miw09_wiki_papers:howto [2019/06/27 15:50] (aktualna) |
====== Opis użycia Wiki Papers ====== | ====== Opis użycia Wiki Papers ====== |
===== Instalacja ===== | ===== Instalacja ===== |
Rozpakuj plik {{:pl:miw:2009:miw09_wiki_papers:wiki_papers_alpha.rar|wiki_papers_alpha.rar}} do katalogu ''lib/plugins''. | |
| |
W przypadku ewentualnych błędów możliwa będzie konieczność poprawienia ścieżek do wiki w kodzie php. FIXME | - Upewnij się, że potrzebne komponenty zostały zainstalowane na serwerze PHP |
| * curl |
| * gd2 |
| - Rozpakuj plik {{:pl:miw:2009:miw09_wiki_papers:wiki_papers-2.tar.gz|wiki_papers-2.tar.gz}} do katalogu ''lib/plugins'' |
| - Nadaj odpowiednie uprawnienia dla skopiowanego katalogu |
| - Edytuj [[pl:miw:2009:miw09_wiki_papers:wyprobuj|stronę testową]] dla [[pl:miw:2009:miw09_wiki_papers|Wiki Papers]] |
| - W razie problemów proszę o kontakt <coolgibas@gmail.com> |
| |
| Uwagi |
| * W przypadku ewentualnych błędów możliwa będzie konieczność poprawienia ścieżek do wiki w kodzie php. FIXME //Była taka konieczność.// |
| |
===== Składnia ===== | ===== Składnia ===== |
[[pl:miw:2009:miw09_wiki_papers#section1|Składnia]] | Między znacznikami ''<papers></papers>'' umieszczamy opcje, nagłówki, tytuł, autorów oraz publikacje. W przypadku wielu opcji, oddziela się je średnikiem. Każdy z elementów zakończony jest podwójnym średnikiem: |
FIXME | <code> |
| <papers> |
| options:OPCJA1;OPCJA2;...;; |
| title:Tytuł wykresu lub tabeli;; |
| author:Jan Nowak;; |
| DBLP:2008;; |
| </papers> |
| </code> |
| |
| ==== Opcje ==== |
| Opcje nie są obowiązkowe. Domyślną opcją jest ''TEXT''. |
| |
| Lista dostępnych opcji: |
| * Główne: |
| * ''TEXT'' -- wyświetl tekst |
| * ''TABLE'' -- wyświetl tabelę |
| * ''CODE'' -- wyświetl jako kod |
| * ''CHART'' -- wyświetl wykres |
| * Sterujące: |
| * ''EXTRASPAN'' -- poszerza wykres (pomocne, gdy opisy na osi nachodzą na siebie) |
| * ''NOHEADERS'' -- nie generuj nagłówków i nie porządkuj kolumn tabeli (nagłówki użytkownika zostaną dodane, jeśli zdefiniowano) |
| * ''HIDEAUTHOR'' -- nie wyświetlaj autora w tekście |
| * ''SHOWINFO'' -- wyświetl identyfikatory obok numerów publikacji |
| |
| Przykład: |
| <code> |
| options:CHART;EXTRASPAN;; |
| </code> |
| Wyświetli się wykres ze zwiększoną szerokością słupków. |
| |
| ==== Nagłówki ==== |
| Nagłówki generują się automatycznie na podstawie wybranych przez użytkownika statystyk publikacji. Można je wyłączyć (opcja ''NOHEADERS'') lub podmienić zdefiniowanymi przez siebie: |
| <code> |
| options:TABLE;; |
| headers:Wiosna;Lato;Jesień;Zima;; |
| </code> |
| Wyświetli się tabela z podmienionymi nagłówkami. |
| |
| ==== Tytuł ==== |
| Dodaje tytuł do tabeli lub wykresu. |
| <code> |
| options:CHART;; |
| title:Tytułowy tytuł;; |
| </code> |
| Wyświetli wykres zatytuowany 'Tytułowy tytuł'. |
| |
| ==== Autorzy ==== |
| Może być wielu autorów w jednym bloku kodu Wiki Papers. Po określeniu autora sprawdzane są jego publikacje, aż do następnego autora lub końca bloku ''</papers>''. Na wyjściu autorowi przydzielony jes wiersz tekstu, jeden wiersz tabeli lub jeden kolor słupka wykresu. Autorowi można określić adres strony, która będzie wyświetlana po kliknięciu na link z jego nazwiskiem. |
| <code> |
| author:Imie i Nazwisko 1;http://www.strona.pana1.com;; |
| [publikacje pana 1] |
| author:Imie i Nazwisko 2;http://www.strona.pana2.com;; |
| [publikacje pana 2] |
| </code> |
| |
| ==== Publikacje ==== |
| Możliwa dowolna ilość publikacji różnego rodzaju. Publikacje określa się, podając jej bibliografię, ewentualne opcje, rok, oraz URL (zalecane), który wskazuje na stronę z określonymi publikacjami. W przypadku niepodania URL, plugin wygeneruje adres automatycznie na podstawie zadanych parametrów, jednak bez gwarancji sukcesu (np. Kowalskich jest w bazie dwóch i nie ma jednoznaczności). |
| |
| Szablon: |
| <code> |
| BIBLIOGRAFIA:OPCJE;ROK;http://strona.zawierająca.publikacje/pana=X;; |
| </code> |
| Opcje, rok i url bibliografii publikacji mogą być podane w dowolnej kolejności. Adres musi się zaczynać od ''[[http://]]'' i powinien wskazywać bezpośrednio na stronę, z której publikacje mają być zliczane. Przykład: |
| <code> |
| author:Grzegorz Jacek Nalepa;; |
| DBLP:2008;http://dblp.uni-trier.de/db/indices/a-tree/n/Nalepa:Grzegorz_J=.html;; |
| DBLP:2008;; |
| </code> |
| Zalecane jest podanie adresu dla publikacji. W przeciwnym wypadku zostanie on wygenerowany automatycznie (bez gwarancji poprawności!!) |
| |
| ==== Przykłady ==== |
| |
| Zobacz: [[pl:miw:2009:miw09_wiki_papers#section1|Składnia]] |
| |
| Rzeczywisty przykład: [[pl:miw:2009:miw09_wiki_papers:wyprobuj|Wypróbuj]] lub [[pl:miw:2009:miw09_wiki_papers:wyprobuj1|Wypróbuj1]] |
==== Dostępne publikacje ==== | ==== Dostępne publikacje ==== |
* BPP plus ew. opcje: | * [[http://www.bpp.agh.edu.pl/|BPP]] plus ew. opcje: |
* IF | * IF |
* LF | * LF |
* MNiSW | * MNiSW |
* LNCS | * LNCS |
* DBLP | * [[http://dblp.uni-trier.de/|DBLP]] |
| * W planach jest obsługa [[http://citeseerx.ist.psu.edu/|CiteSeerX]] |
| |
== Przykłady == | **Przykłady:** |
<code> | <code> |
BPP:2006;; | BPP:2006;; |
| |
| |
===== Przykłady ===== | ===== Przykłady użycia ===== |
FIXME | W przykładach zamieszczam fikcyjne dane jedynie po to, aby zobrazować użycie składni. |
| |
| Działający przykład jest [[pl:miw:2009:miw09_wiki_papers:wyprobuj|tutaj]] i [[pl:miw:2009:miw09_wiki_papers:wyprobuj1|tu]]. |
==== Najprostszy wariant ==== | ==== Najprostszy wariant ==== |
<code> | <code> |
</paprs> | </paprs> |
</code> | </code> |
Wyświetli się: \\ | Wyświetli się: |
Kowalski, [[http://url.dblp/automatycznie/wygenerowany/dla/kowalskiego|13]], [[http://url.bpp/automatycznie/wygenerowany/dla/kowalskiego|1313]] | |
| Kowalski: [[http://url.dblp/automatycznie/wygenerowany/dla/kowalskiego|13]], [[http://url.bpp/automatycznie/wygenerowany/dla/kowalskiego|1313]] |
| |
Lepiej jednak podać url dla publikacji danego autora za każdym razem. Zapobiegnie to sytuacji, kiedy nie zostanie odnaleziony w bazie publikacji zadany autor. Będziemy również pewni, że nasz adres jest prawidłowy i określa autora __jednoznacznie__. W przypadku błędnego url (naszego, czy też wygenerowanego) możemy zobaczyć (jeśli mamy szczęście) zamiast liczby publikacji komunikat o błędzie. | Lepiej jednak podać url dla publikacji danego autora za każdym razem. Zapobiegnie to sytuacji, kiedy nie zostanie odnaleziony w bazie publikacji zadany autor. Będziemy również pewni, że nasz adres jest prawidłowy i określa autora __jednoznacznie__. W przypadku błędnego url (naszego, czy też wygenerowanego) możemy zobaczyć (jeśli mamy szczęście) zamiast liczby publikacji komunikat o błędzie. |
DBLP:2008;http://url.dblp/podany/dla=nowaka;; | DBLP:2008;http://url.dblp/podany/dla=nowaka;; |
BPP:2005;http://url.bpp/podany/dla=nowaka;; | BPP:2005;http://url.bpp/podany/dla=nowaka;; |
</paprs> | </papers> |
</code> | </code> |
Opcje wpisujemy w pluginie raz, kiedy ich nie określimy, używane są domyślne. \\ | Opcje wpisujemy w pluginie raz, kiedy ich nie określimy, używane są domyślne. \\ |
Na wyjściu zobaczymy: | Na wyjściu zobaczymy: |
| |
Kowalski, [[http://url.dblp/podany/dla=kowalskiego|DBLP::2008=13]], [[http://url.bpp/podany/dla=kowalskiego|BPP::2005=1313]] | Kowalski: [[http://url.dblp/podany/dla=kowalskiego|DBLP::2008=13]], [[http://url.bpp/podany/dla=kowalskiego|BPP::2005=1313]] |
| |
[[http://www.nowak.com|Nowak]], [[http://url.dblp/podany/dla=nowaka|DBLP::2008=22]], [[http://url.bpp/podany/dla=nowaka|BPP::2005=44]] | [[http://www.nowak.com|Nowak]]: [[http://url.dblp/podany/dla=nowaka|DBLP::2008=22]], [[http://url.bpp/podany/dla=nowaka|BPP::2005=44]] |
| |
==== Opcje dla wyświetlania tekstu ==== | ==== Opcje dla wyświetlania tekstu ==== |
| |
==== Opcje tabeli ==== | ==== Opcje tabeli ==== |
* ''SHOWINFO'' - też działa | * ''SHOWINFO'' - wyświetla rodzaj, opcje i rok publikacji w każdej komórce z danymi publikacji |
* ''NOHEADERS'' - nie są wyświetlane nagłówki; komórki w tabeli nie są porządkowane. | * ''NOHEADERS'' - nie są wyświetlane nagłówki; komórki w tabeli nie są porządkowane. |
| |
| |
{{:pl:miw:2009:miw09_wiki_papers:demo_chart.png|}} | {{:pl:miw:2009:miw09_wiki_papers:demo_chart.png|}} |
| |
| ==== Wszystko naraz ==== |
| <code> |
| <papers> |
| options:TEXT;TABLE;CHART;; |
| author:Kowalski;; |
| DBLP:2008;http://url.dblp/podany/dla=kowalskiego;; |
| BPP:2005;http://url.bpp/podany/dla=kowalskiego;; |
| author:Nowak;http://www.nowak.com;; |
| BPP:2005;http://url.bpp/podany/dla=nowaka;; |
| DBLP:2008;http://url.dblp/podany/dla=nowaka;; |
| </paprs> |
| </code> |
| Zostaną wyświetlone publikacje na 3 możliwe sposoby: |
| |
| Kowalski: [[http://url.dblp/podany/dla=kowalskiego|13]], [[http://url.bpp/podany/dla=kowalskiego|1313]] |
| |
| [[http://www.nowak.com|Nowak]]: [[http://url.dblp/podany/dla=nowaka|22]], [[http://url.bpp/podany/dla=nowaka|44]] |
| |
| ^ author ^ DBLP::2008 ^ BPP::2005 ^ |
| |Kowalski|[[http://url.dblp/podany/dla=kowalskiego|13]]|[[http://url.bpp/podany/dla=kowalskiego|1313]]| |
| |[[http://www.nowak.com|Nowak]]|[[http://url.dblp/podany/dla=nowaka|22]]|[[http://url.bpp/podany/dla=nowaka|44]]| |
| |
| {{:pl:miw:2009:miw09_wiki_papers:demo_chart.png|}} |
| |