Opis użycia Wiki Papers

Instalacja

  1. Upewnij się, że potrzebne komponenty zostały zainstalowane na serwerze PHP
    • curl
    • gd2
  2. Rozpakuj plik wiki_papers-2.tar.gz do katalogu lib/plugins
  3. Nadaj odpowiednie uprawnienia dla skopiowanego katalogu
  4. 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

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:

<papers>
options:OPCJA1;OPCJA2;...;;
title:Tytuł wykresu lub tabeli;;
author:Jan Nowak;;
DBLP:2008;;
</papers>

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:

options:CHART;EXTRASPAN;;

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:

options:TABLE;;
headers:Wiosna;Lato;Jesień;Zima;;

Wyświetli się tabela z podmienionymi nagłówkami.

Tytuł

Dodaje tytuł do tabeli lub wykresu.

options:CHART;;
title:Tytułowy tytuł;;

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.

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]

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:

BIBLIOGRAFIA:OPCJE;ROK;http://strona.zawierająca.publikacje/pana=X;;

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:

author:Grzegorz Jacek Nalepa;;
DBLP:2008;http://dblp.uni-trier.de/db/indices/a-tree/n/Nalepa:Grzegorz_J=.html;;
DBLP:2008;;

Zalecane jest podanie adresu dla publikacji. W przeciwnym wypadku zostanie on wygenerowany automatycznie (bez gwarancji poprawności!!)

Przykłady

Zobacz: Składnia

Rzeczywisty przykład: Wypróbuj lub Wypróbuj1

Dostępne publikacje

Przykłady:

    BPP:2006;;
    BPP:IF;2005;;
    BPP:LF;2005;;
    BPP:2008;MNiSW;http://url.publikacji.bpp/rekord=autora;; // Zalecane jest podanie URL!
    BPP:LNCS;2003;;

    DBLP:2008;http://dblp.uni-trier.de/db/indices/a-tree/n/Nalepa:Grzegorz_J=.html;;

Przykłady użycia

W przykładach zamieszczam fikcyjne dane jedynie po to, aby zobrazować użycie składni.

Działający przykład jest tutaj i tu.

Najprostszy wariant

<papers>
    author:Kowalski;;
    DBLP:2008;;
    BPP:2005;;
</paprs>

Wyświetli się:

Kowalski: 13, 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.

Tekst plus opis publikacji

<papers>
    options:TEXT;SHOWINFO;;
    author:Kowalski;;
    DBLP:2008;http://url.dblp/podany/dla=kowalskiego;;
    BPP:2005;http://url.bpp/podany/dla=kowalskiego;;
    author:Nowak;http://www.nowak.com;;
    DBLP:2008;http://url.dblp/podany/dla=nowaka;;
    BPP:2005;http://url.bpp/podany/dla=nowaka;;
</papers>

Opcje wpisujemy w pluginie raz, kiedy ich nie określimy, używane są domyślne.
Na wyjściu zobaczymy:

Kowalski: DBLP::2008=13, BPP::2005=1313

Nowak: DBLP::2008=22, BPP::2005=44

Opcje dla wyświetlania tekstu

  • HIDEAUTHOR - autor nie zostanie wyświetlony; widoczne tylko publikacje
  • SHOWINFO - wyświetla rodzaj, opcje i rok publikacji

Tabele

<papers>
    options:TABLE;;
    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;;
</paprs>

Zobaczymy:

author DBLP::2008 BPP::2005
Kowalski131313
Nowak 44

Plugin automatycznie dopasowuje rodzaj publikacji do określonej kolumny, niezależnie od kolejności ich wpisania w pluginie. Na kolejność kolumn wpływają tylko pierwsze wystąpienia określonego typu publikacji.

Opcje tabeli

  • 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.

Wykresy

<papers>
    options: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>

Zostanie wygenerowany wykres słupkowy:

Wszystko naraz

<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>

Zostaną wyświetlone publikacje na 3 możliwe sposoby:

Kowalski: 13, 1313

Nowak: 22, 44

author DBLP::2008 BPP::2005
Kowalski131313
Nowak2244

pl/miw/2009/miw09_wiki_papers/howto.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