Szablon:Dokumentacja: Różnice pomiędzy wersjami
[wersja przejrzana] | [wersja przejrzana] |
m tłumaczenie opisu małego :) |
vva |
||
(Nie pokazano 46 wersji utworzonych przez 13 użytkowników) | |||
Linia 1: | Linia 1: | ||
<div class="template-documentation">{{ |
<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 |
|<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:Test Template Info-Icon.svg|50px|link=]] {{{nagłówek|Dokumentacja{{#switch: {{NAMESPACE}}|Szablon= szablonu|Moduł= modułu|#default=}}}}}</span> |
||
<span class="plainlinks" id="doc_editlinks" style="margin-left: 1em; font-size: 90%;">{{ |
|||
#ifexist: {{{1|{{Dokumentacja/nazwa}}}}} |
#ifexist: {{{1|{{Dokumentacja/nazwa}}}}} |
||
|<!-- /opis istnieje -->[[{{fullurl:{{{1|{{Dokumentacja/nazwa}}}}}|action=edit}} edytuj]] [{{odśwież|odśwież}}] |
|<!-- /opis istnieje -->[[{{fullurl:{{{1|{{Dokumentacja/nazwa}}}}}}} zobacz]] [[{{fullurl:{{{1|{{Dokumentacja/nazwa}}}}}|action=edit}} edytuj]] [[{{fullurl:{{{1|{{Dokumentacja/nazwa}}}}}|action=history}} historia]] [{{odśwież|odśwież}}] |
||
|<!-- nie ma /opis -->{{ |
|<!-- nie ma /opis -->{{ |
||
#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> <span style="{{{styl nagłówka|font-size: 150%}}}">{{{nagłówek|Dokumentacja}}}</span></div> |
|||
}}<!-- endif heading --> |
}}<!-- endif heading --> |
||
⚫ | |||
⚫ | |||
{{#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> |
|||
<td class="mbox-text" style="font-style: italic"> |
|||
⚫ | |||
#ifeq: {{{transcluded|show}}} | show |
#ifeq: {{{transcluded|show}}} | show |
||
|<!-- transcluded show -->{{ |
|<!-- transcluded show -->{{ |
||
#ifexist: {{{1|{{Dokumentacja/nazwa}}}}} |
#ifexist: {{{1|{{Dokumentacja/nazwa}}}}} |
||
|<!-- /doc exists --> |
|<!-- /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 24: | Linia 29: | ||
|#default={{ |
|#default={{ |
||
#switch: {{SUBJECTSPACE}}/{{{sandbox-testcases|show}}} |
#switch: {{SUBJECTSPACE}}/{{{sandbox-testcases|show}}} |
||
| {{ns:template}}/show | {{ns:user}}/show =<!-- show /sandbox /testcases -->{{ |
| {{ns:template}}/show | {{ns:user}}/show | {{ns:module}}/show =<!-- show /sandbox /testcases -->{{ |
||
#ifexist: {{ #rel2abs: /brudnopis }} |
#ifexist: {{ #rel2abs: /brudnopis }} |
||
| |
| Edytorzy mogą eksperymentować w [[/brudnopis|brudnopisie]] <small style="font-style: normal;">([{{fullurl:{{ #rel2abs: /brudnopis }}|action=edit}} edytuj] {{!}} [{{fullurl:Specjalna:Porównywanie stron|page1={{FULLPAGENAMEE}}&page2={{FULLPAGENAMEE}}/brudnopis}} różnice])</small> {{ |
||
#ifexist: {{ #rel2abs: /test }} |
#ifexist: {{ #rel2abs: /test }} |
||
|<!-- /sandbox AND /testcases --> i |
|<!-- /sandbox AND /testcases --> i na stronach [[/test|testowych]] <small style="font-style: normal;">([{{fullurl:{{ #rel2abs: /test }}|action=edit}} edytuj])</small> tego |
||
| |
| tego<!-- /sandbox BUT no /testcases -->}} {{#switch: {{NAMESPACE}} | Moduł = modułu | szablonu}}.<br /> |
||
|<!-- no /sandbox -->{{ |
|<!-- no /sandbox -->{{ |
||
#ifexist: {{ #rel2abs: /test }} |
#ifexist: {{ #rel2abs: /test }} |
||
| |
| Edytorzy mogą eksperymentować na stronach [[/test|testowych]] <small style="font-style: normal;">([{{fullurl:{{ #rel2abs: /test }}|action=edit}} edytuj])</small> tego {{#switch: {{NAMESPACE}} | Moduł = modułu | szablonu}}.<br /> |
||
}} |
}} |
||
}} |
}} |
||
|<!-- hide /sandbox /testcases --> |
|<!-- hide /sandbox /testcases --> |
||
}} |
}} |
||
}} |
}} |
||
{{#switch: {{NAMESPACE}} | Szablon = {{#ifexist: {{FULLPAGENAME}}/opis|Kategorie należy dodawać do podstrony [[{{FULLPAGENAME}}/opis|/opis]]. }}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>}}}} |
|||
</div><noinclude> |
|||
[[als:Vorlage:Dokumentation]] |
|||
[[ar:قالب:توثيق]] |
|||
[[ba:Ҡалып:Doc]] |
|||
[[bg:Шаблон:Документация]] |
|||
[[bar:Vorlage:Dokumentation]] |
|||
[[bs:Šablon:Dokumentacija]] |
|||
[[ca:Plantilla:Ús de la plantilla]] |
|||
[[cs:Šablona:Dokumentace]] |
|||
[[cy:Nodyn:Doc]] |
|||
[[da:Skabelon:Dokumentation]] |
|||
[[de:Vorlage:Dokumentation]] |
|||
[[dsb:Pśedłoga:Dokumentacija]] |
|||
[[et:Mall:Dokumentatsioon]] |
|||
[[el:Πρότυπο:Τεκμηρίωση προτύπου]] |
|||
[[en:Template:Documentation]] |
|||
[[es:Plantilla:Documentación]] |
|||
[[eo:Ŝablono:Dok]] |
|||
[[eu:Txantiloi:Txantiloi dokumentazioa]] |
|||
[[fa:الگو:توضیحات]] |
|||
[[fr:Modèle:Documentation]] |
|||
[[gl:Modelo:Uso de marcador]] |
|||
[[ko:틀:틀 설명문서]] |
|||
[[hy:Կաղապար:Փաստաթղթեր]] |
|||
[[hsb:Předłoha:Dokumentacija]] |
|||
[[id:Templat:Dokumentasi]] |
|||
[[ia:Patrono:Documentation]] |
|||
[[it:Template:Man]] |
|||
[[he:תבנית:תיעוד]] |
|||
[[sw:Kigezo:Documentation]] |
|||
[[ku:Şablon:Belgekirin]] |
|||
[[ltg:Taiss:Dokumentaceja]] |
|||
[[la:Formula:Documentation]] |
|||
[[hu:Sablon:Sablondokumentáció]] |
|||
[[ml:ഫലകം:വിവരണം]] |
|||
[[nl:Sjabloon:Sjabdoc]] |
|||
[[nds-nl:Mal:Dokumentatie]] |
|||
[[ja:Template:Documentation]] |
|||
[[no:Mal:Dokumentasjon]] |
|||
[[tpi:Template:Template doc]] |
|||
[[pt:Predefinição:Documentação]] |
|||
[[ro:Format:Documentație]] |
|||
[[ru:Шаблон:Doc]] |
|||
[[stq:Foarloage:Dokumentation]] |
|||
[[nso:Template:Documentation]] |
|||
[[sq:Stampa:Dokumentacion]] |
|||
[[simple:Template:Documentation]] |
|||
[[sk:Šablóna:Dokumentácia]] |
|||
[[sl:Predloga:Dokumentacija]] |
|||
[[ckb:داڕێژە:Documentation]] |
|||
[[sr:Шаблон:Документација]] |
|||
[[sv:Mall:Dokumentation]] |
|||
[[tl:Suleras:Documentation]] |
|||
[[tt:Калып:Doc]] |
|||
[[te:మూస:Documentation]] |
|||
[[tr:Şablon:Belgeleme]] |
|||
[[uk:Шаблон:Документація]] |
|||
[[ur:سانچہ:Documentation]] |
|||
[[war:Template:Documentation]] |
|||
[[yo:Àdàkọ:Aṣàlàyé]] |
|||
[[diq:Template:Documentation]] |
|||
[[zh:Template:Documentation]] |
|||
</noinclude> |
Aktualna wersja na dzień 19:52, 28 gru 2023
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>
:
<!--Ostatnia linijka kodu Twojego szablonu--><noinclude>
{{Dokumentacja}}
</noinclude>
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:
<!--Ostatnia linijka kodu Twojego szablonu--><noinclude>
{{Dokumentacja|Szablon:Inna strona/opis}}
</noinclude>
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:
<!--Ostatnia linijka kodu Twojego szablonu--><noinclude>
{{Dokumentacja
| zawartość =
(jakiś opis)
}}</noinclude>
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:
<!--Ostatnia linijka kodu Twojego szablonu--><noinclude>
{{Dokumentacja|1=Szablon:Inna strona/opis
| zawartość =
{{Szablon:Inna strona/opis|parametry}}
}}</noinclude>
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}}
- Szablon:Dokumentacja (edytuj • dyskusja • historia • linkujące • obserwuj • rejestr • CSS • opis)
- Szablon:Dokumentacja/opis (edytuj • dyskusja • historia • linkujące • obserwuj • rejestr • CSS • opis)
- Szablon:Dokumentacja/nazwa (edytuj • dyskusja • historia • linkujące • obserwuj • rejestr • CSS • opis)
- Szablon:Dokumentacja/preload (edytuj • dyskusja • historia • linkujące • obserwuj • rejestr • CSS • opis)
Powyższy opis jest dołączany ze strony Szablon:Dokumentacja/opis. (edytuj | historia)
Edytorzy mogą eksperymentować w brudnopisie (edytuj | różnice) tego szablonu. Kategorie należy dodawać do podstrony /opis. Zobacz podstrony tego szablonu. |