Format des fichiers de documentation

Balises XML

Chaque fichier du manuel doit inclure la déclaration XML suivante à la première ligne du fichier :

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- Reviewed: no -->

Les fichiers XML provenant des traductions doivent également inclure le tag de révision correspondant au fichier original en anglais duquel la traduction est tirée.

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 14978 -->
  3. <!-- Reviewed: no -->

Longueur maximum d'une ligne

La longueur maximum d'une ligne, incluant les balises, les attributs, l'indentation ne doit pas excéder 100 caractères. Il existe une seule exception à cette règle, un couple attribut / valeur peut excéder 100 caractères puisqu'il n'est pas autorisé de les séparer.

Indentation

L'indentation est faite de 4 espaces. Les tabulations ne sont pas autorisées.

Les éléments qui sont aux même niveaux doivent avoir la même indentation.

  1. <sect1>
  2. </sect1>
  3. <sect1>
  4. </sect1>

Les éléments qui sont un niveau en-dessous de l'élément précédent doivent être indentés de 4 espaces supplémentaires.

  1. <sect1>
  2.     <sect2>
  3.     </sect2>
  4. </sect1>

Plusieurs éléments bloc sur une même ligne ne sont pas autorisés ; plusieurs éléments en-ligne le sont en revanche.

  1. <!-- NON AUTORISÉ : -->
  2. <sect1><sect2>
  3. </sect2></sect1>
  4. <!-- AUTORISÉ -->
  5. <para>
  6.     <classname>Zend_Magic</classname> n'existe pas. <classname>Zend_Acl</classname> existe.
  7. </para>

Fin de ligne

Les fins de ligne suivent les conventions de fichier Unix. Les lignes doivent être terminées par un seul saut de ligne (LF), le caractère de saut de ligne s'écrit 10 en notation ordinal 10, et 0x0A en hexadécimal.

Note : N'utilisez pas les retours chariot (CR) comme c'est le cas sur les systèmes Apple, ni l'association d'un retour chariot avec un saut de ligne (CRLF) qui est le standard sur les systèmes Windows (0X0D, 0x0A).

Éléments vides

Les éléments vides ne sont pas autorisés, tous les éléments doivent contenir du texte ou des éléments enfants.

  1. <!-- NON AUTORISÉ : -->
  2. <para>
  3.     Lorem ipsum. <link></link>
  4. </para>
  5. <para>
  6. </para>

Utilisation des espaces dans les documents

Espace entre les balises

Les balises ouvrantes des éléments bloc ne devrait pas être suivi par autre chose qu'un saut de ligne (et l'indentation de la ligne suivante).

  1. <!-- NON AUTORISÉ : -->
  2. <sect1>ESPACE
  3. </sect1>

Les balises ouvrantes des éléments en-ligne ne devrait pas être suivi d'espace.

  1. <!-- NON AUTORISÉ : -->
  2. C'est la classe <classname> Zend_Class</classname>.
  3. <!-- AUTORISÉ : -->
  4. C'est la classe <classname>Zend_Class</classname>.

Les balises des éléments bloc peuvent être précédés par des espaces, si ceux-ci sont équivalents aux nombres d'espaces nécessaires pour l'indentation, mais pas plus.

  1. <!-- NON AUTORISÉ : -->
  2.     <sect1>
  3.      </sect1>
  4. <!-- AUTORISÉ : -->
  5.     <sect1>
  6.     </sect1>

Les balises des éléments en-ligne ne doivent pas être précédés d'espaces.

  1. <!-- NON AUTORISÉ -->
  2. C'est la classe <classname>Zend_Class </classname>
  3. <!-- AUTORISÉ -->
  4. C'est la classe  <classname>Zend_Class</classname>

Sauts de ligne multiples

Les sauts de ligne multiples ne sont pas autorisés ni dans les balises, ni entre elles.

  1. <!-- NON AUTORISÉ -->
  2. <para>
  3.     Lorem ipsum...
  4.     ... dolor sid amet
  5. </para>
  6.  
  7.  
  8. <para>
  9.     Un autre paragraphe.
  10. </para>
  11. <!-- AUTORISÉ -->
  12. <para>
  13.     Lorem ipsum...
  14.     ... dolor sid amet
  15. </para>
  16.  
  17. <para>
  18.     Un autre paragraphe.
  19. </para>

Séparation entre les balises

Les éléments qui sont au même niveau doivent être séparés par une ligne vide pour améliorer la lisibilité.

  1. <!-- NON AUTORISÉ -->
  2. <para>
  3.     Lorem ipsum...
  4. </para>
  5. <para>
  6.     Dolor sid amet...
  7. </para>
  8. <!-- AUTORISÉ -->
  9. <para>
  10.     Lorem ipsum...
  11. </para>
  12.  
  13. <para>
  14.     Dolor sid amet...
  15. </para>

Le premier élément enfant devrait être ouvert directement après son parent, sans ligne vide entre eux ; le dernier élément enfant quant à lui, devrait être fermé juste avant la balise fermante de son parent.

  1. <!-- NON AUTORISÉ -->
  2. <sect1>
  3.  
  4.     <sect2>
  5.     </sect2>
  6.  
  7.     <sect2>
  8.     </sect2>
  9.  
  10.     <sect2>
  11.     </sect2>
  12.  
  13. </sect1>
  14. <!-- AUTORISÉ -->
  15. <sect1>
  16.     <sect2>
  17.     </sect2>
  18.  
  19.     <sect2>
  20.     </sect2>
  21.  
  22.     <sect2>
  23.     </sect2>
  24. </sect1>

Exemple de code

La balise ouvrante de l'élement <programlisting> doit indiquer l'attribut de langage (language) approprié et doit être indenté au même niveau que ces blocs frères.

  1. <para>Paragraphe frère.</para>
  2. <programlisting language="php"><![CDATA[

CDATA devrait être utilisé autour de tous les exemples de code.

Les sections <programlisting> ne doivent pas contenir de saut de ligne ou d'espace ni au début ni à la fin, étant donné qu'ils sont représentés tels quels.

  1. <!-- NON AUTORISÉ -->
  2. <programlisting language="php"><![CDATA[
  3. $render = "xxx";
  4. ]]></programlisting>
  5. <!-- AUTORISÉ -->
  6. <programlisting language="php"><![CDATA[
  7. $render = "xxx";
  8. ]]></programlisting>

La fermeture des éléments CDATA et <programlisting> devrait être sur la même ligne, sans aucune indentation.

  1. <!-- NON AUTORISÉ -->
  2.     <programlisting language="php"><![CDATA[
  3. $render = "xxx";
  4. ]]>
  5.     </programlisting>
  6. <!-- NON AUTORISÉ -->
  7.     <programlisting language="php"><![CDATA[
  8. $render = "xxx";
  9.     ]]></programlisting>
  10. <!-- AUTORISÉ -->
  11.     <programlisting language="php"><![CDATA[
  12. $render = "xxx";
  13. ]]></programlisting>

L'élément <programlisting> devrait contenir l'attribut de langage avec la valeur appropriée au contenu. Les valeurs les plus courantes sont "css", "html", "ini", "javascript", "text", et "xml".

  1. <!-- PHP -->
  2. <programlisting language="php"><![CDATA[
  3. <!-- Javascript -->
  4. <programlisting language="javascript"><![CDATA[
  5. <!-- XML -->
  6. <programlisting language="xml"><![CDATA[

Pour les exemples contenant uniquement du code PHP, Les balises PHP ("<?php" et "?>") ne sont pas requises, et ne devrait pas être utilisées. Elles compliquent la lisibilité du code, et sont implicites lors de l'utilisation de l'élément <programlisting>.

  1. <!-- NON AUTORISÉ -->
  2. <programlisting language="php"<![CDATA[<?php
  3.     // ...
  4. ?>]]></programlisting>
  5. <programlisting language="php"<![CDATA[
  6. <?php
  7.     // ...
  8. ?>
  9. ]]></programlisting>

La longueur maximum des lignes pour les exemples de code devrait suivre les recommandations de la convention de codage.

Évitez d'utiliser require_once(), require(), include_once(), et include() dans les exemples PHP. Ils emcombrent la documentation, et sont la plupart du temps inutile si vous utilisez un autoloader. Utilisez-les uniquement lorsqu'ils sont essentiels à la compréhension d'un exemple.

Note: N'utilisez jamais les short tags
Les short tags (e.g., "<?", "<?=") ne devrait jamais être utilisés dans l'élément programlisting ni dans le reste de la documentation.

Notes spécifiques sur les éléments en-ligne

classname

L'élément <classname> doit être utilisé chaque fois que le nom d'une classe est mentionné ; il ne doivent cependant pas être utilisé lorsque celle-ci est associé au nom d'une méthode, d'un membre, ou d'une constante, rien d'autre n'est autorisé dans cet élément.

  1. <para>
  2.     La classe <classname>Zend_Class</classname>.
  3. </para>

varname

Les variables doivent être entourées par les balises <varname> . Les variables doivent être écrites en utilisant le symbole "$". Rien d'autre n'est autorisé dans cet élément, excepté le nom d'une classe, s'il s'agit d'un membre de celle-ci.

  1. <para>
  2.     La variable <varname>$var</varname> et le membre de classe
  3.     <varname>Zend_Class::$var</varname>.
  4. </para>

methodname

Les méthodes doivent être entourées par les balises <methodname>. Les méthodes doivent soit contenir la signature complète, soit au moins une paire de parenthèses (ex : "()"). Aucun autre contenu n'est autorisé dans cet élément, excepté le nom d'une classe, pour indiquer qu'il s'agit d'une méthode de celle-ci.

  1. <para>
  2.     La fonction <methodname>foo()</methodname> et la méthode
  3.     <methodname>Zend_Class::foo()</methodname>. Une fonction avec une signature :
  4.     <methodname>foo($bar, $baz)</methodname>
  5. </para>

constant

Utilisez l'élément <constant> pour indiquer qu'il s'agit d'une constante. Les constantes doivent être écrites en majuscules. Aucun autre contenu n'est autorisé, excepté le nom d'une classe, pour indiquer qu'il s'agit d'une constante de classe.

  1. <para>
  2.     La constante <constant>FOO</constant> et la constante de classe
  3.     <constant>Zend_Class::FOO</constant>.
  4. </para>

filename

Les noms de fichier et chemins doivent être entourés par les balises <filename>. Aucun autre contenu n'est autorisé dans cet élément.

  1. <para>
  2.     Le nom de fichier <filename>application/Bootstrap.php</filename>.
  3. </para>

command

Les commandes, les scripts shell, ainsi que l'appel de programme doivent être entourés par les balises <command>. Si la commande nécessite des arguments, ceux-ci doivent également être présent.

  1. <para>
  2.     Executez <command>zf.sh create project</command> pour créer un projet.
  3. </para>

code

L'utilisation de l'élément <code> est déconseillée, en faveur des autres éléments discutés précédement.

Notes spécifiques sur les éléments bloc

title

L'élément <title> ne peut pas contenir d'éléments enfants.

  1. <!-- NON AUTORISÉ -->
  2. <title>Utilisation de <classname>Zend_Class</classname></title>
  3. <!-- AUTORISÉ -->
  4. <title>Utilisation de Zend_Class</title>
blog comments powered by Disqus