Ce site met a disposition le build journalier de la traduction francaise du Maven: The Definitive Guide
Consultez :
  • Les documents de reference sur le projet original
  • Les sources de la traduction fr sur GitHub
  • maven


    10.5. Écrire la documentation d'un projet

    Maven utilise en moteur de traitement de documentation appelé Doxia. Doxia peut transformer différents formats de fichiers avec un même modèle de document, manipuler ces modèles et effectuer le rendu dans différents formats de sorties dont PDF ou XHTML. Pour écrire un document pour votre projet, vous devez écrire votre contenu dans un format reconnu par Doxia. À ce jour, Doxia supporte la plupart des formats "plein texte" (autrement dit "Almost Plain Text", ou APT), XDoc (format de la documentation de Maven 1.x), XHTML et FML (utilisé pour écrire des FAQ).

    Ce chapitre présente succinctement le format APT. Pour une plus de précisions sur ce format, ou pour une introduction à XDoc ou à FML, consultez les ressources suivantes :

    10.5.1. Exemple de fichier APT

    L'Exemple 10.5, « Document APT » affiche un document APT simple dont le contenu est composé d'un paragraphe d'introduction et d'une liste. Notez que la liste se termine par le pseudo élément "[]".

    Exemple 10.5. Document APT

    ---
    Introduction to Sample Project
    ---
    Brian Fox
    ---
    26-Mar-2008
    ---
     
    Welcome to Sample Project
     
      This is a sample project, welcome!   We're excited that you've decided to 
      read the index page of this Sample Project.  We hope you enjoy the simple 
      sample project we've assembled for you.
     
      Here are some useful links to get you started:
     
       * {{{news.html}News}}
     
       * {{{features.html}Features}}
     
       * {{{faq.html}FAQ}}
     
       []
    

    Si le document APT de l'Exemple 10.5, « Document APT » est placé dans src/site/apt/index.apt, le plugin Maven Site en analysera le contenu APT avec Doxia et produira un fichier index.html contenant le XHTML généré.