* Bugs 16071+16072+16075 fixed: prettyprint() debugged & a bit improved
[scilab.git] / scilab / modules / string / help / ja_JP / prettyprint.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  *
4  * This help file was generated from prettyprint.sci using help_from_sci().
5  *
6  -->
7 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
8           xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml"
9           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
10           xmlns:scilab="http://www.scilab.org" xml:id="prettyprint" xml:lang="ja">
11     <refnamediv>
12         <refname>prettyprint</refname>
13         <refpurpose>Scilabデータ型からTeX, LaTeXまたはMathML形式の出力を得る</refpurpose>
14     </refnamediv>
15     <refsynopsisdiv>
16         <title>呼び出し手順</title>
17         <synopsis>
18             str = prettyprint(a) // デフォルト形式 (LaTeX)で変数を表示
19             str = prettyprint(a, exportFormat) // 指定された形式で変数を表示
20             str = prettyprint(a, exportFormat, delim) // 上と同様ですが,デリミタを変更
21             str = prettyprint(a, exportFormat, delim, processByElement) // 上と同様ですが,各要素を独立に処理
22             str = prettyprint(a, exportFormat, delim, processByElement, isWrapped) // 上と同様ですが,TeXまたはLaTeXエクスポートのspecialキーワードを追加
23         </synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Pパラメータ</title>
27         <variablelist>
28             <varlistentry>
29                 <term>a</term>
30                 <listitem>
31                     <para>a Scilab object.
32                         <itemizedlist>
33                             <listitem>
34                                 Supported types: booleans, encoded integers, real or complex numbers,
35                                 polynomials and rationals with real or complex coefficients, texts,
36                                 cells, linear dynamical systems (as generated with syslin()),
37                                 other Tlists.
38                             </listitem>
39                             <listitem>
40                                 Supported sizes: scalar, vector, matrix. Hypermatrices are
41                                 not supported (only the first page is processed.)
42                             </listitem>
43                         </itemizedlist>
44                     </para>
45                 </listitem>
46             </varlistentry>
47             <varlistentry>
48                 <term>exportFormat</term>
49                 <listitem>
50                     <para>出力形式で,省略された場合はデフォルトで'latex'が使用されます.
51                         'latex', 'tex' または 'mathml'とすることができます. It is case-insensitive.
52                     </para>
53                 </listitem>
54             </varlistentry>
55             <varlistentry>
56                 <term>delimiter</term>
57                 <listitem>
58                     <para> 結果の行列で使用されるデリミタを示す文字列で,
59                         isWrappedがtrueの場合にみ使用されます.
60                         It can be '(' (default), '{', '[', '|', '||', or '' if no bracketting
61                         is required.
62                     </para>
63                 </listitem>
64             </varlistentry>
65             <varlistentry>
66                 <term>processByElement</term>
67                 <listitem>
68                     <para> 結果の行列が一つの文字列に変換されるかどうかを設定する論理値.</para>
69                 </listitem>
70             </varlistentry>
71             <varlistentry>
72                 <term>isWrapped</term>
73                 <listitem>
74                     <para>xstring または xtitleで使用される際,
75                         結果がデリミタ(latexおよびtexの場合は'$',mathmlの場合はなし)で
76                         括られるかどうかを設定する論理値.
77                     </para>
78                 </listitem>
79             </varlistentry>
80             <varlistentry>
81                 <term>str</term>
82                 <listitem>
83                     <para>変数aの表現</para>
84                 </listitem>
85             </varlistentry>
86         </variablelist>
87     </refsection>
88     <refsection>
89         <title>説明</title>
90         <para>
91             変数を指定すると,
92             prettyprint 関数はこれを整形した結果を出力します.
93             形式はTeX, LaTeX または MathMLです.
94             これらはサードパーティアプリケーションだけでなく,
95             Scilab内でも多くの
96             <link linkend="math_rendering_features_in_graphic">Scilabグラフィック機能</link>で
97             使用できます.
98         </para>
99     </refsection>
100     <refsection>
101         <title>例</title>
102         <programlisting role="example"><![CDATA[
103 str = prettyprint(rand(3,3)) // 3x3 行列のLaTeX表現を返す
104 xstring(0.2,0.2,str) // グラフィックウインドウに表示
105 prettyprint(rand(3,4),"mathml") // 3x4行列のMathML表現を返す
106 prettyprint(rand(3,4),"mathml","[") // 3x4行列のMathML表現を'['をデリミタとして 返す
107 s=poly(0,'s'); G=[1,s;1+s^2,3*s^3];
108 xstring(0.2,0.2,prettyprint(G*s-1)); // LaTeX表現により多項式を表示
109  ]]></programlisting>
110     </refsection>
111     <refsection role="see also">
112         <title>参照</title>
113         <simplelist type="inline">
114             <member>
115                 <link linkend="math_rendering_features_in_graphic">math_rendering_features_in_graphic</link>
116             </member>
117             <member>
118                 <link linkend="xnumb">xnumb</link>
119             </member>
120             <member>
121                 <link linkend="string">string</link>
122             </member>
123             <member>
124                 <link linkend="pol2str">pol2str</link>
125             </member>
126             <member>
127                 <link linkend="msprintf">msprintf</link>
128             </member>
129             <member>
130                 <link linkend="uicontrol">uicontrol(table)</link>
131             </member>
132             <member>
133                 <link linkend="sci2exp">sci2exp</link>
134             </member>
135         </simplelist>
136     </refsection>
137     <refsection role="history">
138         <title>履歴</title>
139         <revhistory>
140             <revision>
141                 <revnumber>5.2.0</revnumber>
142                 <revdescription>
143                     Function introduced.
144                 </revdescription>
145             </revision>
146         </revhistory>
147     </refsection>
148 </refentry>