* Bug #13069 fixed - Xcos help: %MODELICA_USER_LIBS is now global 31/13131/4
Paul BIGNIER [Tue, 12 Nov 2013 11:06:16 +0000 (12:06 +0100)]
Follow up on commit https://codereview.scilab.org/#/c/5461/

Change-Id: I290e9a92d69a5b155c08d614c17fd2e37f8fa749

scilab/CHANGES_5.5.X
scilab/modules/xcos/help/en_US/scilab_utilities_functions/MODELICA_USER_LIBS.xml [new file with mode: 0644]
scilab/modules/xcos/help/en_US/scilab_utilities_functions/getModelicaPath.xml
scilab/modules/xcos/help/fr_FR/scilab_utilities_functions/MODELICA_USER_LIBS.xml [new file with mode: 0644]

index 4e49c7e..a5d76d2 100644 (file)
@@ -161,6 +161,8 @@ Scilab Bug Fixes
 
 * Bug #13063 fixed - Color selection in SciNotes preferences threw exceptions.
 
+* Bug #13069 fixed - Documentation for %MODELICA_USER_LIBS updated.
+
 
 Xcos Bug Fixes
 ==============
diff --git a/scilab/modules/xcos/help/en_US/scilab_utilities_functions/MODELICA_USER_LIBS.xml b/scilab/modules/xcos/help/en_US/scilab_utilities_functions/MODELICA_USER_LIBS.xml
new file mode 100644 (file)
index 0000000..5ab417f
--- /dev/null
@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2013 - Scilab Enterprises - Paul Bignier
+ *
+ * This file must be used under the terms of the CeCILL.
+ * This source file is licensed as described in the file COPYING, which
+ * you should have received as part of this distribution.  The terms
+ * are also available at
+ * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
+ *
+ -->
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en_US" xml:id="MODELICA_USER_LIBS">
+    <refnamediv>
+        <refname>%MODELICA_USER_LIBS</refname>
+        <refpurpose>
+            Specify the paths of the directories containing the Modelica class definition files
+        </refpurpose>
+    </refnamediv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            This variable is used to specify where are the Modelica class definition files
+        </para>
+        <para>
+            If the user wants to define his own Modelica blocks, Modelica files
+            describing the blocks must be indicated. The variable %MODELICA_USER_LIBS has
+            to be declared as global before launching Xcos.
+        </para>
+    </refsection>
+    <refsection id="Example_MODELICA_USER_LIBS">
+        <title>Example</title>
+        <programlisting role="example">
+            // Get the current Modelica path and directory
+            [modelica_path, modelica_directory] = getModelicaPath()
+            
+            // To define user's Modelica blocks
+            // path of the directory containing the user's Modelica files
+            // It has to be global to be accessed from Atoms toolbox
+            global %MODELICA_USER_LIBS
+            %MODELICA_USER_LIBS = SCI + "/modules/xcos/modelica_library";
+            
+            // Launch Xcos
+            xcos();
+            // Load the diagram with Modelica blocks
+            
+            [modelica_path, modelica_directory] = getModelicaPath()
+            
+            // To add another Modelica folder
+            %MODELICA_USER_LIBS = [%MODELICA_USER_LIBS , SCI + "/modules/xcos/my_modelica_blocks/Electrical_network"];
+            
+            // Launch Xcos
+            xcos();
+            // Load the diagram with Modelica blocks
+            
+            [modelica_path, modelica_directory] = getModelicaPath()
+            
+        </programlisting>
+    </refsection>
+    <refsection id="SeeAlso_MODELICA_USER_LIBS">
+        <title>See Also</title>
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <link linkend="getModelicaPath">getModelicaPath</link>: get the Modelica directory path needed by Xcos diagram containing Modelica blocks
+                </para>
+            </listitem>
+        </itemizedlist>
+    </refsection>
+</refentry>
index f8e79e7..037ec18 100644 (file)
@@ -28,7 +28,7 @@
         </para>
         <para>If the user wants to define his own Modelica blocks, Modelica files
             describing the blocks must be indicated. The variable %MODELICA_USER_LIBS has
-            to be declared before launching xcos.
+            to be declared as global before launching Xcos.
         </para>
     </refsection>
     <refsection>
     <refsection id="Example_getModelicaPath">
         <title>Example</title>
         <programlisting role="example">
-            //Get the modelica path and directory
+            // Get the current Modelica path and directory
             [modelica_path, modelica_directory] = getModelicaPath()
             
             // To define user's Modelica blocks
             // path of the directory containing the user's Modelica files
+            // It has to be global to be accessed from Atoms toolbox
+            global %MODELICA_USER_LIBS
             %MODELICA_USER_LIBS = SCI + "/modules/xcos/modelica_library";
             
-            // launch xcos
+            // Launch Xcos
             xcos();
-            // load the diagram with Modelica blocks
+            // Load the diagram with Modelica blocks
             
             [modelica_path, modelica_directory] = getModelicaPath()
             
             // paths of the directory containing the user's Modelica files
             %MODELICA_USER_LIBS = [%MODELICA_USER_LIBS , SCI + "/modules/xcos/my_modelica_blocks/Electrical_network"];
             
-            // launch xcos
+            // Launch Xcos
             xcos();
-            // load the diagram with Modelica blocks
+            // Load the diagram with Modelica blocks
             
             [modelica_path, modelica_directory] = getModelicaPath()
             
         </programlisting>
     </refsection>
+    <refsection id="SeeAlso_getModelicaPath">
+        <title>See Also</title>
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <link linkend="MODELICA_USER_LIBS">MODELICA_USER_LIBS</link>: specify the paths of the directories containing the Modelica class definition files
+                </para>
+            </listitem>
+        </itemizedlist>
+    </refsection>
 </refentry>
diff --git a/scilab/modules/xcos/help/fr_FR/scilab_utilities_functions/MODELICA_USER_LIBS.xml b/scilab/modules/xcos/help/fr_FR/scilab_utilities_functions/MODELICA_USER_LIBS.xml
new file mode 100644 (file)
index 0000000..b018c03
--- /dev/null
@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2013 - Scilab Enterprises - Paul Bignier
+ *
+ * This file must be used under the terms of the CeCILL.
+ * This source file is licensed as described in the file COPYING, which
+ * you should have received as part of this distribution.  The terms
+ * are also available at
+ * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
+ *
+ -->
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="fr_FR" xml:id="MODELICA_USER_LIBS">
+    <refnamediv>
+        <refname>%MODELICA_USER_LIBS</refname>
+        <refpurpose>
+            Spécifier l'emplacement des librairies Modelica
+        </refpurpose>
+    </refnamediv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            Cette variable sert à spécifier où se trouvent les librairies Modelica.
+        </para>
+        <para>
+            Si l'utilisateur souhaite définir ses propres blocs Modelica, les fichiers
+            décrivant ces blocs doivent être indiqués. La variable %MODELICA_USER_LIBS doit
+            être déclarée globale avant de lancer Xcos.
+        </para>
+    </refsection>
+    <refsection id="Example_MODELICA_USER_LIBS">
+        <title>Example</title>
+        <programlisting role="example">
+            // Obtenir le chemin Modelica actuel
+            [modelica_path, modelica_directory] = getModelicaPath()
+            
+            // Pour définir le chemin du dossier contenant les librairies Modelica
+            // Elle doit être globale pour être appelée depuis les toolbox Atoms
+            global %MODELICA_USER_LIBS
+            %MODELICA_USER_LIBS = SCI + "/modules/xcos/modelica_library";
+            
+            // Lancer Xcos
+            xcos();
+            // Charger le diagamme aux blocs Modelica blocks
+            
+            [modelica_path, modelica_directory] = getModelicaPath()
+            
+            // Pour ajouter un nouveau dossier Modelica
+            %MODELICA_USER_LIBS = [%MODELICA_USER_LIBS , SCI + "/modules/xcos/my_modelica_blocks/Electrical_network"];
+            
+            // Lancer Xcos
+            xcos();
+            // Charger le diagamme aux blocs Modelica blocks
+            
+            [modelica_path, modelica_directory] = getModelicaPath()
+            
+        </programlisting>
+    </refsection>
+    <refsection id="SeeAlso_MODELICA_USER_LIBS">
+        <title>Voir aussi</title>
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <link linkend="getModelicaPath">getModelicaPath</link>: obtenir le chemin du dossier Modelica requis par les diargamme Xcos contenant des blocs Modelica
+                </para>
+            </listitem>
+        </itemizedlist>
+    </refsection>
+</refentry>