28-mar-2016: Welcome to our new server! Faster and less prone to crashing.

Welcome to the Slackware Documentation Project

Guide de Style pour les Articles Publiés sur SlackDocs

Quelques règles de base devraient être gardés à l'esprit lors de l'édition des pages de ce wiki.

Politique d'Édition

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.


Règles de Fonctionnement

Une Modification Majeure 1) ne devrait pas être effectuée sur l'article d'un contributeur à son insu et sans discussion éditoriale préalable.

Un enregistrement du discours entre l'éditeur et le contributeur doit être présent sur la page de discussion.

Exceptions à cette Règle

  1. Les documents de base dans ces espaces de noms nécessitent une vérification éditoriale plus exigeante: slackware, slackdocs or slackbook.
  2. Une autorisation explicite est accordée via la page de discussion par l'auteur d'origine pour permettre les éditions/améliortions.
  3. L'auteur est inconnu ou n'est plus un participant actif ici.
  4. L'édition ou reversion est nécessaire pour corriger le vandalisme.
  5. 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.
  6. L'édition est nécessaire pour corriger des informations erronées.

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).


Commentaire

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é .

Nous vous remercions de votre compréhension et de votre coopération à ce sujet.

Page Editing Etiquette

Désactiver le Verrouillage

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.

Modifier un Article, Pas Toute une Page

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.

Ajouter un Résumé

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 changements récents.

Modifications Mineures

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

Ajouter un Pied de Page

Chaque page peut se terminer par le code wiki ci-dessous, surtout si vous avez copié un texte à partir d'une source externe:

===== Sources =====

  * Auteur principal
  * Contributeurs

{{tag>list of tags}}

Note à Propos des "Notes"

Vous pouvez utiliser plusieurs boîtes visuelles telles que:

note

astuce

important

avertisement

C'est le résultat de :

<note>note</note>
<note tip>astuce</note>
<note important>important</note>
<note warning>avertissement</note>

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

This is a wiki so a certain degree of informality is acceptable. This includes, for example, conversational contractions such as “you've”. Readers should feel that they are talking to a knowledgeable friend rather than reading a manual. However, any appearance of sloppiness must be avoided.

  • Do not use slang or “textspeak”.
  • Write complete sentences and try to avoid grammatical errors. If English is not your native language, you can always get help from an English editor.
  • Follow proper capitalization rules for words in titles and headings.
  • Long passages of plain text are hard to read; always consider if something can be better expressed using a list format. Use numbered lists only for sequential operations, bulleted lists for options or examples (as shown here). Sometimes a table or a flowchart can be useful.
  • If quoting computer output, reproduce it exactly, including spelling (which is usually American). Use <code></code> tags to enclose the output for better legibility.
  • If your text has examples of key presses, use the <key></key> markup to make a visual impact. Alt+F2 looks better than “Alt-F2”.
  • Avoid the passive voice. Use it only when alternatives would be clumsy.
  • Try to avoid long-windedness. “To do x, use the -y option” or “To do x, type foo -y” reads better than “If you want foo to do x for you, you need to type foo -y”.

Translating a Page

The multi-language capability of this Wiki requires that you stick to a few rules. Please read them in the specific Translation Guidelines.

Pages That Require Attention from an Admin

If you think that a Wiki page (written by somebody else or by yourself) is in need of attention from the admin team, you can add a tag “needs_attention” to that page. This will cause the affected page to show up on the “pages that need attention” page. The admin team will check that page regularly for new entries.

When should you use this? For instance, you find an incomplete or badly written text or even an empty page (this can happen if someone writes a non-English text but does not take action to get a proper English translation arranged). Or perhaps you find spam, or offensive language.
Your observations will help us keep the Wiki clean and high-quality.

See Also

1) est considéré comme modification majeure toute édition qui modifie substantiellement le contenu, flux, ou la mise en page de l'article.

Autres langues
Traductions de cette page?:
QR Code
QR Code fr:slackdocs:styleguide (generated for current page)