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
index 0460325..d81a42c 100644 (file)
@@ -1,38 +1,48 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<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" version="5.0-subset Scilab" xml:id="with_texmacs" xml:lang="en">
-  <refnamediv>
-    <refname>with_texmacs</refname>
-    <refpurpose>Checks if Scilab has been called by texmacs</refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>r = with_texmacs()</synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Arguments</title>
-    <variablelist>
-      <varlistentry>
-        <term>r</term>
-        <listitem>
-          <para>a boolean</para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsection>
-  <refsection>
-    <title>Description</title>
-    <para>
-      Returns <literal>%t</literal> if Scilab has been called by TeXmacs
-      (required to install ATOMS module: atomsInstall('texmacs'))
-    </para>
-  </refsection>
-  <refsection>
-    <title>History</title>
-    <revhistory>
-      <revision>
-        <revnumber>5.4.0</revnumber>
-        <revremark>This function will be removed in Scilab 5.4.1</revremark>
-      </revision>
-    </revhistory>
-  </refsection>
+<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">
+    <refnamediv>
+        <refname>with_texmacs</refname>
+        <refpurpose>Checks if Scilab has been called by texmacs. <emphasize role="bold">This function is obsolete.</emphasize> </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>r = with_texmacs()</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Arguments</title>
+        <variablelist>
+            <varlistentry>
+                <term>r</term>
+                <listitem>
+                    <para>a boolean</para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>
+            Returns <literal>%t</literal> if Scilab has been called by TeXmacs
+            (required to install ATOMS module: <code>atomsInstall('texmacs')</code>)
+        </para>
+    </refsection>
+    <refsection>
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.4.0</revnumber>
+                <revremark>This function will be removed in Scilab 5.4.1</revremark>
+            </revision>
+        </revhistory>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[ 
+if with_texmacs() == %t then
+   disp("Texmacs is available");
+else
+   disp("Texmacs is not available");
+end
+ ]]></programlisting>
+    </refsection>
 </refentry>