ConseilRedaction

De Magazine fedora-fr
Révision de 4 février 2008 à 09:14 par ThomasCanniot (discussion | contributions) (Conventions de style propres au magazine Fedora)

Aller à : navigation, rechercher
Article en cours de rédaction !
InProgress tip.png
Le présent article est actuellement en cours de rédaction.
Adressez-vous à la personne en charge pour toute proposition ou modification.
Auteur / Éditeur : MatthieuGautier

Création d'une nouvelle page

  • créez un lien sur une page existante : entourez le lien de crochets doubles [[LienPage]]. Il est également possible d'utiliser un nom différent de celui de la page à créer : [[LienPage | nom de la page]];
  • entrez directement l'URL de la nouvelle page : l'URL de cette page, par exemple est http://doc.fedora-fr.org/wiki/Contribuer. Remplacez simplement « Contribuer » par le nom de page que vous voulez créer.
  • Un article doit commencer par une section introduction afin de présenter l'objet et le but du tutoriel. Cette section doit utiliser le modèle == Introduction ==.
  • Les références seront ajouter à la fin de l'article sous forme d'une liste avec un intitulé == Références ==.
  • Ne dépassez pas 4 niveaux de sectionnement, si c'est le cas, l'architecture de l'article est probablement à revoir.
  • Évitez le style parlé, SMS et/ou familier comme : « bon ben maintenant on va faire un truc cool » ou encore « c moi ki é ecri l'article » !
  • Si vous hésitez sur vos conjugaisons, vous pouvez jeter un oeil au site http://www.leconjugueur.com, ou sous Fedora installer le logiciel verbiste ;
  • N'hésiter pas à utiliser le correcteur grammatical sur le site http://www.bonpatron.com ;
  • N'utilisez pas de titres de 1er niveau (= titre =) dans les articles (sauf cas particuliers), commencez avec des titres de second niveau (== titre ==) ;
  • Prenez le temps de vous relire (et de vous faire relire si possible), il est préférable de proposer une documentation de qualité que tous pourront aborder sans problèmes de compréhension ;

Recommandations typographique

  • Utilisez un maximum de mots français, comme paquetage ou paquet au lieu de l'anglais package ;
  • Respectez les conventions d'écriture française. Par exemple, la ponctuation simple (le point, la virgule) est toujours suivie d'un espace. La ponctuation double (les deux points, le point d'exclamation, le point d'interrogation, le point virgule) est toujours précédée et suivie d'un espace. N'oubliez pas que les guillemets françaises sont « et » et non " et ", qui sont des guillemets anglaises ;
  • N'ajoutez pas de numérotation aux titres, le sommaire s'en charge ;
  • Restez dans la simplicité, ne pas détourner l'utilisation des balises (par exemple * '''Titre''', une liste n'est pas faite pour un titre de section) ;
  • Un saut de ligne équivaut à un changement de paragraphe. Ne sautez pas de ligne si vous ne voulez pas changer de paragraphe. Ne pas sauter de ligne, les espaces inter-paragraphe sont ajoutés automatiquement par Scribus.
  • Utilisez le ; à la fin d'un élément d'une liste sauf le dernier ;
  • Évitez l'utilisation des balises de mise en forme tel que le gras et l'italique, cela interfère avec la mise en forme du nom des applications, commandes et autres mots clés.
  • Ne pas utilisez -- pour indiquer un tiret demi-quadratin, utilisez le caractère correspondant : – ou –. De même pour le tiret quadratin : — ou — ;
  • Utilisez au maximum les balises sus-indiqués, cela simplifie la mise en page dans Scribus;
  • Ne pas insérer de balises dans les titres de sectionnement. Par exemple, ceci n'est pas bon : == Mon ''titre'' <app>test</app> == ;
  • Un titre, par définition, introduit un contenu. Les : (deux points) ou . (point) sont à proscrire puisque les deux point introduisent un contenu, ce qui est redondant avec la nature du titre et que le point termine une phrase, ce qui va à l'encontre de la nature du titre ;
  • Ne pas écrire les titres en majuscule, ou avec une majuscule à chaque mot (convention anglaise).
  • Le caractère d'introduction d'un commentaire dans un extrait de code ou une commande est le dièse (#). Dans un soucis d'harmonisation, merci d'éviter les <--- et autres éléments du même genre ;
  • Commencez les commande par $ ou #.

Recommandations sur le style de rédaction

  • Considérez que les articles doivent pouvoir être lus autant par des personnes débutantes sous Fedora que par des personnes y étant habituées. C'est un exercice de style difficile qui ne peut pas s'appliquer sur tous les articles, mais garder cette idée en tête lorsque vous rédigez vos articles. Voici quelques conseils pour vous aider :
    • N'utilisez jamais d'acronyme ou de termes compliqués sans les avoir expliqué auparavant ;
    • Vous avez la possibilité d'utiliser des encadrés. Faites le, soit pour ajouter des informations complémentaire pour les connaisseurs, soit pour expliquer des concepts aux néophytes . N'en abusez pas pour autant, avoir trop d'encadrés casse le rythme de lecture ;
    • Si vous avez d'autres conseils, ils sont les bienvenus .
  • Il y a des "visuels" et des "textuels". Faites des articles pour les deux types de personne. Utilisez des schémas, diagrammes et autres graphiques. De même, mettez toujours une légende à vos graphiques.

Conventions de style propres au magazine Fedora

La mise en page finale est assurée par le rédacteur en chef du magazine grâce au logiciel Scribus. Ainsi, la plupart des balises de mise en forme sont destinées au rédacteur en chef plutôt qu'au wiki.

Il existe deux types de balise :

  • Des balises qui s'appliquent à une partie seulement de texte à l'intérieur d'un paragraphe. Ces balises sont "interprétées" par le rédacteur en chef. pour que ce dernier puisse facilement les repérer, ces balises sont de la forme [**** NomDeLaBalise]text[**** /NomDeLaBalise]
  • Des balises qui s'appliquent à tout un paragraphe. Ces balises sont directement interprétées par Scribus et sont seulement "ouvrantes". Ces balises sont généralement de la forme [** NomDeLaBalise]Paragraphe

Voici une liste des balises que vous pouvez utiliser.

Termes Marques
Noms des applications [**** App]nom de l'appication[**** /App]
[**** Application]nom de l'appication[**** /Application]
Fichiers, répertoires [**** Chemin]/chemin/vers[**** /Chemin]
[**** Path]/chemin/vers[**** /Path]
Paquetages [**** Paquet]nom_du_paquet[**** /Paquet]
Menus graphiques et objets.
Utilisez le caractère "&gt" comme séparateur, précédé et suivi d'un espace
[**** menu]Fichier > Enregistrer[**** /menu]
[** menu]Fichier > Enregistrer
Autres GUI ou Éléments Web d'interface utilisateur [**** menu]Soumettre[**** /menu]
Insertion d'une commande [**** cmd]commande[**** cmd]
[** cmd]commande
Tous paragraphes qui commencent par les caractères # ou $ sont interprétés comme des commandes
Insertion de code [**** code]code à insérer[**** /code]
[** code]code...
Touches [**** touche]Touche[**** /touche]
Encadrés [** Encadre Titre de l'encadré]Texte de l'encadré
Images [** Image]Chemin/vers/l'image Légende
Titres == Titre 1 ==
===Titre 2===
====Titre 3====
=====Titre 4=====

Vous pouvez laissez des commentaires destinés au rédacteur en chef au sujet de la mise en page dans votre article. Pour cela utilisez la balise : [**** Votre commentaire ici]

Utilisez les tableaux pour des données tabulaires et non pour une mise en forme quelconque.

Raccourcis clavier

Certains caractères ne sont pas forcément évidents à trouver sur un clavier.
Cette section vous aidera à en localiser certains...

  • « (guillemet ouvrant)
    • <touche>ALT-GR</touche>+<touche>z</touche> en clavier Latin 1 ;
    • <touche>ALT-GR</touche>+<touche>z</touche> en clavier Latin 9.
  •  » (guillemet fermant)
    • <touche>ALT-GR</touche>+<touche>w</touche> en clavier Latin 1 ;
    • <touche>ALT-GR</touche>+<touche>x</touche> en clavier Latin 9.