Szablon:Dokumentacja: Różnice pomiędzy wersjami

Z VatoWiki
Przejdź do nawigacji Przejdź do wyszukiwania
Nie podano opisu zmian
m 1 wersja
 
(Nie pokazano 2 wersji utworzonych przez 2 użytkowników)
Linia 1: Linia 1:
<div class="template-documentation" style="padding: 14px;">{{
<div class="template-documentation" style="padding: 14px;">{{
   #if: {{{nagłówek|Dokumentacja}}}
   #if: {{{nagłówek|Dokumentacja}}}
   |<div style="padding-bottom: {{{heading-padding|3px}}}; border-bottom: 1px solid #aaa; margin-bottom: {{{margines nagłówka|1ex}}}"><span style="{{{styl nagłówka|font-size: 125%; font-weight: 600;}}}">[[Plik:Template-info.png|50px]]&nbsp;{{{nagłówek|Dokumentacja{{#switch: {{NAMESPACE}}|Szablon=&nbsp;szablonu|Moduł=&nbsp;modułu|#default=}}}}}</span>
   |<div style="padding-bottom: {{{heading-padding|3px}}}; border-bottom: 1px solid #aaa; margin-bottom: {{{margines nagłówka|1ex}}}"><span style="{{{styl nagłówka|font-size: 125%; font-weight: 600;}}}">[[Plik:Template-info.png|50px|link=]]&nbsp;{{{nagłówek|Dokumentacja{{#switch: {{NAMESPACE}}|Szablon=&nbsp;szablonu|Moduł=&nbsp;modułu|#default=}}}}}</span>
<span class="plainlinks" id="doc_editlinks" style="margin-left: 1em; font-size: 90%;">{{
<span class="plainlinks" id="doc_editlinks" style="margin-left: 1em; font-size: 90%;">{{
     #ifexist: {{{1|{{Dokumentacja/nazwa}}}}}
     #ifexist: {{{1|{{Dokumentacja/nazwa}}}}}
Linia 8: Linia 8:
       #if: {{{zawartość|}}}
       #if: {{{zawartość|}}}
       |[{{odśwież|odśwież}}]
       |[{{odśwież|odśwież}}]
       |<!-- no content -->[[{{fullurl:{{{1|{{Dokumentacja/nazwa }}}}}|action=edit&preload={{{preload opisu|Szablon:Dokumentacja/preload}}}}} stwórz]]
       |<!-- no content -->[[{{fullurl:{{{1|{{Dokumentacja/nazwa }}}}}|action=edit&preload={{{preload opisu|Szablon:Dokumentacja/preload}}}}} stwórz]] [{{odśwież|odśwież}}]  
     }}
     }}
   }}</span></div>
   }}</span></div>
}}<!-- endif heading -->
}}<!-- endif heading -->
{{{zawartość|{{ {{ #ifexist: {{{1|{{Dokumentacja/nazwa}}}}} | {{{1|{{Dokumentacja/nazwa}}}}} | ns:0 }} }}}}}
{{{zawartość|{{ {{ #ifexist: {{{1|{{Dokumentacja/nazwa}}}}} | {{{1|{{Dokumentacja/nazwa}}}}} | ns:0 }} }}}}}</div>
</div>
{{#switch: {{{okno linków}}}|nie=|tak|#default={{#if:{{{zawartość|}}}||<table id="documentation-meta-data" class="plainlinks fmbox fmbox-system" role="presentation" style="background-color: #ecfcf4">
{{#switch: {{{okno linków}}}|nie=|tak|#default={{#if:{{{zawartość|}}}||<table id="documentation-meta-data" class="plainlinks fmbox fmbox-system" role="presentation" style="background-color: #ecfcf4">
<tr>
<tr>
Linia 21: Linia 20:
   |<!-- transcluded show -->{{
   |<!-- transcluded show -->{{
     #ifexist: {{{1|{{Dokumentacja/nazwa}}}}}
     #ifexist: {{{1|{{Dokumentacja/nazwa}}}}}
     |<!-- /doc exists -->Powyższy [[Pomoc:Schemat opisu szablonu|opis]] jest [[Pomoc:Transkluzja|dołączany]] ze strony [[{{{1|{{Dokumentacja/nazwa}}}}}]]. <small style="font-style: normal;">([{{fullurl:{{ #rel2abs: /test }}|action=edit}} edytuj] {{!}} [{{fullurl:{{ #rel2abs: /test }}|action=history}} historia])</small><br />
     |<!-- /doc exists -->Powyższy [[Pomoc:Schemat opisu szablonu|opis]] jest [[Pomoc:Transkluzja|dołączany]] ze strony [[{{{1|{{Dokumentacja/nazwa}}}}}]]. <small style="font-style: normal;">([{{fullurl:{{{1|{{Dokumentacja/nazwa}}}}}|action=edit}} edytuj] {{!}} [{{fullurl:{{{1|{{Dokumentacja/nazwa}}}}}|action=history}} historia])</small><br />
   }}
   }}
   |<!-- transcluded hide -->
   |<!-- transcluded hide -->
Linia 44: Linia 43:
   }}
   }}
}}
}}
{{#switch: {{NAMESPACE}} | Szablon = {{#ifexist: {{FULLPAGENAME}}/opis|Kategorie należy dodawać do podstrony [[{{FULLPAGENAME}}/opis|/opis]].&nbsp;}}Zobacz [[Specjalna:Strony według prefiksu/{{#ifexist: {{#rel2abs: ../.}}|{{#rel2abs: ../.}}|{{FULLPAGENAME}}}}/|podstrony tego szablonu]]. | Moduł = Zobacz [[Specjalna:Strony według prefiksu/{{#ifexist: {{#rel2abs: ../.}}|{{#rel2abs: ../.}}|{{FULLPAGENAME}}}}/|podstrony tego modułu]].}}</td></tr></table>
{{#switch: {{NAMESPACE}} | Szablon = {{#ifexist: {{FULLPAGENAME}}/opis|Kategorie należy dodawać do podstrony [[{{FULLPAGENAME}}/opis|/opis]].&nbsp;}}Zobacz [[Specjalna:Strony według prefiksu/{{#ifexist: {{#rel2abs: ../.}}|{{#rel2abs: ../.}}|{{FULLPAGENAME}}}}/|podstrony tego szablonu]]. | Moduł = Zobacz [[Specjalna:Strony według prefiksu/{{#ifexist: {{#rel2abs: ../.}}|{{#rel2abs: ../.}}|{{FULLPAGENAME}}}}/|podstrony tego modułu]].}}</div>
</td></tr></table>}}}}
</td></tr></table>}}}}
</div>

Aktualna wersja na dzień 08:37, 8 kwi 2022

 Dokumentacja szablonu [zobacz] [edytuj] [historia] [odśwież]

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

Normalnie ten szablon jest używany bez żadnych parametrów, przez umieszczenie na dole strony szablonu w kontenerze <noinclude>:

<syntaxhighlight lang="xml+smarty">

</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">

</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">

</syntaxhighlight>

Kiedy użyty jest 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 | 1 = i | zawartość = mogą być także łączone, na przykład:

<syntaxhighlight lang="xml+smarty">

</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

Kod powinien być dodany na dole kodu szablonu, bez odstępu przed tagiem <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 <includeonly>. Interwiki szablonu powinny być umieszczane w Wikidanych.

Jeśli strona dokumentacji zawiera tagi <includeonly> lub <noinclude> jako część widocznego tekstu dokumentcji, zamień „<” na „&lt;”.

Nagłówek

W przestrzeni nazw szablonów, szablon pokazuje następujący nagłówek:

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.:

{{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

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 | okno linków = nie.

Funkcje automatyczne

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

Stroną z preloadem dla przycisku [stwórz] jest Szablon:Dokumentacja/preload.

Pełna składnia

{{Dokumentacja}}

{{Dokumentacja
 | zawartość =
}}

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

Zobacz też

Rodzina {{Dokumentacji}}