6686167e768309b794de66487f93b78ee09cd57b
[scilab.git] / scilab / modules / core / help / en_US / configuration / with_texmacs.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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="with_texmacs" xml:lang="en">
3     <refnamediv>
4         <refname>with_texmacs</refname>
5         <refpurpose>
6             Checks if Scilab has been called by texmacs. <emphasis role="bold">This function is obsolete.</emphasis> 
7         </refpurpose>
8     </refnamediv>
9     <refsynopsisdiv>
10         <title>Calling Sequence</title>
11         <synopsis>r = with_texmacs()</synopsis>
12     </refsynopsisdiv>
13     <refsection>
14         <title>Arguments</title>
15         <variablelist>
16             <varlistentry>
17                 <term>r</term>
18                 <listitem>
19                     <para>a boolean</para>
20                 </listitem>
21             </varlistentry>
22         </variablelist>
23     </refsection>
24     <refsection>
25         <title>Description</title>
26         <para>
27             Returns <literal>%t</literal> if Scilab has been called by TeXmacs
28             (required to install ATOMS module: <code>atomsInstall('texmacs')</code>)
29         </para>
30     </refsection>
31     <refsection>
32         <title>History</title>
33         <revhistory>
34             <revision>
35                 <revnumber>5.4.0</revnumber>
36                 <revremark>This function will be removed in Scilab 5.4.1</revremark>
37             </revision>
38         </revhistory>
39     </refsection>
40     <refsection>
41         <title>Examples</title>
42         <programlisting role="example"><![CDATA[ 
43 if with_texmacs() == %t then
44    disp("Texmacs is available");
45 else
46    disp("Texmacs is not available");
47 end
48  ]]></programlisting>
49     </refsection>
50 </refentry>