Pomoc:Parametry szablonów

Szablony pozwalają na podawanie parametrów. Dzięki nim możesz zmieniać sposób działania i wygląd szablonu — np. wyświetlać różny tekst lub modyfikować styl. Znak pionowej kreski | to element wikitekstu, który oddziela kolejne parametry szablonu ({{Szablon|<Pierwszy parametr>|<Drugi parametr>|<Trzeci parametr>|<...>}}).

Uwaga: poniższa strona opisuje pracę z szablonami w edytorze kodu źródłowego. Podczas wstawiania szablonów na strony, VisualEditor pozwala wpisywać parametry bez dotykania wikitekstu.

Proste parametry

W prostych szablonach zazwyczaj wystarczą parametry nienazwane. Wartości tych parametrów są przypisywane do kolejnych numerów: {{{1}}}, {{{2}}}, {{{3}}} itd.

Przykład

Poniżej prosty przewodnik tworzący prosty szablon ramki z parametrami nienazwanymi:

  1. Utwórz stronę szablonu (np. „Szablon:Box”).
  2. Wstaw do niej poniższy kod: 
    <div style="background-color: #DDD2; border: 1px solid #5556; padding-top: 2em; text-align: center; width: 10em;">
{{{1}}}
</div>
  3. Zapisz stronę — zobaczysz domyślną zawartość szablonu:
    {{{1}}}
  4. Utwórz stronę artykułu, gdzie użyjesz utworzonego szablonu, np. „Test szablonu”.
  5. Wstaw do niej:
    {{Box|Przykładowy tekst 1|Przykładowy tekst 2}}
  6. Po zapisaniu strona wyświetli:
    Przykładowy tekst 1

Jak to działa?

Szablon wyświetlił „Przykładowy tekst 1”, ponieważ parser MediaWiki zastąpił {{{1}}} treścią pierwszego parametru przekazanego podczas wywołania. Podobnie zachowa się w przypadku innych parametrów tzn. {{{2}}}, {{{3}}}, itd. Gdyby szablon używał {{{2}}}, zamiast pierwszej wartości pojawiłaby się druga:

Przykładowy tekst 2

Kolejne numery odpowiadają kolejnym parametrom:

{{Box|Pierwszy <-- {{{1}}}|Drugi <-- {{{2}}}|Trzeci <-- {{{3}}}|...}}

Parametry nazwane

W bardziej złożonych szablonach lepiej stosować parametry nazwane — użytkownik od razu wie, za co każdy odpowiada. Pamiętaj, że:

  • Wielkość liter w nazwach parametrów ma znaczenie, np. {{{parametr}}} i {{{Parametr}}} to dwa różne parametry.
  • Spacja i podkreślenie są rozróżniane, np. {{{nazwa parametru}}} i {{{nazwa_parametru}}} to również dwa różne parametry.
  • Nazwy parametrów obsługują znaki diakrytyczne, więc można stosować parametry z poprawnym zapisem, np: {{{Źródło}}}.

Przykład

Kontynuujemy pracę nad szablonem „Szablon:Box”.

  1. Edytuj „Szablon:Box” i zastąp kod następującym: 
    <div style="background-color: {{{kolor tła|#DDD2}}}; border: 1px solid #5556; padding: 2em; text-align: center; width: 10em;">
{{{zawartość}}}
</div>
    • {{{zawartość}}} — parametr nazwany zawartość.
    • {{{kolor tła|#DDD2}}} — parametr kolor tła z wartością domyślną #DDD2. Zostanie użyta za każdym razem gdy nie użyjesz tego parametru.
  2. Edytuj stronę „Test szablonu” i wstaw:
    {{Box|kolor tła=navy|zawartość=Granatowe pudełko}}
  3. Po zapisaniu strona wyświetli:
    Granatowe pudełko

Jak to działa?

W przypadku parametrów nazwanych nie ma znaczenia kolejność w jakiej zostały podane. Oznacza to, że poniższy kod da taki sam efekt:

{{Box|zawartość=Granatowe pudełko|kolor tła=navy}}

Dzięki parametrowi domyślnemu kolor tła, pominięcie tego parametry nie spowoduje zepsucia szablonu — zostanie użyta wartość podana po pionowej kresce.

{{Box|zawartość=Granatowe pudełko}}
Granatowe pudełko

Parametry nazwane są często zapisywane w osobnych wierszach i/lub z odstępem między nazwą parametru a znakiem „=”, aby ułatwić czytanie. Zazwyczaj stosuje się to w dużych szablonach składających się z wielu parametrów. Często spotyka się je w następującej formie: 

{{Box
|kolor tła = navy
|zawartość = Granatowe pudełko
}}

Możliwe jest również ustawienie innego parametru jako domyślnego parametru, np. {{{zawartość|{{{1|}}}}}}. Dzięki temu szablon zadziała tak samo — niezależnie czy użyjesz {{Box|Przykładowy tekst}} czy {{Box|zawartość=Przykładowy tekst}}.

W skrócie, jeśli szablon nie znajdzie parametru zawartość=, użyje {{{1}}}. Jeśli i tego nie ma — nic nie wstawi.

Pomijanie parametrów

W niektórych szablonach mogą występować parametry opcjonalne – można je podać lub nie. W zależności jak zostały zdefiniowane, pozostawienie go pustego może dać różny efekt:

  • {{{zawartość}}} → brak parametru pokaże „{{{zawartość}}}” na stronie
  • {{{zawartość|Domyślna zawartość}}} → brak parametru pokaże „{{{Domyślna zawartość}}}” na stronie
  • {{{zawartość|}}} → brak parametru pokaże nic

Podczas tworzenia szablonu z opcjonalnymi parametrami zaleca się użycie nazwanego parametru dla parametru opcjonalnego i/lub umieszczenie go jako ostatniego, aby użytkownicy mogli po prostu go nie podawać.

Jeśli parametr opcjonalny nie został nazwany i nie jest ostatnim, nie ma łatwego sposobu, aby go pominąć. Użycie poniższego kodu nie spowoduje pominięcia patametru: 

{{Box|Pierwszy parametr||Trzeci parametr}}

W powyższym przykładzie MediaWiki uzna, że drugi parametr został podany, ale ma pustą wartość. Oznacza to, że nie zostanie użyta jego wartość domyślna. Może to spowodować nieoczekiwane działanie — szczególnie gdy szablon opiera się na domyślnych treściach uzupełnianych automatycznie.

Jeśli szablon używa opcjonalnych parametrów bez nazw i konieczne jest pominięcie parametru bez nazwy, można to zrobić, używając numerów jako nazw parametrów, np. 

{{Box|1=Pierwszy parametr|3=Trzeci parametr}}

Inną alternatywą jest sprawdzanie czy parametr jest pusty za pomocą funkcji parsera (np. #if)

Uwagi

Aby parametr był widoczny na stronie szablonu, ale dopiero po wywołaniu przyjął inną wartość, można użyć znaczników <includeonly>: {{{Parametr<includeonly>|</includeonly>}}}, {{{Parametr<includeonly>|Wartość domyślna</includeonly>}}}

Zobacz też

Dalsze wsparcie

Szukasz dalszego wsparcia lub masz pytanie? Sprawdź poniższe linki, aby dowiedzieć się więcej.