ged and object editor unavailabilities on MacOS is now documented. 97/17497/4
Charlotte HECQUET [Wed, 25 Nov 2015 14:16:47 +0000 (15:16 +0100)]
Change-Id: Ie22266d0cf0cee05f4f27d9e8c9195a6be076bc6

scilab/modules/graphics/help/en_US/handle/ged.xml
scilab/modules/graphics/help/en_US/object_editor.xml
scilab/modules/graphics/help/fr_FR/object_editor.xml
scilab/modules/graphics/macros/ged.sci
scilab/modules/helptools/data/pages/homepage-en_US.html
scilab/modules/helptools/data/pages/homepage-fr_FR.html

index 0e4abd1..dedb48e 100644 (file)
     <refsection>
         <title>Description</title>
         <para>
-            <literal>ged</literal> starts Scilab Graphic Editor on figure number <literal>fignum</literal> and execute action given by <literal>action</literal>.
+            The Scilab Graphic Editor is the underlying Scilab function for the graphic <link linkend="object_editor">object editor</link>, the visual tool available from the graphics windows Edit menu. <code>ged()</code> is of limited use by itself (most the functionalities are available from other functions), and is only present to ensure that all Object Editor functionalities are also available in the Scilab language.
+        </para>
+        <para>
+            <code>ged()</code> starts Scilab Graphic Editor on figure number <varname>fignum</varname> and execute action given by <varname>action</varname>.
+        </para>
+        <para>
+            Note that, the Scilab Graphic Editor is implemented using the Tcl/Tk language; it is not available on MacOS, where Tcl/TK is not available.
         </para>
     </refsection>
     <refsection>
@@ -96,4 +102,12 @@ plot2d();
 ged(6,0) // Then click on a curve and try moving it
  ]]></programlisting>
     </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="object_editor">object editor</link>
+            </member>
+        </simplelist>
+    </refsection>
 </refentry>
index 8f0649f..ec560be 100644 (file)
             description of the graphic object editor capacities
         </refpurpose>
     </refnamediv>
-    <refnamediv xml:id="graphic">
-        <refname>graphic </refname>
-        <refpurpose>
-            description of the graphic object editor capacities
-        </refpurpose>
-    </refnamediv>
-    <refnamediv xml:id="menus">
-        <refname>menus</refname>
-        <refpurpose>
-            description of the graphic object editor capacities
-        </refpurpose>
-    </refnamediv>
     <refsection>
         <title>Description</title>
-        <para>
+        <!--para>
             Scilab graphics allow the user to have interaction with graphics
             before and after having them drawn. Each graphics window and the
             drawing it contains are represented by hierarchical entities. The
             details) that can be enabled for each graphic window. To make it
             work, select the <literal>Edit</literal> menu in the graphic window.
             Seven graphics editing operations are available :
+        </para-->
+        <para>
+            The graphic Object Editor is a set of visual (GUI) editors, available 
+            in the <literal>Edit</literal> menu of graphic windows. They provide graphic editing operations 
+            for the different kind of graphics objects (see <link linkend="graphics_entities">graphics entities</link> 
+            for more details), including the enabling them, disabling them, and editing their properties, 
+            before or after they have been drawn.
+        </para>
+        <para>
+            Internally, each graphic window, and the drawing it contains, are represented by 
+            a hierarchy of entities. The hierarchy top level is the <literal>Figure</literal>. 
+            Each <literal>Figure</literal> defines at least one child of type <literal>Axes</literal>. 
+            Each <literal>Axes</literal> entity contains a set of leaf entities which are the basic graphics
+            objects like <literal>Polylines</literal>, <literal>Rectangles</literal>, <literal>Arcs</literal>, <literal>Segs</literal>,... 
+            It can also contain a <literal>Compound</literal> type which is recursive sets of entities. 
+            The graphic Object Editor manipulates this hierarchy of entities.
+        </para>
+        <para>
+            In the Scilab language, graphics entities are associated to Scilab variables of type <literal>handle</literal>. 
+            The handle is a unique identifier which is associated to each instance of a created graphical entity. 
+            Using this handle, it will be possible to reach entities' properties through 
+            <function>set</function> and <function>get</function> routines. 
+            The handles are also used to manipulate graphics objects, to move them, to make copies or delete them. 
+            A set of high-level graphing routines (see <link linkend="set">set</link>, <link
+            linkend="get">get</link>) allow accessing and editing the objects' 
+            properties such as data, coordinates and scaling, color and appearances without requiring 
+            to replay the initial graphics commands.
         </para>
+        <para>
+            The graphic Object Editor is implemented using the Tcl/Tk language; it is not available on MacOS, 
+            where Tcl/TK is not available.
+        </para>
+        <para>The following editing operations are available in the Object Editor:</para>
         <para/>
         <variablelist>
             <varlistentry>
             <member>
                 <link linkend="plot">plot</link>
             </member>
+            <member>
+                <link linkend="ged">ged</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index 2a8de4e..7e56c6d 100644 (file)
@@ -6,24 +6,6 @@
             l'éditeur graphique
         </refpurpose>
     </refnamediv>
-    <refnamediv xml:id="graphic">
-        <refname>graphic </refname>
-        <refpurpose>description des capacités de l'éditeur
-            graphique
-        </refpurpose>
-    </refnamediv>
-    <refnamediv xml:id="graphique">
-        <refname>graphique </refname>
-        <refpurpose>description des capacités de l'éditeur
-            graphique
-        </refpurpose>
-    </refnamediv>
-    <refnamediv xml:id="menus">
-        <refname>menus</refname>
-        <refpurpose>description des capacités de l'éditeur
-            graphique
-        </refpurpose>
-    </refnamediv>
     <refsection>
         <title>Description</title>
         <para>La module graphique de Scilab permet de nombreuses intéractions
             <member>
                 <link linkend="plot">plot</link>
             </member>
+            <member>
+                <link linkend="ged">ged</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index 6a16a2f..b4e73a3 100644 (file)
@@ -8,6 +8,10 @@
 
 function ged(k,win)
 
+    if getos() == "Darwin" then
+        error(msprintf(gettext("The ged function is not available on MacOSX.")));
+    end
+
     if ~%tk then
         warning(msprintf(gettext("Tcl/Tk interface not installed.")));
         return
index a672c78..35ac396 100644 (file)
@@ -95,7 +95,7 @@
       <p class="para">
       All other functionalities of Scilab are present on all platforms, with a few exceptions:
       <ul>
-        <li>TCL/TK functionalities are not available in MacOS.</li>
+        <li>TCL/TK functionalities, as well as fonctionalities which depend on them (as ged or object_editor), are not available in MacOS.</li>
         <li>Some functions using specific Windows platform are only available on Windows (<a href="section_02d42947da4b16801e15b82ca80009fc.html">Windows tools</a>).</li>
         <li>Compilation of C/C++ or other native code in additional modules (toolboxes), and interface with additional native third-party libraries may depend on the platforms, and may not always be supported on all platforms.</li>
       </ul>
index 76930c7..ab3b8d5 100644 (file)
@@ -92,7 +92,7 @@
       <h2 class="title">Limitations spécifiques aux systèmes d'exploitation</h2>
       <p class="para">
       <ul>
-        <li>La fonctionalité TCL/TK n'est pas disponible sous MacOS.</li>
+        <li>La fonctionalité TCL/TK, ainsi que les fonctionalités qui en dépendent (ged, object_editor) ne sont pas disponibles sous MacOS.</li>
         <li>Certaines fonctions concernant Windows sont évidemment disponibles uniquement sous Windows (<a href="section_02d42947da4b16801e15b82ca80009fc.html">Windows tools</a>).</li>
         <li>La compilation de C/C++ ou autre code natif dans les modules additionnels (toolboxes), ainsi que les interfaces avec les third-parties peuvent dépendre du système d'exploitation, et donc peuvent ne pas être supportés sur toutes les plateformes.</li>
       </ul>