Pomoc:Parametry
Z Wikipedii
Parametry są konstrukcjami wikikodu, możliwymi do stosowania dzięki rozszerzeniu silnika MediaWiki w postaci funkcji parsera, stosowanymi do tworzenia szablonów, szablonów specjalnych, a zwłaszcza infoboksów, czyli de facto wikimakr. Parametrem jest taki element wikikodu, który znajduje się w treści szablonu i występuje po trzech otwierających (lewych) nawiasach klamrowych.
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 1: 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ć tworzone 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ść}}
Tak więc w przypadku tzw. parametrów nazwanych nie ma znaczenia ich kolejność w wywołaniu szablonu.
[edytuj] Parametry nienazwane
Parametry nienazwane (numeryczne) 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ść}}
- Uwaga: Tak naprawdę parametry numeryczne są parametrami nazwanymi, w których nazwy są numerami. Gdy wszystkie parametry w wywołaniu szablonu są ponazywane, wtedy ich kolejność nie ma znaczenia.
[edytuj] Parametry warunkowe
Drugim rodzajem parametrów są parametry warunkowe. Tworzy się je poprzez dodanie znaku "|" (ang. pipe) przed nawiasami klamrowymi zamykającymi parametr. 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}}}}}}, {{{2|{{{miasto|}}}}}}, 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 (także może być to parametr warunkowy wypełniony), a nawet szablon z innymi lub tymi samymi parametrami.
Wywołanie tego rodzaju parametrów jest analogiczne jak wcześniejszych. Różnią się natomiast efektem końcowym, gdy brak jest wywołania, a więc gdy w wywołaniu szablonu zabraknie danego parametru. 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 parametru 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. W kolumnie efekt znajduje się efekt takiego wywołania lub wyjaśnienie, dlaczego kod 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 pojawia się przez kod szablonu (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 |
| przykładowe błędy | ||
Urodził{{{płeć|a}}} się:
|
{{Testowy|kobieta}} | Urodziła się (brak parametru płeć, a więc pojawi się tekst za znakiem "|", zamiast parametru płeć pojawia się w wywołaniu szablonu treść nienazwanego parametru. W kodzie szablonu go nie ma, więc jest ignorowany) |
Miasto {{{Nazwa miasta|}}}:
|
{{Testowy|Kraków}} | Miasto (w wywołaniu szablonu jest parametr nienazwany o treści Kraków, a w kodzie szablonu jest parametr Nazwa miasta) |
Miasto {{{Nazwa miasta|}}}:
|
{{Testowy|Nazwa_miasta=Kraków}} | Miasto (w wywołaniu szablonu jest parametr Nazwa_miasta, a w kodzie szablonu jest parametr Nazwa miasta. Nazwy więc się różnią) |
Miasto {{{Nazwa miasta|}}} |
{{Testowy|Nazwa miasta=Kraków}} | Miasto Kraków ma {{{mieszkańcy}}} mieszkańców (w wywołaniu szablonu zabrakło parametru mieszkańcy i mediawiki potraktowała ten parametr jako tekst, łącznie z nawiasami klamrowymi.) |

