Bug Fix #14415 - Corrected some spellings error in help pages
[scilab.git] / scilab / modules / compatibility_functions / help / en_US / mtlb_box.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) 2004-2007 - INRIA - Vincent COUVERT
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="mtlb_box">
17     <refnamediv>
18         <refname>mtlb_box</refname>
19         <refpurpose>Matlab box emulation function</refpurpose>
20     </refnamediv>
21     <refsection>
22         <title>Description</title>
23         <para>
24             There is no Scilab equivalent function for Matlab <literal>box</literal> but it can be easily replaced.
25         </para>
26         <para>
27             The function <literal>mtlb_box([axes_handle[,val]])</literal> is used by
28             <literal>mfile2sci</literal> to replace <literal>box([axes_handle[,va]]l)</literal> when it was not
29             possible to know what were the inputs while porting Matlab code to Scilab. This function will
30             determine the correct semantic at run time. If you want to have a
31             more efficient code it is possible to replace <literal>mtlb_box</literal> calls:
32         </para>
33         <itemizedlist>
34             <listitem>
35                 <para>
36                     When called without input parameters,
37                     <literal>mtlb_box()</literal> may be replaced by <literal>a=gca();if a.box=="on" then a.box="off";else a.box="on";end;</literal>
38                 </para>
39             </listitem>
40             <listitem>
41                 <para>
42                     If <literal>axes_handle</literal> is a character string,
43                     <literal>mtlb_box(axes_handle)</literal> may be replaced by <literal>a=gca();a.box=convstr(axes_handle,"l");</literal>
44                 </para>
45             </listitem>
46             <listitem>
47                 <para>
48                     If <literal>axes_handle</literal> is a graphic handle
49                     <literal>mtlb_box(axes_handle)</literal> may be replaced by
50                     <literal>if axes_handle.box=="on" then axes_handle.box="off";else axes_handle.box="on";end;</literal>
51                 </para>
52             </listitem>
53             <listitem>
54                 <para>
55                     If <literal>axes_handle</literal> is a graphic handle and <literal>val</literal> is a character string
56                     <literal>mtlb_box(axes_handle,val)</literal> may be replaced by <literal>axes_handle.box=convstr(val,"l");</literal>
57                 </para>
58             </listitem>
59         </itemizedlist>
60         <para>
61             <warning>
62                 Caution: <literal>mtlb_box</literal> has not to be used for hand coded functions.
63             </warning>
64         </para>
65     </refsection>
66     <refsection role="see also">
67         <title>See Also</title>
68         <simplelist type="inline">
69             <member>
70                 <link linkend="axes_properties">axes_properties</link>
71             </member>
72         </simplelist>
73     </refsection>
74 </refentry>