Format:Documentație/doc

De la Wikiștiri


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

Format de bază[modificare]

{{Documentație}}

Mod de folosire[modificare]

  • 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[modificare]

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[modificare]

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

Limitări[modificare]

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 este interpretat ca un parametru al formatului. Dacă trebuie să folosiți bara verticală în astfel de situații tastați în locul ei &#124;.

Detalii tehnice[modificare]

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ă.

Vezi și[modificare]