Sablon:Dokumentációs allap/doc

Használat

{{Dokumentációs allap}}

vagy

{{Dokumentációs allap|[[Sablon:Var]]}}

Nincs leírás.

Sablonparaméterek

Ennek a sablonnak ajánlott egy sorba írni a paramétereit.

Paraméter		Leírás	Típus	Állapot
név	1	A sablon neve; az „Ez a lap a(z) <név> dokumentációja” mondatban jelenik meg Alap­értelmezett <a sablon neve>	Karakterlánc	opcionális
allapnév	allapnév override	A dokumentációs allap neve, csak a megadott nevű allapon jelenik meg a sablon Alap­értelmezett doc Példa doc2	Sor	opcionális
doboz	doboz doc-notice	A figyelemfelhívó doboz „show” vagy „mutat” érték esetén (vagy a paraméter elhagyásakor) megjelenik, egyébként nem Alap­értelmezett mutat	Sor	opcionális
megnevezés	text1 text2	A sablon megnevezése, alapértelmezetten „sablon”, „modul”, „szerkesztői sablon”, „szócikk” stb. (a névtértől függően)	Karakterlánc	opcionális
alapértelmezett rendezési kulcs	defaultsort	A sablondokumentáció kategóriáiban használt alapértelmezett rendezési kulcs Alap­értelmezett <a sablon neve>	Sor	opcionális
minta	minta inhibit	Ha bármilyen értéket kap, nem kategorizál ez a sablon	Sor	opcionális

Megjelenés

Ezt a sablont általában a /doc allapok tetejére kell elhelyezni. A kimenete az aktuálisan megtekintett laptól függ:

• Egy /doc lapon egy, a sablondokumentációt elmagyarázó és a sablonlapra hivatkozó dobozt jelenít meg.
• Más (vagyis a /doc allapot beillesztő) lapokon a sablon nem jelenik meg. Maga a sablonlap (ami tartalmazza {{Sablondokumentáció}}^(?) sablont) automatikusan észleli, hogy a dokumentáció be van illesztve egy allapról.