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

m (moved guidelines to Guidelines (Français): Move to french part of the wiki)
 
(One intermediate revision by one other user not shown)
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>.
  
 
== Documentation ==
 
== Documentation ==
  
Les pages de documentation ''doivent'' suivre la même structure si la documentation doit être utilisable.  
+
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]]:
 
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]]:
Line 34: Line 34:
  
 
<pre>
 
<pre>
{{#set:Description=Draws an [[Image]] on screen.}}
+
{{#set:Description=Affiche une [[Image]] sur l'écran.}}
 
</pre>
 
</pre>
  
Line 66: Line 66:
 
=== Fonctions ===
 
=== 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.
+
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é.
 
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''.
+
Les éléments externes dans la liste ci-dessous sont des entêtes de ''niveau 2'', et ceux locaux sont de ''niveau 3''.
  
 
* Constructeurs
 
* Constructeurs

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