Ajutor: manuale șablon
Șabloanele sunt o caracteristică foarte puternică a software-ului MediaWiki , dar pot fi dificil de utilizat de noii utilizatori și chiar și experții pot avea probleme să înțeleagă modul în care funcționează cele mai complexe. Din acest motiv, șabloanele ar trebui să vină întotdeauna cu un manual de utilizare , care poate fi citit chiar pe pagina șablonului.
Manualul trebuie să explice ce face un șablon și cum să îl folosească, într-un mod suficient de clar, chiar și pentru utilizatorii care nu sunt experți în sintaxa programării șabloanelor, nu puțini chiar și în rândul veteranilor Wikipedia.
În ceea ce privește structura, toate manualele ar trebui să respecte pe cât posibil acest ghid, pentru a încerca să-și standardizeze funcționalitatea și aspectul grafic.
 - Birou de informare |
Ce trebuie inclus în manual
Un manual de șablon ar trebui să includă:
- Scopul șablonului: rezultatul, dacă nu este imediat evident, utilitatea, împreună cu descrierea tipurilor de pagini și elemente pentru care este posibil sau nu este posibil să se utilizeze.
- Parametrii șablonului: dacă este suficient să îi indicați secvențial sau ar trebui să fie denumiți în mod explicit, dacă sunt obligatorii sau opționali, care sunt valorile permise pentru fiecare parametru, care sunt valorile implicite și ce efect au. Toate acestea trebuie explicate clar, pentru toți parametrii.
- Dacă șablonul poate și / sau ar trebui să fie substatificat sau nu.
- Exemple de utilizare : indicația exactă a codului de limbă wiki care ar trebui utilizat și rezultatul pe care îl produce. Exemplul ar trebui inclus între
<code>...</code>, pentru a fi clar și ușor de copiat, cum ar fi:
{{non firmato|pinco pallino|01:19, 13 set 2010}}
Dacă șablonul poate fi utilizat în mai multe moduri diferite, cu sau fără parametri opționali, ar trebui date exemple adecvate. Poate fi foarte util să includeți șablonul în sine în manualul dvs. de câteva ori, în câteva exemple reale, cu parametri diferiți, care indică același lucru. - Pagini conexe : dacă șablonul aparține unei serii, includeți linkurile wikilink către celelalte șabloane din aceeași serie, pentru a face navigarea mai ușoară (un șablon de navigare special poate fi util). Cu toate acestea, trebuie indicate șabloane similare și diferențele pentru a alege cel mai potrivit. În cele din urmă, este necesar să indicați paginile de ajutor, liniile directoare și proiectul utile pentru înțelegerea modului de utilizare a șablonului.
Creați un manual
Documentația șablonului este adesea scrisă într-o subpagină a șablonului în sine, care este apoi inclusă la sfârșitul codului șablonului.
Pentru a crea un manual, asigurați-vă că pagina șablonului nu este deja prezentă în șablonul: service man ( {{ man }} ). Dacă este absent, introduceți-l între <noinclude></noinclude> (pentru a preveni raportarea manualului în paginile care utilizează șablonul), salvați pagina și faceți clic pe cuvântul Creați instrucțiuni! .
Manualul este inserat într-o subpagină, deoarece în acest fel codul adesea complex este separat de documentație, ceea ce face ca partea de documentare să fie mai ușor de compilat și gestionat. De asemenea, permite o protecție mai ușoară a codului șablon, acolo unde este necesar, lăsând în același timp oricui posibilitatea de a modifica sau integra manualul.
Editați un manual
Manualele șablonului pot fi întotdeauna editate. Dacă ați introdus corect {{ man }} atunci va exista un link pentru a-l edita.
Structura manualului
Prin urmare, în manual ar trebui să găsiți aceste secțiuni esențiale:
Incipit
== Uso ==
== Parametri ==
== Esempi d'uso ==
== Note ==
== Pagine correlate ==
[[Categoria:Manuali dei template]]
Începeți să scrieți manualul scriind scopul și utilitatea pentru care a fost creat șablonul.
Utilizare
Furnizați detalii cu privire la tipurile de pagini și articole în care utilizarea este posibilă sau nu, precum și comparația cu șabloane similare.
Parametrii
Funcționarea fiecărui parametru trebuie explicată. O metodă bună este să scrieți codul șablonului în forma în care va fi utilizat, cu o explicație a parametrilor alături.
De exemplu:
{{Nume șablon
| parametru1 =
| parametru2 =
...
}}
- parametru1 = explicația parametrului1
- parametru2 = explicația parametrului2
- ...
Pentru a introduce parametri, mai ales dacă sunt mulți, puteți utiliza șabloanele {{ TableTemplate }} și {{ Parameter }} cu tabelul relativ de culori pentru a atribui priorități.
Sunt obligatorii , opționale , recomandate și care trebuie acordate atenție , adică acelea în care sunt acceptate numai anumite valori, pentru care, dacă este necesar, se recomandă inserarea unei subsecțiuni (de exemplu == Valori accettati dal parametro "pincopallino" == ) pentru a explica mai bine cum funcționează.
Exemple de utilizare
Uneori, numai explicația parametrilor poate să nu fie suficientă pentru a clarifica modul de utilizare a șablonului. Prin urmare, se recomandă să furnizați câteva exemple practice în care șablonul a fost utilizat prin crearea antetului == Esempi d'uso == .
De obicei se folosește formularul „ cod - exemplu ”, adică la stânga codul așa cum ar trebui inserat și la dreapta ceea ce generează codul, adică șablonul așa cum apare pe paginile în care este utilizat.
Exemplul de cod va fi inclus în <poem><code><nowiki>...</nowiki></code></poem> („ cod ”) sau <pre>..</pre> („ pre -formatat ") pentru o mai ușoară lizibilitate.
De exemplu:
Cu eticheta <poem><code><nowiki>...</nowiki></code></poem>
{{Libro
|titolo=commedia
|titoloalfa=Divina Commedia
|immagine=Gustave Doré - Dante Alighieri - Inferno - Plate 18 (Canto V - Dante has a touch of the vapours).jpg
|didascalia=Scena del poema illustrata da<br>[[Gustave Doré]]
|autore=[[Dante Alighieri]]
|annoorig=tra il [[1304]] e il [[1321]]
|genere=[[Poema]]
|protagonista=[[Dante]]
|altri_personaggi=[[Virgilio]], [[Beatrice]]
}}
Cu eticheta <pre>..</pre>
{{Carte
| titlu = comedie
| titoloalfa = Divine Comedy
| image = Gustave Doré - Dante Alighieri - Inferno - Placa 18 (Canto V - Dante are o notă de vapori) .jpg
| legenda = Scena din poezia ilustrată de <br> [[Gustave Doré]]
| autor = [[Dante Alighieri]]
| annoorig = între [[1304]] și [[1321]]
| gen = [[Poem]]
| protagonist = [[Dante]]
| alte_caractere = [[Virgil]], [[Beatrice]]
}} | comedie | |
|---|---|
 Gustave Doré | |
| Autor | Dante Alighieri |
| Prima ed. original | între 1304 și 1321 |
| Tip | Poem |
| Protagonisti | Dante |
| Alte personaje | Virgil , Beatrice |
În cazul șabloanelor care sunt excesiv de largi sau care ocupă întreaga lățime a paginii, puteți insera șablonul generat ca exemplu sub codul de explicație.
Notă
Utilizarea notelor este permisă și în manualele șablonului, pentru a oferi toate informațiile posibile.
Pagini conexe
Pentru a facilita navigarea între șabloane, care poate fi adesea complexă, este recomandabil să includeți, sub titlul == Pagine correlate == , orice șabloane legate de cel în cauză. Se recomandă utilizarea unei liste cu marcatori pentru a le enumera .
De exemplu, pentru șablonul {{ Coloane }} scrieți:
În cele din urmă, printre paginile aferente, trebuie inserate și paginile de ajutor sau liniile directoare privind utilizarea șablonului.
În cele din urmă, este recomandabil să atașați șablonul {{ Proiect }} listând proiectul (proiectele) în care șablonul se încadrează tematic, pe lângă Proiect: Șablon .
De exemplu, pentru șablonul {{ Film }} (care este utilizat în articolele legate de proiect: Cinema ) scrieți:
{{Progetto|Cinema|Template}}
a obtine:
Abrevierile utile (redirecționări) ale numelui șablonului pot fi raportate la începutul manualului prin {{ abrevieri }}.
Categorizare
Fiecare manual trebuie inserat în categoria: manuale șabloane, scriind șirul la sfârșitul paginii:
<noinclude>[[Categoria:Manuali dei template]]</noinclude>
Etichetele fără noinclude evită această clasificare chiar și pentru paginile în care șablonul va fi inserat.