summaryrefslogtreecommitdiffstats
path: root/kdoctools/docbook/xsl/params/tex.math.in.alt.xml
diff options
context:
space:
mode:
Diffstat (limited to 'kdoctools/docbook/xsl/params/tex.math.in.alt.xml')
-rw-r--r--kdoctools/docbook/xsl/params/tex.math.in.alt.xml56
1 files changed, 56 insertions, 0 deletions
diff --git a/kdoctools/docbook/xsl/params/tex.math.in.alt.xml b/kdoctools/docbook/xsl/params/tex.math.in.alt.xml
new file mode 100644
index 000000000..0b956c6c8
--- /dev/null
+++ b/kdoctools/docbook/xsl/params/tex.math.in.alt.xml
@@ -0,0 +1,56 @@
+<refentry id="tex.math.in.alt">
+<refmeta>
+<refentrytitle>tex.math.in.alt</refentrytitle>
+<refmiscinfo role="type">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>tex.math.in.alt</refname>
+<refpurpose>TeX notation used for equations</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment id='tex.math.in.alt.frag'>
+<xsl:param name="tex.math.in.alt" select="''"/>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>If you want type math directly in TeX notation in equations,
+this parameter specifies notation used. Currently are supported two
+values -- <literal>plain</literal> and <literal>latex</literal>. Empty
+value means that you are not using TeX math at all.</para>
+
+<para>Preferred way for including TeX alternative of math is inside of
+<sgmltag>textobject</sgmltag> element. Eg.:</para>
+
+<programlisting><![CDATA[<inlineequation>
+<inlinemediaobject>
+<imageobject>
+<imagedata fileref="eq1.gif"/>
+</imageobject>
+<textobject><phrase>E=mc squared</phrase></textobject>
+<textobject role="tex"><phrase>E=mc^2</phrase></textobject>
+</inlinemediaobject>
+</inlineequation>]]></programlisting>
+
+<para>If you are using <sgmltag>graphic</sgmltag> element, you can
+store TeX inside <sgmltag>alt</sgmltag> element:</para>
+
+<programlisting><![CDATA[<inlineequation>
+<alt role="tex">a^2+b^2=c^2</alt>
+<graphic fileref="a2b2c2.gif"/>
+</inlineequation>]]></programlisting>
+
+<para>If you want use this feature, you should process your FO with
+PassiveTeX, which only supports TeX math notation. When calling
+stylsheet, don't forget to specify also
+passivetex.extensions=1.</para>
+
+<para>If you want equations in HTML, just process generated file
+<filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run
+dvi2bitmap program on result DVI file. You will get images for
+equations in your document.</para>
+
+</refsect1>
+</refentry>