Format:Documentație

Documentația formatului[afișează] [editează] [istoric] [regenerează]

Formatul {{documentație}} este folosit pentru a cuprinde informațiile și instrucțiunile documentate despre un anumit format, de regulă dintr-o subpagină /doc. Poate fi configurat să încarce conținutul și din alte pagini, sau să-l primească direct.

Acest format are două părți: Caseta cea mare de documentație, care conține documentația plus un toolbar (legăturile [afișează][editează][istoric][regenerează] links), și caseta de linkuri, mai mică, cu metadate despre documentație împreună cu legăturile spre paginile de experimente și de cazuri de test.

Utilizarea acestui format permite formatelor să fie protejate, dacă e nevoie, permițând în schimb oricui să editeze documentația și categoriile.

Sintaxă generală

Formatul este folosit în mod normal fără parametri și stă în cadrul unor taguri <noinclude>...</noinclude> în partea de jos a paginii formatului:

<!--Last line of your template code--><noinclude>
{{Documentație}}
<!-- Add categories to the /doc subpage -->
</noinclude>

Transcluderea unei alte pagini

Pentru a transclude o altă pagină decât subpagina /doc, specificați |1= astfel:

<!--Last line of your template code--><noinclude>
{{Documentație|Format:Altă pagină/doc}}
</noinclude>

Aveți grijă că, atunci când încărcați documentația dintr-o altă pagină decât subpagina /doc locală, tratamentul categoriilor se complică.

Folosirea parametrului |content=

Documentația poate fi primită și direct, ca text, folosind parametrul |content=:

<!--Last line of your template code--><noinclude>
{{Documentație
 | content =
<!-- documentația formatului -->
}}</noinclude>

Când folosiți acest parametru, toolbarul nu mai apare. Atenție că subpagina /doc din tcaseta de linkuri va apărea dacă exista.

Când se specifică |1= și |content=, |content= are prioritate și apare mereu în caseta documentației.

Sintaxă avansată

Personalizarea antetului

Antetul din caseta de documentație se schimbă în funcție de spațiul de nume. Vedeți mai jos lista textelor implicite din fiecare spațiu de nume:

• Spațiul formatelor: Documentația formatului
• Spațiul modulelor: Documentația modulului
• Alte spații de nume: Documentație

Pentru a personaliza antetul, dați parametrului |heading= orice argument doriți, cum ar fi |heading=Documentația infocasetei.

Dacă parametrul pentru antet nu are argument, dar este definit (ca |heading=), antetul și toolbarul nu vor apărea.

Parametrul |heading-style= poate primi valori opționale în CSS, ca |heading-style=font-size:150%;color:red;.

Personalizarea casetei de linkuri

Pentru a personaliza caseta de linkuri, setați |link box= la o altă valoare, ca |link box=Documentația de mai sus este generată automat de la Format:Foo.

Pentru a ascunde caseta de linkuri, puneți parametrul |link box= pe off.

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.

Testare

Puteți simula rezultatul pentru o pagină dată folosind parametrul |page=. De exemplu, dacă folosiți codul |page=Format:Edit protected, formatul se va comporta exact ca atunci când este pus în pagina Format:Edit protected, inclusiv cu documentația de la Format:Edit protected/doc, linkuri către Format:Edit protected/sandbox, etc.

Poziționare și taguri

Acest cod trebuie adăugat în josul paginii cu codul formatului, fără spațiu înainte de <noinclude> (care ar face să apară spații în plus pe paginile în care formatul este transclus):

<!--Last line of your template code--><noinclude>
{{documentation}}
<!-- Add categories to the /doc subpage -->
</noinclude>

Detalii tehnice

Funcții automate

Dacă pagina de documentație nu există, toolbarul este înlocuit cu un set de linkuri [creează][regenerează]. Linkul [creează] creează automat pagina cu un text preîncărcat cu structura de bază a unei documentații. Textul preîncărcat se folosește și pentru linkurile [creează] pentru /sandbox și /testcases.

Pagina preîncărcată pentru linkul [creează] al subpaginilor /doc este Format:Documentație/Model. Paginile preîncărcate pentru /sandbox și /testcases sunt Format:Documentație/preload-sandbox și Format:Documentație/preload-testcases. Pagina preîncărcată pentru linkul [oglindă] al subpaginii /sandbox este Format:Documentație/oglindă.

Acest format adaugă și {{pp-template}} la o pagină de format protejat. Când acest format se află pe o pagină /sandbox, el adaugă și formatul {{Template sandbox notice}}.

Elementele casetei de linkuri

În funcție de spațiul de nume, caseta de linkuri poate avea mai puține elemente, sau chiar ar putea să nu apară deloc, după cum arată următorul tabel:

Spațiu de nume	Comportament
Format	Conținut complet
Modul	Conținut complet, plus un link „creează documentație” când pagina nu există
Utilizator	Conținut complet
Alte spații de nume	Ascuns, dacă |1= nu este specificat (caz în care apare „Documentația de mai sus este transclusă din Format:Param")

În plus, dacă se specifică |1= sau |content=, textul „Adăugați categorii în subpagina /doc” nu va mai apărea.

Spațiile subiect vs. spațiile de discuții

Acest format se pune de obicei în spațiile subiect. În unele cazuri, acest format trebuie să fie însă într-un spațiu de discuții:

• În spațiul de nume MediaWiki, întrucât <noinclude> adesea nu funcționează în mesajele sistem, și întrucât spațiul de nume MediaWiki are nevoie să rămână curat din motive de performanță.

Când este pus în pagini de discuții, acest format stă de regulă aproape de susul paginii și fără taguri <noinclude>...</noinclude>.

Subpaginile /doc, /sandbox și /testcases ar trebuie să fie în mod normal în spațiul de nume subiect, cu excepția spațiilor de nume care nu au feature-ul subpaginilor activat: principal, Fișier, și MediaWiki. (Categoriile pot avea subpagini, dar documentația se creează în spațiul de nume de discuții pentru a împiedica crearea de categorii goale.

Formatul știe să trimită prin legăturile [creează] pentru /doc, /sandbox și /testcases către spațiul de nume corect.

Schema de culori

Culorile de fundal pentru Format:Template link (Help:Using colors)

	RGB	HSV	Culoare	Uz general	Note
A	#ECFCF4	150°, 6%, 99%		Eșantion	Fundalul curent al documentației
B	#00FF80	Hue=150° (41.7%; 106/255dec) 100%, 100%		Colorizare de bază	Ceea ce am numi „culoarea”
1	#A3BFB1	150°, 15%, 75%		Doar chenarul antetului
2	#CEF2E0	150°, 15%, 95%		Chenarul principal; fundalul antetului
3	#E6FFF2	150°, 10%, 100%		al doilea antet, culoare accentuată
4	#F5FFFA	150°, 4%, 100%		Fundalul principal	Deci saturația din A diferă puțin

Culorile casetelor de navigare a documentațiilor

Acestea sunt culorile unei casete de navigație gândite exclusiv pentru pagini de documentație. Ele urmează coloristica casetelor de navigare albastre: | titlestyle = background:#ccffe5 | basestyle = background:#ddffee <!-- basestyle= sets groupstyle, abovestyle, belowstyle together --> Pentru subgrupuri, în casetele de navigare-copil: {{Navbox|child | groupstyle = background:#e6fff2 ... Exemplu:Format:Template link expanded

Sintaxă completă

{{Documentație}}

sau

{{Documentație
 | [cale către pagina de documentație]
}}

{{Documentație
 | content =
}}

or

{{Documentație
| [cale către pagina de documentație]
| heading-style = 
| heading = 
| link box = 
}}

sau

{{Documentație
| [cale către pagina de documentație]
| content = 
| heading-style = 
| heading = 
| link box = 
| page =
}}

Vezi și

• Ajutor:Manualele formatelor
• Format:Documentație/Exemple
• {{Documentație/Subpagină}}
• {{Documentație/Model}}

Documentația de mai sus este transclusă din Format:Documentație/doc. (editează | istoric)
Editorii pot experimenta în paginile sandbox (creează | oglindește) și testcases (creează) ale acestui format.
Adăugați categorii la subpagina /doc. Subpagini ale acestui format.