Format:Documentație/doc

Aceasta este pagina de documentație pentru Format:Documentație.
Pagina descrie modul de folosire al formatului și conține categoriile de care acesta aparține, precum și orice altceva ce nu face parte din formatul propriu-zis.

Acest format afișeaază o casetă „Documentație format”, cum este și aceasta.

Format de bază

{{Documentație}}

Mod de folosire

Adăugați codul următor în format:

<noinclude>
  {{Documentație}}
</noinclude>

Dacă pagina documentației nu există, clic pe „creează”. Veți fi redirecționați la subpagina /doc unde puteți scrie documentația formatului.
Adăugați categoriile și legăturile interwiki ale formatului în subpagina /doc, la sfârșitul acesteia, incluse între <includeonly> </includeonly>, similar modelului care este afișat.

Parametri

Formatul poate accepta cel mult doi parametri fără nume, care pot fi folosiți în două moduri.

Pentru cazurile în care documentația trebuie să se afle în altă parte decât în subpagina /doc, se specifică doar primul parametru, a cărui valoare va fi numele paginii unde se află documentația.
Formatul poate fi folosit și fără o subpagină de documentație, înlocuind valoarea primului parametru cu {{subst:FULLPAGENAME}} iar valoarea celui de-al doilea parametru cu textul documentației. Cu toate acestea, este recomandat să procedați astfel numai dacă scrieți doar una sau două propoziții scurte și nu folosiți categorii sau legături interwiki.

Exemple

Din motive tehnice, exemplele nu pot fi afișate aici. Ele pot fi consultate pe pagina cu exemple.

Limitări

Un caracter bară verticală (engleză pipe, denumire pentru semnul: |) în pagina de documentație care nu este inclus între acolade duble sau între acolade triple perturbă funcționarea corectă a acestui format. În această situație, conținutul paginii după acel caracter este interpretat ca un parametru al formatului. În astfel de situații, dacă aveți nevoie de caracter, folosiți Format:! pentru a-l include în pagina de documenație.

Detalii tehnice

Formatul afișează legăturile în felul următor: dacă pagina documentației nu există, sunt afișate creează și actualizează formatul; dacă documentația există la subpagina /doc a formatului, sunt afișate vizualizează, modifică și actualizează formatul.

Alternativă

Dacă doriți să realizați o documentație scurtă pentru un format fără să creați o pagină separată (/doc), puteți folosi formatele {{Doc start}} și {{Doc stop}}.

<noinclude>
 {{Doc start}}

 .. Introduceți aici documentația ..

 {{Doc stop}}
</noinclude>

Exemplu de formate în care documentația este realizată astfel: {{Titlu IMDb}} și {{Nume IMDb}}