Pomoc:Funkcje parsera


Skrót: WP:FP, WP:If

Pomoc:Funkcje parsera w encyklopedii

Z Wikipedii, wolnej encyklopedii Przejdź do nawigacji Przejdź do wyszukiwania Dla zaawansowanych

Funkcje parserarozszerzeniami mechanizmu szablonów ułatwiającymi konstrukcję skomplikowanych szablonów, dających różne efekty w zależności od użytych parametrów. Zostały aktywowane na wszystkich Wikipediach na zasadzie testu.

Spis treści

Funkcje | edytuj kod

Istnieje rozszerzenie MediaWiki, będące kolekcją funkcji parsera. Ich wywołanie najczęściej ma postać:

{{#nazwa_funkcji: argument 1 | argument 2 | argument 3...}} 

Poniżej opisano pięć funkcji: if, ifeq, switch, expr oraz ifexpr

if | edytuj kod

If (z ang. jeśli, jeżeli). Funkcja if ma w ogólności postać:

{{#if: warunek | tekst 1 | tekst 2 }} 

czyli:

{{#if: niepusty argument 1|to wyświetl argument 2|w przeciwnym wypadku wyświetl argument 3}} 

Jeśli warunek nie jest pusty, albo nie zawiera samych spacji, to wyświetlany jest tekst 1. W przeciwnym wypadku (gdy pole warunek jest puste, albo zawiera same spacje) wyświetlany jest tekst 2. Warunek może się składać np. z jednego lub większej ilości sprawdzanych parametrów szablonu. Przy wielu parametrach zasada jest analogiczna jak przy jednym - jeśli po rozwinięciu wszystkich parametrów warunek nie jest pusty, albo nie zawiera samych spacji, to wyświetlany jest tekst 1, w przeciwnym wypadku tekst 2.

Sprawdzanie parametru szablonu | edytuj kod

Jako warunek w różnych szablonach najlepiej podawać dowolny parametr i w ten sposób szablon będzie mógł "reagować" na to czy parametr jest pusty czy nie.

{{#if: {{{parametr|}}} | Parametr jest nie pusty. | Parametr nie został podany lub jest pusty.}} 
  • Wywołanie jako {{Szablon|parametr=cokolwiek}} daje wynik:
Parametr jest nie pusty.
  • Wywołanie jako {{Szablon|parametr=}} lub po prostu {{Szablon}} daje wynik:
Parametr nie został podany lub jest pusty.

Czyli w pierwszej sytuacji wyświetlany jest pierwszy tekst, a w drugiej ten drugi.

Sprawdzanie i wstawianie parametru | edytuj kod

Skoro można przetestować, czy jakiś parametr jest pusty, to można go też dalej wstawić i wyświetlić.

{{#if: {{{parametr|}}} | Parametr jest nie pusty i oto on: {{{parametr|}}}. | Parametr nie został podany lub jest pusty.}} 
  • Wywołanie jako {{Szablon|parametr=cokolwiek}} daje wynik:
Parametr jest nie pusty i oto on: cokolwiek.
  • Wywołanie jako {{Szablon|parametr=}} lub po prostu {{Szablon}} jest identyczne z powyższym i daje wynik:
Parametr nie został podany lub jest pusty.

Przykład użytkowy | edytuj kod

Nieco sensowniejszym przykładem, który pozwoli zrozumieć, po co to jest, może być poniższy prosty szablon:

{{#if:{{{kobieta|}}}|Ta wikipedystka|Ten wikipedysta}} potrafi już używać funkcji parsera i jest z tego dumn{{#if:{{{kobieta|}}}|a|y}}. 
  • Wywołanie jako {{Szablon|kobieta=tak}} daje wynik:
Ta wikipedystka potrafi już używać funkcji parsera i jest z tego dumna.
  • Wywołanie jako {{Szablon|kobieta=}}
Ten wikipedysta potrafi już używać funkcji parsera i jest z tego dumny.

Wszystko będzie w porządku, póki będziemy pamiętać, że sprawdzane jest tylko, czy podany parametr jest pusty, stąd

  • Wywołanie jako {{Szablon|kobieta=nie}} daje wynik:
Ta wikipedystka potrafi już używać funkcji parsera i jest z tego dumna.

ifeq | edytuj kod

ifeq (od if equalang. jeśli równe). Funkcja ifeq ma w ogólności postać:

{{#ifeq: porównaj A | porównaj B | tekst 1 | tekst 2 }} 

czyli:

{{#ifeq: argument 1|jest równy argument 2 | to wyświetl argument 3|w przeciwnym wypadku wyświetl argument 4}} 

Jeśli porównaj A i porównaj B są identyczne, to wyświetlany jest tekst 1. W przeciwnym wypadku (gdy pole porównaj A i porównaj B są różne) wyświetlany jest tekst 2.

Przykład użytkowy w wydaniu ifeq | edytuj kod

Funkcja ifeq nadaje się idealnie do uczynienia poprzedniego szablonu nieco bardziej intuicyjnym:

{{#ifeq:{{{kobieta}}}|tak|Ta wikipedystka|Ten wikipedysta}} potrafi już używać funkcji parsera i jest z tego dumn{{#ifeq:{{{kobieta}}}|tak|a|y}}. 
  • Wywołanie jako {{Szablon|kobieta=tak}} daje wynik:
Ta wikipedystka potrafi już używać funkcji parsera i jest z tego dumna.
  • Wywołanie jako {{Szablon|kobieta=}}
Ten wikipedysta potrafi już używać funkcji parsera i jest z tego dumny.
  • Wywołanie jako {{Szablon|kobieta=nie}} daje wynik:
Ten wikipedysta potrafi już używać funkcji parsera i jest z tego dumny.

Prostszy przykład | edytuj kod

Ale żeby nie zagubić sensu, może warto jednak dać dwa proste przykłady (tym razem bez użycia szablonów).

  • Treść przykładu (1)
{{#ifeq: tak | tak | podane argumenty są równe | podane argumenty są różne }} 
  • Wynik
podane argumenty są równe
  • Treść przykładu (2)
{{#ifeq: tak | nie | podane argumenty są równe | podane argumenty są różne }} 
  • Wynik
podane argumenty są różne

Czyli tak jest równe tak, nie jest różne od tak. To chyba oczywiste ☺.

W wypadku tej funkcji też można jednak ponarzekać, że nie wszystko jest tak jak chcemy:

  • Treść przykładu (3)
{{#ifeq: tak | Tak | podane argumenty są równe | podane argumenty są różne }} 
  • Wynik
podane argumenty są różne

Jednak tak jest różne od Tak, co jak się przyjrzeć może nie jest aż takie dziwne ;).

ifexist | edytuj kod

ifexist (od if existang. jeśli istnieje). Funkcja ifexist ma w ogólności postać:

{{#ifexist: artykuł | tekst 1 | tekst 2 }} 

czyli:

{{#ifexist: artykuł o nazwie argument 1|to wyświetl argument 2|w przeciwnym wypadku wyświetl argument 3}} 

Jeśli istnieje artykuł, to wyświetl tekst 1. W przeciwnym wypadku (gdy artykuł nie istnieje) wyświetlany jest tekst 2.

Przykłady | edytuj kod

{{#ifexist:Cosik|Cosik istnieje|Cosik nie istnieje}} - daje w wyniku "Cosik nie istnieje", bo artykuł Cosik nie istnieje. {{#ifexist:Łoś|Łoś istnieje|Łoś nie istnieje}} - daje w wyniku "Łoś istnieje", bo artykuł Łoś istnieje. {{#ifexist:Wikipedia:Funkcje parsera|dziękujemy za funkcje parsera ;)|mam pomysł na ciekawą funkcję}} - daje w wyniku "dziękujemy za funkcje parsera ;)".

Wyjątki | edytuj kod

Tu należy zwrócić uwagę, że funkcja działa analogicznie do oznaczania linków na niebiesko (gdy artykuł istnieje) i na czerwono (gdy artykuł nie istnieje). Jak do tej pory, takie oznaczanie linków nie działa dla interwiki (oraz linków do pokrewnych projektów). Podobnie ta funkcja parsera nie obsługuje tego rodzaju linków.

Choć en:Moose istnieje, to: {{#ifexist::en:Moose|Moose istnieje?|Moose nie istnieje?}} daje w wyniku "Moose nie istnieje?", co nie jest prawdą.

Uwagi | edytuj kod

#ifexist jest kosztowną funkcją parsera, tzn. można tylko ograniczoną liczbę tych funkcji zamieścić na stronie. Jeżeli jest ich użytych za dużo, tekst 2 będzie wyświetlany, bez względu na to, czy artykuł istnieje czy nie, a strona będzie umieszczona w kategorii stron ze zbyt dużą liczbą wywołań kosztownych funkcji parsera.

switch | edytuj kod

switch porównuje pojedynczą wartość z wieloma innymi. Jeżeli znajdzie taką samą wartość zwraca odpowiedni ciąg znaków. W przeciwnym wypadku zwróci wartość domyślną, o ile taka zostanie podana.

sposób wywołania:

{{ #switch: wartość do porównania | wartość1 = wynik1 | wartość2 = wynik2 | ... | wartośćn = wynikn | wartość domyślna }} 

lub (w przypadku gdy wartość domyślna musi zawierać znak równości):

{{ #switch: wartość do porównania | wartość1 = wynik1 | wartość2 = wynik2 | ... | wartośćn = wynikn | #default = wartość domyślna }} 

lub (w przypadku gdy dla kilku różnych wartości ma być ten sam wynik):

{{ #switch: wartość do porównania | wartość1 | wartość2 | wartość3 = wynik1/2/3 | ... | wartośćn = wynikn | wartość domyślna }} 

Przykład:

{{ #switch: {{{dzień}}} | 1 = poniedziałek | 2 = wtorek | 3 = środa | 4 = czwartek | 5 = piątek | 6 = sobota | 7 = niedziela | weekend }} 

Porównuje treść przesyłaną przez parametr dzień. Jeśli ta treść to 1-7 w wyniku otrzymamy odpowienią nazwę dnia tygodnia. Gdy treść będzie inna lub będzie pusta, otrzymamy tekst weekend.

expr | edytuj kod

Funkcja expr wykonuje obliczenia matematyczne.

{{ #expr: wyrażenie }} 

Tabela używanych operatorów | edytuj kod

UWAGA! Separatorem dziesiętnym w wyniku jest . (kropka), a więc np. liczba półtora ma zapis "1.5".

Pomoc dotycząca zaokrąglania liczb

Praktyczny przykład | edytuj kod

Aby obliczyć ile stopni Celsjusza odpowiada 100°F można skorzystać ze wzoru (wyrażenia) podanego poniżej.

  • Treść przykładu:
{{#expr: (100 - 32) / 9 * 5 round 0 }} 
  • Wynik:

38

Tu należy zauważyć, że 100 °F nie jest dokładnie równe 38°C, jednak dzięki użyciu round 0, wynik został zaokrąglony do najbliższej liczby całkowitej (round 1 zaokrągliłoby do pierwszego miejsca po przecinku).

ifexpr | edytuj kod

ifexpr (od if expressionang. jeśli wyrażenie). Funkcja ifexpr ma w ogólności postać:

{{#ifexpr: jeśli wyrażenie jest równe 1 | wtedy tekst 1 | w przeciwnym wypadku tekst 2}} 

Jeżeli wyrażenie da wynik 0, to zostanie wyświetlony tekst w przeciwnym wypadku tekst 2. Natomiast, jeżeli wynikiem jest liczba inna niż 0, to wyświetlony zostanie tekst wtedy tekst 1. Funkcja obsługuje te same operatory co funkcja expr.

time | edytuj kod

time zwraca czas w żądanym formacie – także dla daty podanej w opcjonalnym drugim parametrze, bądź w wersji względnej (np. +1 month).

{{#time: format | określenie czasu (opcjonalne)}} 

Składnia formatu została zapożyczona ze składni PHP. Została jednak ona rozszerzona o dodatkowe kody podane poniżej.

Poniżej lista kodów znakowych zapożyczonych ze składni PHP.

Zobacz więcej: na stronach Mediawiki.

Znak potoku | edytuj kod

Przy tworzeniu tabel w formacie MediaWiki należy użyć szablonu {{!}} zamiast znaku potoku (|), gdyż funkcje parsera uniemożliwiają zwykłe jego wstawienie (alternatywnie można użyć składni HTML). Przy wpisywaniu znaku potoku jako zwykły tekst można użyć encji &#124; lub konstrukcji <nowiki>|</nowiki>.

Nowy wiersz | edytuj kod

W obrębie funkcji parsera należy użyć składni HTML dla nowego wiersza (<br/>).

Nowy akapit | edytuj kod

W następującym przypadku:

Pierwszy akapit, wyświetlany zawsze.{{#if:{{{1|}}}| Drugi akapit, wyświetlany jedynie, gdy zostanie podany argument {{{1}}}.}}

należy dodać <nowiki/> przed rozpoczęciem drugiego akapitu (tzw. whitespace) aby został poprawnie wyświetlony, np.:

Pierwszy akapit, wyświetlany zawsze.{{#if:{{{1|}}}| Drugi akapit, wyświetlany jedynie, gdy zostanie podany argument {{{1}}}.}}

Zobacz też | edytuj kod

Linki zewnętrzne | edytuj kod

Na podstawie artykułu: "Pomoc:Funkcje parsera" pochodzącego z Wikipedii
OryginałEdytujHistoria i autorzy