text_properties page improved 96/19596/6
Samuel GOUGEON [Sun, 10 Dec 2017 01:25:55 +0000 (02:25 +0100)]
 * properties reordered for better grouping and priority
 * data and font_angle descriptions improved (noticeably about how to
   center the block on the pivot).
 * alignment: + applies to all columns
 * Examples: Extrawide MathML string wrapped.
 * See also improved: + xstring, label_properties, legend_properties,
   latex & mathML page; - set, get (too general)
 * History section created.
 * <emphasis> replaced with <literal> for better readability.
 * Other misc. styles improvements.

Change-Id: I95ac39a831e0be4c3f320e1246697be9c27378d2

scilab/CHANGES.md
scilab/modules/graphics/help/en_US/text/text_properties.xml
scilab/modules/graphics/help/ja_JP/text/text_properties.xml

index 4a9f1bf..b580ace 100644 (file)
@@ -227,7 +227,7 @@ Help pages:
 * Support to `id` attribute added for the `<tr>` tag.
 * fixed / improved:  `members`, `part`, `ode`, `ode_optional_output`, `ode_root`, `plot2d`, `roots`,
   `printf`, `sprintf`, `iconvert`, `stdev`, `xlabel`, `and_op`, `or_op`, `permute`, `tree2code`, `%helps`,
-  `scilab|scilex`, `flipdim`, `Matplot_properties`, `meshgrid`, `ismatrix`, `xget`, `xset`, `ieee`, `evstr`,
+  `scilab|scilex`, `flipdim`, `Matplot_properties`, `text_properties`, `meshgrid`, `ismatrix`, `xget`, `xset`, `ieee`, `evstr`,
   `uigetfont`, `uigetdir`, `uigetfile`, `uiputfile`, `cat`, `makecell`, `xstring`, `norm`, `barhomogenize`,
   `colordef`, `matrix`, `coffg`, `diag`, `speye`, `sparse`
 * rewritten: `consolebox`, `double`, `isoview`, `pixel_drawing_mode`, `householder`, `or`, `|,||`,
index c25f728..f9b97e3 100644 (file)
@@ -3,6 +3,7 @@
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) INRIA - Djalel Abdemouche
  * Copyright (C) INRIA - Jean-Baptiste silvy
+ * Copyright (C) 2018 - Samuel GOUGEON
  *
  * Copyright (C) 2012 - 2016 - Scilab Enterprises
  *
  * along with this program.
  *
  -->
-<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="text_properties">
+<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="text_properties">
     <refnamediv>
         <refname>text properties</refname>
-        <refpurpose>description of the Text entity
-            properties
+        <refpurpose>
+            description of the Text entity properties
         </refpurpose>
     </refnamediv>
     <refsection>
         <title>Description</title>
-        <para>The Text entity is a leaf of the graphics entities hierarchy. This
-            entity defines the parameters for string drawing
+        <para>
+            The Text entity is a leaf of the graphics entities hierarchy. This entity defines
+            the parameters for string drawing
         </para>
         <variablelist>
             <varlistentry>
                 <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, the text is visible, the value's property is
-                        <literal>"on"</literal>. If <literal>"off"</literal> the text is not displayed on
-                        the screen.
+                        the entity . It should be <literal>"on" </literal> or <literal>"off"</literal>.
+                        By default, the text is visible, the value's property is <literal>"on"</literal>.
+                        If <literal>"off"</literal> the text is not displayed on the screen.
                     </para>
                 </listitem>
             </varlistentry>
                 <term>text: </term>
                 <listitem>
                     <para>the matrix containing the strings of the object. The rows of the
-                        matrix are displayed horizontally and the columns vertically.
-                    </para>
-                    <para>
-                        Starting from Scilab 5.2, it is possible to write <link linkend="math_rendering_features_in_graphic">LaTeX or MathML expression</link>.
+                        matrix are displayed horizontally, and the columns vertically.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>alignment: </term>
+                <term>data: </term>
                 <listitem>
-                    <para>Specify how the strings are aligned in their columns. The value
-                        must be <emphasis role="bold">'left'</emphasis>,<emphasis role="bold"> 'center' </emphasis>or <emphasis role="bold">'right'</emphasis>.
+                    <para>
+                        Vector <literal>[x,y,[z]]</literal> setting the position of the pivot of the
+                        text, in data units of the axes. By default, the pivot is set on the lower
+                        left corner of the framing box of the block of text.
                     </para>
+                    <note>
+                        <literal>e = gce(); e.text_box=[0 0]; e.text_box_mode="centered"</literal>
+                        centers the framing box on the pivot, so at the <literal>.data</literal>
+                        position.
+                    </note>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>data: </term>
+                <term>font_angle: </term>
                 <listitem>
                     <para>
-                        This field is the vector <literal>[x,y,[z]]</literal> of the origin of
-                        the text in the data units of the axes.
+                     This property sets the orientation of the block of text around its pivot,
+                     in clockwise degrees starting from the (0-right) direction (it is definitely
+                     not related to the font slanting).
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>box: </term>
+                <term>alignment: </term>
                 <listitem>
                     <para>
-                        This field takes the values <literal>"on"</literal> or
-                        <literal>"off"</literal>. If <literal>"on"</literal> a box is draw around the text
-                        with a line on its edge and a background.
+                        Specifies how the strings are aligned in their columns. The value must be
+                        <literal>"left"</literal>,
+                        <literal>"center"</literal> or
+                        <literal>"right"</literal>. It applies to all columns.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>line_mode: </term>
+                <term>font_style: </term>
                 <listitem>
-                    <para>This boolean property allows to draw or not a line around the box
-                        when the <literal>box</literal> property is <literal>"on"</literal>. If
-                        <literal>line_mode</literal> is <literal>"off"</literal>, the line of the box is
-                        not drawn.
+                    <para>Specifies the font used to display the character strings.
+                        This is a positive integer referecing one of the loaded fonts.
+                        Its value must be between 0, referecing the first font,
+                        and the number of loaded fonts minus one, referencing the last font.
+                        For more information see <link linkend="graphics_fonts">graphics_fonts</link>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>fill_mode: </term>
+                <term>font_foreground: </term>
                 <listitem>
-                    <para>This boolean property allows to draw or not the background of the
-                        box when the <literal>box</literal> property is <literal>"on"</literal>. If
-                        <literal>fill_mode</literal> is <literal>"off"</literal>, the background of the
-                        box is not transparent.
+                    <para>This field contains the color used to display the characters of
+                        the text. Its value should be a color index (relative to the current
+                        colormap).
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>text_box: </term>
+                <term>font_size: </term>
                 <listitem>
-                    <para>A two dimensional vector specifying the size of a rectangle in user coordinates.
-                        The rectangle is used when the text_box_mode property is set to
-                        <emphasis role="bold">'centered'</emphasis> or <emphasis role="bold">'filled'</emphasis>.
+                    <para>It is a scalar specifying the displayed characters size.
+                        If <literal>fractional_font</literal> property is <literal>"off"</literal>
+                        only the integer part of the value is used.
+                        For more information see <link linkend="graphics_fonts">graphics_fonts</link>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>text_box_mode: </term>
+                <term>fractional_font: </term>
                 <listitem>
                     <para>
-                        May have three different value : <emphasis role="bold">'off'</emphasis>,
-                        <emphasis role="bold">'centered'</emphasis> or <emphasis role="bold">'filled'</emphasis>. If <emphasis role="bold">'off'</emphasis>, the
-                        strings are displayed using the given font and the data field
-                        specifies the position of the lower-left point of the text. If
-                        <emphasis role="bold">'centered'</emphasis>, the text is displayed in the middle of the
-                        rectangle whose size is given by text_box. If <emphasis role="bold">'filled'</emphasis> the
-                        font size of the strings will be expanded to fill the rectangle.
+                        This property specify whether text is displayed using fractional font sizes.
+                        Its value must be either <literal>"on"</literal> or <literal>"off"</literal>.
+                        If <literal>"on"</literal> the floating point value of <literal>font_size</literal>
+                        is used for display and the font is anti-aliased. If <literal>"off"</literal>
+                        only the integer part is used and the font is not smoothed.
                     </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>box: </term>
+                <listitem>
                     <para>
-                        When using <emphasis role="bold">'off'</emphasis> or <emphasis role="bold">'centered'</emphasis> modes,
-                        text size remains constant upon zooming. They are the best modes to create annotations
-                        in a graph. On the contrary, when using the <emphasis role="bold">'filled'</emphasis> mode, the text size follow
-                        the graphic scale. It is then possible to zoom upon text objects.
+                        <itemizedlist>
+                            <listitem>
+                                <literal>"on"</literal>: a box is drawn around the block of text,
+                                made of a boxing frame or/and a filling background.
+                            </listitem>
+                            <listitem>"off" (default): no box is drawn.</listitem>
+                        </itemizedlist>
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>auto_dimensionning: </term>
+                <term>line_mode: </term>
                 <listitem>
                     <para>
-                        auto_dimensionning set to "off" is equivalent to text_box_mode set to "filled". If text_box_mode is "off" or "centered" then it implies that auto_dimensionning is "on".
+                        <itemizedlist>
+                            <listitem>
+                                <literal>"on"</literal> : If <literal>.box="on"</literal>, the line
+                                of the box is drawn (frame).
+                            </listitem>
+                            <listitem>
+                                <literal>"off"</literal> : If <literal>.box="on"</literal>, the box
+                                is drawn without surrounding frame (only with its filling color).
+                            </listitem>
+                        </itemizedlist>
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>font_foreground: </term>
+                <term>foreground: </term>
                 <listitem>
-                    <para>This field contains the color used to display the characters of
-                        the text. Its value should be a color index (relative to the current
-                        colormap).
+                    <para>Color index of the line used to draw the edge of the box, when
+                    <literal>.line_mode</literal> is turned on. Its value refers to the current
+                       colormap. <literal>-1</literal> is black (default) and <literal>-2</literal>
+                       is white whatever is the colormap.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>foreground: </term>
+                <term>fill_mode: </term>
                 <listitem>
-                    <para>This field contains the color used to display the line on the edge
-                        of the box. Its value should be a color index (relative to the current
-                        colormap).
+                    <para>
+                        This boolean property allows to draw or not the background of the box
+                        when the <literal>box</literal> property is <literal>"on"</literal>.
+                        If <literal>fill_mode</literal> is <literal>"off"</literal>, the
+                        background of the box is not transparent.
                     </para>
                 </listitem>
             </varlistentry>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>font_size: </term>
+                <term>text_box: </term>
                 <listitem>
-                    <para>It is a scalar specifying the displayed characters size.
-                        If <literal>fractional_font</literal> property is <literal>"off"</literal>
-                        only the integer part of the value is used.
-                        For more information see <link linkend="graphics_fonts">graphics_fonts</link>.
+                    <para>A two dimensional vector specifying the size of a rectangle in user
+                        coordinates. The rectangle is used when the text_box_mode property is set to
+                        <literal>"centered"</literal> or
+                        <literal>"filled"</literal>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>font_style: </term>
+                <term>text_box_mode: </term>
                 <listitem>
-                    <para>Specifies the font used to display the character strings.
-                        This is a positive integer referecing one of the loaded fonts.
-                        Its value must be between 0, referecing the first font,
-                        and the number of loaded fonts minus one, referencing the last font.
-                        For more information see <link linkend="graphics_fonts">graphics_fonts</link>.
+                    <para>
+                        <itemizedlist>
+                            <listitem>
+                            <literal>"off"</literal> : the strings are displayed using the given
+                            font, and <literal>.data</literal> specifies the position of the
+                            lower-left corner of the frame boxing the whole block of text.
+                            </listitem>
+                            <listitem>
+                                <literal>"centered"</literal> : the text is displayed in the middle
+                                of the  rectangle whose size is given by <literal>.text_box</literal>.
+                            </listitem>
+                            <listitem>
+                                <literal>"filled"</literal> : the font size of the strings will be
+                                expanded to fill the rectangle. Zooming updates the font size
+                                accordingly.
+                            </listitem>
+                        </itemizedlist>
                     </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>fractional_font: </term>
-                <listitem>
                     <para>
-                        This property specify whether text is displayed using fractional font sizes.
-                        Its value must be either <literal>"on"</literal> or <literal>"off"</literal>.
-                        If <literal>"on"</literal> the floating point value of <literal>font_size</literal>
-                        is used for display and the font is anti-aliased. If <literal>"off"</literal> only the integer part is used
-                        and the font is not smoothed.
+                        When using the <literal>"off"</literal> or the <literal>"centered"</literal>
+                        modes, the text size remains constant upon zooming. They are the best modes
+                        to create annotations in a graph.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>font_angle: </term>
+                <term>auto_dimensionning: </term>
                 <listitem>
-                    <para>This property determines the orientation of the text string.
-                        Specify value of rotation in degrees.
+                    <para>
+                        auto_dimensionning set to "off" is equivalent to text_box_mode set to "filled".
+                        If text_box_mode is "off" or "centered" then it implies that
+                       auto_dimensionning is "on".
                     </para>
                 </listitem>
             </varlistentry>
@@ -279,7 +315,7 @@ a.axes_visible = 'on' ;
 
 xstring(0.5,0.5,"Scilab is not esilaB",0,0)
 
-t=get("hdl")   //get the handle of the newly created object
+t = gce();   // get the handle of the newly created object
 
 t.font_foreground=6; // change font properties
 t.font_size=5;
@@ -293,11 +329,14 @@ t.text_box_mode = 'centered' ; // the text is now centered on [0.5,0.5].
 t.alignment = 'center' ;
 t.box = 'on' ; // draw a box around the text
 
-// Only valid from Scilab 5.2
-mathml="<mrow>      <mfrac>        <mrow>          <mi>d</mi>          <mi>y</mi>        </mrow>        <mrow>          <mi>d</mi>          <mi>x</mi>        </mrow>      </mfrac>      <mo>=</mo>      <mfrac>        <mn>1</mn>        <msup>          <mi>y</mi>          <mn>2</mn>        </msup>      </mfrac>    </mrow>";
+// Using LaTeX and MathML:
+mathml = "<mrow><mfrac><mrow> <mi>d</mi> <mi>y</mi> </mrow>" + ..
+                      "<mrow> <mi>d</mi> <mi>x</mi> </mrow>" + ..
+               "</mfrac>" + ..
+               "<mo> = </mo>" + ..
+               "<mfrac> <mn>1</mn> <msup><mi>y</mi> <mn>2</mn> </msup> </mfrac>" + ..
+         "</mrow>";
 t.text=["SCILAB","can write LaTeX :","$\frac{abc}{xyz}$";"or","MathML :",mathml] ;
-
-
  ]]></programlisting>
         <scilab:image>
             a=get("current_axes");
@@ -317,13 +356,13 @@ t.text=["SCILAB","can write LaTeX :","$\frac{abc}{xyz}$";"or","MathML :",mathml]
         <title>See also</title>
         <simplelist type="inline">
             <member>
-                <link linkend="set">set</link>
+                <link linkend="xstring">xstring</link>
             </member>
             <member>
-                <link linkend="get">get</link>
+                <link linkend="label_properties">label_properties</link>
             </member>
             <member>
-                <link linkend="delete">delete</link>
+                <link linkend="legend_properties">legend_properties</link>
             </member>
             <member>
                 <link linkend="xtitle">xtitle</link>
@@ -331,6 +370,28 @@ t.text=["SCILAB","can write LaTeX :","$\frac{abc}{xyz}$";"or","MathML :",mathml]
             <member>
                 <link linkend="graphics_entities">graphics_entities</link>
             </member>
+            <member>
+                <link linkend="math_rendering_features_in_graphic">LaTeX or MathML expression</link>
+            </member>
         </simplelist>
     </refsection>
+    <refsection role="history">
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.0</revnumber>
+                <revdescription>
+                  <literal>.text_box</literal>, <literal>.text_box_mode</literal>,
+                  <literal>.alignment</literal>, and <literal>.auto_dimensionning</literal>
+                  properties added.
+                </revdescription>
+            </revision>
+            <revision>
+                <revnumber>5.2</revnumber>
+                <revdescription>
+                    LaTeX and MathML expressions are now supported.
+                </revdescription>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
index 40f2483..3bbba19 100644 (file)
@@ -1,16 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
-
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
-
  * Copyright (C) INRIA - Djalel Abdemouche
-
  * Copyright (C) INRIA - Jean-Baptiste silvy
-
+ * Copyright (C) 2018 - Samuel GOUGEON
  *
-
-
  * Copyright (C) 2012 - 2016 - Scilab Enterprises
  *
  * This file is hereby licensed under the terms of the GNU GPL v2.0,
  * and continues to be available under such terms.
  * For more information, see the COPYING file which you should have received
  * along with this program.
-
  *
-
  -->
-
-<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="ja" xml:id="text_properties">
-
+<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="ja" xml:id="text_properties">
     <refnamediv>
-
         <refname>text_properties</refname>
-
         <refpurpose>Textエンティティプロパティの説明</refpurpose>
-
     </refnamediv>
-
     <refsection>
-
         <title>説明</title>
-
         <para>Textエンティティはグラフィックエンティティ階層の葉です.
-
             このエンティティは文字列描画用のパラメータを定義します.
-
         </para>
-
         <variablelist>
-
             <varlistentry>
-
                 <term>parent: </term>
-
                 <listitem>
-
                     <para>このフィールドには親のハンドルが含まれます.
-
                         textエンティティの親は<literal>"Axes"</literal> 型または
-
                         <literal>"Compound"</literal>型です.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>children: </term>
-
                 <listitem>
-
                     <para>
-
                         このプロパティにはこのハンドルの<literal>children</literal>
-
                         のベクトルが含まれます.
-
                         しかし,現在, textハンドルには<literal>children</literal>がありません.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>visible: </term>
-
                 <listitem>
-
                     <para>
-
                         このフィールドはエンティティの <literal>visible</literal> プロパティを有します.
-
                         この値は, "on" または "off"とします. デフォルトでテキストは可視で,
-
                         このプロパティの値は "on" です. "off" の場合, テキストは画面に表示されません.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>text: </term>
-
                 <listitem>
-
                     <para>オブジェクトの文字列を保持する行列.行列の各行は
-
                         水平に表示され,列は縦方向に表示されます.
-
                     </para>
-
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>data: </term>
+                <listitem>
                     <para>
-
-                        Scilab 5.2以降,<link linkend="math_rendering_features_in_graphic">LaTeX または MathML 式</link>
-
-                        を指定することができます.
-
+                        ベクトル<literal>[x、y、[z]]</literal>は、テキストブロックのピボットの位置を軸のデータ単位で設定します。
+                        デフォルトでは、ピボットはテキストブロックのフレーミングボックスの左下隅に設定されています。
                     </para>
-
+                    <note>
+                        <literal>e = gce(); e.text_box = [0 0]; e.text_box_mode = "centered"</literal>
+                        ピボット上にフレーミングボックスを配置するので、<literal>.data </literal> ポジション。
+                    </note>
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
-                <term>alignment: </term>
-
+                <term>font_angle: </term>
                 <listitem>
-
-                    <para>文字列が列の中で整列される方法を指定します.値には,
-
-                        <emphasis role="bold">'left'</emphasis>,<emphasis role="bold"> 'center' </emphasis>
-
-                        または <emphasis role="bold">'right'</emphasis>を指定します.
-
+                    <para>このプロパティは、ピボットの周りのテキストブロックの向きを設定します。
+                    (0-右)方向から時計回りに回転する(これは間違いなく
+                    フォントの傾きには関係しません)。
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
-                <term>data: </term>
-
+                <term>alignment: </term>
                 <listitem>
-
-                    <para>
-
-                        このフィールドはテキストの原点位置を表すベクトル<literal>[x,y,[z]]</literal>です.単位は,軸(axes)のデータ単位です.
-
+                    <para>文字列が列の中で整列される方法を指定します.値には,
+                        <literal>'left'</literal>, <literal>'center'</literal>
+                        または <literal>'right'</literal> を指定します. すべての列に適用されます。
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
-                <term>box: </term>
-
+                <term>font_style: </term>
                 <listitem>
-
                     <para>
-
-                        このフィールドの値は,<literal>"on"</literal> または
-
-                        <literal>"off"</literal>です. <literal>"on"</literal>の場合,テキストの周囲に縁に線が引かれ,背景を有するボックスが描画されます.
-
+                        文字列の表示に使用されるフォントを指定します.
+                        これはロード済みのフォントの一つを指す正の整数です.
+                        その値は最初のフォントを指す 0 から最後のフォントを指すロード済みの
+                        フォントの数から1を引いた数までとします.
+                        詳細については<link linkend="graphics_fonts">graphics_fonts</link>を参照ください.
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
-                <term>line_mode: </term>
-
+                <term>font_foreground: </term>
                 <listitem>
-
-                    <para>
-
-                        この論理値プロパティにより,<literal>box</literal> プロパティが
-
-                        <literal>"on"</literal>の時にボックスの周囲に線を描画するかどうかを指定できます.
-
-                        <literal>line_mode</literal> が <literal>"off"</literal>の場合,ボックスの線は
-
-                        描画されません.
-
+                    <para>このフィールドはテキストの文字を表示する際に使用される色を
+                        有します.色のインデックスは(カレントのカラーマップに基づく)色インデックス
+                        である必要があります.
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
-                <term>fill_mode: </term>
-
+                <term>font_size: </term>
                 <listitem>
-
                     <para>
-
-                        この論理値プロパティにより,<literal>box</literal> プロパティが
-
-                        <literal>"on"</literal>の時にボックスの背景を塗りつぶすかどうかを指定できます.
-
-                        <literal>fill_mode</literal> が <literal>"off"</literal>の場合,
-
-                        ボックスの背景は透明ではありません..
-
+                        表示される文字の大きさを指定するスカラー値です.
+                        <literal>fractional_font</literal>プロファイルが <literal>"off"</literal>の場合,
+                        値の整数部のみが使用されます.
+                        詳細については<link linkend="graphics_fonts">graphics_fonts</link>を参照ください.
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
-                <term>text_box: </term>
-
+                <term>fractional_font: </term>
                 <listitem>
-
-                    <para>ユーザ座標で矩形の大きさを指定する2次元ベクトル.
-
-                        この矩形は,text_box_mode プロパティが
-
-                        <emphasis role="bold">'centered'</emphasis> または <emphasis role="bold">'filled'</emphasis>
-
-                        に設定されている時に使用されます.
-
+                    <para>このプロパティはテキストを分数のフォントサイズにより表示するかどうかを
+                        指定します.この値には,<literal>"on"</literal> または <literal>"off"</literal>を指定します.
+                        <literal>"on"</literal> の場合,<literal>font_size</literal>の浮動小数点の値が
+                        表示の際に使用され,フォントはアンチエイリアス処理されます.
+                        <literal>"off"</literal> の場合,整数部のみが使用され,フォントは平滑化されません.
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
-                <term>text_box_mode: </term>
-
+                <term>box: </term>
                 <listitem>
-
                     <para>
-
-                        以下の3種類の値をとる可能性があります : <emphasis role="bold">'off'</emphasis>,
-
-                        <emphasis role="bold">'centered'</emphasis> または <emphasis role="bold">'filled'</emphasis>.
-
-                        <emphasis role="bold">'off'</emphasis>の場合,
-
-                        文字列は指令したフォントで表示され,
-
-                        dataフィールドはテキストの左下の点の位置を指定します.
-
-                        <emphasis role="bold">'centered'</emphasis>の場合, テキストは
-
-                        大きさがtext_boxで指定された矩形の中心に表示されます.
-
-                        <emphasis role="bold">'filled'</emphasis>の場合,
-
-                        文字列のフォントの大きさは矩形を塗りつぶすように拡大されます.
-
-                    </para>
-
-                    <para>
-
-                        <emphasis role="bold">'off'</emphasis>または<emphasis role="bold">'centered'</emphasis>モードを
-
-                        使用する場合,テキストの大きさはズームの際にも一定となります.
-
-                        これらはグラフの注記を作成する際には最適のモードです.
-
-                        逆に<emphasis role="bold">'filled'</emphasis>モードを使用した場合,
-
-                        テキストの大きさはグラフィックの縮尺に依存します.
-
-                        この場合,テキストオブジェクトをズームすることが可能です.
-
+                        このフィールドの値は,<literal>"on"</literal> または
+                        <literal>"off"</literal>です. <literal>"on"</literal>の場合,テキストの周囲に縁に線が引かれ,背景を有するボックスが描画されます.
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
-                <term>auto_dimensionning: </term>
-
+                <term>line_mode: </term>
                 <listitem>
-
                     <para>
-
-                        auto_dimensionning を "off" にすることは,
-
-                        text_box_mode を "filled" にすることと等価です.
-
-                        text_box_mode が "off" または "centered" の場合,
-
-                        auto_dimensionning は "on" となります.
-
+                        この論理値プロパティにより,<literal>box</literal> プロパティが
+                        <literal>"on"</literal>の時にボックスの周囲に線を描画するかどうかを指定できます.
+                        <literal>line_mode</literal> が <literal>"off"</literal>の場合,ボックスの線は
+                        描画されません.
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
-                <term>font_foreground: </term>
-
+                <term>foreground: </term>
                 <listitem>
-
-                    <para>このフィールドはテキストの文字を表示する際に使用される色を
-
-                        有します.色のインデックスは(カレントのカラーマップに基づく)色インデックス
-
+                    <para>このフィールドはボックスの周りに線を表示する際に使用される色を
+                        有します.この値は(カレントのカラーマップに基づく)色インデックス
                         である必要があります.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
-                <term>foreground: </term>
-
+                <term>fill_mode: </term>
                 <listitem>
-
-                    <para>このフィールドはボックスの周りに線を表示する際に使用される色を
-
-                        有します.この値は(カレントのカラーマップに基づく)色インデックス
-
-                        である必要があります.
-
+                    <para>
+                        この論理値プロパティにより,<literal>box</literal> プロパティが
+                        <literal>"on"</literal>の時にボックスの背景を塗りつぶすかどうかを指定できます.
+                        <literal>fill_mode</literal> が <literal>"off"</literal>の場合,
+                        ボックスの背景は透明ではありません..
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>background: </term>
-
                 <listitem>
-
                     <para>このフィールドはボックスを塗る際に使用される色を
-
                         有します.この値は(カレントのカラーマップに基づく)色インデックス
-
                         である必要があります.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
-                <term>font_size: </term>
-
+                <term>text_box: </term>
                 <listitem>
-
-                    <para>
-
-                        表示される文字の大きさを指定するスカラー値です.
-
-                        <literal>fractional_font</literal>プロファイルが <literal>"off"</literal>の場合,
-
-                        値の整数部のみが使用されます.
-
-                        詳細については<link linkend="graphics_fonts">graphics_fonts</link>を参照ください.
-
+                    <para>ユーザ座標で矩形の大きさを指定する2次元ベクトル.
+                        この矩形は,text_box_mode プロパティが
+                        <literal>'centered'</literal> または <literal>'filled'</literal>
+                        に設定されている時に使用されます.
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
-                <term>font_style: </term>
-
+                <term>text_box_mode: </term>
                 <listitem>
-
                     <para>
-
-                        文字列の表示に使用されるフォントを指定します.
-
-                        これはロード済みのフォントの一つを指す正の整数です.
-
-                        その値は最初のフォントを指す 0 から最後のフォントを指すロード済みの
-
-                        フォントの数から1を引いた数までとします.
-
-                        詳細については<link linkend="graphics_fonts">graphics_fonts</link>を参照ください.
-
+                        以下の3種類の値をとる可能性があります : <literal>'off'</literal>,
+                        <literal>'centered'</literal> または <literal>'filled'</literal>.
+                        <literal>'off'</literal>の場合,
+                        文字列は指令したフォントで表示され,
+                        dataフィールドはテキストの左下の点の位置を指定します.
+                        <literal>'centered'</literal>の場合, テキストは
+                        大きさがtext_boxで指定された矩形の中心に表示されます.
+                        <literal>'filled'</literal>の場合,
+                        文字列のフォントの大きさは矩形を塗りつぶすように拡大されます.
                     </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>fractional_font: </term>
-
-                <listitem>
-
-                    <para>このプロパティはテキストを分数のフォントサイズにより表示するかどうかを
-
-                        指定します.この値には,<literal>"on"</literal> または <literal>"off"</literal>を指定します.
-
-                        <literal>"on"</literal> の場合,<literal>font_size</literal>の浮動小数点の値が
-
-                        表示の際に使用され,フォントはアンチエイリアス処理されます.
-
-                        <literal>"off"</literal> の場合,整数部のみが使用され,フォントは平滑化されません.
-
+                    <para>
+                        <literal>'off'</literal>または<literal>'centered'</literal>モードを
+                        使用する場合,テキストの大きさはズームの際にも一定となります.
+                        これらはグラフの注記を作成する際には最適のモードです.
+                        逆に<literal>'filled'</literal>モードを使用した場合,
+                        テキストの大きさはグラフィックの縮尺に依存します.
+                        この場合,テキストオブジェクトをズームすることが可能です.
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
-                <term>font_angle: </term>
-
+                <term>auto_dimensionning: </term>
                 <listitem>
-
-                    <para>このプロパティはテキスト文字列の向きを定義します.
-
-                        回転角(単位:度)の値を指定してください.
-
+                    <para>
+                        auto_dimensionning を "off" にすることは,
+                        text_box_mode を "filled" にすることと等価です.
+                        text_box_mode が "off" または "centered" の場合,
+                        auto_dimensionning は "on" となります.
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>clip_state: </term>
-
                 <listitem>
-
                     <para>このフィールドは,テキストに関する
-
                         <literal>clip_state</literal>プロパティの値を有します.
-
                         値は以下となります :
-
                     </para>
-
                     <itemizedlist>
-
                         <listitem>
-
                             <para>
-
                                 <literal>"off"</literal>
-
                                 テキストはクリップされません.
-
                             </para>
-
                         </listitem>
-
                         <listitem>
-
                             <para>
-
                                 <literal>"clipgrf"</literal>
-
                                 テキストはAxesボックスの外側でクリップされます.
-
                             </para>
-
                         </listitem>
-
                         <listitem>
-
                             <para>
-
                                 <literal>"on"</literal>
-
                                 テキストは<literal>clip_box</literal>プロパティで指定される
-
                                 矩形の外側でクリップされます.
-
                             </para>
-
                         </listitem>
-
                     </itemizedlist>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>clip_box: </term>
-
                 <listitem>
-
                     <para>
-
                         このフィールドは
-
                         <literal>clip_box</literal>プロパティを有します.
-
                         この値はclip_state が"off"の場合,空の行列となります.
-
                         その他の場合,ベクトル<literal>[x,y,w,h]</literal> (左上の点,幅,高さ)により
-
                         クリップ領域が指定されます.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>user_data: </term>
-
                 <listitem>
-
                     <para>このフィールドは任意のScilab変数をtextデータ構造体に保存し,
-
                         復元する際に使用できます.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
         </variablelist>
-
     </refsection>
-
     <refsection>
-
         <title>例</title>
-
         <programlisting role="example"><![CDATA[
-
-a=get("current_axes");
-
-a.data_bounds=[0,0;1,1];
-
+a = get("current_axes");
+a.data_bounds = [0,0;1,1];
 a.axes_visible = 'on' ;
 
-
-
 xstring(0.5,0.5,"Scilab is not esilaB",0,0)
 
-
-
-t=get("hdl")   //新規に作成されたオブジェクトのハンドルを取得
-
-
-
-t.font_foreground=6; // フォントプロパティを変更
-
-t.font_size=5;
-
-t.font_style=5;
-
-
-
-
-
-t.text=["SCILAB","is";"not","esilaB"] ; // テキストを変更
-
-t.font_angle=90 ; // turn the strings
-
+t = gce()   //新規に作成されたオブジェクトのハンドルを取得
+t.font_foreground = 6; // フォントプロパティを変更
+t.font_size  = 5;
+t.font_style = 5;
+t.text = ["SCILAB","is";"not","esilaB"] ; // テキストを変更
+t.font_angle = 90 ; // turn the strings
 t.text_box = [0,0] ;
-
 t.text_box_mode = 'centered' ; // テキストの中心を [0.5,0.5]に設定.
-
 t.alignment = 'center' ;
-
 t.box = 'on' ; // テキストの周囲にボックスを描画
 
-
-
-//  Scilab 5.2以降でのみ有効
-
-mathml="<mrow>      <mfrac>        <mrow>          <mi>d</mi>          <mi>y</mi>        </mrow>        <mrow>          <mi>d</mi>          <mi>x</mi>        </mrow>      </mfrac>      <mo>=</mo>      <mfrac>        <mn>1</mn>        <msup>          <mi>y</mi>          <mn>2</mn>        </msup>      </mfrac>    </mrow>";
-
-t.text=["SCILAB","can write LaTeX :","$\frac{abc}{xyz}$";"or","MathML :",mathml] ;
-
-
-
-
-
+// Using LaTeX and MathML:
+mathml = "<mrow><mfrac><mrow> <mi>d</mi> <mi>y</mi> </mrow>" + ..
+                      "<mrow> <mi>d</mi> <mi>x</mi> </mrow>" + ..
+               "</mfrac>" + ..
+               "<mo> = </mo>" + ..
+               "<mfrac> <mn>1</mn> <msup><mi>y</mi> <mn>2</mn> </msup> </mfrac>" + ..
+         "</mrow>";
+t.text = ["SCILAB","can write LaTeX :","$\frac{abc}{xyz}$";"or","MathML :",mathml] ;
  ]]></programlisting>
-
         <scilab:image>
-
             a=get("current_axes");
-
             a.data_bounds=[0,0;1,1];
-
             a.axes_visible = 'on' ;
-
-
-
             xstring(0,0,"Scilab is not esilaB",0,0)
-
-
-
             t=get("hdl")
-
-
-
             t.font_foreground=6;
-
             t.font_size=5;
-
             t.font_style=5;
-
         </scilab:image>
-
     </refsection>
-
     <refsection role="see also">
-
         <title>参照</title>
-
         <simplelist type="inline">
-
             <member>
-
-                <link linkend="set">set</link>
-
+                <link linkend="xstring">xstring</link>
             </member>
-
             <member>
-
-                <link linkend="get">get</link>
-
+                <link linkend="label_properties">label_properties</link>
             </member>
-
             <member>
-
-                <link linkend="delete">delete</link>
-
+                <link linkend="legend_properties">legend_properties</link>
             </member>
-
             <member>
-
                 <link linkend="xtitle">xtitle</link>
-
             </member>
-
             <member>
-
                 <link linkend="graphics_entities">graphics_entities</link>
-
             </member>
-
+            <member>
+                <link linkend="math_rendering_features_in_graphic">LaTeX or MathML expression</link>
+            </member>
         </simplelist>
-
     </refsection>
-
-</refentry>
-
+    <refsection role="history">
+        <title>履歴</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.0</revnumber>
+                <revdescription>
+                  <literal>.text_box</literal>, <literal>.text_box_mode</literal>,
+                  <literal>.alignment</literal>, and <literal>.auto_dimensionning</literal>
+                  properties added.
+                </revdescription>
+            </revision>
+            <revision>
+                <revnumber>5.2</revnumber>
+                <revdescription>
+                    LaTeX and MathML expressions are now supported.
+                </revdescription>
+            </revision>
+        </revhistory>
+    </refsection>
+</refentry>
\ No newline at end of file