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

[wersja nieprzejrzana][wersja przejrzana]
Usunięta treść Dodana treść
m Wycofano edycje użytkownika 78.154.83.101 (dyskusja). Autor przywróconej wersji to Malarz pl.
Linia 1:
Niniejszy '''schemat opisu szablonu''' jest metodą bezpiecznego oddzielenia dokumentacji szablonu od kodu szablonu, poprzez umieszczenie dokumentacji na oddzielnej stronie. Pozwala to na całkowite zabezpieczenie szablonu, jednocześnie umożliwiając pozostawienie dokumentacji niezabezpieczonej, tak by wszyscy mogli ją edytować.
 
== Co to daje? ==
Linia 10:
Niniejsza strona pomocy 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—noinclude—/noinclude, który jest bardzo krótki, a zatem łatwiejszy do przetworzenia przez procesor.
 
Daje to także dwa dodatkowe plusy:
Linia 19:
Dla szablonu o nazwie Szablon:X, należy utworzyć stronę Szablon:X/opis i wkleić na nią następujący kod:
 
: <code style="display:table; line-height:1.2em;"><nowiki>
{{Podstrona dokumentacji}}</nowiki><br /><nowiki>
<!-- EDYTUJ DOKUMENTACJĘ SZABLONU PONIŻEJ TEJ LINII --></nowiki><br /><nowiki>
</nowiki><br /><nowiki>
<includeonly></nowiki><br /><nowiki>
<!-- DODAJ KATEGORIE PONIŻEJ TEJ LINII --></nowiki><br /><nowiki>
</nowiki><br /><nowiki>
<!-- DODAJ INTERWIKI PONIŻEJ TEJ LINII --></nowiki><br /><nowiki>
</includeonly></nowiki><br /><nowiki>
</nowiki></code>
 
Linia 34:
Na stronie szablonu X dodaj:
 
: <code style="display:table; line-height:1.2em;"><nowiki>
<noinclude>{{Dokumentacja}}</nowiki><br /><nowiki>
<!-- Kategorie i interwiki dodawaj do podstrony /opis, nie tutaj! --></nowiki><br /><nowiki>
</noinclude></nowiki><br /><nowiki>
</nowiki></code>
 
Linia 57:
== Zobacz też ==
* [[m:Help:Templates#Noinclude, includeonly, and onlyinclude|&lt;noinclude>, &lt;onlyinclude> i &lt;includeonly>]]
* [[Pomoc:Transkluzja|Wikipedia:Transkluzja]]
* [[Szablon:Dokumentacja]]
* [[Szablon:Podstrona dokumentacji]]