Atenţie! Aceasta este o versiune veche a paginii, scrisă la 2008-11-12 08:43:43.
Revizia anterioară   Revizia următoare  

Tutorial articole

TODO

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.

Template-ul unui articol

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

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 macro-urile, folosind in schimb constante, typedef-uri si functii inline
  • sa aerisesti codul prin separarea operatorilor de restul codului prin spatii (de exemplu, o atribuire ar arata sub forma A = B; totusi o incrementare se scrie legat ++i)
  • sa te asiguri ca nu ai probleme la compilarea codului

Alte aspecte

  • 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 al celorlalte.

Acestea fiind zise, spor la treaba!