Add role in the 'see also' section in the help page
[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" version="5.0-subset Scilab" xml:lang="en" xml:id="name2rgb">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>name2rgb</refname>
19     <refpurpose> returns the RGB values of a named color</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>rgb=name2rgb(name)</synopsis>
24   </refsynopsisdiv>
25   <refsection>
26     <title>Arguments</title>
27     <variablelist>
28       <varlistentry>
29         <term>name</term>
30         <listitem>
31           <para>name of the color.</para>
32         </listitem>
33       </varlistentry>
34       <varlistentry>
35         <term>rgb</term>
36         <listitem>
37           <para>vector of RGB integer values of a color.</para>
38         </listitem>
39       </varlistentry>
40     </variablelist>
41   </refsection>
42   <refsection>
43     <title>Description</title>
44     <para><literal>name2rgb</literal> returns the RGB values of a color given by its name. The result is
45     a vector <literal>[r,g,b]</literal> where <literal>r</literal>, <literal>g</literal> and <literal>b</literal> are integers between 0 and 255
46     corresponding to colors components red, green and blue. As usual 0 means no intensity and 
47     255 means all the intensity of the color.
48     </para>
49     <para> If no color is found <literal>[]</literal> is returned.</para>
50     <para> The list of all known colors is given by <link linkend="color_list">color_list</link>.</para>
51   </refsection>
52   <refsection>
53     <title>Examples</title>
54     <programlisting role="example"><![CDATA[ 
55 rgb=name2rgb("gold")
56 rgb2name(rgb)
57  ]]></programlisting>
58   </refsection>
59   <refsection role="see also">
60 <title>See Also</title>
61     <simplelist type="inline">
62       <member>
63         <link linkend="color">color</link>
64       </member>
65       <member>
66         <link linkend="color_list">color_list</link>
67       </member>
68       <member>
69         <link linkend="rgb2name">rgb2name</link>
70       </member>
71     </simplelist>
72   </refsection>
73 </refentry>