Szablon:Dokumentacja/opis
{{
#ifeq: opis | opis |
{{
#ifeq: show | show
|
{{#ifeq:{{#invoke:Ikona|szablon}}|brak | | }}{{#if:
| }}{{#ifeq:Szablon|Szablon|{{#if:||{{#ifexist:Szablon:Dokumentacja||}}}}}}
}}{{
#if: {{#ifeq:Szablon|Szablon||1}}
|
|
}}
| }}
{{#ifeq:{{#invoke:Ikona|szablon}}|brak | | }} {{#if: | }} {{#ifeq:{{#invoke:Ikona|szablon}}|brak | | }} {{#if: | }}To jest szablon {{Dokumentacja}}.
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 /opis szablonu. Przeznaczony jest do dokumentowania szablonów oraz pozostałych stron, które są transkludowane na innych stronach. Może być używany w przestrzeni nazw szablonów oraz większości innych 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[edytuj kod]
Normalnie ten szablon jest używany bez żadnych parametrów, przez umieszczenie na dole strony szablonu w kontenerze {{#switch:o
|z|zamykający =
|p|pojedynczy
|o|otwierający
|para = <noinclude{{#if:| {{{parametry}}}}}
}}{{#switch:o
|z|zamykający =
|p|pojedynczy = />
|o|otwierający = >
|para = {{#ifeq:noinclude|!--||>}}...
}}{{#switch:o
|p|pojedynczy
|o|otwierający =
|z|zamykający
|para = {{#ifeq:noinclude|!--|-->|</noinclude>}}
}}:
<syntaxhighlight lang="xml+smarty">
#if: Dokumentacja|
{{
#ifexist: {{#switch:opis
|test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}}
|[[{{fullurl:{{#switch:opis
|test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}}}} zobacz]] [[{{fullurl:{{#switch:opis
|test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}}|action=edit}} edytuj]] [[{{fullurl:{{#switch:opis
|test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}}|action=history}} historia]] []
|{{
#if:
|[]
|[[{{fullurl:{{#switch:opis
|test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}}|action=edit&preload=Szablon:Dokumentacja/preload}} stwórz]] []
}}}}
}} {{ {{ #ifexist: {{#switch:opis
|test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}} | {{#switch:opis
|test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}} | ns:0 }} }}{{#switch: {{{okno linków}}}|nie=|tak|#default={{#if:||
|
{{
#ifeq: show | show
|{{
#ifexist: {{#switch:opis
|test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}} |Powyższy opis jest dołączany ze strony [[{{#switch:opis |test={{ #rel2abs: ../opis }} |#default=Szablon:Dokumentacja/opis/opis }}]]. ([{{fullurl:{{#switch:opis |test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}}|action=edit}} edytuj] | [{{fullurl:{{#switch:opis |test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}}|action=history}} historia]) }} | }}{{ #switch: opis
|brudnopis=
|test=
|#default={{
#switch: Szablon/show
| Szablon/show | Użytkownik/show | /show ={{
#ifexist: {{ #rel2abs: /brudnopis }}
| Edytorzy mogą eksperymentować w brudnopisie ([{{fullurl:{{ #rel2abs: /brudnopis }}|action=edit}} edytuj] | różnice) {{
#ifexist: {{ #rel2abs: /test }}
| i na stronach testowych ([{{fullurl:{{ #rel2abs: /test }}|action=edit}} edytuj]) tego
| tego}} {{#switch: Szablon | Moduł = modułu | szablonu}}.
}} {{#switch: Szablon | Szablon = {{#ifexist: Szablon:Dokumentacja/opis/opis|Kategorie należy dodawać do podstrony /opis. }}Zobacz [[Specjalna:Strony według prefiksu/{{#ifexist: {{#rel2abs: ../.}}|{{#rel2abs: ../.}}|Szablon:Dokumentacja/opis}}/|podstrony tego szablonu]]. | Moduł = Zobacz [[Specjalna:Strony według prefiksu/{{#ifexist: {{#rel2abs: ../.}}|{{#rel2abs: ../.}}|Szablon:Dokumentacja/opis}}/|podstrony tego modułu]].}} |
}}}}
</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="xml+smarty">
#if: Dokumentacja|
{{
#ifexist: Szablon:Inna strona/opis |[zobacz] [edytuj] [historia] [] |{{ #if: |[] |[stwórz] [] }}}}
}}
{{ {{ #ifexist: Szablon:Inna strona/opis | Szablon:Inna strona/opis | ns:0 }} }}{{#switch: {{{okno linków}}}|nie=|tak|#default={{#if:||
|
{{
#ifeq: show | show
|{{
#ifexist: Szablon:Inna strona/opis
|Powyższy opis jest dołączany ze strony Szablon:Inna strona/opis. (edytuj | historia)
}}{{ #switch: opis
|brudnopis=
|test=
|#default={{
#switch: Szablon/show
| Szablon/show | Użytkownik/show | /show ={{
#ifexist: {{ #rel2abs: /brudnopis }}
| Edytorzy mogą eksperymentować w brudnopisie ([{{fullurl:{{ #rel2abs: /brudnopis }}|action=edit}} edytuj] | różnice) {{
#ifexist: {{ #rel2abs: /test }}
| i na stronach testowych ([{{fullurl:{{ #rel2abs: /test }}|action=edit}} edytuj]) tego
| tego}} {{#switch: Szablon | Moduł = modułu | szablonu}}.
}} {{#switch: Szablon | Szablon = {{#ifexist: Szablon:Dokumentacja/opis/opis|Kategorie należy dodawać do podstrony /opis. }}Zobacz [[Specjalna:Strony według prefiksu/{{#ifexist: {{#rel2abs: ../.}}|{{#rel2abs: ../.}}|Szablon:Dokumentacja/opis}}/|podstrony tego szablonu]]. | Moduł = Zobacz [[Specjalna:Strony według prefiksu/{{#ifexist: {{#rel2abs: ../.}}|{{#rel2abs: ../.}}|Szablon:Dokumentacja/opis}}/|podstrony tego modułu]].}} |
}}}}
</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="xml+smarty">
#if: Dokumentacja|
{{
#ifexist: {{#switch:opis
|test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}}
|[[{{fullurl:{{#switch:opis
|test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}}}} zobacz]] [[{{fullurl:{{#switch:opis
|test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}}|action=edit}} edytuj]] [[{{fullurl:{{#switch:opis
|test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}}|action=history}} historia]] []
|{{
#if: (jakiś opis)
|[]
|[[{{fullurl:{{#switch:opis
|test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}}|action=edit&preload=Szablon:Dokumentacja/preload}} stwórz]] []
}}}}
}}
(jakiś opis){{#switch: {{{okno linków}}}|nie=|tak|#default={{#if:(jakiś opis)||
|
{{
#ifeq: show | show
|{{
#ifexist: {{#switch:opis
|test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}} |Powyższy opis jest dołączany ze strony [[{{#switch:opis |test={{ #rel2abs: ../opis }} |#default=Szablon:Dokumentacja/opis/opis }}]]. ([{{fullurl:{{#switch:opis |test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}}|action=edit}} edytuj] | [{{fullurl:{{#switch:opis |test={{ #rel2abs: ../opis }}
|#default=Szablon:Dokumentacja/opis/opis
}}|action=history}} historia]) }} | }}{{ #switch: opis
|brudnopis=
|test=
|#default={{
#switch: Szablon/show
| Szablon/show | Użytkownik/show | /show ={{
#ifexist: {{ #rel2abs: /brudnopis }}
| Edytorzy mogą eksperymentować w brudnopisie ([{{fullurl:{{ #rel2abs: /brudnopis }}|action=edit}} edytuj] | różnice) {{
#ifexist: {{ #rel2abs: /test }}
| i na stronach testowych ([{{fullurl:{{ #rel2abs: /test }}|action=edit}} edytuj]) tego
| tego}} {{#switch: Szablon | Moduł = modułu | szablonu}}.
}} {{#switch: Szablon | Szablon = {{#ifexist: Szablon:Dokumentacja/opis/opis|Kategorie należy dodawać do podstrony /opis. }}Zobacz [[Specjalna:Strony według prefiksu/{{#ifexist: {{#rel2abs: ../.}}|{{#rel2abs: ../.}}|Szablon:Dokumentacja/opis}}/|podstrony tego szablonu]]. | Moduł = Zobacz [[Specjalna:Strony według prefiksu/{{#ifexist: {{#rel2abs: ../.}}|{{#rel2abs: ../.}}|Szablon:Dokumentacja/opis}}/|podstrony tego modułu]].}} |
}}}}
</syntaxhighlight>
Kiedy użyty jest parametr {{#if:||| }}{{#if:zawartość|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 {{#if:||| }}{{#if:1|1 =}} i {{#if:||| }}{{#if:zawartość|zawartość =}} mogą być także łączone, na przykład:
<syntaxhighlight lang="xml+smarty">
#if: Dokumentacja|
{{
#ifexist: Szablon:Inna strona/opis |[zobacz] [edytuj] [historia] [] |{{ #if: Szablon:Inna strona/opis |[] |[stwórz] [] }}}}
}}
Szablon:Inna strona/opis{{#switch: {{{okno linków}}}|nie=|tak|#default={{#if:Szablon:Inna strona/opis||
|
{{
#ifeq: show | show
|{{
#ifexist: Szablon:Inna strona/opis
|Powyższy opis jest dołączany ze strony Szablon:Inna strona/opis. (edytuj | historia)
}}{{ #switch: opis
|brudnopis=
|test=
|#default={{
#switch: Szablon/show
| Szablon/show | Użytkownik/show | /show ={{
#ifexist: {{ #rel2abs: /brudnopis }}
| Edytorzy mogą eksperymentować w brudnopisie ([{{fullurl:{{ #rel2abs: /brudnopis }}|action=edit}} edytuj] | różnice) {{
#ifexist: {{ #rel2abs: /test }}
| i na stronach testowych ([{{fullurl:{{ #rel2abs: /test }}|action=edit}} edytuj]) tego
| tego}} {{#switch: Szablon | Moduł = modułu | szablonu}}.
}} {{#switch: Szablon | Szablon = {{#ifexist: Szablon:Dokumentacja/opis/opis|Kategorie należy dodawać do podstrony /opis. }}Zobacz [[Specjalna:Strony według prefiksu/{{#ifexist: {{#rel2abs: ../.}}|{{#rel2abs: ../.}}|Szablon:Dokumentacja/opis}}/|podstrony tego szablonu]]. | Moduł = Zobacz [[Specjalna:Strony według prefiksu/{{#ifexist: {{#rel2abs: ../.}}|{{#rel2abs: ../.}}|Szablon:Dokumentacja/opis}}/|podstrony tego modułu]].}} |
}}}}
</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 {{Inna strona/opis{{!}}parametry}}. W tym przykładzie parametry są także dołączane do podstrony /opis.
Najlepsza praktyka[edytuj kod]
Kod powinien być dodany na dole kodu szablonu, bez odstępu przed tagiem {{#switch:o
|z|zamykający =
|p|pojedynczy
|o|otwierający
|para = <noinclude{{#if:| {{{parametry}}}}}
}}{{#switch:o
|z|zamykający =
|p|pojedynczy = />
|o|otwierający = >
|para = {{#ifeq:noinclude|!--||>}}...
}}{{#switch:o
|p|pojedynczy
|o|otwierający =
|z|zamykający
|para = {{#ifeq:noinclude|!--|-->|</noinclude>}}
}}, (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 {{#switch:o
|z|zamykający =
|p|pojedynczy
|o|otwierający
|para = <includeonly{{#if:| {{{parametry}}}}}
}}{{#switch:o
|z|zamykający =
|p|pojedynczy = />
|o|otwierający = >
|para = {{#ifeq:includeonly|!--||>}}...
}}{{#switch:o
|p|pojedynczy
|o|otwierający =
|z|zamykający
|para = {{#ifeq:includeonly|!--|-->|</includeonly>}}
}}. Interwiki szablonu powinny być umieszczane w Wikidanych.
Jeśli strona dokumentacji zawiera tagi {{#switch:o
|z|zamykający = |p|pojedynczy |o|otwierający |para = <includeonly{{#if:| {{{parametry}}}}} }}{{#switch:o |z|zamykający = |p|pojedynczy = /> |o|otwierający = > |para = {{#ifeq:includeonly|!--||>}}... }}{{#switch:o |p|pojedynczy |o|otwierający = |z|zamykający |para = {{#ifeq:includeonly|!--|-->|</includeonly>}} }}lub{{#switch:o |z|zamykający = |p|pojedynczy |o|otwierający |para = <noinclude{{#if:| {{{parametry}}}}} }}{{#switch:o |z|zamykający = |p|pojedynczy = /> |o|otwierający = > |para = {{#ifeq:noinclude|!--||>}}... }}{{#switch:o |p|pojedynczy |o|otwierający = |z|zamykający |para = {{#ifeq:noinclude|!--|-->|</noinclude>}} }}jako część widocznego tekstu dokumentcji, zamień „<” na „<”.
Nagłówek[edytuj kod]
W przestrzeni nazw szablonów, szablon pokazuje następujący nagłówek:
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.:
{{Dokumentacja|nagłówek=Dokumentacja infoboksu}}
Jeśli parametr nagłówek jest pusty, ale zdefiniowany, nad dokumentacją nie wyświetla się nagłówek, ani linki, na przykład"
{{Dokumentacja|nagłówek=}}
Parametr styl nagłówka może być dodatkowo wypełniony wartościami CSS do zmiany jego wyglądu (bez cudzysłowów " ", ale ze średnikami ;); na przykład:
heading-style=font-size:150%;color:red;
Ramka z linkami[edytuj kod]
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 {{#if:||| }}{{#if:okno linków|okno linków =}} nie.
Funkcje automatyczne[edytuj kod]
Jeśli podstrona dokumentacji nie istnieje, link [stwórz] zawiera parametr preload, dzięki czemu pole edycji zostanie wypełnione podstawowym kodem dokumentacji.
Szczegóły techniczne[edytuj kod]
Stroną z preloadem dla przycisku [stwórz] jest Szablon:Dokumentacja/preload.
Pełna składnia[edytuj kod]
{{Dokumentacja}}
{{Dokumentacja
| zawartość =
}}
{{Dokumentacja
| [ścieżka strony dokumentacji]
| styl nagłówka =
| nagłówek =
| okno linków =
}}
Zobacz też[edytuj kod]
Rodzina {{Dokumentacji}}[edytuj kod]
- {{#invoke:Ikona|szablon}} Szablon:Dokumentacja (edytuj • dyskusja • historia • linkujące • obserwuj • rejestr{{#switch:Szablon:|:Kategoria:= • 0 elementów|Szablon:|Moduł:= • CSS • opis}})
- {{#invoke:Ikona|szablon}} Szablon:Dokumentacja/opis (edytuj • dyskusja • historia • linkujące • obserwuj • rejestr{{#switch:Szablon:|:Kategoria:= • 0 elementów|Szablon:|Moduł:= • CSS • opis}})
- {{#invoke:Ikona|szablon}} Szablon:Dokumentacja/nazwa (edytuj • dyskusja • historia • linkujące • obserwuj • rejestr{{#switch:Szablon:|:Kategoria:= • 0 elementów|Szablon:|Moduł:= • CSS • opis}})
- {{#invoke:Ikona|szablon}} Szablon:Dokumentacja/preload (edytuj • dyskusja • historia • linkujące • obserwuj • rejestr{{#switch:Szablon:|:Kategoria:= • 0 elementów|Szablon:|Moduł:= • CSS • opis}})
- {{#invoke:Ikona|szablon}} Szablon:Podstrona dokumentacji (edytuj • dyskusja • historia • linkujące • obserwuj • rejestr{{#switch:Szablon:|:Kategoria:= • 0 elementów|Szablon:|Moduł:= • CSS • opis}})
- {{#invoke:Ikona|szablon}} Szablon:Podstrona dokumentacji/opis (edytuj • dyskusja • historia • linkujące • obserwuj • rejestr{{#switch:Szablon:|:Kategoria:= • 0 elementów|Szablon:|Moduł:= • CSS • opis}})