Introduction au Projet de Documentation de FreeBSD pour les nouveaux participants
Précédent | Chapitre 7. * Le Manuel de Référence | Suivant

# 7.3. Guide de style

Respectez s'il vous plaît les conventions de style ci-dessous pour garder aux sources du Manuel une consistance malgré les nombreuses personnes qui interviennent dessus.

## 7.3.1. Majuscules et minuscules

Les marques doivent être en minuscules `<para>` et non `<PARA>`.

Le texte dans les contextes SGML est normalement en majuscules, `<!ENTITY...>` ou `<!DOCTYPE...>` et non `<!entity...>` ou `<!doctype...>`.

## 7.3.2. Indentation

Chaque fichier est indenté à partir de la colonne 0, quel que soit le niveau d'indentation dans le fichier où il est inclus.

Chaque marque de début augmente l'indentation de 2 blancs et chaque marque de fin la décrémente d'autant. Le contenu des éléments doit être indenté de 2 blancs s'il court sur plusieurs lignes.

A titre d'exemple, voici à quoi ressemble le source de cette section :

    +--- C'est la colonne 0

    <chapter>
      <title>...</title>

      <sect1>
        <title>...</title>

        <sect2>
          <title>Indentation</title>

          <para>Chaque fichier est indent&eacute; &agrave; partir de la colonne 0,
    	<emphasis>quel que soit</emphasis> le niveau d'indentation dans le
            fichier o&ugrave; il est inclus.</para>

          <para>Chaque marque de d&eacute;but augmente l'indentation de 2 blancs et
            chaque marque de fin la d&eacute;cr&eacute;mente d'autant. Le contenu des &eacute;l&eacute;ments
            doit &ecirc;tre indent&eacute; de 2 blancs s'il court sur plusieurs lignes.</para>

          ...
        </sect2>
      </sect1>
    </chapter>

Si vous vous servez d'Emacs ou Xemacs pour éditer les fichiers, le `sgml-mode` doit être chargé automatiquement, et les variables Emacs locales en fin de chaque fichier doivent mettre ces indentations en pratique.

## 7.3.3. Modifications de présentation des sources

Quand vous intégrez des modifications, ne faites pas en même temps de modification de contenu et de présentation des sources.

Cela pour que les équipes de traductions du Manuel puissent rapidement voir les modifications de contenu que vous avez intégrées, sans avoir à se demander si une ligne a changé de contenu ou simplement de présentation.

Si vous avez par exemple ajouté deux phrases à un paragraphe, de sorte que les lignes du paragraphe débordent maintenant des 80 colonnes, intégrez d'abord la modification avec les lignes trop longues. Puis corrigez ensuite ce problème, en précisant qu'il ne s'agit que d'une modification de présentation, dont les équipes de traduction n'ont pas à se soucier.

Précédent | Sommaire | Suivant
Organisation physique | Niveau supérieur | * Conversion du Manuel dans d'autres formats

Ce document, ainsi que d'autres peut être téléchargé sur ftp.FreeBSD.org/pub/FreeBSD/doc/.

Pour toutes questions à propos de FreeBSD, lisez la documentation avant de contacter <questions@FreeBSD.org>.
Pour les questions sur cette documentation, contactez <doc@FreeBSD.org>.