Differences
This shows you the differences between two versions of the page.
|
poo-ca-cd:intern:conventii [2020/07/28 23:08] 127.0.0.1 external edit |
poo-ca-cd:intern:conventii [2020/10/01 19:52] (current) adriana.draghici [Plugins utile] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | = Convenții redactare wiki = | + | ===== Convenții redactare wiki ===== |
| Line 5: | Line 5: | ||
| - | Cercetați sursa paginii pentru observarea marcajelor. Pentru detalii, consultați **[[:poo-ca-cd:https://www.dokuwiki.org/wiki:syntax|documentația sintaxei]]**. | + | Cercetați sursa paginii pentru observarea marcajelor. Pentru detalii, consultați **[[https://www.dokuwiki.org/wiki:syntax|documentația sintaxei]]**. |
| //Cum adaug o pagina noua?// | //Cum adaug o pagina noua?// | ||
| Line 20: | Line 20: | ||
| - | == Structură == | + | ==== Structură ==== |
| - | * Paginile vor fi organizate în **namespace**-uri diferite, pe baza funcției îndeplinite, astfel: | + | * Paginile vor fi organizate în **namespace**-uri diferite, pe baza funcției îndeplinite, astfel: |
| - | * laboratoarele în namespace-ul ''laboratoare'' | + | * laboratoarele în namespace-ul ''laboratoare'' |
| - | * temele în namespace-ul ''teme''. | + | * 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//. | + | * **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''. | + | * Î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: | + | * 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: | + | * 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-ex.zip'': scheletele exercițiilor propuse (opțional) |
| - | * ''constructori-referinte-sol.zip'': soluțiile exercițiilor propuse | + | * ''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: | + | * 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-schelet.zip'': scheletul temei (opțional) | ||
| * ''arbori-binari-tester.zip'': tester-ul temei, cu instrucțiuni de utilizare într-un fișier ''README''. | * ''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. | + | * Toate fișierele vor conține **autorul** și **data**, la început. |
| - | * Puteți porni de la aceste **șabloane** de: | + | * Puteți porni de la aceste **șabloane** de: |
| - | * [[:poo-ca-cd:sablon-laborator|laboratoare]] | + | * [[:poo-ca-cd:sablon-laborator|laboratoare]] |
| - | * [[:poo-ca-cd:sablon-tema|teme]]. | + | * [[:poo-ca-cd:sablon-tema|teme]]. |
| - | == Text == | + | ==== Text ==== |
| <note important> | <note important> | ||
| **Linkuri interne:** | **Linkuri interne:** | ||
| - | * relativ la namespace-ul curent: <nowiki> [[:poo-ca-cd:..:foo:bar | blbla] </nowiki> | + | * relativ la namespace-ul curent: <nowiki> [[:poo-ca-cd:..:foo:bar | blbla] </nowiki> |
| - | * niciodata relativ la root <del><nowiki> [[:poo-ca-cd::foo:bar | blbla] </nowiki></del> | + | * niciodata relativ la root <del><nowiki> [[:poo-ca-cd::foo:bar | blbla] </nowiki></del> |
| </note> | </note> | ||
| - | * Se vor utiliza **diacritice**. Altfel, aspectul tinde să pară neprofesionist :-). ([[:poo-ca-cd:http://www.diacritice.com | diacritice.com]] is your friend 8-)) | + | * Se vor utiliza **diacritice**. Altfel, aspectul tinde să pară neprofesionist :-). ([[http://www.diacritice.com | 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ă. | + | * 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: ''[[:poo-ca-cd:http://docs.oracle.com/javase/7/docs/api/java/lang/System.html#out|System.out]]''. Verificați linkurile din laboratoare, să fie către documentația curentă. | + | * La prezentarea diverselor entități din limbaje, ar trebui date link-uri către **documentație**. Exemplu: ''[[http://docs.oracle.com/javase/7/docs/api/java/lang/System.html#out|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: [[:poo-ca-cd:http://example.com|Example domain]], și nu http://example.com. | + | * În cazul link-urilor, evitați trecerea URL-ului în clar. Exemplu: [[http://example.com|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 | + | * Dacă o imagine nu o faceți voi, puneți link către pagina de unde ați luat-o |
| - | == Cod == | + | ==== Cod ==== |
| - | * Toate exemplele de cod trebuie să respecte **code style-ul** Java | + | * 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ă** | + | * 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//>''. | + | * 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: <code java> | + | * 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: <code java> |
| public class C { } | public class C { } | ||
| </code> | </code> | ||
| Line 67: | Line 67: | ||
| public class C { } | public class C { } | ||
| </code> | </code> | ||
| - | * Fontul **''monospace''** e util pentru menționarea variabilelor, claselor, intrucțunilor. | + | * Fontul **''monospace''** e util pentru menționarea variabilelor, claselor, intrucțunilor. |
| - | == Plugins utile == | + | ==== Plugins utile ==== |
| - | * Folosiți plugin-ul pentru //image captions// (există și buton de shortcut în meniul de editare): | + | * 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 <nowiki>/* */</nowiki> |
| - | * <nowiki> <imgcaption image1|> Adds an ImageCaption tag </imgcaption> </nowiki> | + | * Puteți folosi plugin-ul //ifauth// dacă vreți ca o parte de text să fie vizibilă doar asistenților |
| - | * <nowiki><imgref image1></nowiki> | + | |
| - | * Folosiți plugin-ul pentru //table captions// (există și buton de shortcut în meniul de editare): | + | |
| - | * <nowiki><tabcaption table1|> Adds an ImageCaption tag </tabcaption></nowiki> | + | |
| - | * <nowiki> <tabgref table1></nowiki> | + | |
| - | * 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 <nowiki>/* */</nowiki> | + | |
| - | * Puteți folosi plugin-ul //ifauth// dacă vreți ca o parte de text să fie vizibilă doar asistenților | + | |
| * exemplu: [[:poo-ca-cd::|homepage-ul]] | * exemplu: [[:poo-ca-cd::|homepage-ul]] | ||
