Pomoc:Parametry

Dla zaawansowanych

Te informacje dotyczą edytora wikikodu. Brak analogicznych dotyczących edytora wizualnego (Czym to się różni?)

Parametr (dla użytkowników edytora wizualnego − pole) − konstrukcja możliwa do stosowania dzięki rozszerzeniu silnika MediaWiki w postaci funkcji parsera, stosowana przy tworzeniu i korzystaniu (wywoływaniu) z szablonów, a zwłaszcza infoboksów.

W kodzie źródłowym cechą charakterystyczną parametru jest otwarcie i zamknięcie trzema nawiasami klamrowymi wewnątrz kodu szablonu, zaś w VE pole występuje jako element okna edycji szablonu, w którym użytkownik może wpisać określoną treść. Poradnik ten jest oparty na perspektywie wikikodu z elementami VE, ponieważ mimo że z wielu szablonów można skorzystać w VE, to jednak tworzy i edytuje się je wyłącznie w wikikodzie.

Rodzaje parametrów

Parametry typowe

Ze względu na specyfikację (wywołanie) parametrów (cecha niewidoczna z perspektywy obsługującego VE) można podzielić szablony na dwa rodzaje, po dwa typy każdy. Podział i nazwy są umowne, jednak przyjęły się w języku wikipedystów:

• 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 dla tworzących szablony: w nazwach parametrów stosujemy spacje, nie podkreślniki.

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.

Parametry nazwane

Powyższe dwa rodzaje różnią się sposobem wywoływania (korzystania z szablonu w kodzie źródłowym). I tak fragment kodu źródłowego:

{{Szablon|nazwa parametru=treść|dwa=treść2}}

powoduje wywołanie szablonu o nazwie Szablon, w roli parametru (pola) o nazwie (technicznej, nie zawsze tożsamej z etykietą, czyli nazwą pola w VE) nazwa parametru pojawia się tekst treść, zaś w roli parametru dwa pojawia się tekst treść2. W przypadku tzw. parametrów nazwanych nie ma znaczenia ich kolejność we wpisaniu w kodzie źródłowym, dlatego to samo osiągniemy, gdy napiszemy tak:

{{Szablon|dwa=treść2|nazwa parametru=treść}}

Parametry nienazwane

Parametry nienazwane (numeryczne) przekazujemy w następujący sposób:

{{Szablon|treść|treść2}}

Uwaga 1: parametry nienazwane można (a czasami trzeba, patrz problemy ze znakiem "=") przekazywać do szablonu w sposób podobny do parametrów nazwanych, jako nazwę podając ich numery.

Uwaga 2: parametry nienazwane są bardziej problematyczne z perspektywy VE, ponieważ − skoro nie mają nazwy i w przeciwieństwie do nazwanych − nie podpowiadają, jaka ma być etykieta pola.

Analogiczny efekt do powyższego przykładu uzyskamy, kiedy napiszemy tak:

• 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 nienazwane są parametrami nazwanymi, których nazwy są kolejnymi numerami. Gdy wszystkie parametry w kodzie źródłowym są ponazywane, wtedy ich kolejność nie ma znaczenia.

Parametry warunkowe

Drugim rodzajem parametrów są parametry warunkowe, to także jest podział widoczny wyłącznie w kodzie źródłowym. 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 (jakby: zażądamy pola, a nie podamy treści). Wymagany jest brak wywołania. A więc {{Szablon|nazwa miasta=}} będzie wyglądało jak wywołanie parametru pustego, nawet gdy parametr nazwa miasta jest wypełniony (Warszawa). Aby ten sposób działał i pojawiła się Warszawa, należy wywołać szablon bez tego parametru, np. {{Szablon}} lub {{Szablon|}}.

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 niepotrzebnie zawiera słowo "mieszkańców", już statycznie występujące w kodzie szablonu, co powoduje dwukrotne jego pojawienie się w wynikowym tekście)
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 parametru)
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|}}} ma {{{mieszkańcy}}} mieszkańców:	{{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.)

Linki zewnętrzne

• (ang.) m:Help:Parameter default
• (ang.) m:Help:Substitution