Convenții redactare wiki

Pagina este destinată adunării de convenții pentru structurarea și redactarea paginilor.

Cercetați sursa paginii pentru observarea marcajelor. Pentru detalii, consultați documentația sintaxei.

Cum adaug o pagina noua?

Ma duc pe url-ul pe care vreau sa il aiba pagina (e.g. elf.cs.pub.ro/poo/intern/blabla) si apas Create New page (buton in dreapta paginii).

Cum sterg o pagina?

O editez stergand tot continutul ei si o salvez.

Cum adaug o pagina in sidebar?

Go to Sitemap —> Sidebar —> edit

Structură

  • Paginile vor fi organizate în namespace-uri diferite, pe baza funcției îndeplinite, astfel:
    • laboratoarele în namespace-ul laboratoare
    • temele în namespace-ul teme.
  • Titlurile paginilor nu vor include numere de ordine, pentru a putea fi rearanjate cu ușurință. Ordonarea se va face în sidebar (bara laterală de navigare). Exemplu: Introducere, și nu Laborator 01: Introducere.
  • În aceste condiții, numele paginii (din URL) ar trebui să conțină două-trei cuvinte reprezentative, separate prin cratime. Exemplu: constructori-referinte.
  • Similar paginilor, fișierele aferente acestora vor fi organizate în namespace-uri media diferite, astfel:
    • Fiecare laborator va avea între una și două arhive, al căror nume va fi prefixat de cel al paginii. Acestea vor fi încărcate în namespace-ul media laboratoare. Exemplu: pentru laboratorul constructori-referinte, arhivele vor avea numele:
      • constructori-referinte-ex.zip: scheletele exercițiilor propuse (opțional)
      • constructori-referinte-sol.zip: soluțiile exercițiilor propuse
  • Fiecare temă va avea între una și două arhive, al căror nume va fi prefixat de cel al paginii. Acestea vor fi încărcate în namespace-ul media teme. Exemplu: pentru tema arbori-binari, arhivele vor avea numele:
    • arbori-binari-schelet.zip: scheletul temei (opțional)
    • arbori-binari-tester.zip: tester-ul temei, cu instrucțiuni de utilizare într-un fișier README.
  • Toate fișierele vor conține autorul și data, la început.
  • Puteți porni de la aceste șabloane de:

Text

Linkuri interne:

  • relativ la namespace-ul curent: [[:poo-ca-cd:..:foo:bar | blbla]
  • niciodata relativ la root [[:poo-ca-cd::foo:bar | blbla]

  • Se vor utiliza diacritice. Altfel, aspectul tinde să pară neprofesionist :-). ( diacritice.com is your friend 8-))
  • Pe cât posibil, listele ar trebui folosite în locul enumerărilor cu virgule. Exemplu: listele din această pagină.
  • La prezentarea diverselor entități din limbaje, ar trebui date link-uri către documentație. Exemplu: System.out. Verificați linkurile din laboratoare, să fie către documentația curentă.
  • În cazul link-urilor, evitați trecerea URL-ului în clar. Exemplu: Example domain, și nu http://example.com.
  • Dacă o imagine nu o faceți voi, puneți link către pagina de unde ați luat-o

Cod

  • Toate exemplele de cod trebuie să respecte code style-ul Java
  • Toate denumirile si comentariile folosite în exemplele de cod vor fi doar în engleză
  • Secvențele de cod mai lungi de o simplă instrucțiune se vor trece in tag-ul <code limbaj>.
    • Pentru secvențe de cod, în interiorul unor liste, plasați tag-urile pe aceleași linii cu textul ce precede, respectiv urmează zona de cod. Exemplu:
      public class C { }
  • Pentru adăugarea posibilității de descărcare a secvenței sub forma unui fișier, folosiți varianta <code limbaj nume_fișier>. Exemplu:
    C.java
    public class C { }
  • Fontul monospace e util pentru menționarea variabilelor, claselor, intrucțunilor.

Plugins utile

  • Puteţi folosi plugin-ul comments dacă e nevoie să comentaţi o porţiune de text şi să nu fie vizibilă. Comentariile se încadrează în /* */
  • Puteți folosi plugin-ul ifauth dacă vreți ca o parte de text să fie vizibilă doar asistenților
poo-ca-cd/intern/conventii.txt · Last modified: 2020/10/01 19:52 by adriana.draghici
CC Attribution-Share Alike 3.0 Unported
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0