Guidelines (Français)

Tous les utilisateurs enregistrés peuvent éditer le wiki, mais veuillez s'il vous plaît suivre ces lignes directrices pour la cohérence. Si vous pensez que ce guide devrait être modifié, ou devrait contenir des informations supplémentaires, s'il vous plaît n'hésitez pas à contacter Rude.

Objectifs

Les objectifs principaux de ce Wiki sont :

1. Documenter l'API LÖVE et fournir des tutoriaux.
2. Donner des informations sur les jeux et librairies utilisant LÖVE.

Ceci dit, il est pleinement autorisé d'ajouter des informations sur d'autres items qui sortent de ces catégories.

Si vous souhaitez apporter des changements majeurs dans le wiki, comme le déploiement d'une nouvelle structure pour les types prédéfinis, par exemple, ne le faites pas. Vous devez"" en discuter avec Rude en premier lieu, sinon il y a de fortes chances que vos modifications soient annulées.

Conflits de nom

Pour éviter des URLs trop compliqués, les pages de documentation ont des titres ordinaire, sans préfixes ou suffixes. Par exemple, le type Image peut être référencé comme http://love2d.org/wiki/Image.

Cela peut parfois conduire à des conflits de nom. Dans ce cas, Une page de documentation gagnera toujours. Si vous créez un jeu appeléUnTruc, et que les développeurs de LÖVE décident plus tard d'exposer un typeappeléUnTruc (pas totalement improbable), votre jeu sera déplacé vers un autre titre.

Style

Si vous parlez de types construit dans LÖVE, placez un lien vers lui. Par exemple, Image est un objet qui peut être affiché à l'écran.

Lorsque vous faites référence à des variables et code à l'intérieur d'une phrase, utilisez le <code> tag pour améliorer la lecture. Par exemple: lorsque vous ajoutez foo et bar, le résultat est foobar.

When referring to variables and code inside a regular sentence, use the <code> tag to improve the reading experience. For instance: when you add foo and bar, the result is foobar.

Documentation

Documentation pages must follow the same structure if the documentation is to be usable.

All documentation pages must have a semantic link to their parent in their See Also section. Without this, the item will not appear in the automatic lists throughout the wiki. A semantic link is added like this for a function, type or enum in love.audio:

[[parent::love.audio]]

All documentation pages must also have a semantic, 'list-friendly' description. This is done by adding the following to the bottom of the page:

{{#set:Description=Draws an [[Image]] on screen.}}

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]]