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

Z VatoWiki
Przejdź do nawigacji Przejdź do wyszukiwania
← poprzednia edycja
WizualnieWikikod
Nie podano opisu zmian
m 1 wersja
 
(Nie pokazano 2 wersji utworzonych przez 2 użytkowników)
Linia 1: Linia 1:
{{Podstrona dokumentacji}}__NOTOC__
{{Podstrona dokumentacji}}__NOTOC__
<!-- DODAWAJ KATEGORIE NA DOLE STRONY -->
<!-- DODAWAJ KATEGORIE NA DOLE STRONY -->
 
{{wysokie ryzyko|liczba=ponad 10 000}}
{{wysokie ryzyko|skomplikowany}}
To jest szablon <nowiki>{{</nowiki>'''Dokumentacja'''<nowiki>}}</nowiki>.
To jest szablon <nowiki>{{</nowiki>'''Dokumentacja'''<nowiki>}}</nowiki>.


Dla większości instrukcji określających kiedy i jak stosować ten szablon, zobacz [[w:Pomoc:Schemat opisu szablonu]].
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ą [[w:Pomoc:Transkluzja|transkludowane]] na innych stronach. Może być używany w przestrzeni nazw szablonów oraz większości innych [[w: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.
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 ==
== Użycie ==
Normalnie ten szablon jest używany bez żadnych parametrów, przez umieszczenie na dole strony szablonu w kontenerze {{tag|noinclude|o}}:
Normalnie ten szablon jest używany bez żadnych parametrów, przez umieszczenie na dole strony szablonu w kontenerze {{tag|noinclude|o}}:


<source lang="xml+smarty">
<syntaxhighlight lang="xml+smarty">
<!--Ostatnia linijka kodu Twojego szablonu--><noinclude>
<!--Ostatnia linijka kodu Twojego szablonu--><noinclude>
{{Dokumentacja}}
{{Dokumentacja}}
</noinclude>
</noinclude>
</source>
</syntaxhighlight>


Wówczas ten szablon automatycznie ładuje zawartość podstrony /opis szablonu, dla którego jest używany.
Wówczas ten szablon automatycznie ładuje zawartość podstrony /opis szablonu, dla którego jest używany.
Linia 21: Linia 22:
Jednak szablon może załadować dokumentację z każdej innej dowolnej strony, na przykład:
Jednak szablon może załadować dokumentację z każdej innej dowolnej strony, na przykład:


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


Zwróć uwagę, że przy ładowaniu dokumentacji strony innej niż lokalna podstrona /opis, trudnym staje się zarządzanie kategoriami szablonu.
Zwróć uwagę, że przy ładowaniu dokumentacji strony innej niż lokalna podstrona /opis, trudnym staje się zarządzanie kategoriami szablonu.
Linia 31: Linia 32:
Zawartość dokumentacji może być także podana bezpośrednio jako tekst, na przykład:
Zawartość dokumentacji może być także podana bezpośrednio jako tekst, na przykład:


<source lang="xml+smarty">
<syntaxhighlight lang="xml+smarty">
<!--Ostatnia linijka kodu Twojego szablonu--><noinclude>
<!--Ostatnia linijka kodu Twojego szablonu--><noinclude>
{{Dokumentacja
{{Dokumentacja
Linia 37: Linia 38:
(jakiś opis)
(jakiś opis)
}}</noinclude>
}}</noinclude>
</source>
</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ł.
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:
Parametry {{parametr|1}} i {{parametr|zawartość}} mogą być także łączone, na przykład:


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


Wówczas strona podana w parametrze 1 jest wykorzystywana 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 <tt><nowiki>{{Inna strona/opis{{!}}parametry}}</nowiki></tt>. W tym przykładzie parametry są także dołączane do podstrony /opis.
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 ==
== Najlepsza praktyka ==
Linia 58: Linia 59:
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]].
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 dokumentacji, zamień „<code>&lt;</code>” na „<code>&amp;lt;</code>”.
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 ==
== Nagłówek ==
Linia 75: Linia 76:
: <code><nowiki>{{Dokumentacja|nagłówek=}}</nowiki></code>
: <code><nowiki>{{Dokumentacja|nagłówek=}}</nowiki></code>


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


== Ramka z linkami ==
== 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 pewnych przypadkach nie pokazuje się ono wcale.
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}}.<!--


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 ==
== Funkcje automatyczne ==
Linia 104: Linia 108:
}}
}}
</pre>
</pre>
== 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><!--
<includeonly><!--
++++ DODAWAJ KATEGORIE PONIŻEJ TEJ LINII -->
++++ DODAWAJ KATEGORIE PONIŻEJ TEJ LINII -->
[[Kategoria:Narzędzia dokumentacji szablonów|{{PAGENAME}}]]
[[Kategoria:Szablony do dokumentacji szablonów|{{PAGENAME}}]][[Kategoria:Szablony szablonów]]
</includeonly>
</includeonly>

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

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

 Dokumentacja szablonu [stwórz] [odśwież]

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

 Dokumentacja szablonu [stwórz] [odśwież]

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

 Dokumentacja szablonu [odśwież]
(jakiś opis)

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

 Dokumentacja szablonu [odśwież]
Szablon:Inna strona/opis

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


Źródło: „https://bajkowscy.pl/mw22/index.php?title=Szablon:Dokumentacja/opis&oldid=1996”