r1047 - in trunk/src/site: . en/rst/devel rst/devel - Coser-commits

14 Aug 2012

Author: echatellier
Date: 2012-08-14 16:16:17 +0200 (Tue, 14 Aug 2012)
New Revision: 1047

Url: http://forge.codelutin.com/repositories/revision/coser/1047

Log:
fixes #1334: Am?\195?\169liorer la documentation (mise ?\195?\160 jour des textes du site) 

Modified:
   trunk/src/site/en/rst/devel/textupdate.rst
   trunk/src/site/rst/devel/textupdate.rst
   trunk/src/site/site_en.xml
   trunk/src/site/site_fr.xml

Modified: trunk/src/site/en/rst/devel/textupdate.rst
===================================================================

--- trunk/src/site/en/rst/devel/textupdate.rst	2012-08-14 13:45:56 UTC (rev 1046)
+++ trunk/src/site/en/rst/devel/textupdate.rst	2012-08-14 14:16:17 UTC (rev 1047)
@@ -23,3 +23,77 @@
 .. * #L%
 .. -
 
+
+Website text update
+===================
+
+This documentation shows hom to update text content of website available at:
+http://www.ifremer.fr/SIH-indices-campagnes/.
+
+Source
+------
+In order to modify source content, you have to be part of coser project developper
+to be allowed to commit on repository.
+
+After this autorisation, sources can be retreived with a subversion client:
+
+  * Windows : http://tortoisesvn.net/
+  * Linux : command line ``svn``
+
+Repository address is : http://svn.forge.codelutin.com/svn/coser/trunk
+
+Directory layout
+----------------
+Root directory contains 3 maven modules:
+
+  * *coser-business* : contains all business code (used by both other modules)
+  * *coser-ui* : swing client
+  * *coser-web* : website
+
+In order to modify website content *coser-web* module will be used.
+
+
+coser-web module source
+-----------------------
+In coser-web module, two groups of files concern the modification of text content:
+
+  * ``src/main/webapp/WEB-INF/content`` : html pages
+  * ``src/main/resources/fr/ifremer/coser/web`` : text translation to include in html pages
+
+
+Indeed, in the html pages, we find this kind of code ::
+
+  <head>
+    <title><s:text name="message.index.title" /></title>
+  </head>
+
+This code define a html page title, with the translation key `message.layout.title`.
+
+And in files ``package_en.properties`` and ``package_fr.properties`` we find
+respectively::
+
+  message.index.title=Home
+
+et::
+
+  message.index.title=Accueil
+
+
+Change and commit to the server
+-------------------------------
+You can change the formatting and content of HTML pages.
+However, it is important to ensure that the contents of translation files
+are in adequacy with the html.
+
+After making changes, you can commiting these changes
+on the server with your svn client.
+
+
+Production
+----------
+The act of commiting does not mean that the production site will be updated.
+Indeed, a new stable release must be prepared and installed in production.
+The changes you make will only be integrated in the next production.
+
+However, it is possible to ask the development team to prepare
+a new version if your changes were urgent.

Modified: trunk/src/site/rst/devel/textupdate.rst
===================================================================
--- trunk/src/site/rst/devel/textupdate.rst	2012-08-14 13:45:56 UTC (rev 1046)
+++ trunk/src/site/rst/devel/textupdate.rst	2012-08-14 14:16:17 UTC (rev 1047)
@@ -46,7 +46,7 @@
 Le répertoire racine est constitué de 3 modules maven:
 
   * *coser-business* : contenant le code métier (tout le code utilisé par les deux
-    autre modules)
+    autres modules)
   * *coser-ui* : client swing
   * *coser-web* : site internet
 
@@ -56,7 +56,7 @@
 
 Source du modules coser-web
 ---------------------------
-Dans le module coser-web, deux groupes de fichiers concerne la modification
+Dans le module coser-web, deux groupes de fichiers concernent la modification
 du contenu textuel:
 
   * ``src/main/webapp/WEB-INF/content`` : qui contient les pages html
@@ -69,7 +69,7 @@
     <title><s:text name="message.index.title" /></title>
   </head>
 
-Cette code défini un titre de page html, contenant la traduction de le clé
+Ce code défini un titre de page html, contenant la traduction de le clé
 `message.layout.title`.
 
 Et dans les fichiers ``package_en.properties`` et ``package_fr.properties``, on trouve
@@ -79,4 +79,25 @@
 
 et::
 
-  message.index.title=Accueil
\ No newline at end of file
+  message.index.title=Accueil
+
+
+Modification et commit sur le serveur
+-------------------------------------
+Il est possible de modifier la mise en forme et le contenu des pages html.
+Toutefois, il est important de veiller à ce que le contenu des fichiers de
+traductions soit en adequation avec les fichiers html.
+
+Une fois les modifications effectuées, vous pouvez commiter ces modifications
+sur le serveur avec votre client svn.
+
+
+Mise en prod
+------------
+Le fait de commiter ne signifie pas que le site de production sera mis à jour.
+En effet, une nouvelle version stable (release) doit être préparée et mise
+en production. Les modifications que vous pourrez effectuer ne seront
+intégrées que lors de la prochaine mise en production.
+
+Il est toutefois possible de demander à l'equipe de developpement la production
+d'une nouvelle version si vos modifications se révélaient urgentes.

Modified: trunk/src/site/site_en.xml
===================================================================
--- trunk/src/site/site_en.xml	2012-08-14 13:45:56 UTC (rev 1046)
+++ trunk/src/site/site_en.xml	2012-08-14 14:16:17 UTC (rev 1047)
@@ -47,8 +47,6 @@
 
     <poweredBy>
         <logo href="http://maven.apache.org" name="Maven" img="http://maven-site.forge.codelutin.com/coser/images/logos/maven-feather.png"/>
-        <logo href="http://maven-site.nuiton.org/jrst" name="JRst" img="http://maven-site.forge.codelutin.com/coser/images/jrst-logo.png"/>
-        <logo href="http://docutils.sourceforge.net/rst.html" name="ReStructuredText" img="http://maven-site.forge.codelutin.com/coser/images/restructuredtext-logo.png"/>
     </poweredBy>
 
     <body>

Modified: trunk/src/site/site_fr.xml
===================================================================
--- trunk/src/site/site_fr.xml	2012-08-14 13:45:56 UTC (rev 1046)
+++ trunk/src/site/site_fr.xml	2012-08-14 14:16:17 UTC (rev 1047)
@@ -47,8 +47,6 @@
 
     <poweredBy>
         <logo href="http://maven.apache.org" name="Maven" img="http://maven-site.forge.codelutin.com/coser/images/logos/maven-feather.png"/>
-        <logo href="http://maven-site.nuiton.org/jrst" name="JRst" img="http://maven-site.forge.codelutin.com/coser/images/jrst-logo.png"/>
-        <logo href="http://docutils.sourceforge.net/rst.html" name="ReStructuredText" img="http://maven-site.forge.codelutin.com/coser/images/restructuredtext-logo.png"/>
     </poweredBy>
 
     <body>

    

r1047 - in trunk/src/site: . en/rst/devel rst/devel

echatellier＠users.forge.codelutin.com

tags

participants (1)