Changeset 696 for branches/PublicaMundi_David-devel/docs/contribute

Timestamp:

Jun 30, 2015, 10:35:39 AM (9 years ago)

Author:

djay

Message:

Small fixes in the main documentation.

Location:

branches/PublicaMundi_David-devel/docs/contribute

Files:

• code.rst (modified) (1 diff, 1 prop)
• contributors.rst (modified) (1 prop)
• dev.rst (modified) (2 diffs, 1 prop)
• doc.rst (modified) (5 diffs, 1 prop)
• howto.rst (modified) (2 diffs, 1 prop)
• index.rst (modified) (1 prop)
• translate.rst (modified) (4 diffs, 1 prop)

branches/PublicaMundi_David-devel/docs/contribute/code.rst

@@ -13 +13 @@
 
 Submit new code
---------------------------
+---------------
 
 For new comers
-*************************
+**************
 
 New source code or existing source code corrections (patches) should
-be submitted using the ZOO-Project bug tracking system (`ZOO-Trac <http://zoo-project.org/trac>`__ ).
+be submitted using the ZOO-Project bug tracking system (`ZOO-Trac
+<http://zoo-project.org/trac>`__ ).
 
-Create a new ticket in order to describe your code or patch and attach
-it to the ticket (attach all the needed files needed to use your code
-or patch). It will then be checked and discussed with the developers,
-and can potentially be integrated and merged with the trunk.
+Create a `new ticket <http://zoo-project.org/trac/newticket>`__ in
+order to describe your code or patch and attach it to the ticket
+(attach all the files required to use your code or patch). It will
+then be checked and discussed with the developers, and can potentially
+be integrated and merged with the trunk.
 
 For registered developers

branches/PublicaMundi_David-devel/docs/contribute/dev.rst

@@ -9 +9 @@
 -----------------------------
 
-Permission for SVN commit access shall be provided to new developers only if accepted by the ZOO-Project Project Steering Committee. A proposal should be written to the PSC for new committers and voted. 
+Permission for SVN commit access shall be provided to new developers only if accepted by the ZOO-Project Project Steering Committee. A proposal should be written to the PSC for new committers and voted.
 
 Removal of SVN commit access should be handled by the same process.
@@ -24 +24 @@
 ------------------
 
-A list of all project committers will be kept in the main zoo-project directory (called COMMITTERS) listing for each SVN committer:
+A list of all project committers will be kept in the main zoo-project directory (called `COMMITTERS <http://zoo-project.org/trac/browser/trunk/zoo-project/COMMITTERS>`__) listing for each SVN committer:
 
     * Userid: the id that will appear in the SVN logs for this person.
     * Full name: the users actual name.
     * Email address: A current email address at which the committer can be reached. It may be altered in normal ways to make it harder to auto-harvest.
+
 
 SVN Administrator

branches/PublicaMundi_David-devel/docs/contribute/doc.rst

@@ -28 +28 @@
 ........................................
 
-The current structure of the ZOO Project documentation process is for developers with :ref:`SVN <svn>` commit access to maintain their documents in reStructuredText format, and therefore all documents live in the /docs directory in SVN.  The `Sphinx <http://sphinx.pocoo.org/>`__ documentation generator is used to convert the reStructuredText files to html, and the live
-website is then updated on an hourly basis.
+The current structure of the ZOO Project documentation process is for
+developers with :ref:`SVN <svn>` commit access to maintain their
+documents in reStructuredText format, and therefore all documents live
+in the /docs directory in SVN.  The `Sphinx
+<http://sphinx.pocoo.org/>`__ documentation generator is used to
+convert the reStructuredText files to html, and the live website is
+then updated on an hourly basis.
 
 
@@ -49 +54 @@
    ::
 
-       sudo easy_install Sphinx
+       sudo easy_install Sphinx==1.3.1
        
    .. note::
     
-      Make sure you install Sphinx 1.0 or more recent.  See note above.  
+      Make sure you install Sphinx 1.3.1 or more recent. 
       
 * Checkout the /docs directory from SVN, such as:
@@ -88 +93 @@
    ::
 
-       sudo easy_install Sphinx
+       sudo easy_install-2.7 Sphinx==1.3.1
        
    .. note::
    
-      Make sure you install Sphinx 1.0 or more recent.  See note above.        
+      Make sure you install Sphinx 1.3.1 or more recent. 
 
 * Install `MacTex <http://www.tug.org/mactex/2009/>`__ if you want to build pdfs
@@ -127 +132 @@
    ::
 
-       easy_install Sphinx
+       easy_install Sphinx==1.3.1
 
    ...you should see message: "Finished processing dependencies for Sphinx"
@@ -133 +138 @@
    .. note::
    
-      Make sure you install Sphinx 1.0 or more recent.  See note above.
+      Make sure you install Sphinx 1.3.1 or more recent.  See note above.
       
 * Install `MiKTeX <http://miktex.org>`__ if you want to build pdfs

branches/PublicaMundi_David-devel/docs/contribute/howto.rst

@@ -1 +1 @@
 How to contribute ?
-==================
+===================
 
 Please consider the following simple rules if you would like to contribute to  the `ZOO-Project <http://zoo-project.org>`__  open source software.
@@ -37 +37 @@
 ..   csv-table::
      
-  Name,Description,Address
-    zoo-discuss,General mailing list for ZOO-Project users and developers,zoo-discuss@lists.osgeo.org
-    zoo-psc,Project Steering Committe mailing list,zoo-psc@lists.osgeo.org
+  Name,Description
+    `zoo-discuss <http://lists.osgeo.org/cgi-bin/mailman/listinfo/zoo-discuss>`__,General mailing list for ZOO-Project users and developers
+    `zoo-psc <http://lists.osgeo.org/cgi-bin/mailman/listinfo/zoo-psc>`__,Project Steering Committe mailing list
     
 

branches/PublicaMundi_David-devel/docs/contribute/translate.rst

@@ -23 +23 @@
           for i in Title Abstract; 
            do
-            grep $i $j | sed "s:$i = :_(\":g;s:$:\"):g" ;
+            grep $i $j | sed "s:$i = :_ss(\":g;s:$:\"):g" ;
            done;
        done > locale/.cache/my_service_string_to_translate.c
@@ -33 +33 @@
   
       #!/bin/bash
-      xgettext service.c locale/.cache/my_service_string_to_translate.c -o message.po -p locale/po/ -k_
+      xgettext service.c locale/.cache/my_service_string_to_translate.c -o message.po -p locale/po/ -k_ss
 
 Once 'messages.po' is created, use the following command to create the po file for the targeted language for translation. We will use the French language here as an example :
@@ -45 +45 @@
 Edit the zoo_fr_FR.po file with your favorite text editor or using one of the following tools :
 
- * [http://www.poedit.net/ poedit]
- * [http://translate.sourceforge.net/wiki/virtaal/index virtaal]
- * [https://www.transifex.net/projects/p/grass6/c/grass64/ transifex]
+ * `poedit <http://www.poedit.net/>`__
+ * `virtaal <http://translate.sourceforge.net/wiki/virtaal/index>`__
+ * `transifex <https://www.transifex.net/>`__
  
 Once the zoo_fr_FR.po file is completed, you can generate and install the corresponding *mo* file using the following command : 
@@ -61 +61 @@
 example, such a request:
 
-[http://youserver/cgi-bin/zoo_loader.cgi?request=GetCapabilities&service=WPS]
+http://youserver/cgi-bin/zoo_loader.cgi?request=GetCapabilities&service=WPS
 
 would become the following:
 
-[http://youserver/cgi-bin/zoo_loader.cgi?request=GetCapabilities&service=WPS&language=fr-FR]
+http://youserver/cgi-bin/zoo_loader.cgi?request=GetCapabilities&service=WPS&language=fr-FR
 
 The following command may also be useful in order to pull all the translations already available for a specific language.