Ĉi tiu ŝablono utilas por provizi dokumentadon al ŝablono.
Esceptoj estas kelkaj grupoj de ŝablonoj, nome:
{{Dok|dok=Ŝablono:Lingva adverbo|aldono= == Alidirektas ĉi tien == * {{Ŝ|Ref-ar}}, {{ŝ|Arabe}} }} [[Kategorio:Ŝablono:Lingvonomo|Ar]]
{{Dok|dok=Ŝablono:Lingva adverbo}} [[Kategorio:Ŝablono:Lingvonomo|De]] [[Kategorio:Flagoj por lingvoj]]
Lang-
, ekz. {{Lang-hsb}}.{{Dok/komenco|Ŝablono:Lingva adverbo}} {{Lingva adverbo|ekzemplo=słónco|a1=L-hsn|a2=L-suprasorbe}} {{Dok/fino|dok=Ŝablono:Lingva adverbo}} [[Kategorio:Ŝablono:Lingvonomo|Hsb]]
Sufiĉas aldoni post la ŝablona kodo:
{{dok}}
kaj estiĝos aŭtomata ligilo al subpaĝo Nomo de la paĝo/dokumentado
.
Bonvolu tiam redakti la dokumentadon de la ŝablono por klarigi al aliaj uzantoj la celon, sintakson kaj parametrojn de la ŝablono kiun vi kreis.
Enmeto de {{Ŝablona navigado}} en la komenco de la dokumenta paĝo estigas aŭtomatan navigilon inter la ŝablona paĝo, ties dokumenta subpaĝo kaj diskutpaĝo (kiel ekzemple en la jena paĝo).
{{Ŝablona navigado}}
aŭ
{{Ŝablona navigado}}
Sed vi ankaŭ povas uzi {{Ŝablona navigado}} por la provejo kaj testoj de ŝablono. Tiam ĝi aŭtomate aranĝas ligilon al la alia varianto. T.e. en la provejon ĝi metas ligilon al la testoj kaj inverse.
Prefere vi tiam uzi ĝin jene, precipe se ne ekzistas dokumentado de la koncernata subpaĝo.
{{Ŝablona navigado|dok=ne}}
Atentu, ke la ŝablono aŭtomate analizas la lastan nomparton (post /) de la ŝablono. Do, eĉ proveja aŭ testeja versio de ŝablono povas havi dokumentadon.
La ŝablono nun havas kvin nedevigajn parametrojn, nome ns
(mallongigo por nomspaco), dok
, ekzemploj
, truko
kaj supra marĝeno
.
La parametro povas havi unu el la jenaj valoroj.
La parametro influas unu frazon je la fino de dokumentado, kiu krome enhavas ligilon. Per la ligilo vi povas rigardi al speciala paĝo pri la ŝablona uzado, sed limigita laŭ nomspaco.
Se la parametro mankas, aperas la jena frazo:
Se vi volas uzi dokumentadon por pliaj ŝablonoj, vi povas enskribi la jenan kodon.
{{dok|dok=kompleta nomo de la dokumentado}}
Ekzemploj por tio estas {{0/4}}, {{1/4}}, {{2/4}}, {{3/4}}, kiuj komune uzas la dokumentadon de la ŝablono {{4/4}}. Se vi volas transdoni parametron al la dokumentpaĝo aldonu 2=
. Ekzemplo ĉe {{InternaciaVikipedio/tabelo/100}}.
Atentu, ke ĉe la ŝablono, kies dokumentadon vi tiel enplektas, devas esti uzata la normala sintakso; do sen ĉi tiu parametro. Ĉe la antaŭe nomitaj ŝablonoj {{4/4}} enhavas nur {{Dok}}.
La parametro ekzemploj
estu ĉefe uzata, se ekzemploj ne (nur) troviĝas en la dokumentado, sed (ankaŭ) en aparta subpaĝo, kies nomskemo estas Ŝablono1/ekzemploj
. Ekzemplo por tio troviĝas en {{koordinato}}.
Eblaj valoroj de ekzemploj
estas difinitaj en {{dok/komenco}}:
aldono
(vidu en {{situo sur mapo/+}})kaplinio
klarigoj
(Se aldonaj klarigoj estu metataj aparte, por ne konfuzi uzantojn. Vidu {{informkesto libro}})koordinatoj
(vidu en {{koordinato}})malnova
(Por ke malnova sintakso aperu aparte. Vidu en {{informkesto rivero}})Krome aŭtomate estas aldonata la kategorio Ŝablono:Kun apartaj ekzemploj.
Vidu ankaŭ ŝablona navigado/dokumentado.
La parametro truko
estu nur uzata, se la koncerna ŝablono havas subpaĝon pri iel truka uzado. Tiu subpaĝo sekvas la nomskemon Ŝablono/truko
. Ekzemplo troviĝas en {{informkesto insulo}}.
Krome aŭtomate estas aldonata la kategorio Ŝablono:Kun truka ekzemplo.
La parametro supra marĝeno
difinas supran marĝenon de la ĉirkaŭkadro aranĝata per {{Dok}}.
Tio utilas en kombino kun la ŝablonoj {{Komenco de langetoj}} kaj {{Fino de langetoj}}, kiuj ligas similajn ŝablonojn.
Atentu, ke la ĉi tie nomata ŝablonoj ne estu rekte uzataj en aliaj ŝablonoj.
Antaŭ ol klaki ĉi tie, bonvolu entajpi en la koncernan kesteton la nomon de la ŝablono, por kiu vi volas krei provejon aŭ testan paĝon.
Kelkfoje necesas aranĝi, ke la enhavtabelo sekvu post komenca ŝablono en la dokumentado. Por tio necesas du aldonoj:
{{Dok}}
fariĝu {{Dok|notoc=jes}}
en la ŝablona paĝo, por malaktivigi la defaŭltan enhavtabelon. {{TOC-dekstre}}
estu metata post la ŝablonoj en la dokumentadoj, post kiuj sekvu la enhavtabelo.Vi povas trovi ŝablonojn sen dokumentadoj sur la paĝo Kategorio:Ŝablono:Sen dokumentado.
kaj
.Se vi havas demandon pri ĉi tiu ŝablono, tiam vi povas demandi en la ŝablonprojekta diskutejo. La Intervikiaj ligiloj estu metataj al Vikidatumoj. (Vidu Helpopaĝon pri tio.) |
|