Helpo:Dokumentado

Estas bona ideo doni al ŝablono klarigon pri ties funkcio aŭ almenaŭ pri tio, ke ĝi estas helpa ŝablono de alia ŝablono. Por tio ekzistas kelkaj ŝablonoj, kiuj ĉiam devas stari inter <noinclude> kaj </noinclude> en la ŝablono mem¹, por ne aperi en artikoloj aŭ aliaj ŝablonoj. (¹Se ne io alia estas malsupre menciita.)

Uzeblaj ŝablonoj

• {{Dok}} taŭgas por pli detala dokumentado, kiu troviĝas en subpaĝo de la ŝablono laŭ la skemo Ŝablono/dokumentado.
  • {{Ŝablona navigado}} estas metenda en la dokumentadon mem, por meti tien kelkajn ligilojn, nome al la ŝablono, la dokumentado kaj la diskutopaĝo.
• {{Ŝabloninformo}} taŭgas por malgranda dokumentado, kiu ne bezonas subpaĝon aŭ informas pri uzateco fare de alia ŝablono.
  • {{Ŝabloninformo/komenco}} kaj {{Ŝabloninformo/fino}} estas disaj variaĵoj de la antaŭ ŝablono, uzendaj ĉiam kune, se la antaŭa ne funkcias pro teknikaj kialoj, kiel ekz. uzo de tabela sintakso.

Atentigo

La ŝablonoj {{Dok}} kaj {{Ŝabloninformo}} metas krome kadron ĉirkaŭ la dokumentadon, tiel ke tuj videblas, ke tio ne estas la ŝablona enhavo mem, sed la dokumentado.