Difference between revisions of "Guidelines (Français)"

(Created page with '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 …')
 
m (moved guidelines to Guidelines (Français): Move to french part of the wiki)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
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 [[Utilisateur: Rude | Rude]].
+
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 [[User:Rude|Rude]].
  
 
== Objectifs ==
 
== Objectifs ==
Line 8: Line 8:
 
Ceci dit, il est pleinement autorisé d'ajouter des informations sur d'autres items qui sortent de ces catégories.
 
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 [[User: Rude | Rude]] en premier lieu, sinon il y a de fortes chances que vos modifications soient annulées.
+
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 [[User: Rude | Rude]] en premier lieu, sinon il y a de fortes chances que vos modifications soient annulées.
  
 
== Conflits de nom ==
 
== 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.
+
Pour éviter des URLs trop compliqués, les pages de documentation ont des titres ordinaires, 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 type''appelé''UnTruc (pas totalement improbable), votre jeu sera déplacé vers un autre titre.
+
Cela peut parfois conduire à des conflits de nom. Dans ce cas, Une page de documentation gagnera toujours. Si vous créez un jeu appelé <code>UnTruc</code>, et que les développeurs de LÖVE décident plus tard d'exposer un type appelé <code>UnTruc</code> (pas totalement improbable), votre jeu sera déplacé vers un autre titre.
  
 
== Style ==
 
== 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.
 
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 <nowiki><code></nowiki> tag pour améliorer la  lecture. Par exemple: lorsque vous ajoutez <code>foo</code> et <code>bar</code>, le résultat est <code>foobar</code>.
+
Lorsque vous faites référence à des variables et code à l'intérieur d'une phrase, utilisez la balise <nowiki><code></nowiki> pour améliorer la  lecture. Par exemple: lorsque vous ajoutez <code>foo</code> et <code>bar</code>, le résultat est <code>foobar</code>.
  
When referring to variables and code inside a regular sentence, use the <nowiki><code></nowiki> tag to improve the reading experience. For instance: when you add <code>foo</code> and <code>bar</code>, the result is <code>foobar</code>.
 
 
== Documentation ==
 
== Documentation ==
  
Documentation pages ''must'' follow the same structure if the documentation is to be usable.  
+
Les pages de documentation ''doivent'' suivre la même structure pour que la documentation puisse être utilisable.  
  
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]]:
+
Toutes les pages de documentation doivent avoir un lien sémantique vers leurs parents dans leur section ''Voir également''. Sans cela, l'élément n'apparaît pas dans les listes automatiques du wiki. Un lien sémantique est ajouté comme ceci pour une fonction, un type ou une enumération dans [[love.audio]]:
  
 
<pre>
 
<pre>
Line 32: Line 31:
 
</pre>
 
</pre>
  
All documentation pages must also have a semantic, 'list-friendly' description. This is done by adding the following to the bottom of the page:  
+
Toutes les pages de documentation doivent également avoir une description sémantique, 'list-friendly'. Ceci est fait en ajoutant la ligne suivante en bas de la page:
  
 
<pre>
 
<pre>
{{#set:Description=Draws an [[Image]] on screen.}}
+
{{#set:Description=Affiche une [[Image]] sur l'écran.}}
 
</pre>
 
</pre>
  
 
=== Modules ===
 
=== Modules ===
  
The following 'level 2' headers are allowed, but should only be used if they contain anything.
+
L'entête de niveau 2 suivant est autorisé, mais seulement s'il contient quelque chose.
  
 
* Types
 
* Types
* Functions
+
* Fonctions
* Enums
+
* Énumération
 
* Notes
 
* Notes
* Examples
+
* Exemples
* See Also
+
* Voir aussi
  
All modules must be assiciated with [[:Category:Modules]].
+
Tout les modules doivent être associés avec [[:Category:Modules]].
  
 
=== Types ===
 
=== Types ===
  
The following 'level 2' headers are allowed, but again, don't use then and leave them empty.
+
L'entête de niveau 2 suivant est autorisé, mais encore une fois seulement s'il contient quelque chose.
  
* Functions
+
* Fonctions
* Enums
+
* Énumération
 
* Supertypes
 
* Supertypes
 
* Subtypes
 
* Subtypes
 
* Notes
 
* Notes
* Examples
+
* Exemples
* See Also
+
* Voir aussi
  
All types must be assiciated with [[:Category:Types]].
+
Tout les types doivent être associés avec [[:Category:Types]].
  
=== Functions ===
+
=== Fonctions ===
  
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.  
+
Pour les fonctions, tous les en-têtes sont ''nécessaires'', à l'exception des ''Notes'', ''Exemples'' et ''Voir aussi''. Cela signifie que si la fonction ne retourne rien, il convient de dire explicitement qu'elle ne retourne rien. Il en va de même pour les arguments.
  
Similarly, if there are no constructors for a certain type (e.g. [[Contact]]), this should be explicitly mentioned.
+
De même, s'il n'y a pas de constructeurs pour un certain type (par exemple [[Contact]]), ceci devrait être explicitement mentionné.
  
The outer items in the list below are 'level 2' headers, and the inner ones are 'level 3'.  
+
Les éléments externes dans la liste ci-dessous sont des entêtes de ''niveau 2'', et ceux locaux sont de ''niveau 3''.
  
* Constructors
+
* Constructeurs
* Function
+
* Fonction
 
** Synopsis
 
** Synopsis
 
** Arguments
 
** Arguments
** Returns
+
** Renvoi
 
* Notes
 
* Notes
* Examples
+
* Exemples
* See Also
+
* Voir aussi
  
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.  
+
Si une fonction zqt surchargée, répétez l'entête de «fonction» pour chaque surcharge. Cela n'est pas nécessaire pour l'ajout d'arguments optionnels, il suffit d'indiquer la valeur par défaut entre parenthèses à la place.
  
Arguments and return values should be presented as a definition list, using [[:Template:param]].
 
  
All functions must be assiciated with [[:Category:Functions]].
+
Arguments et valeurs de retour doit être présenté comme une liste de définitions, en utilisant [[:Template:param]].
  
=== Enums ===
+
Toutes les fonctions doivent être associés avec [[:Category:Functions]].
  
For enums, these headers are allowed:
+
=== Énumérations ===
  
* Constants
+
Pour les énumérations, ces en-têtes sont autorisés:
 +
 
 +
* Constantes
 
* Notes
 
* Notes
* See Also
+
* Voir aussi
  
The constants should be listed as a definition list.
+
Les constantes doivent être énumérés comme une liste de définitions.
  
All enums must be associated with [[:Category:Enums]].
+
Tous les énumérations doivent être associés avec [[:Category:Enums]].
  
== Games ==
+
== Jeux ==
  
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 [[:Category:Games|list of games]]:
+
Pour les jeux, vous pouvez choisir votre propre structure, mais vous devriez toujours ajouter des propriétés sémantiques de la page pour la faire apparaître correctement dans [[:Category:Games|list of games]]:
  
 
<pre>
 
<pre>
{{#set:Name=NoGame}} (Should be same as page title)
+
{{#set:Name=NoGame}} (Doit être identique au titre de la page)
 
{{#set:Author=User:Rude}}
 
{{#set:Author=User:Rude}}
{{#set:Genre=What kind of game your game is}}
+
{{#set:Genre=Le type de jeu}}
 
{{#set:LOVE Version=0.6.1}}
 
{{#set:LOVE Version=0.6.1}}
{{#set:Description=A short description of your game.}}
+
{{#set:Description=Une courte description de votre jeu.}}
 
{{#set:Screenshot=File:ScreenshotURL.png}}
 
{{#set:Screenshot=File:ScreenshotURL.png}}
 
</pre>
 
</pre>
  
Screenshots will automatically be resized to fit a box of 161x100 pixels.
+
Les captures d'écran seront automatiquement redimensionnées pour s'adapter à une taille de 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.
+
De plus, mettre votre jeu en [[:Category:Games]] pour le faire apparaître automatiquement dans la page [[Games]]. Pour mettre votre jeu dans la bonne catégorie, ajoutez cette ligne à la fin de la page.
  
 
<pre>
 
<pre>
Line 121: Line 121:
 
</pre>
 
</pre>
  
It is also recommended that you provide screenshots of your game.
+
Il est également recommandé de fournir des captures d'écran de votre jeu.
  
== Libraries ==
+
== Librairies ==
  
No strict rules, but as for games, you should add these semantic properties:
+
Aucune règle stricte, mais comme pour les jeux, vous devez ajouter ces propriétés sémantiques:
  
 
<pre>
 
<pre>
 
{{#set:LOVE Version=0.6.1}}
 
{{#set:LOVE Version=0.6.1}}
{{#set:Description=A short description of your library.}}
+
{{#set:Description=une courte description de votre librairie.}}
 
</pre>
 
</pre>
  
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.
+
Placez votre bibliothèque dans [[:Category:Libraries]] pour la faire apparaître automatiquement dans la page [[Libraries]]. Pour mettre votre bibliothèque dans la bonne catégorie, ajoutez cette ligne à la fin de la page.
  
 
<pre>
 
<pre>
 
[[Category:Libraries]]
 
[[Category:Libraries]]
 
</pre>
 
</pre>

Latest revision as of 15:45, 26 August 2014

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 ordinaires, 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 type appelé 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 la balise <code> pour améliorer la lecture. Par exemple: lorsque vous ajoutez foo et bar, le résultat est foobar.

Documentation

Les pages de documentation doivent suivre la même structure pour que la documentation puisse être utilisable.

Toutes les pages de documentation doivent avoir un lien sémantique vers leurs parents dans leur section Voir également. Sans cela, l'élément n'apparaît pas dans les listes automatiques du wiki. Un lien sémantique est ajouté comme ceci pour une fonction, un type ou une enumération dans love.audio:

[[parent::love.audio]]

Toutes les pages de documentation doivent également avoir une description sémantique, 'list-friendly'. Ceci est fait en ajoutant la ligne suivante en bas de la page:

{{#set:Description=Affiche une [[Image]] sur l'écran.}}

Modules

L'entête de niveau 2 suivant est autorisé, mais seulement s'il contient quelque chose.

  • Types
  • Fonctions
  • Énumération
  • Notes
  • Exemples
  • Voir aussi

Tout les modules doivent être associés avec Category:Modules.

Types

L'entête de niveau 2 suivant est autorisé, mais encore une fois seulement s'il contient quelque chose.

  • Fonctions
  • Énumération
  • Supertypes
  • Subtypes
  • Notes
  • Exemples
  • Voir aussi

Tout les types doivent être associés avec Category:Types.

Fonctions

Pour les fonctions, tous les en-têtes sont nécessaires, à l'exception des Notes, Exemples et Voir aussi. Cela signifie que si la fonction ne retourne rien, il convient de dire explicitement qu'elle ne retourne rien. Il en va de même pour les arguments.

De même, s'il n'y a pas de constructeurs pour un certain type (par exemple Contact), ceci devrait être explicitement mentionné.

Les éléments externes dans la liste ci-dessous sont des entêtes de niveau 2, et ceux locaux sont de niveau 3.

  • Constructeurs
  • Fonction
    • Synopsis
    • Arguments
    • Renvoi
  • Notes
  • Exemples
  • Voir aussi

Si une fonction zqt surchargée, répétez l'entête de «fonction» pour chaque surcharge. Cela n'est pas nécessaire pour l'ajout d'arguments optionnels, il suffit d'indiquer la valeur par défaut entre parenthèses à la place.


Arguments et valeurs de retour doit être présenté comme une liste de définitions, en utilisant Template:param.

Toutes les fonctions doivent être associés avec Category:Functions.

Énumérations

Pour les énumérations, ces en-têtes sont autorisés:

  • Constantes
  • Notes
  • Voir aussi

Les constantes doivent être énumérés comme une liste de définitions.

Tous les énumérations doivent être associés avec Category:Enums.

Jeux

Pour les jeux, vous pouvez choisir votre propre structure, mais vous devriez toujours ajouter des propriétés sémantiques de la page pour la faire apparaître correctement dans list of games:

{{#set:Name=NoGame}} (Doit être identique au titre de la page)
{{#set:Author=User:Rude}}
{{#set:Genre=Le type de jeu}}
{{#set:LOVE Version=0.6.1}}
{{#set:Description=Une courte description de votre jeu.}}
{{#set:Screenshot=File:ScreenshotURL.png}}

Les captures d'écran seront automatiquement redimensionnées pour s'adapter à une taille de 161x100 pixels.

De plus, mettre votre jeu en Category:Games pour le faire apparaître automatiquement dans la page Games. Pour mettre votre jeu dans la bonne catégorie, ajoutez cette ligne à la fin de la page.

[[Category:Games]]

Il est également recommandé de fournir des captures d'écran de votre jeu.

Librairies

Aucune règle stricte, mais comme pour les jeux, vous devez ajouter ces propriétés sémantiques:

{{#set:LOVE Version=0.6.1}}
{{#set:Description=une courte description de votre librairie.}}

Placez votre bibliothèque dans Category:Libraries pour la faire apparaître automatiquement dans la page Libraries. Pour mettre votre bibliothèque dans la bonne catégorie, ajoutez cette ligne à la fin de la page.

[[Category:Libraries]]