Szablon:Doc

Z Wiedźmińska Wiki
Skocz do: Nawigacja, szukaj
Template-info.png Dokumentacja

By wykorzystać szablon, stwórz podstronę szablonu o nazwie doc, wstaw {{doc/start}} na szczycie strony i {{doc/end}} na jej końcu.

Następnie, na stronie samego szablonu, wstaw <noinclude>{{doc}}</noinclude> w nowej linii poniżej końca szablonu. Wszystkie podstrony /doc są automatycznie wstawiane do kategorii Kategoria:Szablony dokumentacji.

Parametry opcjonalne

clear

Jeśli główny szablon posiada zawartość typu "float" (tekst opływa szablon), {{doc/start|clear}} zamiast zwykłego {{doc/start}} pozwala na wymuszenie wstawienia dokumentacji poniżej szablonu.
Pozwala to także na stworzenie wyraźnej granicy pomiędzy szzablonem a dokumentacją, w przypadku gdy ten pierwszy nie wykorzystuje funkcji <includeonly>.

nodoc=1

Jeśli szablon nie posiada dokumentacji i brak informacji jak go używać, wstaw {{doc/start|nodoc=1}} (lub {{doc/start|clear|nodoc=1}}, by wymusić pojawienie się dokumentacji poniżej szablonu) zamiast {{doc/start}} na podstronie dokumentacji.
Tło dokumentacji zostanie oznaczone na czerwono i strona zostanie umieszczona w kategorii Kategoria:Szablony bez dokumentacji

baddoc=1

Podobnie jak nodoc, parametr ten przydaje się przy oznaczaniu szablonów które mają dokumentację, ale jest ona cokolwiek kiepska. Może to oznaczać wszystko, od braku przykładów, poprzez brak objaśnienia funkcji szablonu, po brak informacji na temat przeznaczenia szablonu.
Tło dokumentacji zostanie oznaczone na żółto, a strona umieszczona w kategorii Kategoria:Szablony z niewłaściwą dokumentacją.

Parametr nodoc ma wyższy priorytet niż baddoc. W przypadku użycia obu, tylko nodoc zostanie użyty.