Pomoc:Dokumentacja szablonu

Szablony to jedna z najpotężniejszych funkcji MediaWiki, ale jednocześnie często bywają trudne do zrozumienia dla nowych użytkowników. Nawet doświadczeni edytorzy mogą mieć problem z bardziej rozbudowanymi szablonami. Dlatego każdy szablon powinien posiadać dokumentację, aby ułatwić korzystanie z niego.

Dokumentacja powinna wyjaśniać, do czego służy szablon oraz jak go poprawnie używać. Powinna być napisana prosto, tak aby nawet osoby, które nie znają jeszcze dobrze szablonów, mogły korzystać z nich bez problemu.

Co powinna zawierać dokumentacja?

Dokumentacja szablonu powinna obejmować:

  • Cel szablonu — co robi i dlaczego,
  • Parametry szablonu,
  • Przykłady użycia,
  • TemplateData,
  • Powiązane szablony.

Jak dodać dokumentację

Dodanie dokumentacji do szablonu

Dodanie dokumentacji jest proste — wymaga jedynie podstaw wikitekstu.

  1. Otwórz wybrany szablon, np. Szablon:Zalążek,
  2. Przejdź do edycji,
  3. Dodaj szablon {{Dokumentacja}} na dole strony,
  4. Zapisz stronę.

Jeśli dokumentacja już istnieje, nad kodem wyświetli się sekcja „Dokumentacja”.

Tworzenie dokumentacji

Jeśli używasz bardziej rozbudowanej wersji szablonu dokumentacji (np. z polskiego startera, wyświetli on komunikat o braku dokumentacji.

Kliknij link „Kliknij tutaj, aby ją dodać!”, a edytor automatycznie załaduje zawartość strony w:c:pl.starter:Szablon:Dokumentacja/preload. Możesz dowolnie edytować tekst.

Co dodać do dokumentacji

Istnieje wiele sposobów pisania dokumentacji szablonów. Sprawdź, czy Twoje wiki ma własne standardy lub wytyczne.

Jeśli nie — możesz skopiować i dostosować poniższy format. 

== Opis ==
Ten szablon służy do...

== Składnia ==
{{s|Szablon}}

== Przykładowy wynik ==
<code>{{Szablon}}</code> wyświetli:

{{Template}}

Szablony z parametrami

Dla szablonów posiadających parametry, struktura zależy od potrzeb szablonu. Opisz, co każdy parametr robi i jakich wartości oczekuje.

Jeśli szablon jest często używany w artykułach, warto dodatkowo dodać TemplateData — treść TemplateData pojawi się w edytorze podczas dodawania szablonu. Po sekcji == Składnia == dodaj: 

== Składnia ==
{{s|Szablon}}

=== Parametry ===
; <code>param=</code>
: Ten parametr robi abc.

=== TemplateData ===
<templatedata>{}</templatedata>

Zobacz też

Dalsze wsparcie

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