0702e60279fdb452d715010398b2ef68a7b1d76b
[scilab.git] / scilab / modules / core / help / en_US / variables / names.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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="names">
3     <refnamediv>
4         <refname>names</refname>
5         <refpurpose>Scilab names syntax</refpurpose>
6     </refnamediv>
7     <refsection>
8         <title>Description</title><para>
9             Names of variables and functions must begin with a letter or one of
10             the following special characters  '<literal>%</literal>', '<literal>_</literal>', '<literal>#</literal>', '<literal>!</literal>', '<literal>$</literal>', '<literal>?</literal>'.
11         </para>
12         <para>
13             Next characters may be letters or digits or any special character in '<literal>_</literal>',
14             '<literal>#</literal>', '<literal>!</literal>', '<literal>$</literal>', '<literal>?</literal>'.
15         </para>
16         <para>
17         </para>
18         Upper and lower case letters are different.
19         <para>
20             Names may be as long as you want but only the first 24 characters are
21             taken into account. If you exceed this limit you get a warning. Please note that this limitation will be fixed with the release of Scilab 6.
22         </para>
23     </refsection>
24     <refsection>
25         <title>Examples</title>
26         <programlisting role="example"><![CDATA[
27 //Valid names
28 %eps
29 A1=123
30 #Color=8
31 My_Special_Color_Table=rand(10,3)
32 //Non valid names
33 //1A , b%, .C
34
35 // Long names
36 Try_to_use_a_long_name = 1 // long, but not too
37 Try_to_use_a_too_long_name = 1 // too long
38
39 // let we insert a second variable with similar long name...
40 Try_to_use_a_too_long_name2 = 2
41
42 // ... and see the value of first variable
43 disp(Try_to_use_a_too_long_name)
44 // Please note that this limitation will be fixed with the release of Scilab 6.
45  ]]></programlisting>
46     </refsection>
47 </refentry>