path: root/Master/texmf-dist/doc/jadetex/base/releasenotes.xml

<?xml version='1.0'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "/usr/share/sgml/docbook/xml-dtd-4.1.2/docbookx.dtd" [
]>
<book>
<bookinfo>
	<title>JadeTeX 3.12</title>
	<subtitle>Release Notes</subtitle>
	<corpauthor>JadeTeX Development Team</corpauthor>
        <edition>Release 3.12</edition>
        <pubdate>January 2002</pubdate>
        <copyright>
                <year>2002</year>
                <holder>Ian Castle</holder>
        </copyright>
</bookinfo>

<chapter><title>JadeTeX 3.12 Release Notes</title>
<para>JadeTeX is a companion package to the OpenJade DSSSL processor.
OpenJade applies a DSSSL stylesheet to an SGML or XML document. The output
of this process can be in a number of forms, including a set of high level
LaTeX macros. It is the task of the JadeTeX package to transform these
macros into DVI/PostScript (use the command <command>jadetex</command>) or Portable Document Format (PDF) form (use the command <command>pdfjadetex</command>).</para>
<para>JadeTeX is architecture and platform independent. If LaTeX is available for your platform, then JadeTeX will be also.</para>
<sect1><title>Obtaining JadeTeX</title>
<para>The latest version of JadeTeX may be obtained from
<filename>http://jadetex.sourceforge.net</filename></para>
</sect1>
<sect1><title>Dependencies</title>
<para>Jadetex is dependent upon OpenJade and a reasonably up to date and full featured LaTeX installation. For best results OpenJade 1.3.1 should be used. However, JadeTeX will work fine with older versions (including Jade 1.2.1), although it may be necessary to adjust your <filename>jadetex.cfg</filename> configuration file to supply JadeTeX with any features missing from your version of OpenJade.</para>
<para>Any recent LaTeX distribution such as TeXlive, fpTeX or teTeX is required. As a guide the following table lists some of the requirements and suggested minimum versions.</para>
<table id="texdepends" frame="topbot"><title>Dependencies on LaTeX</title>
<tgroup cols="4" align="left" colsep="0" rowsep="0">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="3*" />
<thead>
<row rowsep="1">
        <entry>Package</entry>
        <entry>Minimum Required Version</entry>
</row>
</thead>
<tbody>
<row>
   <entry ><filename>times</filename></entry>
   <entry></entry>
</row>
<row>
   <entry ><filename>fontenc</filename></entry>
   <entry></entry>
</row>
<row>
   <entry ><filename>array</filename></entry>
   <entry></entry>
</row>
<row>
   <entry ><filename>longtable</filename></entry>
   <entry></entry>
</row>
<row>
   <entry ><filename>color</filename></entry>
   <entry></entry>
</row>
<row>
   <entry ><filename>colortbl</filename></entry>
   <entry></entry>
</row>
<row>
   <entry ><filename>marvosym</filename></entry>
   <entry></entry>
</row>
<row>
   <entry ><filename>graphicx</filename></entry>
   <entry>1997/06/09</entry>
</row>
<row>
   <entry ><filename>multicol</filename></entry>
   <entry></entry>
</row>
<row>
   <entry ><filename>hyperref</filename></entry>
   <entry>2000/03/01</entry>
</row>
<row>
   <entry ><filename>fancyhdr</filename></entry>
   <entry></entry>
</row>
<row>
   <entry ><filename>inputenc</filename></entry>
   <entry>1997/12/20</entry>
</row>
<row>
   <entry ><filename>ulem</filename></entry>
   <entry></entry>
</row>
<row>
   <entry ><filename>pdfTeX</filename></entry>
   <entry>0.13d</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
<sect1><title>Installation</title>
<para>See the installation guide.</para>
</sect1>
<sect1><title>Configuration</title>
<para>It is possible to customize the behavior of JadeTeX by placing definitions in the file <filename>jadetex.cfg</filename>. This is usually placed in your working directory, but theoretically make be placed anywhere in your TeX path.</para>
<para>If you are producing PDF files then you may wish to consult the <command>hyperref</command> documentation. Options for customizing the look and feel of the PDF file described in the hyperref documentation should be placed in the <filename>jadetex.cfg</filename>. For example:
<screen>
\hypersetup{pdfpagemode=None,  pdfauthor=jadetex team,  colorlinks=false,
 linkcolor=black,  pdfstartview=FitH}
\def\Gin@extensions{.pdf,.png,.jpg,.mps,.tif}
</screen>
Would cause the PDF document to open without displaying book marks.
Links would not be highlighted in anyway (if they were, the would be color black).
The document will be placed in a "fit width" viewing mode.
Finally, pdfjadetex would prefer image with a pdf extensions over a png extension if none is specified.
This is useful if you want to give priority to scalable documents for a PDF file, while preferring a bit mapped format for other output types.</para>
<para>If you have a out of date version of openjade, which does not support the characteristics 
<screen>
  "UNREGISTERED::OpenJade//Characteristic::page-two-side?"

  "UNREGISTERED::OpenJade//Characteristic::two-side-start-on-right?"
</screen>
and you want to use two sided output then you would have to add the definitions
<screen>
\def\PageTwoSide{1}
\def\TwoSideStartOnRight{1}
</screen>
to your <filename>jadetex.cfg</filename> to make up for the deficiency.</para>
</sect1>
<sect1><title>Version 3.12</title>
<formalpara><title>Released January 2002.</title>
<para>This release is primarily a maintenance release and is intended
to be used with openjade 1.3.1. In addition to fixing some bugs it
also provides enhanced support for the "euro" monetary symbol &euro;.</para>
</formalpara>
<table id="id1" frame="topbot"><title>Changes for release 3.12</title>
<tgroup cols="2" align="left" colsep="0" rowsep="0">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="3*" />
<thead>
<row rowsep="1">
	<entry>Item 1</entry>
	<entry>Fix for space above horizontal rule</entry>
</row>
</thead>
<tbody>
<row>
	<entry><para>References</para></entry>
	<entry><para>Source Forge patch #444445</para></entry>
</row>
<row>
	<entry><para>Category</para></entry>
	<entry><para>Software Bug</para></entry>
</row>
<row>
<entry><para>Problem</para></entry>
<entry><para>A horizontal rule has spurious blank space above it</para></entry>
</row>
<row>
<entry><para>Resolution</para></entry>
<entry><para>Added \nointerlineskip to suppress the blank space</para></entry>
</row>
</tbody>
</tgroup>
<tgroup cols="2" align="left" colsep="0" rowsep="0">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="3*" />
<thead>
<row rowsep="1">
	<entry>Item 2</entry>
	<entry>Graphics centered within page not column</entry>
</row>
</thead>
<tbody>
<row>
	<entry><para>References</para></entry>
	<entry><para>Source Forge patch #470586</para></entry>
</row>
<row>
	<entry><para>Category</para></entry>
	<entry><para>Software Bug</para></entry>
</row>
<row>
<entry><para>Problem</para></entry>
<entry><para>External Graphics are centered with respect to the entire page. This causes a problem in multicolumn mode.</para></entry>
</row>
<row>
<entry><para>Resolution</para></entry>
<entry><para>External Graphics are now centered within the column width</para></entry>
</row>
</tbody>
</tgroup>
<tgroup cols="2" align="left" colsep="0" rowsep="0">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="3*" />
<thead>
<row rowsep="1">
	<entry>Item 3</entry>
    <entry>Fix fatal error with unbalanced columns</entry>
</row>
</thead>
<tbody>
<row>
    <entry><para>References</para></entry>
	<entry><para>Source Forge patch #492522</para></entry>
</row>
<row>
	<entry><para>Category</para></entry>
    <entry><para>Software Bug</para></entry>
</row>
<row>
	<entry><para>Problem</para></entry>
    <entry><para>The TeX multicol package supports
	both balanced and unbalanced columns.  However, JadeTeX 3.11
	didn't call the functions for unbalanced columns correctly.  Since
	a bug in the handling of %page-balanced-columns?% was fixed in
	3.11, this is now the common case - so multicolumn documents that
	used to work in 3.10 no longer work</para></entry>
</row>
<row>
    <entry><para>Resolution</para></entry>
    <entry><para>Reworked the invocation of the unbalanced column macros.
    It isn't pretty, but it works.</para></entry>
</row>
</tbody>
</tgroup>
<tgroup cols="2" align="left" colsep="0" rowsep="0">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="3*" />
<thead>
<row rowsep="1">
	<entry>Item 4</entry>
    <entry>Add <varname>DESTDIR</varname> environment variable to
      <filename>Makefile</filename></entry>
</row>
</thead>
<tbody>
<row><entry><para>References</para></entry>
   <entry><para>None</para></entry>
</row>
<row>
   <entry><para>Category</para></entry>
   <entry><para>Software Installation / Configuration</para></entry>
</row>
<row>
   <entry><para>Problem</para></entry>
   <entry><para>Makefile doesn't have <varname>DESTDIR</varname> environment variable</para></entry>
</row>
<row>
   <entry><para>Resolution</para></entry>
   <entry><para>Make makefile more friendly for packagers with
	introduction of <varname>DESTDIR</varname> environment variable. This change is
	transparent to those that don't want to use <varname>DESTDIR</varname>.</para></entry>
</row>
</tbody>
</tgroup>
<tgroup cols="2" align="left" colsep="0" rowsep="0">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="3*" />
<thead>
<row rowsep="1">
	<entry>Item 5</entry>
    <entry>Long directory/file names disappear of the page</entry>
</row>
</thead>
<tbody>
<row>
    <entry><para>References</para></entry>
    <entry><para>Red Hat Bugzilla bug 47345</para></entry>
</row>
<row>
   <entry><para>Category</para></entry>
   <entry><para>Software Bug</para></entry>
</row>
<row>
   <entry><para>Problem</para></entry>
   <entry><para>If there is a long directory
	path in a document it goes off the side of the page.  Long
	pathnames should be split or put on a separate line so that they
	don't go off the edge of the page.</para></entry>
</row>
<row>
    <entry><para>Resolution</para></entry>
    <entry><para>Added '\setlength\emergencystretch{2in}'.
    In case of overfull hboxes, an extra stretchable length gets
    added to the end of the lines.</para></entry>
</row>
</tbody>
</tgroup>
<tgroup cols="2" align="left" colsep="0" rowsep="0">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="3*" />
<thead>
<row rowsep="1">
   <entry>Item 6</entry>
   <entry>Add Extra Fonts</entry>
</row>
</thead>
<tbody>
<row>
   <entry><para>References</para></entry>
   <entry><para>sf.net request #452537, Mandrakesoft Documentation Project</para></entry>
</row>
<row>
   <entry><para>Category</para></entry>
   <entry><para>Software Bug</para></entry>
</row>
<row>
   <entry><para>Problem</para></entry>
   <entry><para>Many commonly installed fonts such as Charter and Utopia 
are not available for use with JadeTeX</para></entry>
</row>
<row>
   <entry><para>Resolution</para></entry>
   <entry><para>Added the following fonts: Utopia, ZapfChancery, Fibonacci,
Funny, Dunhill, Concrete, Charter, Fontpxr, Fontaer, Fontaess, Fontaett, 
Fontlcmss, Fontlcmtt, Fontlcmvtt, Fontcmbr, Fontcmtl, Fontpxss, Fonttxss,
Fonttxr. Note that this justs makes the fonts available to JadeTeX. You must
have them installed already to actually use them in documents</para></entry>
</row>
</tbody>
</tgroup>
<tgroup cols="2" align="left" colsep="0" rowsep="0">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="3*" />
<thead>
<row rowsep="1">
   <entry>Item 7</entry>
   <entry>Enhanced Euro symbol &euro; support</entry>
</row>
</thead>
<tbody>
<row>
    <entry><para>References</para></entry>
    <entry><para>None</para></entry>
</row>
<row>
    <entry><para>Category</para></entry>
    <entry><para>Functional Change</para></entry>
</row>
<row>
    <entry><para>Problem</para></entry>
    <entry><para>Using the reference <command>&amp;euro;</command> does
not produce any output. Using the Unicode character reference produces
a black square unless a Computer Modern font is being used.</para></entry>
</row>
<row>
    <entry><para>Resolution</para></entry>
    <entry><para>Switched to the <command>marvosym.sty</command> package
for the euro symbol. This is provides a good quality postscript font
containing the euro symbol. Some consideration was given to using Adobe's
freely available euro fonts and the <command>eurosans.sty</command> package.
However as the adobe fonts cannot be distributed freely this option
was not chosen. In addition, the <command>marvosym.sty</command> package
is available in most modern TeX distributions.</para>
<para>Additionally, support was added for the <command>&amp;euro;</command>
entity reference.</para></entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
</chapter>
</book>