Author: tchemit Date: 2010-04-16 17:47:18 +0200 (Fri, 16 Apr 2010) New Revision: 1757 Log: finalize documentation english + french Modified: trunk/pom.xml trunk/src/site/fr/apt/descriptor.apt trunk/src/site/fr/apt/header.apt trunk/src/site/fr/apt/index.apt trunk/src/site/site_en.xml trunk/src/site/site_fr.xml Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2010-04-16 14:06:40 UTC (rev 1756) +++ trunk/pom.xml 2010-04-16 15:47:18 UTC (rev 1757) @@ -23,7 +23,9 @@ <http://www.gnu.org/licenses/lgpl-3.0.html>. #L% --> -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> @@ -340,7 +342,7 @@ <mdoVersion>1.0.0</mdoVersion> <!-- documentation is in english --> - <siteLocales>en</siteLocales> + <siteLocales>en,fr</siteLocales> </properties> @@ -405,29 +407,6 @@ </plugins> - <!--pluginManagement> - <plugins> - - <plugin> - <artifactId>maven-site-plugin</artifactId> - <dependencies> - <dependency> - <groupId>org.nuiton.jrst</groupId> - <artifactId>doxia-module-jrst</artifactId> - <version>${jrst.version}</version> - <exclusions> - <exclusion> - <groupId>log4j</groupId> - <artifactId>log4j</artifactId> - </exclusion> - </exclusions> - </dependency> - </dependencies> - </plugin> - - </plugins> - </pluginManagement--> - </build> <profiles> Modified: trunk/src/site/fr/apt/descriptor.apt =================================================================== --- trunk/src/site/fr/apt/descriptor.apt 2010-04-16 14:06:40 UTC (rev 1756) +++ trunk/src/site/fr/apt/descriptor.apt 2010-04-16 15:47:18 UTC (rev 1757) @@ -40,12 +40,12 @@ xsd - Ce fichier est géré par un {{{./licenseProjectDescriptor-1.0.0.xsd}fichier xsd}}_. + Ce fichier est géré par un {{{./licenseProjectDescriptor-1.0.0.xsd}fichier xsd}}. Exemple L'exemple suivant applique la license lgpl v3 à tous les fichier java présents - dans **src/main/java**. + dans <<src/main/java>>. ------------------------------------------------------------------------------- @@ -73,7 +73,7 @@ Comment créer son propre fichier project.xml - Le fichier project.xml doit être situé dans le dossier **src/license**. + Le fichier <<project.xml>> doit être situé dans le dossier <<src/license>>. Le fichier xml est inclus entre des balises project. Vous décrivez ensuite la license principale du projet en utilisant les codes du plugin (utilisez @@ -85,8 +85,8 @@ principale du projet est utilisée. Vous pouvez déclarer le répertoire de base et le pattern de sélection/inclusion de fichiers. - Nottez que vous n'êtes pas limités dans le nombre de headers. Vous pouvez + Notez que vous n'êtes pas limités dans le nombre de headers. Vous pouvez créer un header pour un fichier dans le cas de code copié depuis un autre - projet par exemple, ou vous pouvez utiliser le tag %%IgnoreLicense dans le - fichier lui-même. L'exemple précédent devrait vous permettre de créer votre + projet par exemple, ou vous pouvez utiliser le tag <<% %Ignore-License>> dans + le fichier lui-même. L'exemple précédent devrait vous permettre de créer votre propre fichier project.xml. Modified: trunk/src/site/fr/apt/header.apt =================================================================== --- trunk/src/site/fr/apt/header.apt 2010-04-16 14:06:40 UTC (rev 1756) +++ trunk/src/site/fr/apt/header.apt 2010-04-16 15:47:18 UTC (rev 1757) @@ -51,11 +51,17 @@ -------------------------------------------------------------------------------- * (1) Le tag de début de process, utilisé pour détecter le début du header (ne JAMAIS l'enlever). + * (2) Section de description du projet + * (3) Délimiteur de section + * (4) Section copyright (plus d'information ci-dessous) + * (5) Délimiteur de section + * (6) Section license + * (7) Le tag de fin de process, utilisé pour détecter la fin du header (ne JAMAIS l'enlever). * Configuration @@ -63,7 +69,9 @@ Vous pouvez configurer : * le tag de début de process + * le délimiteur de section + * le tag de fin de process * Modèle de copyright @@ -75,7 +83,7 @@ Copyright (C) firstYear[ - lastYear] holder -------------------------------------------------------------------------------- - Si *firstYear* et *lastYear* sont les même, lastYear peut être omis. + Si <<firstYear>> et <<lastYear>> sont les même, lastYear peut être omis. * Bloc commentaire @@ -134,7 +142,8 @@ Ignorer un header - Si ne voulez pas que le goal `update-file-header` traite un fichier en + Si ne voulez pas que le goal + {{{./update-file-header-mojo.html}update-file-header}} traite un fichier en particulier, vous pouvez utiliser un tag spécifique dans votre classe : -------------------------------------------------------------------------------- @@ -142,4 +151,4 @@ %%License-Ignore -------------------------------------------------------------------------------- - Vous pouvez le changer avec la propriété **ignoreTag**. + Vous pouvez le changer avec la propriété <<ignoreTag>>. Modified: trunk/src/site/fr/apt/index.apt =================================================================== --- trunk/src/site/fr/apt/index.apt 2010-04-16 14:06:40 UTC (rev 1756) +++ trunk/src/site/fr/apt/index.apt 2010-04-16 15:47:18 UTC (rev 1757) @@ -52,6 +52,7 @@ * la première partie donne des informations générales du module maven telles que nom du projet, organisation, ... + * la séconde partie résume la license elle-même. Voici un example : Modified: trunk/src/site/site_en.xml =================================================================== --- trunk/src/site/site_en.xml 2010-04-16 14:06:40 UTC (rev 1756) +++ trunk/src/site/site_en.xml 2010-04-16 15:47:18 UTC (rev 1757) @@ -48,6 +48,12 @@ <item name="${project.name}" href="index.html"/> </breadcrumbs> + <links> + <item name="Libre-Entreprise" href="http://www.libre-entreprise.org/"/> + <item name="[fr" href="./fr/index.html" /> + <item name="en]" href="index.html" /> + </links> + <menu name="User"> <item name="Introduction" href="index.html"/> <item name="File header model" href="header.html"/> Modified: trunk/src/site/site_fr.xml =================================================================== --- trunk/src/site/site_fr.xml 2010-04-16 14:06:40 UTC (rev 1756) +++ trunk/src/site/site_fr.xml 2010-04-16 15:47:18 UTC (rev 1757) @@ -48,6 +48,12 @@ <item name="${project.name}" href="index.html"/> </breadcrumbs> + <links> + <item name="Libre-Entreprise" href="http://www.libre-entreprise.org/"/> + <item name="[fr" href="index.html" /> + <item name="en]" href="../index.html" /> + </links> + <menu name="Utilisateur"> <item name="Introduction" href="index.html"/> <item name="Modèle de header de fichier" href="header.html"/>