diff options
Diffstat (limited to 'fo/param.xml')
| -rw-r--r-- | fo/param.xml | 163 |
1 files changed, 141 insertions, 22 deletions
diff --git a/fo/param.xml b/fo/param.xml index d821c97..00a4447 100644 --- a/fo/param.xml +++ b/fo/param.xml @@ -3,7 +3,7 @@ <info> <title>FO Parameter Reference</title> <releaseinfo role="meta"> -$Id: param.xweb 9238 2012-03-02 18:38:42Z bobstayton $ +$Id: param.xweb 9673 2012-12-02 20:06:41Z bobstayton $ </releaseinfo> <author> <personname> @@ -1766,19 +1766,12 @@ should still be used for FOP version 0.20.5 and earlier. <refsection><info><title>Description</title></info> -<para>If non-zero, -<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://projects.oucs.ox.ac.uk/passivetex/">PassiveTeX</link> -extensions will be used. At present, this consists of PDF bookmarks -and sorted index terms. -</para> +<important><para>The PassiveTeX XSL-FO processor is +no longer supported by DocBook XSL, beginning with version 1.78.</para></important> -<para>This parameter can also affect which graphics file formats -are supported</para> - -<note> - <para>PassiveTeX is incomplete and development has ceased. In most cases, -another XSL-FO engine is probably a better choice.</para> -</note> +<para>PassiveTeX was never a complete implementation of +XSL-FO, and development has ceased. Setting this parameter will +have no effect on the output.</para> </refsection> </refentry> @@ -3464,6 +3457,71 @@ identifier does not appear in the document itself. </para> </refsection> </refentry> +<refentry version="5.0" xml:id="activate.external.olinks"> +<refmeta> +<refentrytitle>activate.external.olinks</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>activate.external.olinks</refname> +<refpurpose>Make external olinks into active links</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="activate.external.olinks.frag"> +<xsl:param name="activate.external.olinks" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If <parameter>activate.external.olinks</parameter> is nonzero +(the default), then any olinks that reference another document +become active links that can be clicked on to follow the link. +If the parameter is set to zero, then external olinks +will have the appropriate link text generated, but the link is +not made active. Olinks to destinations in +the current document remain active.</para> + +<para>To make an external olink active for HTML +outputs, the link text is wrapped in an <tag>a</tag> +element with an <tag>href</tag> attribute. To +make an external olink active for FO outputs, the link text is +wrapped in an <tag>fo:basic-link</tag> element with an +<tag>external-destination</tag> attribute.</para> + +<para>This parameter is useful when you need external olinks +to resolve but not be clickable. For example, if documents +in a collection are available independently of each other, +then having active links between them could lead to +unresolved links when a given target document is missing.</para> + +<para>The epub stylesheets set this parameter to zero by default +because there is no standard linking mechanism between Epub documents.</para> + +<para>If external links are made inactive, you should +consider setting the +stylesheet parameter <parameter>olink.doctitle</parameter> +to <literal>yes</literal>. That will append the external document's +title to the link text, making it easier for the user to +locate the other document.</para> + +<para>An olink is considered external when the +<parameter>current.docid</parameter> stylesheet parameter +is set to some value, and the olink's <tag>targetdoc</tag> +attribute has a different value. If the two values +match, then the link is considered internal. If the +<parameter>current.docid</parameter> parameter is blank, or +the <tag>olink</tag> element does not have a <tag>targetdoc</tag> attribute, +then the link is considered to be internal and will become +an active link.</para> + +<para>See also <parameter>olink.doctitle</parameter>, +<parameter>prefer.internal.olink</parameter>.</para> + +</refsection> +</refentry> + <refentry version="5.0" xml:id="collect.xref.targets"> <refmeta> <refentrytitle>collect.xref.targets</refentrytitle> @@ -6645,6 +6703,7 @@ that you may have trouble using those symbols for footnotes.</para> <xsl:attribute name="font-style">normal</xsl:attribute> <xsl:attribute name="text-align"><xsl:value-of select="$alignment"></xsl:value-of></xsl:attribute> <xsl:attribute name="start-indent">0pt</xsl:attribute> + <xsl:attribute name="end-indent">0pt</xsl:attribute> <xsl:attribute name="text-indent">0pt</xsl:attribute> <xsl:attribute name="hyphenate"><xsl:value-of select="$hyphenate"></xsl:value-of></xsl:attribute> <xsl:attribute name="wrap-option">wrap</xsl:attribute> @@ -7700,6 +7759,8 @@ zero by default, so this is simply the page-master margin-right. <xsl:when test="$paper.type = 'A4landscape'">210mm</xsl:when> <xsl:when test="$paper.type = 'USletter'">11in</xsl:when> <xsl:when test="$paper.type = 'USlandscape'">8.5in</xsl:when> + <xsl:when test="$paper.type = 'USlegal'">14in</xsl:when> + <xsl:when test="$paper.type = 'USlegallandscape'">8.5in</xsl:when> <xsl:when test="$paper.type = '4A0'">2378mm</xsl:when> <xsl:when test="$paper.type = '2A0'">1682mm</xsl:when> <xsl:when test="$paper.type = 'A0'">1189mm</xsl:when> @@ -7823,6 +7884,8 @@ this bug is fixed by RenderX. It does not affect documents with left-to-right text direction.</para> </note> +<para>See also <parameter>writing.mode</parameter>.</para> + </refsection> </refentry> @@ -7872,6 +7935,8 @@ this bug is fixed by RenderX. It does not affect documents with left-to-right text direction.</para> </note> +<para>See also <parameter>writing.mode</parameter>.</para> + </refsection> </refentry> @@ -7973,6 +8038,9 @@ landscape orientation, it is vertical. <programlisting xml:id="page.width.portrait.frag"><xsl:param name="page.width.portrait"> <xsl:choose> <xsl:when test="$paper.type = 'USletter'">8.5in</xsl:when> + <xsl:when test="$paper.type = 'USlandscape'">11in</xsl:when> + <xsl:when test="$paper.type = 'USlegal'">8.5in</xsl:when> + <xsl:when test="$paper.type = 'USlegallandscape'">14in</xsl:when> <xsl:when test="$paper.type = '4A0'">1682mm</xsl:when> <xsl:when test="$paper.type = '2A0'">1189mm</xsl:when> <xsl:when test="$paper.type = 'A0'">841mm</xsl:when> @@ -8109,11 +8177,63 @@ B, and C sizes. See <parameter>page.width.portrait</parameter>, for example. <refsection><info><title>Description</title></info> -<para>Double-sided documents are printed with a slightly wider margin -on the binding edge of the page. +<para>This parameter is useful when printing a document +on both sides of the paper.</para> + +<para>if set to non-zero, documents are formatted using different page-masters +for odd and even pages. These can differ by using a slightly wider margin +on the binding edge of the page, and alternating left-right +positions of header or footer elements. +</para> + +<para>If set to zero (the default), then only the 'odd' page masters +are used for both even and odd numbered pages.</para> + +<para>See also <parameter>force.blank.pages</parameter>, +<parameter>page.margin.inner</parameter> and +<parameter>page.margin.outer</parameter>.</para> + +</refsection> +</refentry> + +<refentry version="5.0" xml:id="force.blank.pages"> +<refmeta> +<refentrytitle>force.blank.pages</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>force.blank.pages</refname> +<refpurpose>Generate blank page to end on even page number</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<programlisting xml:id="force.blank.pages.frag"> +<xsl:param name="force.blank.pages" select="1"></xsl:param> +</programlisting> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero (the default), then each page sequence will be forced to +end on an even-numbered page, by inserting a blank page +if necessary. This will force the next page sequence to start +on an odd-numbered page, which is a standard convention +for printed and bound books.</para> + +<para>If zero, then such blank pages will not be inserted. +Chapters will start on the next available page, +regardless of whether it is an even or odd number. +This is useful when publishing online where blank +pages are not needed. +</para> + +<para>This param is independent of the +<parameter>double.sided</parameter> parameter, which +just triggers the use of even and odd page sequence +masters that differ in their header and footer placement. +So you can combine the two params for alternating +headers/footers and no blank pages. </para> -<para>FIXME: The current set of parameters does not take writing direction -into account.</para> </refsection> </refentry> @@ -11656,9 +11776,6 @@ used for all titles below level 5.</para> <refsynopsisdiv> <programlisting xml:id="article.appendix.title.properties.frag"> <xsl:attribute-set name="article.appendix.title.properties" use-attribute-sets="section.title.properties section.title.level1.properties"> - <xsl:attribute name="margin-{$direction.align.start}"> - <xsl:value-of select="$title.margin.left"></xsl:value-of> - </xsl:attribute> </xsl:attribute-set> </programlisting> </refsynopsisdiv> @@ -12613,7 +12730,7 @@ to be treated as case insensitive".</para> The value is normally taken from the gentext file for the lang attribute of the document's root element, using the key name 'writing-mode' to look it up in the gentext file. -But the param can also be +But this param can also be set on the command line to override that gentext value. </para> <para>Accepted values are: @@ -12835,7 +12952,7 @@ around all these parameters.</para> <!-- This file is generated from param.xweb --> <!-- ******************************************************************** - $Id: param.xweb 9238 2012-03-02 18:38:42Z bobstayton $ + $Id: param.xweb 9673 2012-12-02 20:06:41Z bobstayton $ ******************************************************************** This file is part of the XSL DocBook Stylesheet distribution. @@ -12846,6 +12963,7 @@ around all these parameters.</para> <src:fragref linkend="abstract.properties.frag"></src:fragref> <src:fragref linkend="abstract.title.properties.frag"></src:fragref> +<src:fragref linkend="activate.external.olinks.frag"></src:fragref> <src:fragref linkend="admon.graphics.extension.frag"></src:fragref> <src:fragref linkend="admon.graphics.frag"></src:fragref> <src:fragref linkend="admon.graphics.path.frag"></src:fragref> @@ -12948,6 +13066,7 @@ around all these parameters.</para> <src:fragref linkend="footnote.sep.leader.properties.frag"></src:fragref> <src:fragref linkend="fop.extensions.frag"></src:fragref> <src:fragref linkend="fop1.extensions.frag"></src:fragref> +<src:fragref linkend="force.blank.pages.frag"></src:fragref> <src:fragref linkend="formal.object.properties.frag"></src:fragref> <src:fragref linkend="formal.procedures.frag"></src:fragref> <src:fragref linkend="formal.title.placement.frag"></src:fragref> |