Tekst źródłowy strony Szablon:Dokumentacja/opis

{{Podstrona dokumentacji}}
<!-- DODAWAJ KATEGORIE NA DOLE STRONY -->
{{wysokie ryzyko|liczba=ponad 10 000}}
{{wysokie ryzyko|skomplikowany}}
To jest szablon <nowiki>{{</nowiki>'''Dokumentacja'''<nowiki>}}</nowiki>.

Dla większości instrukcji określających kiedy i jak stosować ten szablon, zobacz [[Pomoc:Schemat opisu szablonu]].

Ten szablon wyświetla zieloną ramkę, którą teraz widzisz, i automatycznie przedstawia w niej zawartość podstrony <code>/opis</code> szablonu. Przeznaczony jest do dokumentowania szablonów oraz pozostałych stron, które są [[Pomoc:Transkluzja|transkludowane]] na innych stronach. Może być używany w przestrzeni nazw szablonów oraz większości innych [[Pomoc:Przestrzeń nazw|przestrzeni nazw]]. Użycie tego szablonu umożliwia ponadto zabezpieczenie szablonu, podczas gdy zawartość dokumentacji i kategorii nadal jest możliwa dla każdego.

== Użycie ==
Normalnie ten szablon jest używany bez żadnych parametrów, przez umieszczenie na dole strony szablonu w kontenerze {{tag|noinclude|o}}:

<syntaxhighlight lang="wikitext">
<!--Ostatnia linijka kodu Twojego szablonu--><noinclude>
{{Dokumentacja}}
</noinclude>
</syntaxhighlight>

Wówczas ten szablon automatycznie ładuje zawartość podstrony /opis szablonu, dla którego jest używany.

Jednak szablon może załadować dokumentację z każdej innej dowolnej strony, na przykład:

<syntaxhighlight lang="wikitext">
<!--Ostatnia linijka kodu Twojego szablonu--><noinclude>
{{Dokumentacja|Szablon:Inna strona/opis}}
</noinclude>
</syntaxhighlight>

Zwróć uwagę, że przy ładowaniu dokumentacji strony innej niż lokalna podstrona /opis, trudnym staje się zarządzanie kategoriami szablonu.

Zawartość dokumentacji może być także podana bezpośrednio jako tekst, na przykład:

<syntaxhighlight lang="wikitext">
<!--Ostatnia linijka kodu Twojego szablonu--><noinclude>
{{Dokumentacja
 | zawartość =
(jakiś opis)
}}</noinclude>
</syntaxhighlight>

Kiedy użyty jest parametr {{parametr|zawartość}}, okno dokumentacji normalnie nie pokazuje linków [edytuj] i [odśwież] w nagłówku. Zwróć uwagę, że nawet jeśli załączono opis szablonu z trzeciej strony, a podstrona /opis istnieje, w ramce pod dokumentacją link do niej w dalszym ciągu będzie się pokazywał.

Parametry {{parametr|1}} i {{parametr|zawartość}} mogą być także łączone, na przykład:

<syntaxhighlight lang="wikitext">
<!--Ostatnia linijka kodu Twojego szablonu--><noinclude>
{{Dokumentacja|1=Szablon:Inna strona/opis
| zawartość =
{{Szablon:Inna strona/opis|parametry}}
}}</noinclude>
</syntaxhighlight>

Wówczas strona podana w parametrze 1 jest wykorzywana w linkach [edytuj] i [odśwież] i w linku do transkludowanej strony w ramce pod dokumentacją, a parametr '''zawartość''' jest używany do zawartości okna dokumentacji. Powyższy kod oznacza, że treść jest transkludowana jako <kbd><nowiki>{{Inna strona/opis{{!}}parametry}}</nowiki></kbd>. W tym przykładzie parametry są także dołączane do podstrony /opis.

== Najlepsza praktyka ==
Kod powinien być dodany na dole kodu szablonu, bez odstępu przed tagiem {{tag|noinclude|o}}, (który mógłby powodować dodatkowy odstęp na stronach, gdzie szablon jest wykorzystywany).

Kategorie, które odnoszą się do samego szablonu, powinny być dodawane na dole podstrony /opis, wewnątrz tagów {{tag|includeonly|o}}. Interwiki szablonu powinny być umieszczane w [[:wikidata:|Wikidanych]].

Jeśli strona dokumentacji zawiera tagi {{tag|includeonly|o}} lub {{tag|noinclude|o}} jako część widocznego tekstu dokumentcji, zamień „<code>&lt;</code>” na „<code>&amp;lt;</code>”.

== Nagłówek ==
W przestrzeni nazw szablonów, szablon pokazuje następujący nagłówek:
: [[Plik:Template-info.png|32px]] '''Dokumentacja szablonu'''

W większości przestrzeni nazw, takich jak np. „Wikipedia:”, pokazuje następujący nagłówek:
: '''Dokumentacja'''

Parametr '''nagłówek''' może być użyty do zmiany treści nagłówka na dowolny tekst, np.:

: <code><nowiki>{{Dokumentacja|nagłówek=Dokumentacja infoboksu}}</nowiki></code>

Jeśli parametr '''nagłówek''' jest pusty, ale zdefiniowany, nad dokumentacją nie wyświetla się nagłówek, ani linki, na przykład"

: <code><nowiki>{{Dokumentacja|nagłówek=}}</nowiki></code>

Parametr '''styl nagłówka''' może być dodatkowo wypełniony wartościami [[Kaskadowe arkusze stylów|CSS]] do zmiany jego wyglądu (bez cudzysłowów <code>" "</code>, ale ze średnikami <code>;</code>); na przykład:
: <code>heading-style=font-size:150%;color:red;</code>

== Ramka z linkami ==
Pod dużym oknem zawierającym dokumentację znajduje się mniejsze, zawierające linki i metainformacje na temat tej dokumentacji. Zawartość tego okienka zależy od użytych parametrów oraz od przestrzeni nazw. W pewnymch przypadkach nie pokazuje się ono wcale.

Aby ukryć ręcznie to okno, należy podać parametr {{parametr|okno linków|nie}}.<!--

You can also insert customised text in the link box, by defining the {{para|link box}} parameter. For example:
{{para|link box|This documentation is automatically generated by [<nowiki />[Template:Country showdata]]}}-->

== Funkcje automatyczne ==
Jeśli podstrona dokumentacji nie istnieje, link [stwórz] zawiera parametr [[mw:Manual:Creating pages with preloaded text|preload]], dzięki czemu pole edycji zostanie wypełnione podstawowym kodem dokumentacji.

== Szczegóły techniczne ==
Stroną z preloadem dla przycisku [stwórz] jest [[Szablon:Dokumentacja/preload]].

=== Pełna składnia ===
<syntaxhighlight lang="wikitext">
{{Dokumentacja}}

{{Dokumentacja
 | zawartość =
}}

{{Dokumentacja
| [ścieżka strony dokumentacji]
| styl nagłówka =
| nagłówek =
| okno linków =
}}
</syntaxhighlight>

== Zobacz też ==
=== Rodzina &#123;&#123;Dokumentacji&#125;&#125; ===
* {{lt|Dokumentacja}}
* {{lt|Dokumentacja/opis}}
* {{lt|Dokumentacja/nazwa}}
* {{lt|Dokumentacja/preload}}

* {{lt|Podstrona dokumentacji}}
* {{lt|Podstrona dokumentacji/opis}}

<includeonly><!--
++++ DODAWAJ KATEGORIE PONIŻEJ TEJ LINII -->
[[Kategoria:Szablony do dokumentacji szablonów|{{PAGENAME}}]][[Kategoria:Szablony szablonów]]
</includeonly>