Wikicytaty:Schemat opisu szablonu: Różnice pomiędzy wersjami

Usunięta treść Dodana treść
Nova (dyskusja | edycje)
Alessia (dyskusja | edycje)
Linia 2:
 
== Co to daje? ==
Użytkownicy generalnie rzecz biorąc lubią, gdy instrukcja obsługi szablonu znajduje się na samej stronie szablonu (na przykład: [[Szablon:niepodpisana]]). Można to osiągnąć, wpisując opis wprost do kodu szablonu wewnątrz tagów <nowiki>&lt;noinclude>...&lt;/noinclude></nowiki>. Powoduje to jednakże pewne problemy:
 
* Tekst umieszczony w <nowiki>&lt;noinclude>...&lt;/noinclude></nowiki>dodaje się do ''pre-expand include size'', który jest ograniczony (patrz [[Wikicytaty:Ograniczenia szablonów]]).
* Niektóre szablony są całkowicie zabezpieczone, ponieważ są dołączane do wielu stron. Edytowanie ich dokumentacji jest utrudnione, ponieważ nie-admini muszą prosić o pomoc administratora.
* Istnieje górne ograniczenie zarówno rozmiaru strony przed dołączeniem szablonów, jak i po [expand]. (...) (zobacz [[Wikicytaty:Ograniczenia szablonów]]).
 
Ten ''How to'' opisujęopisuje strategię i sposób dokumentacji szablonów, który pozwala użytkownikom przypomnieć sobie zasady użycia szablonu (lub nauczyć się ich), a przy tym przyspiesza ładowanie stron i zmniejsza obciążenie serwerów.
 
Rozwiązaniem jest utworzenie dla dokumentacji i instrukcji obsługi '''szablonu dokumentacji''' i przechowywanie ich tam, zamiast wewnątrz samego szablonu narzędziowego. Szablon dokumentacji jest oddzielony od kodu blokiem noinclude&mdash;/noinclude, który jest bardzo krótki, a zatem łatwiejszy do przetworzenia przez procesor.
 
Daje to także dwa dodatkowe plusy: