Revision of help pages for Compound properties and graphics entities (en_US).
[scilab.git] / scilab / modules / graphics / help / en_US / graphics_entities.xml
index 4eacd29..b7802be 100644 (file)
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" 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" xml:id="graphics_entities">
     <refnamediv>
         <refname>Graphics Entities</refname>
-        <refpurpose>description of the graphics
-            entities data structures
+        <refpurpose>
+            description of the graphics entities data structures
         </refpurpose>
     </refnamediv>
     <refsection>
         <title>Description</title>
-        <para> In Scilab,
-            graphics window and the drawing it contains are represented by hierchical
-            entities. The hierarchy top level is the Figure. Each Figure defines at
-            least one child of type Axes. Each Axes entity contains a set of leaf
-            entities which are the basic graphics objects like Polylines, Rectangles,
-            Arcs, Segs,... It can also contain an Compound type which are recursive
-            sets of entities. The main interest of the graphic mode is to make
-            property change easier. This graphics'mode provides a set of
-            high-level graphing routines (see <link linkend="set">set</link>, <link linkend="get">get</link>) used
-            to control objects' properties such as data, coordinates and scaling,
-            color and appearences without requiring to replay the initial graphics
-            commands.
+        <para>
+            In Scilab, graphics window and the drawing it contains are
+            represented by hierarchical 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 an <literal>Compound</literal> type which is recursive
+            set of entities. The main interest of the graphic mode is to make
+            property change easier. This graphics' mode provides a set of
+            high-level graphing routines (see <link linkend="set">set</link>,
+            <link linkend="get">get</link>) used to control objects' properties
+            such as data, coordinates and scaling, color and appearances without
+            requiring to replay the initial graphics commands.
         </para>
-        <para>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 "set" and "get"
-            routines. The handles are also used to manipulate graphics objects, to
-            move them, to make copies or delete them.
+        <para>
+            Graphics entities are associated to Scilab variables of type
+            <literal>handle</literal>. The handle is an 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.
         </para>
         <para/>
         <variablelist>
             <varlistentry>
                 <term>Figure: </term>
                 <listitem>
-                    <para>The figure entity is the top level of the graphics entities
-                        hierarchy. This entity defines the parameters for the figure itself as
-                        well as the parameters' default values for the children creation. The
-                        figure children are the Axes entities.
-                    </para>
-                    <para>The handle on the current figure (the figure used where the drawing
-                        are sent) may be got using <literal>get("current_figure")</literal> and it
-                        may be set using <literal>set("current_figure",h)</literal>, where
+                    <para>
+                        The figure entity is the top level of the graphics
+                        entities hierarchy. This entity defines the parameters
+                        for the figure itself as well as the parameters' default
+                        values for the children creation. The figure children
+                        are the <literal>Axes</literal> entities.
+                    </para>
+                    <para>
+                        The handle on the current figure (the figure used where
+                        the drawing are sent) may be got using
+                        <code>get("current_figure")</code> and it may be set
+                        using <code>set("current_figure",h)</code>, where
                         <literal>h</literal> is either a handle on a figure or a
-                        <literal>figure_id</literal> in this last case if the figure does not
-                        already exists , it is created
+                        <literal>figure_id</literal> in this last case if the
+                        figure does not already exists, it is created.
                     </para>
                     <para>
-                        See <link linkend="figure_properties">figure_properties</link> for details.
+                        See <link linkend="figure_properties">figure properties</link> for details.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Axes: </term>
                 <listitem>
-                    <para>The Axes entity is the second level of the graphics entities
-                        hierarchy. This entity defines the parameters for the change of
-                        coordinates and the axes drawing as well as the parameters' default
-                        values for its children creation. See <link linkend="axes_properties">axes_properties</link> for
-                        details. The handle on the current Axes may be got using
-                        <literal>get("current_axes")</literal>.
+                    <para>
+                        The <literal>Axes</literal> entity is the second level
+                        of the graphics entities hierarchy. This entity defines
+                        the parameters for the change of coordinates and the
+                        axes drawing as well as the parameters' default values
+                        for its children creation. See <link linkend="axes_properties">axes properties</link> for
+                        details. The handle on the current <literal>Axes</literal> may be got using
+                        <code>get("current_axes")</code>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Compound: </term>
                 <listitem>
-                    <para>The Compound entity is just a vector of children and with a single
-                        property (visibility property). It is used to glue a set of entities
+                    <para>
+                        The <literal>Compound</literal> entity is just a vector
+                        of children and with a single property (visibility
+                        property). It is used to glue a set of entities
                         together.
                     </para>
                     <para>
                         See <link linkend="glue">glue</link>, <link linkend="unglue">unglue</link> and
-                        <link linkend="Compound_properties">Compound_properties</link> functions.
+                        <link linkend="Compound_properties">Compound properties</link> functions.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Axis: </term>
                 <listitem>
-                    <para>The Axis entity is a leaf of the graphics entities hierarchy. This
-                        entity defines the parameters for axis scaling and appearance.
+                    <para>
+                        The <literal>Axis</literal> entity is a leaf of the
+                        graphics entities hierarchy. This entity defines the
+                        parameters for axis scaling and appearance.
                     </para>
                     <para>
-                        See <link linkend="axis_properties">axis_properties</link> for details.
+                        See <link linkend="axis_properties">axis properties</link> for details.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Polyline: </term>
                 <listitem>
-                    <para>The polyline entity is a leaf of the graphics entities hierarchy.
-                        It defines 2D and 3D polylines and polylines extensions drawing
-                        properties.
+                    <para>
+                        The <literal>Polyline</literal> entity is a leaf of the
+                        graphics entities hierarchy. It defines 2D and 3D
+                        polylines and polylines extensions drawing properties.
                     </para>
                     <para>
-                        See <link linkend="polyline_properties">polyline_properties</link> for details.
+                        See <link linkend="polyline_properties">polyline properties</link> for details.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Arc: </term>
                 <listitem>
-                    <para>The Arc entity is a leaf of the graphics entities hierarchy. This
-                        entity defines the parameters for ellipses and part of ellipses.
+                    <para>
+                        The <literal>Arc</literal> entity is a leaf of the
+                        graphics entities hierarchy. This entity defines the
+                        parameters for ellipses and part of ellipses.
                     </para>
                     <para>
-                        See <link linkend="arc_properties">arc_properties</link> for details.
+                        See <link linkend="arc_properties">arc properties</link>
+                        for details.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Rectangle: </term>
                 <listitem>
-                    <para>The Rectangle entity is a leaf of the graphics entities hierarchy.
-                        This entity defines the parameters for rectangles and filled
-                        rectangles.
+                    <para>
+                        The <literal>Rectangle</literal> entity is a leaf of the
+                        graphics entities hierarchy. This entity defines the
+                        parameters for rectangles and filled rectangles.
                     </para>
                     <para>
-                        See <link linkend="rectangle_properties">rectangle_properties</link> for details.
+                        See <link linkend="rectangle_properties">rectangle properties</link> for details.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Surface: </term>
                 <listitem>
-                    <para>The Surface entity is a leaf of the graphics entities hierarchy.
-                        It has sub types <literal>Fac3d</literal> or <literal>Plot3d</literal>. This
-                        entity defines the parameters for 3d surface plots.
+                    <para>
+                        The <literal>Surface</literal> entity is a leaf of the
+                        graphics entities hierarchy. It has subtypes
+                        <literal>Fac3d</literal> or <literal>Plot3d</literal>.
+                        This entity defines the parameters for 3d surface plots.
                     </para>
                     <para>
-                        See <link linkend="surface_properties">surface_properties</link> for details.
+                        See <link linkend="surface_properties">surface properties</link> for details.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Fec: </term>
                 <listitem>
-                    <para>The Fec entity is a leaf of the graphics entities hierarchy. It
-                        represents 2D finite elements plots .
+                    <para>
+                        The <literal>Fec</literal> entity is a leaf of the
+                        graphics entities  hierarchy. It represents 2D finite
+                        elements plots.
                     </para>
                     <para>
-                        See <link linkend="fec_properties">fec_properties</link> for details.
+                        See <link linkend="fec_properties">fec properties</link>
+                        for details.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Grayplot: </term>
                 <listitem>
-                    <para>The Grayplot entity is a leaf of the graphics entities hierarchy.
-                        It represents 2D plots of surface using colors and images.
+                    <para>
+                        The <literal>Grayplot</literal> entity is a leaf of the
+                        graphics entities hierarchy. It represents 2D plots of
+                        surface using colors and images.
                     </para>
                     <para>
-                        See <link linkend="grayplot_properties">grayplot_properties</link> for details.
+                        See <link linkend="grayplot_properties">grayplot properties</link> for details.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Matplot: </term>
                 <listitem>
-                    <para>The Matplot entity is a leaf of the graphics entities hierarchy.
-                        It represents 2D plots using integer matrices.
+                    <para>
+                        The <literal>Matplot</literal> entity is a leaf of the
+                        graphics entities hierarchy. It represents 2D plots
+                        using integer matrices.
                     </para>
                     <para>
-                        See <link linkend="Matplot_properties">Matplot_properties</link> for details.
+                        See <link linkend="Matplot_properties">Matplot properties</link> for details.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Segs: </term>
                 <listitem>
-                    <para>The Segs entity is a leaf of the graphics entities hierarchy. This
-                        entity defines the parameters for a set of colored segments or colored
+                    <para>
+                        The <literal>Segs</literal> entity is a leaf of the
+                        graphics entities hierarchy. This entity defines the
+                        parameters for a set of colored segments or colored
                         arrows.
                     </para>
                     <para>
-                        See <link linkend="segs_properties">segs_properties</link> for details.
+                        See <link linkend="segs_properties">segs properties</link> for details.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Champ: </term>
                 <listitem>
-                    <para>The Champ entity is a leaf of the graphics entities hierarchy.
-                        This entity defines the parameters for a 2D vector field.
+                    <para>
+                        The <literal>Champ</literal> entity is a leaf of the
+                        graphics entities hierarchy. This entity defines the
+                        parameters for a 2D vector field.
                     </para>
                     <para>
-                        See <link linkend="champ_properties">champ_properties</link> for details.
+                        See <link linkend="champ_properties">champ properties</link> for details.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Text: </term>
                 <listitem>
-                    <para>The Text entity is a leaf of the graphics entities hierarchy. This
-                        entity defines the parameters for string drawing.
+                    <para>
+                        The <literal>Text</literal> entity is a leaf of the
+                        graphics entities hierarchy. This entity defines the
+                        parameters for string drawing.
                     </para>
                     <para>
-                        See <link linkend="text_properties">text_properties</link> for details.
+                        See <link linkend="text_properties">text properties</link> for details.
                     </para>
                 </listitem>
             </varlistentry>
                 <term>Label: </term>
                 <listitem>
                     <para>
-                        The Labels entity are children of the <literal>Axes</literal> graphics
-                        entity. This entity defines the parameters for the 3 x,y and z labels
+                        The <literal>Label</literal> entity is a child of the
+                        <literal>Axes</literal> graphics entity. This entity
+                        defines the parameters for the 3 x, y and z labels
                         and title drawn on a graphics window.
                     </para>
                     <para>
-                        See <link linkend="label_properties">label_properties</link> for details.
+                        See <link linkend="label_properties">Label entity properties</link> for details.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Legend: </term>
                 <listitem>
-                    <para>The Legend entity is a leaf of the graphics entities hierarchy.
-                        This entity defines the parameters for legends drawn below
-                        <literal>plot2dx</literal> graphs. This entity requires further
-                        developments.
+                    <para>
+                        The <literal>Legend</literal> entity is a leaf of the
+                        graphics entities hierarchy. This entity defines the
+                        parameters for legends drawn below
+                        <literal>plot2dx</literal> graphs. This entity requires
+                        further developments.
                     </para>
                     <para>
-                        See <link linkend="legend_properties">legend_properties</link> for details.
+                        See <link linkend="legend_properties">Legend entity properties</link> for details.
                     </para>
                 </listitem>
             </varlistentry>
@@ -293,7 +331,7 @@ plot2d(x,x^3)  //the drawing are sent to the initial figure
                 <link linkend="delete">delete</link>
             </member>
             <member>
-                <link linkend="object_editor">object_editor</link>
+                <link linkend="object_editor">object editor</link>
             </member>
             <member>
                 <link linkend="plot">plot</link>