Sablon:Dokumentációs allap/doc

A Wikiforrásból
Ugrás a navigációhoz Ugrás a kereséshez

Használat[szerkesztés]

{{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éterLeírásTípusÁllapot
név1

A sablon neve; az „Ez a lap a(z) <név> dokumentációja” mondatban jelenik meg

Alapértelmezett
<a sablon neve>
Karakterláncopcionális
allapnévallapnév override

A dokumentációs allap neve, csak a megadott nevű allapon jelenik meg a sablon

Alapértelmezett
doc
Példa
doc2
Soropcionális
dobozdoboz 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
Soropcionális
megnevezéstext1 text2

A sablon megnevezése, alapértelmezetten „sablon”, „modul”, „szerkesztői sablon”, „szócikk” stb. (a névtértől függően)

Karakterláncopcionális
alapértelmezett rendezési kulcsdefaultsort

A sablondokumentáció kategóriáiban használt alapértelmezett rendezési kulcs

Alapértelmezett
<a sablon neve>
Soropcionális
mintaminta inhibit

Ha bármilyen értéket kap, nem kategorizál ez a sablon

Soropcionális

Megjelenés[szerkeszté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.