Contributions au wiki et traductions

From Resonite Wiki
Revision as of 08:35, 25 January 2024 by J4 (talk | contribs) (Created page with "Le wiki de Resonite est un environment évoluant rapidement. Cela peut rendre incertain ce qui peut être édité et amélioré.")

Le wiki de Resonite est un projet communautaire. Merci pour toute votre aide et contributions! Nous sommes une petite équipe et le maintenir ne serait pas possible sans vous. Tout le monde, sans égard a leur status sur Resonite peut éditer le wiki et est encouragé a le faire. Éditez!

Modération du wiki

Pour chaque utilisateur, leur premières contributions seront placées dans une file d'attente de modération qui est généralement approuvée rapidement.

Une fois approuvée, les utilisateurs sont ajoutés au groupe "automoderated user" qui leur permet d'éditer le wiki librement.

Lignes directrices d'édition

Avant de commencer, il y a quelques lignes directrices a garder a l'esprit.

Brouillons/Commentaires etc

  1. Juste éditez le wiki! Vous n'avez pas besoin d'un statut spécial, approbation ou permission pour éditer le wiki.
  2. Ne nous envoyez pas vos brouillons, juste éditez.
  3. N'utilisez pas Google Docs pour rédiger un brouillon. Écrire directement sur le wiki vous permet de penser comme un éditeur de wiki.
  4. Suivez le principe d'amélioration progressive: "bon" -> "mieux" -> "meilleur"

Style

Nous n'avons pas de guide de style mais nous avons quelques lignes directrices:

  • Utiliser du Francais standard.
  • Créez des liens vers d'autres articles!
  • Écrivez des phrases correctes avec une case correcte.
    • Évitez le surplus de majuscules.
  • Écrivez avec "vous" et non pour "moi".
  • Évitez les phrases dans les titres d'articles. "ProtFlux" est mieux que "Qu'est-ce que ProtoFlux". ProtoFlux devrait contenir des information sur ce que c'est sans le dire dans le titre.
  • Utilisez des titres. Ils aident avec la lisibilité.
  • Utilisez des listes. C'est bien les listes.
  • Évitez de créer des tableaux pour des long paragraphes de texte.
    • Pour des données factuelles, des données numériques, etc, les tableaux sont corrects, mais on peut souvent voir des tableaux qui seraient mieux comme une collection de tableaux plus petits ou une liste.
  • Évitez d'utiliser "Cliquez ici" ou "ici" ou "page"
    • A la place, essayez d'incorporer le lien ou le titre de la page dans la phrase.
    • Voici un article qui en dit plus.
  • Évitez "Introduction" dans vos titres. Les premières phrases de l'article sont l'introduction. Regardez Wikipedia pour des bons exemples.

Formattage

Étant donné que le wiki change en permanence et ses traductions, nous avons besoin d'un formatage précis.

Vous pouvez trouver un guide sur le formatage WikiText sur la documentation officielle MediaWiki.

  • Évitez d'utiliser des tags HTML anciens.
    • <b>,<br>,<i>,<div> etc
      doivent être remplacés par leur équivalent WikiText.
    • Si vous voulez retourner à la ligne, juste retournez à la ligne.
  • Évitez de démarrer une page avec un titre étant une copie du titre de la page. Le titre de la page est le nom de la page, pas le premier titre.

Couleurs

  • Évitez d'appliquer des couleurs manuellement sur les pages. Cela peut casser les thèmes clairs et obscurs.
  • Utilisez les variables de couleur définies dans Mediawiki:Citizen.css.
  • Nous sommes en train de chercher comment utiliser notre thème pour les couleurs ce qui les feront fonctionner dans les thèmes clairs et obscurs.

Icônes

Vous pouvez utiliser des images SVG pour ceux-cis. Cela permet aux autres utilisateurs de les éditer plus facilement plus tard.

Descriptions de pages

Nous utilisons l'extension Short Description pour permettre d'avoir une description de page courte sur la page de recherche.

Pour ajouter une description a une page, utilisez: {{SHORTDESC:<description>}}

Fenêtre de recherche avec la description de page surlignée.

Trouver du contenu a éditer

Le wiki de Resonite est un environment évoluant rapidement. Cela peut rendre incertain ce qui peut être édité et amélioré.

Stubs

To help with this, we have a number of pages which list content that is in need of attention. These pages are called Stubs. You can find a list of stubs on these automatically generated pages:

Check these pages regularly for lists of pages that need help.

Components & Nodes

Resonite Users use a huge amount of ProtoFlux Nodes and Components to create in-game content. All of these need documentation!

Templates

Currently we do not have proper component/node templates. This will be updated once they are developed!

ProtoFlux Nodes

Check Category:ProtoFlux for a list of nodes. It resembles the in-game Node Browser. Any nodes could do with reviews, edits and updates but if you see a Node with a Red link, that means it is undocumented. Please feel free to type documentation for it!

Components

We have a list of components on Category:Components which can have gaps or missing pages. If you find a component that is missing documentation please go ahead and add it.

Making Larger Changes

When making changes to the wiki, the general principle is to go right ahead. However, when making changes to larger pages such as the Main Page or pages which are edited, touched or translated frequently, please be careful. There are sometimes subtleties and nuances that need to be covered when editing these pages. Please double check in the Wiki channel of the Resonite Discord before you make such changes. The community there will say yes a lot of the time, but sometimes a discussion may be required.

Editing Help

The Resonite Wiki uses Media Wiki as its wiki engine, and MediaWiki has extensive documentation on how to edit Wiki pages.

Everyone can make a wiki account to contribute to existing pages and create new ones.

Categories

A Category is a way to categorize pages that follow a certain theme or topic. You can use them to group together these pages, as a category page will create a table of pages within its category. For more information on categories, please see Media Wiki's guide on categories. However, here are some specific Resonite Wiki items of guidance:

  • Category Pages can contain information and text. Use this to explain what the category is and what it does.
  • Subcategories can exist.
    • To Create one, put a Category page into another Category.
    • For example, Category:Animals, Could contain Category:Animals:Mammals.
    • To do this, make sure Category:Animals:Mammals is named exactly like that and then ensure it also has [[Category:Animals]] within it.
  • A page can be in more than one category.
  • Please try to avoid creating categories that have only one page within them.

Be careful when nesting categories. Members of a category should not also be a category themselves. Category:Vegetables is fine. However, Potato being its own category is NOT ok.

Translating

For translating information read Help:Translating.

Accessibility

Images

Make sure your images are accessible. Our recommendations:

  1. Highlight relevant portions of the image with an image editor such as button pushes or input boxes the user should focus on
  2. Upload a large image, and use WikiText to shrink it down.
  3. Always specify a caption straight after the image name e.g. [[File:bunny.png|A photograph of a bunny]].
    • When the caption is the first item after the image name, it will be automatically placed in the HTML image tag's alt attribute.
    • If you need to make a separate alt-text from a caption, you can use the alt parameter.

External Resources

See Also