Ŝablono:Dok/dokumentado

Dokumentado

Ĉi tiu ŝablono utilas por provizi dokumentadon al ŝablono.

Esceptoj

Esceptoj estas kelkaj grupoj de ŝablonoj, nome:

• la laŭlandaj subŝablonoj de {{Situo sur mapo}}, por kiuj uzendas {{Situo sur mapo/informoj}}.
• la lingvoindikaj ŝablonoj, kies nomskemo estas la mallongigo de la lingvo (ekz. {{Ar}} - araba, {{Zh}} - ĉina), kiuj uzas la ŝablonon {{Lingva adverbo}} jene:

<noinclude>{{Dok|dok=Ŝablono:Lingva adverbo|aldono= == Alidirektas ĉi tien == * {{Ŝ|Ref-ar}}, {{ŝ|Arabe}} <nowiki/><!--malfuŝas la linisalton post la listo--> }}<!--fino "dok"--> [[Kategorio:Ŝablono:Lingvonomo|Ar]] </noinclude>

• la sufiĉe similaj ŝablonoj por flagoj kun sekva lingva indiko (ekz. {{Flag-de}}), kiuj iomete alie uzas la nomitan ŝablonon, nome:

<noinclude>{{Dok|dok=Ŝablono:Lingva adverbo}} [[Kategorio:Ŝablono:Lingvonomo|De]] [[Kategorio:Flagoj por lingvoj]] </noinclude>

• la lingvoindikaj ŝablonoj, kiuj kaŝe eĉ aldonas <span>-etikedon kun atributoj pri la uzata lingvo, kaj kies nomskemo komenciĝas per Lang-, ekz. {{Lang-hsb}}.

<noinclude>
{{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]]
</noinclude>

• la redakta kapaĵo, al kiu bonvolu aldoni nur {{Redakta-kapaĵo-dok}}, ĉar alikaze aperus la dokumentado je malĝusta loko.

Uzado

Sufiĉas aldoni post la ŝablona kodo:

<noinclude>{{dok}}</noinclude>

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.

Informeto

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ŭ

<noinclude>{{Ŝablona navigado}}</noinclude>

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.

<noinclude>{{Ŝablona navigado|dok=ne}}</noinclude>

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.

Parametroj

La ŝablono nun havas kvin nedevigajn parametrojn, nome ns (mallongigo por nomspaco), dok, ekzemploj, truko kaj supra marĝeno.

Parametro ns

La parametro povas havi unu el la jenaj valoroj.

• 1 - indikas, ke la ŝablono ĉefe estas uzata sur diskutaj paĝoj de artikoloj.
• 2 - indikas, ke la ŝablono ĉefe estas uzata sur vikipediistaj paĝoj.
• 4 - indikas, ke la ŝablono ĉefe estas uzata sur sistemaj paĝoj.
• 6 - indikas, ke la ŝablono ĉefe estas uzata sur bildaj paĝoj.
• 10 - indikas, ke la ŝablono ĉefe estas uzata por krei ŝablonojn.
• 14 - indikas, ke la ŝablono ĉefe estas uzata sur kategoriaj paĝoj.

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:

• Uzado de la ŝablono en artikoloj.

Parametro dok

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=<parametro>. 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}}.

Parametro ekzemploj

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.

Parametro truko

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.

Parametro supra marĝeno

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.

Uzataj subŝablonoj

Atentu, ke la ĉi tie nomata ŝablonoj ne estu rekte uzataj en aliaj ŝablonoj.

• {{Dok/komenco}} (kreas la komencan, do supran parton de la helblua kesto)
• {{Dok/fino}} (kreas la finan, do malsupran parton de la helblua kesto)

Krei subpaĝojn

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.

Enhavtabelo post ŝablonoj

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.
  • Tio estas eĉ kombinebla kun la ceteraj parametroj de {{Dok}}.
• {{TOC-dekstre}} estu metata post la ŝablonoj en la dokumentadoj, post kiuj sekvu la enhavtabelo.

Ŝablonoj sen dokumentado

Vi povas trovi ŝablonojn sen dokumentadoj sur la paĝo Kategorio:Ŝablono:Sen dokumentado.

Vidu ankaŭ

• {{Ŝabloninformo}} Ĝi uzeblas por dokumentado, kiu troviĝas en la ŝablono inter <noinclude> kaj </noinclude>.
• {{Ŝabloninformo/komenco}} kaj {{Ŝabloninformo/fino}} estas uzendaj, se la antaŭe menciita ŝablono ne funkcias pro teknikaj kialoj.