Massive indent of all codes:
[scilab.git] / scilab / modules / graphics / help / en_US / color_management / name2rgb.xml
1     <?xml version="1.0" encoding="UTF-8"?>
2     <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13     <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">
14         <refnamediv>
15             <refname>name2rgb</refname>
16             <refpurpose>returns the RGB values of a named color</refpurpose>
17         </refnamediv>
18         <refsynopsisdiv>
19             <title>Calling Sequence</title>
20             <synopsis>rgb=name2rgb(name)</synopsis>
21         </refsynopsisdiv>
22         <refsection>
23             <title>Arguments</title>
24             <variablelist>
25                 <varlistentry>
26                     <term>name</term>
27                     <listitem>
28                         <para>name of the color.</para>
29                     </listitem>
30                 </varlistentry>
31                 <varlistentry>
32                     <term>rgb</term>
33                     <listitem>
34                         <para>vector of RGB integer values of a color.</para>
35                     </listitem>
36                 </varlistentry>
37             </variablelist>
38         </refsection>
39         <refsection>
40             <title>Description</title>
41             <para>
42                 <literal>name2rgb</literal> returns the RGB values of a color given by its name. The result is
43                 a vector <literal>[r,g,b]</literal> where <literal>r</literal>, <literal>g</literal> and <literal>b</literal> are integers between 0 and 255
44                 corresponding to colors components red, green and blue. As usual 0 means no intensity and 
45                 255 means all the intensity of the color.
46             </para>
47             <para>
48                 If no color is found <literal>[]</literal> is returned.
49             </para>
50             <para>
51                 The list of all known colors is given by <link linkend="color_list">color_list</link>.
52             </para>
53         </refsection>
54         <refsection>
55             <title>Examples</title>
56             <programlisting role="example"><![CDATA[ 
57 rgb=name2rgb("gold")
58 rgb2name(rgb)
59  ]]></programlisting>
60         </refsection>
61         <refsection role="see also">
62             <title>See Also</title>
63             <simplelist type="inline">
64                 <member>
65                     <link linkend="color">color</link>
66                 </member>
67                 <member>
68                     <link linkend="color_list">color_list</link>
69                 </member>
70                 <member>
71                     <link linkend="rgb2name">rgb2name</link>
72                 </member>
73             </simplelist>
74         </refsection>
75     </refentry>