Utilisateur:Zorroargh/Brouillons/Guide technique

De EncyclopAtys

Profil de Zorroargh Discussion Guide de rédaction Boite à outils Notes HRP Notes HRP
Dummy.png
Archive 1 Guide technique Travaux courants Travaux courants
Le

GUIDE TECHNIQUE

a dorénavant sa page:

Guide Technique du wiki

Le travail d'équipe

Ne jamais oublier que tout document (a l'exception des pages protégées, accessibles aux seuls administrateurs) peut être modifiable n'importe quand par tout le monde. Voir ci-après (Modifications puis Validation (permanente) du contenu) les bonnes pratiques à adopter

Pages de discussions

Il est souvent utile, pratique ou indispensable de laisser un message à autrui. Or une page « Discussion » est associée à chaque document lors de sa création, par exemple ici : Discussion_Utilisateur:Zorroargh/Brouillons/Guide technique [[Discussion_{{FULLPAGENAME}}]].

Dans tous les cas de figure, il faut essayer de maintenir quelque chose de lisible, donc chaque sujet commencera par un titre ==Titre du sujet abordé==. Il vaut mieux cinquante petits sujets séparés dotés chacun d'un titre, qu'un seul paquet de cinquante sujets. Cela facilite les réponses discriminées dans leur prise en compte, leur réalisation, etc.

À la fin du sujet, toujours signer par ~~~~. Cela permet de savoir immédiatement qui a posté le message, et quand.

Traditionnellement les réponses se font en indentant comme dans les courriels. Cela se fait en commençant la ligne avec un « : » de plus que la partie antérieure. Évidement chaque réponse, chaque rebondissement sera signé. C'est très utile pour quelqu'un qui se posera les mêmes questions plus tard et qui verra ainsi cette discussion comme un élément de « Base de Connaissances ».

En final, il peut être utile d'accoler au titre une pour indiquer que le sujet est clos ==Titre du sujet abordé {{OK}}==. Si le sujet doit être rouvert on pourra remplacer la par une {{KO}}.

Malheureusement, les personnes concernées par le questionnement ne sont pas nécessairement prévenues (il existe un maximum d'articles suivis, donc notifiables, pour ne pas faire sauter la base). Donc, pensez aussi à prévenir la ou les personnes qui peuvent être concernées en indiquant le lien vers la discussion. Là aussi, titre et signature, même si c'est très court, sont bienvenus.

Parrainage

En première lecture on pourra se rendre compte que si le Wiki est facile à la rédaction, il est lourd à gérer avec toutes ses règles de convivialité et d'efficacité, ses traditions construites sur l'expérience des prédécesseurs, etc. C'est que le wiki a aussi sa « Lore » (emprunté à l'anglais signifiant « tradition orale »).

Vous voulez vraiment vous investir dans le wiki ? Alors, n'hésitez pas à vous faire parrainer, sans gêne, ni timidité, ni honte… Nous avons tous débuté, et peut-être, nous l'espérons, ce sera à vous de parrainer plus tard. Vous ne connaissez personne ? Essayez de contacter des « anciens » sur https://chat.ryzom.com/channel/pj-ryzom_wiki ou contactez-les à partir de Spécial:Utilisateurs_actifs

Traductions

Il y a quatre règles qui cohabitent :

• Forge (partie développement), Charte de comportement dans le jeu, Charte graphique, Catégories fondamentales
  • tout doit être traduit en anglais pour être accessible au plus grand nombre dont la majorité comprend, peu ou prou, l'anglais écrit ;
• Charte de comportement dans le jeu, Charte graphique, Modèles de gestion du Wiki, Catégories fondamentales
  • tout doit être traduit dans toutes les langues ;
• Lore, Chroniques, Animations publiques 
  • tout doit être traduit au moins dans les trois langues « maternelles » de Ryzom: DE, EN et FR ;
• le reste et surtout les parties roleplay
  • il n'y a aucune règle, seul l'intérêt des joueurs et des traducteurs prévaut.

Modifications

FR wiki history comparing.png
FR wiki history see.png
À l'exception des documents archivés et des documents ayant certain statut officiel de "document définitif" (Lore, Chronique), tout est perfectible et c'est l'une des richesses des wiki.

Il faut néanmoins respecter certaines règles de convivialité constructive.

Tout d'abord il faut évaluer si les modifications sont profondes ou pas. Il n'y a pas de règles et c'est plus du feeling, mais si la modification est profonde, il est sage de commencer par regarder son histoire (bouton à côté de "Modifier". Si le fond n'a pas évolué depuis un certain temps (pas la forme, le look, l'orthographe...) on peut supposer que son auteur l'a laissé pour tel et que le document a peut-être vieilli et nécessite une mise à jour. Un exemple est affiché sur le côté droit.

On peut considérer qu'une mise à jour est profonde dès lors où elle supprime des paragraphes, voire des lignes fondamentales au développement du sujet. Dans ce cas il devient convenable de laisser un message dans le "Discussion utilisateur:xyz". En attendant sa réponse (une semaine?), il est sage de mettre la partie originale qui sera modifiée en commentaire. Le plus simple pour mettre en commentaire est d'ajouter au début du texte à commenter <!-- et à la fin -->. Mais il y a parfois des problèmes surtout s'il y a déjà d'autres commentaires. Dans ce cas, on peut utiliser le marteau burin en utiliser <noinclude><includeonly> et à la fin </includeonly></noinclude>. Pourquoi une telle complication? Parce qu'il faut toujours respecter les écrits d'un auteurs et sa paternité intellectuelle, même dans le libre, sinon, cela peut conduire fatalement aux:

Guerre d'édition

Extrait de Wikipédia:Guerre d'édition Lors d'une guerre d'édition, deux ou plusieurs éditeurs expriment un profond désaccord sur un point particulier (le contenu ou le titre d'un article, sa subdivision en plusieurs articles de petite taille, un paragraphe non neutre…). On parle de guerre d'édition lorsque l'on peut observer les signes suivants : cycle de révocation actif sur l'article lui-même, commentaires agressifs, attaques personnelles, absence de discussion sur le sujet de l'article entre les protagonistes.

La détérioration délibérée du contenu, le blanchiment des pages ou le recours aux insultes dans la page de discussion ou la boîte de résumé sont considérés comme du vandalisme.

[...]

En dernier recours, un administrateur extérieur au débat pourra protéger la page. Dans ce cas, les éditeurs ayant tous les mêmes droits en matière d'édition, les personnes impliquées dans la polémique sont priées de respecter la règle de non-édition. Il est également rappelé que participer à une guerre d'édition peut conduire à un blocage des contributeurs engagés et qu'à tout moment s'applique la règle des trois révocations.

Il ne faut pas confondre avec le conflit d'édition: (extrait de Aide:Conflit de versions)

Dans Wikipédia, un conflit de versions ou conflit d’édition survient lorsque deux contributeurs travaillent sur une même page en même temps : le second qui enregistre, ayant travaillé avec une version obsolète de la page, voit sa modification rejetée. Depuis la version 1.3 de MediaWiki, cela ne se produit que si les modifications ne peuvent pas être fusionnées automatiquement.

Travailler en paix

Bien sûr les incidents de parcours et les maladresses ne seront jamais évitées à 100% aussi le plus sage est de respecter ces conseils: (extrait et adaptation de Aide:Conflit de versions)

Pour éviter les conflits de versions, le plus simple est d’éviter des modifications trop longues.

Cependant ce n’est pas toujours possible. C’est pourquoi il est possible, lors de la modification en profondeur d’une page, d’ajouter préalablement le bandeau {{WIP|~~~~}}

Important.png
Under Construction Panel.png !!! En travaux !!! Under Construction Panel.png
Il reste actuellement encore 105 articles en préparation dans la catégorie «WIP»
Article en préparation. Laissez l'auteur le terminer avant de le modifier.
La dernière édition était de Lanstiril le 2019-09-09.

-- Zo'ro-Argh Woren Siloy 28 mai 2019 à 14:19 (CEST)

Une fois la page publiée avec ce bandeau, vous pouvez modifier tranquillement la page. Limitez le nombre de modifications en utilisant la prévisualisation pour procéder aux ajustements (cela permet un gain de temps et évite d’encombrer la page de modifications récentes).

Quand vous avez terminé, n’oubliez pas de retirer le modèle {{WIP}}".

Le brouillon

Une autre méthode pour travailler en paix, est de travailler dans son espace. Cet espace c'est [[Utilisateur:Zorroargh/Brouillons/...]]. Les document que vous y préparez ne sont pas visible par les recherches (sauf explicitement). Même Google ne doit pas y aller!

Validation (permanente) du contenu

Normalement, dans le Wiki de Ryzom toutes les pages sont libres de traitement tant qu'il n'y a pas vandalisme. Néanmoins, les joueurs peuvent avoir besoin de documents fiables. Cela concerne essentiellement :

  • La charte de comportementale dans tout le jeux, ce wiki inclus.
  • La Lore qui donne les fondations du jeu (Les homins ne parlent pas klingon, la Karavan ne vole pas sur des dragons de feu et les Kamis ne surgissent pas d'une lampe à huile). Les règles sont détaillées dans le portail de la Lore. Ici, elles seront brièvement décrites pour pointer sur leur existence.

D'autres documents peuvent être jugés sensibles pour la maintenance, comme les modèles très utilisés pouvant changer l'aspect, voire la lisibilité, des documents.

Enfin les contributeurs, développeur, gamer, RP ou non, animateur... peuvent estimer que leur travail entre doit être validé.

Un document validé par les Loristes, les responsables de communications officielles ou les "administrateurs", est protégé contre toutes modifications non autorisées.

La Lore

Résumé du traitement spécifique des documents liés à la Lore.

Copie officielle

Texte écrit par les Loristes ou retranscrit ou traduit par des encyclopatystes.

On appose tout en haut de la page le logo de la Lore {{Lore Officielle}} qui affichera l'image Rubber-Stamp-Lore choix Vert.png.

Création d'utilisateur non Loriste

Pour demander une validation de l'équipe Lore, apposer tout en haut de la page la bannière: {{Demande validation Lore}}

Validation

Un Loriste appose, si ce n'est déjà fait, le logo de la Lore, et il efface les bannières éventuelles de demande de validation. Ensuite il protège la page. Il peut déléguer cette tâche à un administrateur. le logo de la Lore devient alors: Rubber-Stamp-Lore choix H.png.

Catégories

Toutes les données, articles, images, modèles, portails..., doivent être catégorisées.

De l'usage des catégories

Les catégories sont très utiles pour cataloguer les documents et faciliter leur recherche. Il faut comprendre qu'une catégorie ressemble un ensemble au sens mathématique du terme, autrement dit:

  • un article peut appartenir à plusieurs ensembles.
  • il est inutile de déclarer qu'un article appartient simultanément à deux ensembles dont l'un est complètement inclus dans l'autre.

Exemple, une "chaussette rouge" peut appartenir aux catégories: "chaussettes", "objets de couleur rouge", "vêtements rouges", "vêtements". Normalement, dire que cette chaussette appartient aux "vêtements rouges", est suffisant. Mais on pourrait aussi dire qu'elle appartient aux "chaussettes" et "objets de couleur rouge" sans faire référence aux "vêtements rouges". Dans ces deux cas, il est inutile de dire qu'elle appartient aux "vêtements".

Le choix des catégories peut parfois être liée aux outils qui permettent de fouiller dans une catégorie et qui sont souvent affiché dans les portails (par exemple:

Le portail ...

Il y a actuellement 19 pages sur ...

Ce qui est obtenu par Il y a actuellement {{Number of pages}} pages sur ...

Bien sûr, il apparaît de l'exemple précédent qu'il peut y avoir des exceptions essentiellement liée à l'ergonomie de la recherche. En effet, la recherche automatique dans les arborescences de catégories est très gourmande en temps et en énergie, aussi, il vaut mieux utiliser {{Number of pages}} qui ne descend pas dans les sous catégories.

Les catégories fondamentales de ce wiki

Ce wiki, lié à l'univers de Ryzom, est censé partager des données communes aux langues de base du Wiki. Ces données communes sont regroupée dans 4 arborescences détaillées dans l'article Catégorisation. Seules les "grosses branches" sont détaillées pour laisser la liberté d'organisation des données à chaque groupe linguistique. Mais ces troncs et leurs "grosses branches" sont indispensables, surtout pour les traducteurs qui veulent facilement naviguer entre les groupes d'articles.

Template (Modèle)

Extraite de wiki:Aide:Modèle

Un modèle sert à reproduire sur plusieurs pages le même message, ou la même mise en page, parfois en fonction de paramètres.

Il s'agit d'un élément pré-écrit, plus ou moins complexe, destiné à être incrusté dans une page afin d'obtenir instantanément le résultat visuel souhaité (formatage, affichage d'éléments spécifiques, etc.). Les bandeaux en haut des articles, les infobox, l'affichage des siècles... sont des modèles.

Aspect visuel et charte graphique

L'aspect visuel doit rappeler l'identité du jeu. Par exemple: les infobox rappellent les "ambres mémoire" (RP) ou les interfaces de la Karavan (HRP). Les icônes en général font référence plus ou moins explicitement à l'univers du jeu.

Une charte graphique a deux fonctions (au moins):

  • une identitaire qui rappelle l'esprit du site (par exemple "couleurs" des nations, des factions...)
  • une ergonomique qui consiste à éviter ce qui est appelé "effet de surprise", c'est à dire d'avoir des comportements différents d'une page à l'autre, d'une traduction à l'autre.

Pour ces deux raisons, il faut le plus possible s'y tenir.

Bannières, sceaux et indicateurs du haut...

Les modèles de haut de pages, ou de paragraphe, servent à alerter le lecteur sur la manière dont il faut interpréter la page en question (obsolescence, en cours de rédaction..) ainsi que des annonces importantes concernant l'article.

Bannières, navigation, horodateur...

Les modèles de bas de pages servent à informer le lecteur sur des compléments d'information qui peuvent intéresser après lecture de la dite page.

Corps de page

Les modèles de bas de pages servent à mettre en évidence ou en complément des informations liée à la page en cours. La mise en évidence peut être diverse comme l'apparition de gros encarts ou des mises en forme typographique diverses.

Tous les templates

(attention pas rigoureusement identique entre les langues, mais essayons de les harmoniser le plus possible.)

Tous les templates sont dans la catégorie:modèles dont l'arborescence est explicitée dans le document Catégorisation#Le_Wikipatys

Portail

Les portails dans notre wiki servent de pages d’accueil des différents grands centres d'intérêt du jeu. Ils sont répertoriés dans la cartouche {{Portal bottom|}}
Cube d ambre v1.0.png
Tous les portails thématiques de l'Encyclopatys (Wiki de Ryzom)

Ryzom: La LoreLe JeuHRP
Atys: Le monde d'AtysFloreFaune
Nations: FyrosMatisTrykerZoraï
Factions: KamiKaravanMaraudeursRangersTrytonistes

L'encyclopédie: Les Chroniques d'AtysLa Grande BibliothèqueLes arcanesHRP


Chaque portail a une structure plus ou moins identique, mais qui varie selon la complexité des données qu'il offre. En général il est composé de haut en bas:

  • D'onglets de sous thèmes, l'accueil général étant le premier onglet. Dans certains cas, il peut y avoir une seconde rangée d'onglets.
  • Le nombre d'articles concernés et catégorisés (cf #Les catégories associées)
  • Un résumé
  • Des informations (à gauche #Doc du jour, à droite un #Panneau d'affichage
  • La cartouche des principaux portails du Wiki de Ryzom ({{Portal bottom|}})

Les portails n'ont pas été fabriqués en un jour et donc leur modèle s'est affiné au cours du temps. En général on essaye d'y inclure des documents par la méthode {{:<document à inclure>}}

Doc du jour

Il est parfois agréable d'avoir une documentation qui donne un aperçu des thèmes présenté réunis sous le portail. Cela peut se faire par les méthodes:

Un document différent ENGLISH FRANÇAIS
Quand nécessaire {{:Featured article/...}} {{:Lumière sur/...}}
Automatique par jour de la semaine {{:Featured article/GBA/Week/{{CURRENTDOW}}}} {{:Lumière sur/.../Jour/{{CURRENTDOW}}}}
Automatique par jour du mois {{:Featured article/GBA/Month/{{CURRENTDAY2}}}} {{:Lumière sur/.../Mois/{{CURRENTDAY2}}}}

Panneau d'affichage

Les panneaux d'affichage contiennent des informations concernant aussi bien les lecteurs que le contributeurs. Cela peut aller de la simple information aux urgences en passant par les demandes, "to do list" et trucs et astuces.

Les catégories associées

Toutes les pages concernées

Pour associer un article à un portail, il suffit d'ajouter en bas de l'article qui doit être associé à un portail ce type d'indtructions:

{{clear}}{{Last version link}}
<noinclude>{{Portal|xxx}}
[[Category:yyy]]</noinclude>

où:

  • Le clear permet d'assurer que la barre de navigation vers le portail est bien en-dessus de la dernière image.
  • Le last version link permet d'horodater la page et ajoute un onglet discret permettant de retrouver l'original d'une inclusion.
  • Le noinclude peut être mis pour ne pas polluer l'inclusion

À la une

L'ajout de la bannière de navigation vers le portail catégorise en plus l'article dans des catégories "cachées", c'est-à-dire qui ne seront pas affichée en affichage normale, car inopportune (mais elles sont indiquées par un [ + ]) après la dernière catégorie affichée en bas.

La technique de choix au hasard a été condamnée par Mediawiki, car trop coûteuse. Actuellement, on lui préfère un choix bridé (jour de la semaine ou du mois). Cela impose de créer à la main des redirections vers les pages à mettre en lumière. Ainsi, par exemple, la page "Lumière sur/GBA/Jour/3" (3 du mois ou le mercredi) est redirigée vers "Primes Raider".

Que faire si l'article est trop long à inclure, et si seulement certaines parie sont intéressante?

Le plus sage est d'indiquer les parties à afficher ou occulter par en inclusion en les balisant par

  • Les balises contenu à exclure permettent d'exclure un contenu entre balises de la future inclusion.
  • Les balises contenu à inclure permettent d'inclure le contenu entre balises de la future inclusion.
  • Les balises permettent d'inclure le contenu entre balises de la future inclusion, mais de les masquer dans la page originelle. À manipuler prudemment dans un modèle.
Ce dernier balisage est par exemple utilisé pour cacher dans l'article originale le à suivre... ({{read more|<l'article original>}} affiché ci-dessous) mais l'affiche dans l'inclusion.

Accueil

Les pages d’accueil sont « spécifiques » ce sont celles qui s'affichent par défaut lorsque l'on se connecte sur le wiki. Ces pages ne sont pas modifiables et peuvent contenir de nombreux artifices en HTML (et java), ce qui implique que seuls des contributeurs avertis peuvent les modifier avec le consensus de la communauté ou les impératif de la comm.