]> git.stg.codes - stg.git/blob - doc/xslt/params/tex.math.in.alt.xml
Some minor improvements on ticket26.
[stg.git] / doc / xslt / params / tex.math.in.alt.xml
1 <refentry xmlns="http://docbook.org/ns/docbook"
2           xmlns:xlink="http://www.w3.org/1999/xlink"
3           xmlns:xi="http://www.w3.org/2001/XInclude"
4           xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
5           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
6           version="5.0" xml:id="tex.math.in.alt">
7 <refmeta>
8 <refentrytitle>tex.math.in.alt</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
10 <refmiscinfo class="other" otherclass="value">plain</refmiscinfo>
11 <refmiscinfo class="other" otherclass="value">latex</refmiscinfo>
12 </refmeta>
13 <refnamediv>
14 <refname>tex.math.in.alt</refname>
15 <refpurpose>TeX notation used for equations</refpurpose>
16 </refnamediv>
17
18 <refsynopsisdiv>
19 <src:fragment xml:id="tex.math.in.alt.frag">
20 <xsl:param name="tex.math.in.alt"></xsl:param>
21 </src:fragment>
22 </refsynopsisdiv>
23
24 <refsection><info><title>Description</title></info>
25
26 <para>If you want type math directly in TeX notation in equations,
27 this parameter specifies notation used. Currently are supported two
28 values -- <literal>plain</literal> and <literal>latex</literal>. Empty
29 value means that you are not using TeX math at all.</para>
30
31 <para>Preferred way for including TeX alternative of math is inside of
32 <tag>textobject</tag> element. Eg.:</para>
33
34 <programlisting>&lt;inlineequation&gt;
35 &lt;inlinemediaobject&gt;
36 &lt;imageobject&gt;
37 &lt;imagedata fileref="eq1.gif"/&gt;
38 &lt;/imageobject&gt;
39 &lt;textobject&gt;&lt;phrase&gt;E=mc squared&lt;/phrase&gt;&lt;/textobject&gt;
40 &lt;textobject role="tex"&gt;&lt;phrase&gt;E=mc^2&lt;/phrase&gt;&lt;/textobject&gt;
41 &lt;/inlinemediaobject&gt;
42 &lt;/inlineequation&gt;</programlisting>
43
44 <para>If you are using <tag>graphic</tag> element, you can
45 store TeX inside <tag>alt</tag> element:</para>
46
47 <programlisting>&lt;inlineequation&gt;
48 &lt;alt role="tex"&gt;a^2+b^2=c^2&lt;/alt&gt;
49 &lt;graphic fileref="a2b2c2.gif"/&gt;  
50 &lt;/inlineequation&gt;</programlisting>
51
52 <para>If you want use this feature, you should process your FO with
53 PassiveTeX, which only supports TeX math notation. When calling
54 stylsheet, don't forget to specify also
55 passivetex.extensions=1.</para>
56
57 <para>If you want equations in HTML, just process generated file
58 <filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run
59 dvi2bitmap program on result DVI file. You will get images for
60 equations in your document.</para>
61
62 <warning>
63   <para>This feature is useful for print/PDF output only if you
64     use the obsolete and now unsupported PassiveTeX XSL-FO
65     engine.</para>
66 </warning>
67
68 </refsection>
69
70 <refsection><info><title>Related Parameters</title></info>
71   <para><parameter>tex.math.delims</parameter>,
72     <parameter>passivetex.extensions</parameter>,
73     <parameter>tex.math.file</parameter></para>
74 </refsection>
75
76 </refentry>