Dokumentado

Foje okazas, ke en iu artikolo nombra parametro de iu ŝablono (tre verŝajne informkesto) havas nenombran signifon. La ŝablono ((np)) (nombra parametro) provizas facilan manieron kontroli tion en la kodo de ŝablonoj. Sed atentu: se vi ne posedas la lingvon por markado de ŝablonoj, ĉi tiu ŝablono apenaŭ helpos vin.

Se la signifo, transdonita al ĉi tiu ŝablono, estas nombro, la ŝablono formatos ĝin (kaj, se estas indikita, mezurunuon). Se la signifo ne estas nombro, la ŝablono montros ĝin (kaj, se necesas, mezurunuon) senŝanĝe, montros erarmesaĝon kaj, se la ŝablono troviĝas en artikolo, aldonos tiun artikolon al la kaŝita kategorio Nenombraj signifoj de nombraj parametroj.

La ŝablono traktas ĝis tri sennomajn kaj unu nomitan parametrojn:

1. (deviga) parametra nomo, ĉirkaŭita per tri paroj de figuraj krampoj (do, ne nomo sed signifo de la esplorata parametro);
2. (nedeviga) mezurunuo;
3. (nedeviga) estas sama kiel la dua kaj povas esti uzata anstataŭ ĝi.

La nomita parametro estas ŝablono. Ĝi ne estas deviga, tamen estas ege dezirinde uzi ĝin. Ĝia valoro estu la nomo de la ŝablono, en kies kodo vi uzas la ŝablonon ((np)) (sen la vorto ŝablono); ekzemple, en la kodo de la ŝablono ((Informkesto akvofalo)) tio estas |ŝablono=Informkesto akvofalo.

La tabelo montras diferencon inter la dua kaj tria parametroj.

Plej verŝajne, vi ne bezonos la trian parametron: indiku mezurunuon en la dua parametro. La tria parametro necesas nur tiam, kiam en pluraj artikoloj koncerna informkesta parametro estas plenigita per ambaŭ nombro kaj mezurunuo (ekzemple, tio povas okazi, se la informkesta dokumentaro antaŭe rekomendis tion). Se vi ne certas, uzu la duan parametron.

Uzite sen parametroj, la ŝablono donos nenion.

• ((ĈuNombro))
• ((ĈuNombro2))
• ((Unuo))
• ((Atentigo pri numeroj)) estu metata en la dokumentadon de ŝablonoj, kiuj enplektas ((np))

Uzado de la ŝablono en artikoloj. (Helpo pri la koncerna Dok-parametro) Ĉi tiu dokumentado estas enplektita el subpaĝo. Krei subpaĝon por provejo de ŝablono. (Helpo) Krei testan paĝon kun ekzemploj. (Helpo) Listo de subpaĝoj.