help: create a colormaps subsection
[scilab.git] / scilab / modules / graphics / help / en_US / color_management / colormaps / whitecolormap.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 - Serge Steer
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <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="whitecolormap">
17     <refnamediv>
18         <refname>whitecolormap</refname>
19         <refpurpose>completely white colormap</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>cmap=whitecolormap(n)</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Arguments</title>
27         <variablelist>
28             <varlistentry>
29                 <term>n</term>
30                 <listitem>
31                     <para>integer &gt;= 3, the colormap size.</para>
32                 </listitem>
33             </varlistentry>
34             <varlistentry>
35                 <term>cmap</term>
36                 <listitem>
37                     <para>
38                         matrix with 3 columns <literal>[R,G,B]</literal>.
39                     </para>
40                 </listitem>
41             </varlistentry>
42         </variablelist>
43     </refsection>
44     <refsection>
45         <title>Description</title>
46         <para>This colormap is completely white</para>
47     </refsection>
48     <refsection>
49         <title>Examples</title>
50         <programlisting role="example"><![CDATA[ 
51 f = scf();
52 plot3d1();
53 f.color_map = whitecolormap(32);
54  ]]></programlisting>
55         <scilab:image> 
56             f = scf();
57             plot3d1();
58             f.color_map = whitecolormap(32);
59         </scilab:image>
60     </refsection>
61     <refsection role="see also">
62         <title>See also</title>
63         <simplelist type="inline">
64             <member>
65                 <link linkend="colormap">colormap</link>
66             </member>
67             <member>
68                 <link linkend="autumncolormap">autumncolormap</link>
69             </member>
70             <member>
71                 <link linkend="bonecolormap">bonecolormap</link>
72             </member>
73             <member>
74                 <link linkend="coolcolormap">coolcolormap</link>
75             </member>
76             <member>
77                 <link linkend="coppercolormap">coppercolormap</link>
78             </member>
79             <member>
80                 <link linkend="graycolormap">graycolormap</link>
81             </member>
82             <member>
83                 <link linkend="hotcolormap">hotcolormap</link>
84             </member>
85             <member>
86                 <link linkend="hsvcolormap">hsvcolormap</link>
87             </member>
88             <member>
89                 <link linkend="jetcolormap">jetcolormap</link>
90             </member>
91             <member>
92                 <link linkend="oceancolormap">oceancolormap</link>
93             </member>
94             <member>
95                 <link linkend="parulacolormap">parulacolormap</link>
96             </member>
97             <member>
98                 <link linkend="pinkcolormap">pinkcolormap</link>
99             </member>
100             <member>
101                 <link linkend="rainbowcolormap">rainbowcolormap</link>
102             </member>
103             <member>
104                 <link linkend="springcolormap">springcolormap</link>
105             </member>
106             <member>
107                 <link linkend="summercolormap">summercolormap</link>
108             </member>
109             <member>
110                 <link linkend="wintercolormap">wintercolormap</link>
111             </member>
112         </simplelist>
113     </refsection>
114 </refentry>