Format:Documentaţie/doc

Aceasta este pagina de documentaţie pentru Format:Documentaţie.
Pagina conţine descrierea modului de folosire, categorii, legături interwiki ş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 <noinclude>{{Documentaţie}}</noinclude> la formatul principal.
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ă (Format:En, 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 este interpretat ca un parametru al formatului. Dacă trebuie să folosiţi bara verticală în astfel de situaţii tastaţi în locul ei |.

Detalii tehnice

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