Added documentation about page layout and ulink.footnotes and ulink.show

diff --git a/xsl/fo/param.ent b/xsl/fo/param.ent
index 8b9e35b8b27a83e9a2e1b49de7169a03696f6bc3..c187d1382150937e23c0792d7f4e478c205d1b9a 100644 (file)
--- a/xsl/fo/param.ent
+++ b/xsl/fo/param.ent
@@ -120,6 +120,8 @@
 <!ENTITY toc.margin.properties SYSTEM "../params/toc.margin.properties.xml">
 <!ENTITY toc.section.depth SYSTEM "../params/toc.section.depth.xml">
 <!ENTITY use.extensions SYSTEM "../params/use.extensions.xml">
+<!ENTITY ulink.footnotes SYSTEM "../params/ulink.footnotes.xml">
+<!ENTITY ulink.show SYSTEM "../params/ulink.show.xml">
 <!ENTITY variablelist.as.blocks SYSTEM "../params/variablelist.as.blocks.xml">
 <!ENTITY verbatim.properties SYSTEM "../params/verbatim.properties.xml">
 <!ENTITY xep.extensions SYSTEM "../params/xep.extensions.xml">

diff --git a/xsl/fo/param.xweb b/xsl/fo/param.xweb
index 68229baff06051c867a67db7c9101e72e75309e2..3c9d72adb37cdb983f9b284f957f93c21be7687b 100644 (file)
--- a/xsl/fo/param.xweb
+++ b/xsl/fo/param.xweb
@@ -186,6 +186,8 @@ to be incomplete. Don't forget to read the source, too :-)</para>
 &segmentedlist.as.table;
 &variablelist.as.blocks;
 &blockquote.properties;
+&ulink.show;
+&ulink.footnotes;
 </reference>
 
 <reference><title>FO</title>
@@ -193,6 +195,75 @@ to be incomplete. Don't forget to read the source, too :-)</para>
 </reference>
 
 <reference><title>Pagination and General Styles</title>
+<partintro>
+<section><title>Understanding XSL FO Margins</title>
+
+<para>In order for the parameters in this section to make sense, it is useful to
+consider <xref linkend="fig.pagemodel"/>.</para>
+
+<figure id="fig.pagemodel">
+<mediaobject>
+<imageobject>
+<imagedata fileref="page.png"/>
+</imageobject>
+<textobject><phrase>Figure showing page margins</phrase></textobject>
+<textobject>
+<para>This figure shows the physical page with the various FO page regions
+identified.</para>
+</textobject>
+</mediaobject>
+</figure>
+
+<para>First, let's consider the regions on the page.</para>
+
+<para>The white region is the physical page. Its dimensions are determined by
+the <parameter>page.height</parameter> and <parameter>page.width</parameter>
+parameters.</para>
+
+<para>The yellow region is the region-body. The size and placement of
+the region body is constrained by the dimensions labelled in the
+figure.</para>
+
+<para>The pink region at the top of the page is the region-before. The
+darker area inside the region-before is the header text. In XSL, the default
+display alignment for the region-before is <literal>before</literal>, but
+the DocBook stylesheets explicitly make it <literal>after</literal>. That's
+why the darker area is at the bottom.</para>
+
+<para>The pink region at the bottom of the page is the region-after.
+The darker area is the footer text. In XSL, the default display
+alignment for the region-after is <literal>before</literal> (really!),
+but the DocBook stylesheets explicitly make it
+<literal>after</literal>. That's why the darker area is at the bottom.</para>
+
+<para>The dimensions in the figure are:</para>
+
+<itemizedlist numeration="upperalpha">
+<listitem><para>The page-master margin-top.
+</para></listitem>
+<listitem><para>The region-before extent.
+</para></listitem>
+<listitem><para>The region-body margin-top.
+</para></listitem>
+<listitem><para>The region-after extent.
+</para></listitem>
+<listitem><para>The page-master margin-bottom.
+</para></listitem>
+<listitem><para>The region-body margin-bottom.
+</para></listitem>
+<listitem><para>The sum of the page-master margin-left and the
+region-body margin-left. In DocBook, the region-body margin-left is
+zero by default, so this is simply the page-master region-left.
+</para></listitem>
+<listitem><para>The sum of the page-master margin-right and the
+region-body margin-right. In DocBook, the region-body margin-right is
+zero by default, so this is simply the page-master region-left.
+</para></listitem>
+</itemizedlist>
+
+</section>
+</partintro>
+
 &page.height;
 &page.height.portrait;
 &page.margin.bottom;
@@ -395,6 +466,8 @@ around all these parameters.</para>
 <src:fragref linkend="toc.margin.properties.frag"/>
 <src:fragref linkend="toc.section.depth.frag"/>
 <src:fragref linkend="use.extensions.frag"/>
+<src:fragref linkend="ulink.footnotes.frag"/>
+<src:fragref linkend="ulink.show.frag"/>
 <src:fragref linkend="variablelist.as.blocks.frag"/>
 <src:fragref linkend="verbatim.properties.frag"/>
 <src:fragref linkend="xep.extensions.frag"/>