Author: echatellier Date: 2013-03-15 16:23:12 +0100 (Fri, 15 Mar 2013) New Revision: 47 Url: http://nuiton.org/projects/nuiton-js/repository/revisions/47 Log: Fix site Modified: trunk/src/site/fr/rst/index.rst trunk/src/site/rst/index.rst trunk/src/site/site_en.xml trunk/src/site/site_fr.xml Modified: trunk/src/site/fr/rst/index.rst =================================================================== --- trunk/src/site/fr/rst/index.rst 2013-03-15 14:34:23 UTC (rev 46) +++ trunk/src/site/fr/rst/index.rst 2013-03-15 15:23:12 UTC (rev 47) @@ -57,7 +57,7 @@ ----------------------------------------------------- Il faut ensuite ajouter en dépendance Maven les librairies JS et CSS que vous -souhaiter utiliser. Ne vous préocupé par des dépendances Nuiton-js est la pour +souhaiter utiliser. Ne vous préoccupez par des dépendances Nuiton-js est la pour ça. Par exemple si vous avez besoin de jquery et jquery-ui:: @@ -74,7 +74,7 @@ <version>${versionJQueryUI}</version> </dependency> -Dans vos pages JSP vous pouvez alors récupérer les resources via par exemple l'url:: +Dans vos pages JSP vous pouvez alors récupérer les ressources via par exemple l'url:: /nuiton-js/jquery.js @@ -158,9 +158,9 @@ Utilisation du plugin Maven pour générer les ressources ======================================================= -Voici un exemple d'utilisation. La différence avec la configuraiton standard +Voici un exemple d'utilisation. La différence avec la configuration standard est la déclaration de **org.nuiton.js.wro.NuitonJsMavenWroManagerFactory** comme -wroManagerFactory et la déclation des dépendances vers les ressources js et css:: +wroManagerFactory et la déclaration des dépendances vers les ressources js et css:: <build> <plugins> Modified: trunk/src/site/rst/index.rst =================================================================== --- trunk/src/site/rst/index.rst 2013-03-15 14:34:23 UTC (rev 46) +++ trunk/src/site/rst/index.rst 2013-03-15 15:23:12 UTC (rev 47) @@ -163,16 +163,17 @@ Using maven plugin to generate static resources =============================================== -Voici un exemple d'utilisation. La différence avec la configuraiton standard -est la déclaration de **org.nuiton.js.wro.NuitonJsMavenWroManagerFactory** comme -wroManagerFactory et la déclation des dépendances vers les ressources js et css:: +Here is an example of using ``wro4j-maven-plugin`` to generate static resources. +The main difference with standard configuration is the use of +**org.nuiton.js.wro.NuitonJsMavenWroManagerFactory** configuration for +``wroManagerFactory`` and plugin dependencies:: <build> <plugins> <plugin> <groupId>ro.isdc.wro4j</groupId> <artifactId>wro4j-maven-plugin</artifactId> - <version>1.6.2</version> + <version>1.6.3</version> <dependencies> <dependency> @@ -209,34 +210,32 @@ </plugin> </build> -Vous pouvez alors dans vos pages utiliser:: +Then you could use statics js and css files in your application:: <link href="<c:url value='/wro/MonApp.css'/>" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="<c:url value='/wro/MonApp.js'/>"></script> +Creating a new module +===================== -Création d'un nouveau module -============================ +To add a new module for a new javascript or css library, you need to respect +a few rules: -Pour créer un nouveau module il faut respecter quelques règles: +- setup module version using the same packaged resource's version with an additional + packaging number. For example, to package jquery 1.9.1, module version have to be + ``1.9.1-1`` for the first packaging release +- put resources in directory ``src/main/resources/nuiton-js-<resource name>`` +- add resource configuration file ``src/main/resources/META-INF/nuiton-js/wro-<resource name>.xml`` +- define a group name according to resource name in wro configuration file -- mettre en numéro de version du module maven le numero de version de la ressource à packager - avec en plus un numero de packaging. Par exemple pour jquery 1.8.3 la version - du module maven doit être 1.8.3-1 pour la première version de packaging -- mettre les ressources dans le répertoire: src/main/resources/nuiton-js-<nom de la ressource> -- créer le fichier de déclaration: src/main/resources/META-INF/nuiton-js/wro-<nom de la ressource>.xml -- il doit y avoir dans ce fichier de déclaration un groupe partant le nom de la ressource. +Resource have to be committed unminimized. Nuiton-js will minimize then at runtime. -Il ne faut mettre que la version normale des fichiers (pas minimisé) car la -librairie s'occupe elle même de minimiser les fichiers. +It's a good practice to prefix directory name with 'nuiton-js' and resource name. +This will avoid any future problem if use define his own directory with resource +name in the classpath. -le nom du répertoire pourrait être autre chose, mais en le préfixant par -nuiton-js et avec le nom de la ressource, on évite que l'utilisateur ait le même -répertoire dans son classpath ce qui ferait que ces ressources seraient elles aussi -prises en charge sans qu'il le souhaite. +wro.xml file example:: -la déclaration peut ressembler à:: - <groups xmlns="http://www.isdc.ro/wro"> <import>classpath:META-INF/nuiton-js/wro-jquery.xml</import> <group name='jquery-ui'> @@ -246,23 +245,20 @@ </group> </groups> -Pour plus d'explication sur le format de ce fichier reportez-vous à la documentation -de wro https://code.google.com/p/wro4j/wiki/WroFileFormat +For more information about this file format, please refer to wro documentation: +https://code.google.com/p/wro4j/wiki/WroFileFormat -Si la librairie a une dépendance sur une autre, il faut le faire ressortir dans -le pom.xml et aussi dans la déclaration en faisant référence au groupe dont il -dépend (comme dans l'exemple ci-dessus). +If a library depends on another one, it must be present in pom.xml file too +as maven dependencies. -Dans le fichier pom.xml, il ne faut pas mettre la version du dernier package mais -la version annoncé comme minimal par la librairie dont elle dépand. Par exemple -jquery-ui 1.9.2 dépend de jquery 1.6.x il faut donc mettre dans le pom.xml -de nuiton-js-jquery-ui la dépendance:: +In ``pom.xml`` file, you may use a minimum version instead of a hardcoded one. +User will be warned if he use a smaller version of dependencies library. +For example, jquery-ui-1.10.1 depends on jquery at least in version 1.6, +``pom.xml`` file must define following dependency:: <dependency> <groupId>org.nuiton.js</groupId> <artifactId>nuiton-js-jquery</artifactId> - <version>[1.6,)</version> <!-- jquery ui compatible avec jquery >= 1.6 --> + <version>[1.6,)</version> <!-- jquery ui is compatible with jquery >= 1.6 --> <scope>runtime</scope> </dependency> - - Modified: trunk/src/site/site_en.xml =================================================================== --- trunk/src/site/site_en.xml 2013-03-15 14:34:23 UTC (rev 46) +++ trunk/src/site/site_en.xml 2013-03-15 15:23:12 UTC (rev 47) @@ -54,13 +54,6 @@ <poweredBy> <logo href="http://maven.apache.org" name="Maven" img="images/logos/maven-feather.png"/> - - <logo href="http://docutils.sourceforge.net/rst.html" - name="ReStructuredText" - img="images/logos/restructuredtext-logo.png"/> - - <logo href="http://maven-site.nuiton.org/jrst" name="JRst" - img="images/logos/jrst-logo.png"/> </poweredBy> <body> @@ -89,8 +82,6 @@ <item name="Accueil" href="index.html"/> </menu> - <menu ref="modules"/> - <footer> <div id='projectMetas' Modified: trunk/src/site/site_fr.xml =================================================================== --- trunk/src/site/site_fr.xml 2013-03-15 14:34:23 UTC (rev 46) +++ trunk/src/site/site_fr.xml 2013-03-15 15:23:12 UTC (rev 47) @@ -54,13 +54,6 @@ <poweredBy> <logo href="http://maven.apache.org" name="Maven" img="images/logos/maven-feather.png"/> - - <logo href="http://docutils.sourceforge.net/rst.html" - name="ReStructuredText" - img="images/logos/restructuredtext-logo.png"/> - - <logo href="http://maven-site.nuiton.org/jrst" name="JRst" - img="images/logos/jrst-logo.png"/> </poweredBy> <body> @@ -89,8 +82,6 @@ <item name="Accueil" href="index.html"/> </menu> - <menu ref="modules"/> - <footer> <div id='projectMetas'