update japanese translation of core module.
[scilab.git] / scilab / modules / graphics / help / en_US / color_management / name2rgb.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <<<<<<< HEAD
3 <!--
4  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
5  * Copyright (C) INRIA
6  * 
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at    
11  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
12  *
13  -->
14 <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="name2rgb">
15     <refnamediv>
16         <refname>name2rgb</refname>
17         <refpurpose>returns the RGB values of a named color</refpurpose>
18     </refnamediv>
19     <refsynopsisdiv>
20         <title>Calling Sequence</title>
21         <synopsis>rgb=name2rgb(name)</synopsis>
22     </refsynopsisdiv>
23     <refsection>
24         <title>Arguments</title>
25         <variablelist>
26             <varlistentry>
27                 <term>name</term>
28                 <listitem>
29                     <para>name of the color.</para>
30                 </listitem>
31             </varlistentry>
32             <varlistentry>
33                 <term>rgb</term>
34                 <listitem>
35                     <para>vector of RGB integer values of a color.</para>
36                 </listitem>
37             </varlistentry>
38         </variablelist>
39     </refsection>
40     <refsection>
41         <title>Description</title>
42         <para>
43             <literal>name2rgb</literal> returns the RGB values of a color given by its name. The result is
44             a vector <literal>[r,g,b]</literal> where <literal>r</literal>, <literal>g</literal> and <literal>b</literal> are integers between 0 and 255
45             corresponding to colors components red, green and blue. As usual 0 means no intensity and 
46             255 means all the intensity of the color.
47         </para>
48         <para>
49             If no color is found <literal>[]</literal> is returned.
50         </para>
51         <para>
52             The list of all known colors is given by <link linkend="color_list">color_list</link>.
53         </para>
54     </refsection>
55     <refsection>
56         <title>Examples</title>
57         <programlisting role="example"><![CDATA[ 
58 rgb=name2rgb("gold")
59 rgb2name(rgb)
60  ]]></programlisting>
61     </refsection>
62     <refsection role="see also">
63         <title>See Also</title>
64         <simplelist type="inline">
65             <member>
66                 <link linkend="color">color</link>
67             </member>
68             <member>
69                 <link linkend="color_list">color_list</link>
70             </member>
71             <member>
72                 <link linkend="rgb2name">rgb2name</link>
73             </member>
74         </simplelist>
75     </refsection>
76 </refentry>
77 =======
78
79 <!--\r
80  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab\r
81  * Copyright (C) INRIA\r
82  * \r
83  * This file must be used under the terms of the CeCILL.\r
84  * This source file is licensed as described in the file COPYING, which\r
85  * you should have received as part of this distribution.  The terms\r
86  * are also available at    \r
87  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt\r
88  *\r
89  -->
90
91 <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="name2rgb">
92     
93     <refnamediv>
94         
95         <refname>name2rgb</refname>
96         
97         <refpurpose>returns the RGB values of a named color</refpurpose>
98         
99     </refnamediv>
100     
101     <refsynopsisdiv>
102         
103         <title>Calling Sequence</title>
104         
105         <synopsis>rgb=name2rgb(name)</synopsis>
106         
107     </refsynopsisdiv>
108     
109     <refsection>
110         
111         <title>Arguments</title>
112         
113         <variablelist>
114             
115             <varlistentry>
116                 
117                 <term>name</term>
118                 
119                 <listitem>
120                     
121                     <para>name of the color.</para>
122                     
123                 </listitem>
124                 
125             </varlistentry>
126             
127             <varlistentry>
128                 
129                 <term>rgb</term>
130                 
131                 <listitem>
132                     
133                     <para>vector of RGB integer values of a color.</para>
134                     
135                 </listitem>
136                 
137             </varlistentry>
138             
139         </variablelist>
140         
141     </refsection>
142     
143     <refsection>
144         
145         <title>Description</title>
146         
147         <para>
148             
149             <literal>name2rgb</literal> returns the RGB values of a color given by its name. The result is
150             
151             a vector <literal>[r,g,b]</literal> where <literal>r</literal>, <literal>g</literal> and <literal>b</literal> are integers between 0 and 255
152             
153             corresponding to colors components red, green and blue. As usual 0 means no intensity and 
154             
155             255 means all the intensity of the color.
156             
157         </para>
158         
159         <para>
160             
161             If no color is found <literal>[]</literal> is returned.
162             
163         </para>
164         
165         <para>
166             
167             The list of all known colors is given by <link linkend="color_list">color_list</link>.
168             
169         </para>
170         
171     </refsection>
172     
173     <refsection>
174         
175         <title>Examples</title>
176         
177         <programlisting role="example"><![CDATA[ \r
178 rgb=name2rgb("gold")\r
179 rgb2name(rgb)\r
180  ]]></programlisting>
181         
182     </refsection>
183     
184     <refsection role="see also">
185         
186         <title>See Also</title>
187         
188         <simplelist type="inline">
189             
190             <member>
191                 
192                 <link linkend="color">color</link>
193                 
194             </member>
195             
196             <member>
197                 
198                 <link linkend="color_list">color_list</link>
199                 
200             </member>
201             
202             <member>
203                 
204                 <link linkend="rgb2name">rgb2name</link>
205                 
206             </member>
207             
208         </simplelist>
209         
210     </refsection>
211     
212 </refentry>
213
214 >>>>>>> 51f831b... update japanese translation of core module.