Doc

diff --git a/src/PythonAddons/doc/pipeNetworkFeature.rst b/src/PythonAddons/doc/pipeNetworkFeature.rst
index 463ea1589e4f370db3a6c6873d1940169021d59d..cb65c501736c05915e86465fd3a42b6f7e35d190 100644 (file)
--- a/src/PythonAddons/doc/pipeNetworkFeature.rst
+++ b/src/PythonAddons/doc/pipeNetworkFeature.rst
@@ -8,8 +8,8 @@ Cette macro crée les objets SHAPER correspondant à un réseau de tuyauteries d
 
 Pour créer l'objet de la tuyauterie :
 
-#. Choisir dans le menu principal *Macros - > Réseau de tuyaux* item  ou
-#. cliquer le bouton |pipeNetwork.icon| **Réseau de tuyaux** dans la barre des macros.
+#. Choisir dans le menu principal *Macros - > Réseau de tuyaux* ou
+#. Cliquer le bouton |pipeNetwork.icon| **Réseau de tuyaux** dans la barre des macros.
 
 Le menu suivant apparaît :
 
@@ -22,3 +22,47 @@ On doit fournir le fichier de type texte qui contient le réseau. Sa syntaxe est
 
 Syntaxe du fichier de données
 """""""""""""""""""""""""""""
+
+Règles générales
+----------------
+
+- Chaque ligne commençant par # est ignorée
+- Une information par ligne
+- Sur une ligne, les données sont séparés par des blancs
+- Les données sont regroupées en 3 sections : les noeuds, la connectivité, les raccordements
+- Une section débute par **mot-clé section** est finit par *............*
+
+Les noeuds
+----------
+
+- Repérage avec **nodes section**
+
+- Pour un noeud dont on donne les coordonnées en absolu :
+
+``Identifiant du noeud, le signe -, les 3 coordonnées``
+
+- Pour un noeud défini par rapport à un autre :
+
+``Identifiant du noeud, identifiant du noeud de départ, les 3 coordonnées de la translation``
+
+La connectivité
+---------------
+
+- Repérage avec **connectivity section**
+- Choix de la méthode de description avec **method=par_ligne** ou **method=2par2**
+
+- Pour la méthode en ligne :
+
+Chaque ligne est décrite par la suite de ses noeuds repérés par leurs identifiants :
+
+``Identifiant du noeud n°1, identifiant du noeud n°2, ..., identifiant du dernier noeud``
+
+- Pour la méthode 2 par 2 :
+
+Chaque tronçon est décrit par les 2 noeuds repérés par leurs identifiants :
+
+``Identifiant du noeud n°1 , identifiant du noeud n°2``
+
+Exemple
+-------
+.. literalinclude:: ../../../../../../bin/salome/macros/pipeNetwork/pipeNetwork_ligne.txt