Conventii de formatare a articolelor

Tutorial articole

h1. Conventii de formatare a articolelor

h1. Tutorial pentru scrierea articolelor

Ne bucuram ca vrei sa ne ajuti si ca ai ajuns pe aceasta pagina vrand sa scrii un articol sau sa imbunatatesti unul deja existent. Nu vrem sa te sperii de aceste conventii, ci sa le consideri niste sugestii folositoare pentru a pastra un aspect uniform si elegant in cadrul site-ului. :) Desigur, pentru a scrie un articol, va trebui sa respecti in primul rand 'conventiile generale de formatare':documentatie/conventii-de-formatare.

== include(page="documentatie/sidebar")==

h2. Template-ul unui articol

Ne bucuram ca ai ajuns aici si vrei sa contribui la continutul educational al site-ului. Aceasta pagina se vrea un ghid rapid si eficient care sa te puna la treaba. Poti sa citesti inainte si despre 'Textile':documentatie/textile si 'conventiile de formatare':documentatie/conventii-de-formatare pe care le utilizam, dar crearea unui articol este mult mai simpla si mai frumoasa decat acele seturi de reguli. :)

Un articol elegant ar trebui sa aiba urmatoarea structura:
* Titlu
* Scurte detalii: categoria in care se incadreaza, autor(i)
* Cuprins: lista sectiunilor articolului, precum si link-uri de navigare rapida catre acele sectiuni
* Articolul propriu-zis, structurat in sectiuni
 
Un articol este cu atat mai folositor cu cat acopera subiectul cat mai bine. Ne-am bucura daca ai mentiona si
* o lista de probleme relationate cu articolul
* bibliografia care te-a ajutat pe tine sau care ti se pare necesara referitoare la subiectul prezentat
 
h2. Formatarea codului
 
In caz ca incluzi in articolul tau bucati de cod, ar fi indicat:
* sa folosesti nume de variabile sugestive
* sa faci indentare cu 4 spatii (nu tab-uri)
* sa eviti macrourile, folosind in schimb constante si typedef-uri
* sa aerisesti codul prin separarea operatorilor de restul codului prin spatii (de exemplu, o atribuire ar arata sub forma $A = B$)
* sa te asiguri ca nu ai probleme la compilarea codului

h2. Structura articolului

h2. Alte aspecte

Mai mult ca sigur ca ai un plan pe care vrei sa-l urmezi in scrierea articolului. Punerea lui pe infoarena este cu atat mai simpla. Tot ce trebuie sa faci este sa copii continutul paginii '"Structura articol"':documentatie/structura-articol in pagina articolului tau, iar apoi sa il adaptezi in functie de titlul, categoria si sectiunile adecvate. Dupa cum observi in structura, e foarte important sa ai un cuprins care sa-i ajute pe utilizatori sa se duca direct la tinta in articol.
Referitor la structura, iti facem si cateva recomandari care vor pune in valoare munca ta:
 
* Mentine sectiunile de cel mult 1 pagina pentru a fi usor de urmarit.
* Propune-i cititorului o lista de probleme care il pot ajuta in intelegerea subiectului abordat.
* Include la sfarsit si o lista bibliografica cu sursele din care te-ai documentat.
 
h2. Bucati de cod
 
Daca subiectul pe care il tratezi necesita si implementari intr-un limbaj de programare, nu ezita sa incluzi bucati de cod edificatoare. Iata un exemplu despre cum ar trebui sa arate codul pe care il incluzi:
 
== code(cpp) |
const int MAX_N = 100;
 
int N, A[MAX_N], B[MAX_N];
 
void merge_sort(int l, int r) {
    int m = (l + r) >> 1, i, j, k;
    if(l == r) return;
 
    merge_sort(l, m);
    merge_sort(m + 1, r);

* Incearca sa spargi articolul in sectiuni de cel mult 1 pagina, astfel incat sa vezi intreaga sectiune dintr-o singura privire.
* Unele articole vor necesita formule mai frumoase. Poti alege sa le scrii normal (daca nu sunt asa complexe), sa le scrii cu LaTeX, sau hibrid. Pentru ultima varianta, ai grija, totusi, sa se imbine elegant cele doua portiuni.
* Iti sugeram sa arunci o privire si pe ultimele articole scrise de membrii comunitatii si sa compari aspectul articolului tau cu ale celorlalte.

    for(i = l, j = m + 1, k = l; i <= m || j <= r; )
        if(j > r || (i <= m && A[i] < A[j]))
            B[k++] = A[i++];
        else
            B[k++] = A[j++];
 
    for(k = l; k <= r; k++)
        A[k] = B[k];
}
==
 
Ce trebuie sa observi la el?
 
* numele de variabile si de functii sunt sugestive
* indentarea se face cu 4 spatii, nu tab-uri
* se evita macro-urile, folosind in schimb constante, typedef, functii inline
* codul este aerisit prin separarea cu spatii a operatorilor de restul codului (mai putin $++$ si $--$)
* codul compileaza pe o versiune recenta a unui compilator modern
 
h2. Formule
 
Daca articolul tau necesita formule mai complicate, nu te lasa descurajat. Infoarena suporta <tex>\LaTeX</tex>. Si ca sa-ti trezim un pic apetitul si sa iti placa sa lucrezi la articolul tau, iata ce se poate face:
 
<tex>infoarena = \displaystyle\sum_{user=1}^\infty implicare_{user}</tex>
 
h2. Alte aspecte

Acestea fiind zise, spor la treaba!

Speram ca munca la articole sa fie simpla si placuta. Daca totusi te incurci in site-ul nostru, ia legatura cu unul din membrii echipei infoarena si o sa fii indrumat. Spor la treaba!