| Prochaine révision | Révision précédente |
| fr:slackdocs:styleguide [2015/09/08 11:33 (UTC)] – créée - Work in progress (cedric) cedric | fr:slackdocs:styleguide [2015/09/09 13:04 (UTC)] (Version actuelle) – add translator tag cedric |
|---|
| ====== Style Guide for Articles Published at SlackDocs ====== | ====== Guide de Style pour les Articles Publiés sur SlackDocs ====== |
| |
| A few basic rules should be kept in mind when editing pages in this Wiki. | Quelques règles de base devraient être gardés à l'esprit lors de l'édition des pages de ce wiki. |
| |
| ===== Editing Policy ===== | ===== Politique d'Édition ===== |
| |
| ==== Overview ==== | ==== Vue d'ensemble ==== |
| | |
| | |
| | Le wiki du Projet de Documentation Slackware ne sera pas un wiki ouvert à 100%. Bien que tous puissent contribuer, le staff examinera les soumissions et les grandes modifications de page afin d'éviter les guerres d'édition et d'autres effets néfastes vécues par les wikis ouverte. A contributor will have ownership of his submissions to the extent that he can have a reasonable expectation that the basic structure and content of the article will not be modified without his knowledge and editorial discussion via the discussion page. Le personnel estime que cette politique favoriserait une meilleure ambiance pour un archivage des données positif et constructif sur ce wiki. |
| |
| The Slackware Documentation Project wiki will not be a 100% open wiki. While true that all can contribute, in order to avoid the editing wars and other ill effects experienced by open wikis, staff reviewing of submissions and major page edits will be standard procedure. A contributor will have ownership of his submissions to the extent that he can have a reasonable expectation that the basic structure and content of the article will not be modified without his knowledge and editorial discussion via the discussion page. The Staff feels that this policy would foster a better atmosphere for positive and constructive data archiving on this wiki. | |
| ---- | ---- |
| |
| ==== Policy Rule ==== | ==== Règles de Fonctionnement ==== |
| | |
| **Major ((For purposes of this rule, a major edit should be considered to be any edit that substantially changes the content, flow, or layout of the article.)) edits should not be performed on a contributor's submission without his knowledge and editorial discussion.** | **Une Modification Majeure ((est considéré comme modification majeure toute édition qui modifie substantiellement le contenu, flux, ou la mise en page de l'article.)) ne devrait pas être effectuée sur l'article d'un contributeur à son insu et sans discussion éditoriale préalable.** |
| | |
| <note important>A record of the discourse between the contributor and the editor should be present on the discussion page.</note> | |
| |
| **Exceptions to This Rule** | <note important>Un enregistrement du discours entre l'éditeur et le contributeur doit être présent sur la page de discussion.</note> |
| |
| - Core documents in these namespaces that require more exacting editorial overview: **slackware**, **slackdocs** or **slackbook**. | **Exceptions à cette Règle** |
| - Explicit permission is granted via the discussion page by the original author to allow open editing/improvements. | |
| - Author is unknown or no longer an active participant here. | |
| - Editing or reversion is required to correct vandalism. | |
| - Minor edits are required to correct grammar, punctuation, spelling, wiki formatting, or clarity. | |
| - Editing is required to amend obviously incorrect information. | |
| |
| <note>For **Exception 6**, a warning note should be placed within the article by a Staff editor stating that the information is incorrect as it currently appears and will be amended soon (once the original contributor has time to respond).</note> | - Les documents de base dans ces espaces de noms nécessitent une vérification éditoriale plus exigeante: **slackware**, **slackdocs** or **slackbook**. |
| | - Une autorisation explicite est accordée via la page de discussion par l'auteur d'origine pour permettre les éditions/améliortions. |
| | - L'auteur est inconnu ou n'est plus un participant actif ici. |
| | - L'édition ou reversion est nécessaire pour corriger le vandalisme. |
| | - Les éditions Mineur sont nécessaire pour corriger les erreurs grammaticales, de ponctuation, de formulation, de formattage wiki ou pour éclaircir des points précis. |
| | - L'édition est nécessaire pour corriger des informations erronées. |
| |
| | <note>Pour l'**Exception 6**, une note d'avertissement devrait être placée dans le corps de l'article par un Staff editor indiquant que l'information est incorrecte tel qu'elle apparaît actuellement et sera bientôt modifiée (dès que son contributeur aura pris le temps de répondre).</note> |
| |
| ---- | ---- |
| |
| ==== Commentary ==== | ==== Commentaire ==== |
| |
| Regarding the Core namespaces **slackware**, **slackdocs**, and **slackbook**; these are the heart of this project. While howtos and other sections of the wiki are also important to the project, the Core documentation is the reason for all our efforts here. With this in mind, the Staff believes that content in these sections should be more minutely edited and maintained. The more exacting oversight utilized in the care of these Core documents will be appreciated by those using this project as a resource in their learning and continuing use of Slackware Linux. | En ce qui concerne les espaces de noms de base **slackware**, **slackdocs**, and **slackbook**; ceux-ci sont au cœur de ce projet. Alors que les howtos et d'autres sections du wiki sont également importantes pour le projet, la documentation de base est la raison de tous nos efforts ici. Dans cet esprit, le staff estime que le contenu de ces sections devrait être plus minutieusement édité et maintenu. Une attention toute particulière de ces documents de base par ceux qui utilisent ce projet comme une ressource dans leur apprentissage et leur utilisation de Slackware Linux sera particulièrement apprécié . |
| |
| Thank you for your understanding and cooperation in this matter. | Nous vous remercions de votre compréhension et de votre coopération à ce sujet. |
| |
| ===== Page Editing Etiquette ===== | ===== Page Editing Etiquette ===== |
| |
| ==== Release the Lock ==== | ==== Désactiver le Verrouillage ==== |
| |
| When you click on the "edit" button, you go into "editing mode". In this mode, page or section is **locked** to avoid someone else to edit the page at the same time (creating a conflict). If you close your browser window while you are in "edit" mode, the page lock will not be released for a //maximum of 15 minutes//. Leave the editor using the "cancel" button when you finally decide to not modify the page. This removes the lock, and permits other people to immediately edit the page. | Lorsque vous cliquez sur le bouton "Modifier", vous entrez dans le "mode d'édition". Dans ce mode, page ou section sont **verrouillées** pour éviter que quelqu'un d'autre ne modifie la page en même temps (ce qui créerait un conflit). Si vous fermez la fenêtre de votre navigateur lorsque vous êtes en mode "édition", le verrou de la page ne sera pas libéré avant un //maximum de 15 minutes//. Il est préférable de quitter l'éditeur en utilisant le bouton "Annuler" lorsque vous décidez finalement de ne pas modifier la page. Cela supprime le verrou, et permet à d'autres personnes d'éditer immédiatement la page. |
| |
| ==== Edit a Section, Not the Whole Page ==== | ==== Modifier un Article, Pas Toute une Page ==== |
| |
| On the right of each page section header, you see the word [edit]. If you click on it to edit the section, you only lock this section of the page which allows other contributors to edit different sections of the page. This is the recommended way for translating pages, fixing typos or just some sentences/words. | Sur la droite de chaque en-tête de section d'une page, vous pouvez voir le mot [modifier]. Si vous cliquez dessus pour modifier la section, vous ne verrouillerez que cette section de la page, ce qui permettra aux autres contributeurs de modifier les autres sections de la page. Ceci est la méthode recommandée pour la traduction des pages, pour corriger les fautes ou seulement quelques phrases/mots. |
| |
| ==== Add a Summary ==== | ==== Ajouter un Résumé ==== |
| |
| In "edit" mode, you can see an entry field "Edit summary" next to the Save/Preview/Cancel buttons. Use a few words to explain what you have modified. This comment will appear in the "old revisions" tab of the page as well as in the [[http://docs.slackware.com/?do=recent | recent changes]] overview. | En mode "Modifier", vous pouvez voir un champ de saisie "Résumé" à côté des boutons Enregistrer/Aperçu/Annuler. Ecrivez quelques mots pour expliquer ce que vous avez modifié. Ce commentaire apparaîtra dans l'onglet "anciennes révisions" de la page ainsi que dans laperçu des [[http://docs.slackware.com/?do=recent|changements récents]]. |
| |
| ==== Minor Modifications ==== | ==== Modifications Mineures ==== |
| |
| When you only fix a typo, change a word, or make global minor modifications, tick the box "Minor Changes" which you find to the right of the "Edit summary" field. Dokuwiki lets us follow page revisions via [[http://docs.slackware.com/feed.php | RSS]]. By indicating that you made a "minor change" you will not trigger an update to the RSS feed. \\ In the "old revisions" tab, minor modifications **will be** mentioned. | Lorsque vous corrigez une faute de frappe, changez un mot ou apportez des modifications mineures générales, cochez la case "Modifications mineure" que vous trouverez à la droite du champ "Résumé". Dokuwiki nous permet de suivre les révisions de pages via [[http://docs.slackware.com/feed.php | RSS]]. En indiquant que vous avez fait une "modification mineure" vous ne déclencherez pas une mise à jour du fil RSS. \\ Dans l'onglet "anciennes révisions", les modifications mineures **seront** mentionnées. |
| |
| ==== Add a Footer ==== | ==== Ajouter un Pied de Page ==== |
| |
| Every page may end with this wiki code, especially if you copied a text from an external source: | Chaque page peut se terminer par le code wiki ci-dessous, surtout si vous avez copié un texte à partir d'une source externe: |
| |
| <code> | <code> |
| ===== Sources ===== | ===== Sources ===== |
| |
| * principal author | * Auteur principal |
| * contributors | * Contributeurs |
| |
| {{tag>list of tags}} | {{tag>list of tags}} |
| |
| |
| ===== Note About "Notes" ===== | ===== Note à Propos des "Notes" ===== |
| |
| You can use several visual boxes, like : | Vous pouvez utiliser plusieurs boîtes visuelles telles que: |
| <note>note</note> | <note>note</note> |
| <note tip>tip</note> | <note tip>astuce</note> |
| <note important>important</note> | <note important>important</note> |
| <note warning>warning</note> | <note warning>avertisement</note> |
| |
| This is the result of : | C'est le résultat de : |
| <code> | <code> |
| <note>note</note> | <note>note</note> |
| <note tip>tip</note> | <note tip>astuce</note> |
| <note important>important</note> | <note important>important</note> |
| <note warning>warning</note> | <note warning>avertissement</note> |
| </code> | </code> |
| |
| The button bar at the top of the edit window contains buttons for easy creation of these notification boxes. | |
| |
| | La barre de boutons en haut de la fenêtre d'édition contient des boutons pour la création simple de ces boîtes de notification. |
| |
| =====A General Note on Style==== | =====A General Note on Style==== |
| * [[slackdocs:contributing|Ideas for Contributing to the SlackDocs Wiki]] | * [[slackdocs:contributing|Ideas for Contributing to the SlackDocs Wiki]] |
| * [[slackdocs:tutorial|Wiki Tutorial and Guidelines]] | * [[slackdocs:tutorial|Wiki Tutorial and Guidelines]] |
| | |
| | * Traduit de l'anglais par --- //[[wiki:user:cedric|Cedric M.]] 2015/09/09 13:03// |
| <!-- Please do not add anything below, except additional tags.--> | <!-- Please do not add anything below, except additional tags.--> |
| <!-- Do not remove this line and the text below. Thanks! slackdocs@ --> | <!-- Do not remove this line and the text below. Thanks! slackdocs@ --> |
| {{tag>slackdocs syntax style_guide editing policy}} | {{tag>slackdocs syntax style_guide editing policy translator_cedric}} |
