Prérequis

Si vous souhaitez contribuer au manuel, vous aurez besoin d’une autorisation de modification.

TODO : configurer https://www.netlifycms.org/

Dans tous les cas, vous devrez me contacter avec l’adresse e-mail associée à github, google, facebook ou twitter afin de modifier, car Jon doit placer cette adresse e-mail dans un fichier de configuration pour vous accorder les pouvoirs d’édition.

Si vous êtes un utilisateur de Plucky, avant de devenir éditeur, vous devez d’abord réaliser que les éditeurs peuvent intégrer des vidéos ou des images provenant de n’importe quel site dans ce site. Si cela pose problème pour vous, vous pouvez bloquer les vidéos et les images en utilisant les commandes suivantes.

Gardez également à l’esprit que certains utilisateurs de Plucky ne maîtrisent pas le français.

Règles

  1. En général, utilisez des mots en minuscules séparés par des traits d’union pour le nom de la page, de sorte que l’URL ne contienne que des caractères minuscules et ne nécessite aucun échappement spécial. Ne créez pas de pages avec des espaces dans leurs noms. Par exemple, cette page s’appelle « editing-the-manual » et non « editing the manual », et le titre est explicitement défini avec le nom convivial pour les espaces dans le front-matter.

  2. Soyez cohérent. Regardez les documents existants et essayez de formater le texte de manière similaire.

  3. Utilisez la capitalisation de phrase pour les titres et rubriques.

  4. Ne dupliquez pas de portions substantielles d’informations sur plusieurs pages. Le manuel dispose d’une fonction de recherche et est un hypermédia. Utilisez des liens pour pointer vers la source faisant autorité plutôt que de dupliquer l’information. Par exemple, au lieu de décrire comment installer Plucky sur faq et sur comment installer, décrivez-le uniquement sur cette dernière et faites-y un lien depuis la première. Des exceptions à cette directive sont appropriées pour certaines pages, par exemple bases de la ligne de commande, où avoir plusieurs exemples simples et introductifs sur une même page peut être utile pour les nouveaux utilisateurs.

  5. Évitez de faire des modifications uniquement sur les espaces blancs, y compris combiner ou diviser des lignes dans la source. Chaque modification de page est en fait transformée en un commit Git sur le serveur, et les modifications uniquement sur les espaces blancs rendent la sortie d’outils comme Git blame moins utile.

  6. Utilisez une voix cohérente. Soit la deuxième personne (« vous ») soit la voix passive. Notez qu’il existe actuellement un mélange de voix.

  7. Utilisez jusqu’à 600 caractères par ligne. Dans emacs, (set-variable 'fill-column 600).

  8. Pour les screencast, utilisez 1024 x 768 pour la résolution vidéo — cela permet de garder les vidéos légèrement plus petites et plus faciles à voir pour ceux qui ont de petits écrans. Pour le format, préférez webm, puis mp4. Ces règles peuvent parfois être enfreintes : Jon a utilisé 1152x720 et m4v sur une vidéo macOS parce qu’il était pressé et ne savait pas comment faire un screencast autrement qu’avec Quicktime. Mais s’il avait eu le temps, il aurait modifié cela.

Conseils pour les éditeurs fréquents

Si vous modifiez très fréquemment, vous pourriez demander à Jon un accès non-navigateur aux documents. C’est ainsi que Jon met à jour de nombreuses pages car c’est une façon plus rapide et plus puissante de modifier de nombreuses pages à la fois.

Jetez également un œil aux liens utiles ci-dessous.

Sections spécifiques au système d’exploitation

TODO : FIXME : ce contenu est obsolète.

Certaines pages (par exemple, comment installer) ont des sections relatives à des systèmes d’exploitation spécifiques. Étant donné que généralement une seule de ces sections est pertinente pour le lecteur, du JavaScript a été ajouté qui peut automatiquement masquer les sections non pertinentes sur ces pages et donner au lecteur un bouton pour basculer la visibilité de ces sections. Les systèmes d’exploitation possibles sont :

  • Android
  • Chrome OS
  • iOS
  • Linux
  • Mac OS X
  • Windows
  • Windows Phone
  • Inconnu

Liens utiles

Dernière mise à jour : 2026-04-21