Ŝablono:Dok/dokumentado
El Komunejo
E (→Parametro: aldono) |
(korekto, interwiki) |
||
| (11 mezaj versioj ne montrata.) | |||
| Linio 1: | Linio 1: | ||
{{Ŝablona navigado}} | {{Ŝablona navigado}} | ||
| - | + | {{ofte uzata|pli ol 90}} | |
| - | {{ofte uzata| | + | |
== Dokumentado == | == Dokumentado == | ||
Ĉi ŝablono utilas por provizi dokumentadon al ŝablono, escepte de la laŭlandaj subŝablonoj de {{ŝ|Situo sur mapo}}, por kiuj uzendas {{ŝ|Situo sur mapo/informoj}}. | Ĉi ŝablono utilas por provizi dokumentadon al ŝablono, escepte de la laŭlandaj subŝablonoj de {{ŝ|Situo sur mapo}}, por kiuj uzendas {{ŝ|Situo sur mapo/informoj}}. | ||
| Linio 13: | Linio 12: | ||
Bonvolu tiam redakti la dokumentadon de la ŝablono por klarigi al aliaj uzantoj la celon, sintakson kaj parametrojn de la ŝablono kiun vi kreis. | 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). | 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). | ||
| + | <pre> | ||
| + | {{Ŝablona navigado}} | ||
| + | </pre> | ||
| + | aŭ | ||
| + | <pre> | ||
| + | <noinclude>{{Ŝablona navigado}}</noinclude> | ||
| + | </pre> | ||
| + | |||
| + | 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. | ||
| + | <pre> | ||
| + | <noinclude>{{Ŝablona navigado|dok=ne}}</noinclude> | ||
| + | </pre> | ||
| + | |||
| + | '''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== | ==Parametroj== | ||
| - | La ŝablono nun havas | + | La ŝablono nun havas tri nedevigajn parametrojn, nome ''ns'' (mallongigo por nomspaco), ''dok'' kaj ''supra marĝeno''. |
===Parametro ns=== | ===Parametro ns=== | ||
La parametro povas havi unu el la jenaj valoroj. | 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. | *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. | *6 - indikas, ke la ŝablono ĉefe estas uzata sur bildaj paĝoj. | ||
*10 - indikas, ke la ŝablono ĉefe estas uzata por krei ŝablonojn. | *10 - indikas, ke la ŝablono ĉefe estas uzata por krei ŝablonojn. | ||
| Linio 39: | Linio 57: | ||
'''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 {{tl|4/4}} enhavas nur {{tl|Dok}}. | '''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 {{tl|4/4}} enhavas nur {{tl|Dok}}. | ||
| + | |||
| + | ===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 butonoj}} kaj {{ŝ|Fino de butonoj}}, kiuj ligas similajn ŝablonojn. Ekzemplo troviĝas en {{ŝ|Informkesto esperantisto}}. | ||
==Uzataj subŝablonoj== | ==Uzataj subŝablonoj== | ||
'''Atentu''', ke la ĉi tie nomata ŝablonoj ne estu rekte uzataj en aliaj ŝ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 helflava kesto) |
| - | *{{ŝ| | + | *{{ŝ|Dok/fino}} (kreas la finan, do malsupran parton de la helflava kesto) |
== Krei subpaĝojn == | == Krei subpaĝojn == | ||
| Linio 78: | Linio 101: | ||
[[Kategorio:Vikipedio:Helpŝablonoj|Dok]] | [[Kategorio:Vikipedio:Helpŝablonoj|Dok]] | ||
[[Kategorio:Ŝablonoj por dokumentado|Dok]] | [[Kategorio:Ŝablonoj por dokumentado|Dok]] | ||
| - | |||
[[de:Vorlage:Dokumentation]] | [[de:Vorlage:Dokumentation]] | ||
| - | [[ | + | [[eo:Ŝablono:Dok]] |
| - | + | [[hsb:Předłoha:Dokumentacija]] | |
| - | + | </includeonly><noinclude> | |
| - | + | ||
| - | [[hsb:Předłoha | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | </includeonly> | + | |
| - | <noinclude> | + | |
| - | + | ||
[[Kategorio:Ŝablona dokumentado|{{PAGENAME}}]] | [[Kategorio:Ŝablona dokumentado|{{PAGENAME}}]] | ||
| - | |||
</noinclude> | </noinclude> | ||
Nuna versio ekde 21:04, 23. Dec 2009
Ŝablono:Dok • Dokumentado • Diskuto
Enhavo |
Dokumentado
Ĉi ŝablono utilas por provizi dokumentadon al ŝablono, escepte de la laŭlandaj subŝablonoj de {{Situo sur mapo}}, por kiuj uzendas {{Situo sur mapo/informoj}}.
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 tri nedevigajn parametrojn, nome ns (mallongigo por nomspaco), dok 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}}.
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 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 butonoj}} kaj {{Fino de butonoj}}, kiuj ligas similajn ŝablonojn. Ekzemplo troviĝas en {{Informkesto esperantisto}}.
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 helflava kesto)
- {{Dok/fino}} (kreas la finan, do malsupran parton de la helflava 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.
|
|
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.
