Guidelines (Română)

Toți utilizatorii înregistrați pt 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.

Scop

Scopurile principale ale wiki-ului sunt următoarele:

  1. Documentarea API-ului LÖVE și de a oferi tutoriale.
  2. Oferirea informațiilor despre jocuri și librării ce folosesc LÖVE.

Acestea fiind spuse, este complet liberă adăugarea informației legate de subiecte ce nu se încadrează in acele 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ă sufixuri 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.}}

Modules

The following 'level 2' headers are allowed, but should only be used if they contain anything.

  • Types
  • Functions
  • Enums
  • Notes
  • Examples
  • See Also

All modules must be assiciated with Category:Modules.

Types

The following 'level 2' headers are allowed, but again, don't use then and leave them empty.

  • Functions
  • Enums
  • Supertypes
  • Subtypes
  • Notes
  • Examples
  • See Also

All types must be assiciated with Category:Types.

Functions

For functions, all headers are required, except Notes, Examples and See Also. This means that if a function returns nothing, it should explicitly say that it returns nothing. The same goes for arguments.

Similarly, if there are no constructors for a certain type (e.g. Contact), this should be explicitly mentioned.

The outer items in the list below are 'level 2' headers, and the inner ones are 'level 3'.

  • Constructors
  • Function
    • Synopsis
    • Arguments
    • Returns
  • Notes
  • Examples
  • See Also

If a function has overloads, repeat the 'Function' header for each overload. This is not required for trailing optional arguments; just indicate the default value in parentheses instead.

Arguments and return values should be presented as a definition list, using Template:param.

All functions must be assiciated with Category:Functions.

Enums

For enums, these headers are allowed:

  • Constants
  • Notes
  • See Also

The constants should be listed as a definition list.

All enums must be associated with Category:Enums.

Games

For games, you can choose your own structure, but you should always add some semantic properties to the page to make it appear correctly in the list of games:

{{#set:Name=NoGame}} (Should be same as page title)
{{#set:Author=User:Rude}}
{{#set:Genre=What kind of game your game is}}
{{#set:LOVE Version=0.6.1}}
{{#set:Description=A short description of your game.}}
{{#set:Screenshot=File:ScreenshotURL.png}}

Screenshots will automatically be resized to fit a box of 161x100 pixels.

Also, put your game in Category:Games to make it appear automatically in the Games page. To put your game in the correct category, add this line at the end of the page.

[[Category:Games]]

It is also recommended that you provide screenshots of your game.

Libraries

No strict rules, but as for games, you should add these semantic properties:

{{#set:LOVE Version=0.6.1}}
{{#set:Description=A short description of your library.}}

Put your library in Category:Libraries to make it appear automatically in on the Libraries page. To put your library in the correct category, add this line at the end of the page.

[[Category:Libraries]]