Szablon:Dokumentacja
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 „<
”.
Nagłówek
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
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}}
- Błąd Lua: Nie można utworzyć procesu: proc_open(/dev/null): Failed to open stream: Operation not permitted Szablon:Dokumentacja (edytuj • dyskusja • historia • linkujące • obserwuj • rejestr • CSS • opis)
- Błąd Lua: Nie można utworzyć procesu: proc_open(/dev/null): Failed to open stream: Operation not permitted Szablon:Dokumentacja/opis (edytuj • dyskusja • historia • linkujące • obserwuj • rejestr • CSS • opis)
- Błąd Lua: Nie można utworzyć procesu: proc_open(/dev/null): Failed to open stream: Operation not permitted Szablon:Dokumentacja/nazwa (edytuj • dyskusja • historia • linkujące • obserwuj • rejestr • CSS • opis)
- Błąd Lua: Nie można utworzyć procesu: proc_open(/dev/null): Failed to open stream: Operation not permitted Szablon:Dokumentacja/preload (edytuj • dyskusja • historia • linkujące • obserwuj • rejestr • CSS • opis)
- Błąd Lua: Nie można utworzyć procesu: proc_open(/dev/null): Failed to open stream: Operation not permitted Szablon:Podstrona dokumentacji (edytuj • dyskusja • historia • linkujące • obserwuj • rejestr • CSS • opis)
- Błąd Lua: Nie można utworzyć procesu: proc_open(/dev/null): Failed to open stream: Operation not permitted Szablon:Podstrona dokumentacji/opis (edytuj • dyskusja • historia • linkujące • obserwuj • rejestr • CSS • opis)
Powyższy opis jest dołączany ze strony Szablon:Dokumentacja/opis. (edytuj | historia) Kategorie należy dodawać do podstrony /opis. Zobacz podstrony tego szablonu. |