Add also the examples in core help pages in the russian help page (port of modificati...
[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>Checks if Scilab has been called by texmacs. <emphasize role="bold">This function is obsolete.</emphasize> </refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>r = with_texmacs()</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Arguments</title>
13         <variablelist>
14             <varlistentry>
15                 <term>r</term>
16                 <listitem>
17                     <para>a boolean</para>
18                 </listitem>
19             </varlistentry>
20         </variablelist>
21     </refsection>
22     <refsection>
23         <title>Description</title>
24         <para>
25             Returns <literal>%t</literal> if Scilab has been called by TeXmacs
26             (required to install ATOMS module: <code>atomsInstall('texmacs')</code>)
27         </para>
28     </refsection>
29     <refsection>
30         <title>History</title>
31         <revhistory>
32             <revision>
33                 <revnumber>5.4.0</revnumber>
34                 <revremark>This function will be removed in Scilab 5.4.1</revremark>
35             </revision>
36         </revhistory>
37     </refsection>
38     <refsection>
39         <title>Examples</title>
40         <programlisting role="example"><![CDATA[ 
41 if with_texmacs() == %t then
42    disp("Texmacs is available");
43 else
44    disp("Texmacs is not available");
45 end
46  ]]></programlisting>
47     </refsection>
48 </refentry>