Guidelines (Română)
Toți utilizatorii înregistrați pot edita wiki-ul, dar, vă rugăm să urmăriți aceste ghiduri pentru consistență. Dacă credeți că ghidurile ar trebui schimbate, sau ar trebui să conțină alte informații, nu ezita să contactezi pe Rude.
Contents
Scop
Scopurile principale ale wiki-ului sunt următoarele:
- Documentarea API-ului LÖVE și de a oferi tutoriale.
- Oferirea informațiilor despre jocuri și bibliotecilor ce folosesc LÖVE.
Acestea fiind spuse, este complet liberă adăugarea informației legate de subiecte ce nu se încadrează în aceste categorii.
Dacă dorești să faci schimbări majore wiki-ului, ca și creerea unei noi structuri pentru tipurile built-in, de exemplu; NU O FACE! Trebuie să discuți cu Rude mai întâi, ori este o mare șansă ca schimbările să fie anulate.
Conflicte de nume
Pentru a evita URL-uri prea parantezate, paginile de documentare au titluri simple, fără sufixe sau prefixe. De exemplu, tipul Image va fi găsit la http://love2d.org/wiki/Image.
Aceasta va duce la conflicte de nume. În acest caz pagina de documentare va câștiga. De exemplu, dacă faci un joc numit Awesome, iar LÖVE decide, mai târziu, să creeze un tip numit Awesome (nu chiar așa de improbabil), atunci jocul tău va fi mutat la alt titlu.
Stil
Dacă vorbești de tipuri ce aparțin LÖVE, pune un link. De exemplu, Image e un obiect ce poate fi afișat pe ecran.
Când te referi la variabile și cod înăuntrul unei propoziții, folosește tag-ul <code> pentru a îmbunătăți experiența cititorului. De exempu, dacă aduni foo
cu bar
obții foobar
.
Documentare
Paginile de documentare trebuie să folosească aceiași structură dacă documentarea va fi folosită.
Toate paginile de documentare vor trebui să aibă un link către părintele lucrului descris de pagină în zona Vezi și. Fără acesta, articolul nu va apărea în listele generate automat din wiki. Un link ca și acestea se adaugă, de exemplu pentru o funcție, un tip sau un enum din love.audio, așa:
[[parent::love.audio]]
Toate paginile de documentare trebuie să aibă o descriere scurtă, simplă. Aceasta de face adăugând următoarele la sfârșitul paginii:
{{#set:Description=Desenează un obiect [[Image]] pe ecran.}}
Module
Următoarele antete 'de nivel 2' sunt permise, dar ar trebui să fie folosite doar dacă au conținut.
- Tipuri
- Funcții
- Enumerații
- Note
- Exemple
- Vezi și
Toate modulele trebuiesc asociate cu Category:Modules.
Tipuri
Următoarele antete 'de nivel 2' sunt permise, dar din nou, nu le folosi decât dacă au conținut.
- Funcții
- Enumerații
- Supertipuri
- Subtipuri
- Note
- Exemple
- Vezi și
Toate tipurile trebuiesc asociate cu Category:Types.
Funcții
Pentru funcții, toate antetele sunt necesare, cu excepția Note, Exemple și Vezi și. Asta înseamnă că dacă o funcție nu returnează nimic, ar trebui să o spună explicit. La fel merge și pentru argumente.
Similar, dacă nu sunt constructori pentru anumite tipuri (ex. Contact (en)), aceasta ar trebui menționată explicit.
Intrările exterioare din lista de mai jos sunt antete 'nivel 2', iar cele interioare 'nivel 3'.
- Constructori
- Funcție
- Rezumat
- Argumente
- Returnează
- Note
- Exemple
- Vezi și
Dacă o funcție are supraîncărcări, repetă antetul 'Funcție' pentru fiecare supraîncărcare. Aceasta nu este necesară pentru argumente opționale; doar indică valoarea implicită între paranteze.
Argumentele și valorile returnate ar trebui prezentate ca o listă de definiții, folosind Template:param.
Toate funcțiile trebuiesc asociate cu Category:Functions.
Enumerații
Pentru enumerații aceste antete sunt permise:
- Constante
- Note
- Vezi și
Constantele trebuiesc scrise ca o listă de definiții.
Toate enumerațiile trebuiesc asociate cu Category:Enums.
Jocuri
Pentru jocuri, poți alege structura proprie, dar ar trebui să adaugi întotdeauna niște proprietăți semantice paginii, pentru a apărea corect în lista jocurilor:
{{#set:Name=NoGame}} (Ar trebui să fie la fel ca titlul paginii) {{#set:Author=User:Rude}} {{#set:Genre=Ce fel de joc este jocul tău}} {{#set:LOVE Version=0.6.1}} {{#set:Description=O descriere scurtă a jocului tău.}} {{#set:Screenshot=File:URLCapturăDeEcran.png}}
Capturile de ecran vor fi redimensionate automat pentru a încăpea într-un dreptunghi de 161x100 pixeli.
Pune și jocul tău în Games pentru al face să apară automat în pagina de Jocuri. Pentru a pune jocul în categoria corectă adaugă această linie la sfârșitul paginii.
[[Category:Games]]
Este de asemenea recomandat să adaugi capturi de ecran pentru jocul tău.
Biblioteci
Nu sunt reguli stricte, dar la fel ca pentru jocuri, ar trebui să adaugi aceste proprietăți semantice:
{{#set:LOVE Version=0.6.1}} {{#set:Description=O scurtă descriere a bibliotecii tale.}}
Pune librăria ta în Category:Libraries pentru a o face să apară automat pe pagina de Biblioteci (en). Pentru a pune biblioteca ta în categoria corectă, adaugă această linie la sfârșitul paginii.
[[Category:Libraries]]