Pomoc:Parametry
Z Wikipedii
Parametry są rozszerzeniem mediawiki, pomocnym przy tworzeniu i używaniu funkcji parsera, szablonów, szablonów specjalnych, a zwłaszcza infoboksów.
Spis treści |
[edytuj] Rodzaje parametrów
[edytuj] Parametry typowe
Ze względu na specyfikację (wywołanie) parametrów, można je podzielić na dwa rodzaje, po dwa typy każdy. Podział i nazwy są umowne. Typy te to:
- parametry nienazwane (numeryczne): np. {{{1}}}, {{{2}}}, {{{3}}} etc.
- parametry nazwane: np. {{{nazwa_parametru}}}, {{{miasto w Polsce}}}, {{{WARTOŚĆ}}} etc.
- Uwaga: parametry w mediawiki są wrażliwe na wielkość liter i tak np. {{{miasto w Polsce}}} oraz {{{miasto w polsce}}} to dwa różne parametry. W parametrach rozróżnialna jest też spacja i podkreślnik, więc {{{miasto w Polsce}}} i {{{miasto_w_Polsce}}} to też dwa różne parametry.
- Uwaga 2: Nazwy parametrów bezwzględnie powinny być z polskimi znakami diakrytycznymi oraz poprawne ortograficznie. A więc nie np. zrodlo, lecz źródło. Najlepiej też zawsze używać _ zamiast spacji.
[edytuj] parametry nazwane
Powyższe dwa rodzaje różnią się sposobem wywoływania. I tak:
{{Szablon|nazwa parametru=treść|dwa=treść2}}
powoduje wywołanie szablonu o nazwie Szablon, w miejsce parametru o nazwie nazwa parametru podstawiając tekst treść, zaś w miejsce parametru dwa podstawiając tekst treść2. To samo osiągnie się gdy wywołamy szablon w następujący sposób:
{{Szablon|dwa=treść2|nazwa parametru=treść}}.
[edytuj] parametry nienazwane
Parametry nienazwane przekazujemy w następujący sposób:
{{Szablon|treść|treść2}}.
- Uwaga: parametry nienazwane można (a czasami trzeba) przekazywać do szablonu w sposób podobny do parametrów nazwanych, jako nazwę podając ich numery.
Analogiczny efekt do powyższego przykładu uzyskamy dla następujących wywołań:
- numerowanie parametrów:
{{Szablon|1=treść|2=treść2}},
- zmiana kolejności parametrów:
{{Szablon|2=treść2|1=treść}}.
- tak też można:
{{Szablon|treść|2=treść2}}. {{Szablon|2=treść2|treść}}.
- ale to już są błędne wywołania:
{{Szablon|1=treść|treść2}}. {{Szablon|treść2|1=treść}}.
[edytuj] Parametry warunkowe
Drugim rodzajem parametrów są parametry warunkowe. Tworzy się je poprzez dodanie znaku "|" (ang. pipe) przed zamknięciem parametru. Ten rodzaj również dzieli się na dwa typy:
- puste, np. {{{1|}}}, {{{nazwa_miasta|}}}, etc.
- wypełnione, np. {{{1|2}}}, {{{nazwa_miasta|Warszawa}}}, {{{2|{{{3|}}}}}}, etc.
- Uwaga: W przypadku parametrów warunkowych wypełnionych, po znaku "|" pojawia się tekst. To może być ciąg znaków, liczb, lecz również kolejny parametr, a nawet szablon z parametrami.
Wywołanie tego rodzaju parametrów jest analogiczne jak wcześniejszych. Różnią się natomiast efektem końcowym, gdy brak jest wywołania. Mianowicie, oprogramowanie wiki traktuje parametr pusty, jak by go nie było, natomiast zamiast parametru wypełnionego wstawia tekst znajdujący się po znaku "|".
- Uwaga: Nie działa to, gdy wywołanie jest puste. Wymagany jest brak wywołania. A więc {{Szablon|wartość1=}} będzie wyglądało jak wywołanie parametu pustego, nawet gdy parametr wartość1 jest wypełniony. Aby ten sposób działał należy wywołać szablon bez tego parametru, np. {{Szablon}}, lub {{Szablon|}}.
[edytuj] Przykłady
Przykłady dotyczą hipotetycznego szablonu o nazwie testowy. Szablon ten zawiera treść z kolumny kod szablonu. Wywołanie wygląda jak w kolumnie wywołanie. Efekt takiego wywołania widać w kolumnie efekt, lub jest opis dlaczego nie działa.
Kod szablonu | Wywołanie | Efekt |
---|---|---|
proste wywołania | ||
Miasto '''{{{1}}}''' ma {{{2}}} mieszkańców. |
{{Testowy|Ełk|55 846 mieszkańców}} | Miasto Ełk ma 55 846 mieszkańców mieszkańców (jak widać, drugi parametr ma błąd. Wyraz mieszkańców jest dwa razy. Raz przez wywołanie, raz przez kod) |
Miasto '''{{{miasto}}}''' ma {{{liczba_mieszkańców}}} |
{{Testowy|miasto=Ełk|liczba_mieszkańców=55 846}} | Miasto Ełk ma 55 846 (teraz brak określenia czym jest liczba, więc najlepiej napisać to w kodzie szablonu i dobrze opisać w sposobie używania) |
parametry warunkowe wypełnione | ||
Urodził{{{płeć|a}}} się: |
{{Testowy}} | Urodziła się (brak parametru płeć, a więc pojawi się tekst za znakiem "|") |
Urodził{{{płeć|a}}} się: |
{{Testowy|płeć=}} | Urodził się (parametr płeć pusty, a więc nic się nie pojawi na miejscu parameetru) |
Urodził{{{płeć|a}}} się: |
{{Testowy|płeć=''kobieta''}} | Urodziłkobieta się (w miejsce parametru wstawia treść wywołania) |
problemy ze znakiem "=" | ||
Wyrażenie {{{wyrażenie}}} jest spełnione |
{{Testowy|wyrażenie=10=2*5}} | Wyrażenie 10=2*5 jest spełnione |
Wyrażenie {{{1}}} jest spełnione |
{{Testowy|10=2*5}} | Wyrażenie {{{1}}} jest spełnione (błąd - mediawiki potraktowało 10= jako nazwę parametru.) |
Wyrażenie {{{1}}} jest spełnione |
{{Testowy|1=10=2*5}} | Wyrażenie 10=2*5 jest spełnione |