Revision of help pages for Compound properties and graphics entities (en_US).
[scilab.git] / scilab / modules / graphics / help / en_US / compound_properties.xml
index 6b09f8d..515cf9d 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="Compound_properties">
     <refnamediv>
         <refname>Compound properties</refname>
-        <refpurpose>description of the Compound
-            entity properties
+        <refpurpose>
+            description of the Compound entity properties
         </refpurpose>
     </refnamediv>
     <refsection>
         <title>Description</title>
-        <para>The Compound entity is a third of the graphics entities hierarchy. This
-            entity defines interdependencies of the various graphics entities and
-            their global visibility property.
+        <para>
+            The <literal>Compound</literal> entity is a third of the graphics
+            entities hierarchy. This entity defines interdependencies of the
+            various graphics entities and their global visibility property.
         </para>
         <variablelist>
             <varlistentry>
                 <term>parent: </term>
                 <listitem>
-                    <para>This property contains the handle of the parent. The parent of the
-                        text entity should be of the type <literal>"Axes"</literal> or
+                    <para>
+                        This property contains the handle of the parent. The
+                        parent of the text entity should be of the type <literal>"Axes"</literal> or
                         <literal>"Compound"</literal>.
                     </para>
                 </listitem>
             <varlistentry>
                 <term>children: </term>
                 <listitem>
-                    <para>A vector containing the handles of all graphics objects children
-                        of the Compound. These graphics objects can be of type
+                    <para>
+                        A vector containing the handles of all graphics objects
+                        children of the <literal>Compound</literal>. These
+                        graphics objects can be of type
                         <literal>"Compound"</literal>, <literal>"Rectangle"</literal>,
                         <literal>"Polyline"</literal>, <literal>"Patch"</literal>, <literal>"Segs"</literal>,
                         <literal>"Arc"</literal>, <literal>"Grayplot"</literal>, ...
                 <term>visible: </term>
                 <listitem>
                     <para>
-                        This field contains the <literal>visible</literal> property value for
-                        the entity . It should be <literal>"on" </literal> or <literal>"off"</literal>. By
-                        default, value is <literal>"on" </literal> where graphics entities children
-                        of the Compound are drawn according to their visibility property. If
-                        <literal>"off"</literal> all children of Compound are not displayed on the
+                        This field contains the <literal>visible</literal>
+                        property value for the entity. It should be
+                        <literal>"on"</literal> or <literal>"off"</literal>. By
+                        default, value is <literal>"on" </literal> where graphics
+                        entities children of the <literal>Compound</literal> are
+                        drawn according to their visibility property. If
+                        <literal>"off"</literal> all children of
+                        <literal>Compound</literal> are not displayed on the
                         screen.
                     </para>
                 </listitem>
@@ -60,8 +67,9 @@
             <varlistentry>
                 <term>user_data: </term>
                 <listitem>
-                    <para>This field can be use to store any scilab variable in the figure
-                        data structure, and to retreive it.
+                    <para>
+                        This field can be use to store any scilab variable in the
+                        figure data structure, and to retrieve it.
                     </para>
                 </listitem>
             </varlistentry>
@@ -77,7 +85,7 @@
                 <link linkend="unglue">unglue</link>
             </member>
             <member>
-                <link linkend="graphics_entities">graphics_entities</link>
+                <link linkend="graphics_entities">graphics entities</link>
             </member>
         </simplelist>
     </refsection>