From 7ed52aa6900d6214d6acb0baea11dcf90909a077 Mon Sep 17 00:00:00 2001
From: Bob Stayton <bobs@sagehill.net>
Date: Wed, 23 Nov 2011 22:01:40 +0000
Subject: [PATCH] Complete support for side regions.

---
 xsl/params/body.margin.inner.xml              |  9 +++-
 xsl/params/body.margin.outer.xml              |  9 +++-
 .../inner.region.content.properties.xml       | 48 +++++++++++++++++
 .../outer.region.content.properties.xml       | 47 +++++++++++++++++
 xsl/params/region.inner.extent.xml            |  9 +++-
 xsl/params/region.inner.properties.xml        | 51 +++++++++++++++++++
 xsl/params/region.outer.extent.xml            |  8 ++-
 xsl/params/region.outer.properties.xml        | 51 +++++++++++++++++++
 xsl/params/side.region.precedence.xml         | 45 ++++++++++++++++
 9 files changed, 273 insertions(+), 4 deletions(-)
 create mode 100644 xsl/params/inner.region.content.properties.xml
 create mode 100644 xsl/params/outer.region.content.properties.xml
 create mode 100644 xsl/params/region.inner.properties.xml
 create mode 100644 xsl/params/region.outer.properties.xml
 create mode 100644 xsl/params/side.region.precedence.xml

diff --git a/xsl/params/body.margin.inner.xml b/xsl/params/body.margin.inner.xml
index b4c43830d..6cad6dc72 100644
--- a/xsl/params/body.margin.inner.xml
+++ b/xsl/params/body.margin.inner.xml
@@ -15,7 +15,7 @@
 
 <refsynopsisdiv>
 <src:fragment xml:id="body.margin.inner.frag">
-<xsl:param name="body.margin.inner">0.5in</xsl:param>
+<xsl:param name="body.margin.inner">0in</xsl:param>
 </src:fragment>
 </refsynopsisdiv>
 
@@ -41,5 +41,12 @@ is <literal>fo:region-start</literal> for all pages.</para>
 both left-to-right and right-to-left writing modes.</para>
 
 <para>The default value is zero.</para>
+
+<para>See also <parameter>
+<parameter>region.inner.extent</parameter>,
+<parameter>region.outer.extent</parameter>,
+<parameter>body.margin.outer</parameter>,
+<parameter>side.region.precedence</parameter>.
+</para>
 </refsection>
 </refentry>
diff --git a/xsl/params/body.margin.outer.xml b/xsl/params/body.margin.outer.xml
index 48833f92f..4101b5564 100644
--- a/xsl/params/body.margin.outer.xml
+++ b/xsl/params/body.margin.outer.xml
@@ -15,7 +15,7 @@
 
 <refsynopsisdiv>
 <src:fragment xml:id="body.margin.outer.frag">
-<xsl:param name="body.margin.outer">0.5in</xsl:param>
+<xsl:param name="body.margin.outer">0in</xsl:param>
 </src:fragment>
 </refsynopsisdiv>
 
@@ -42,5 +42,12 @@ is <literal>fo:region-end</literal> for all pages.</para>
 both left-to-right and right-to-left writing modes.</para>
 
 <para>The default value is zero.</para>
+
+<para>See also <parameter>
+<parameter>region.inner.extent</parameter>,
+<parameter>region.outer.extent</parameter>,
+<parameter>body.margin.inner</parameter>,
+<parameter>side.region.precedence</parameter>.
+</para>
 </refsection>
 </refentry>
diff --git a/xsl/params/inner.region.content.properties.xml b/xsl/params/inner.region.content.properties.xml
new file mode 100644
index 000000000..72d932255
--- /dev/null
+++ b/xsl/params/inner.region.content.properties.xml
@@ -0,0 +1,48 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="inner.region.content.properties">
+<refmeta>
+<refentrytitle>inner.region.content.properties</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>inner.region.content.properties</refname>
+<refpurpose>Properties of running inner side content</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="inner.region.content.properties.frag">
+<xsl:attribute-set name="inner.region.content.properties">
+</xsl:attribute-set>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>The FO stylesheet supports optional side regions
+similar to the header and footer regions.
+Any attributes declared in this attribute-set 
+are applied to the fo:block in the side region
+on the inner side (binding side) of the page.
+This corresponds to the <literal>start</literal>
+region on odd-numbered pages and the <literal>end</literal>
+region on even-numbered pages.
+For single-sided output, it always corresponds to
+the <literal>start</literal> region.</para>
+
+<para>You can customize the template named 
+<literal>inner.region.content</literal> to specify
+the content of the inner side region.</para>
+
+<para>See also
+<parameter>region.inner.properties</parameter>,
+<parameter>page.margin.inner</parameter>, 
+<parameter>body.margin.inner</parameter>,
+and the corresponding <literal>outer</literal>
+parameters.</para>
+
+</refsection>
+</refentry>
diff --git a/xsl/params/outer.region.content.properties.xml b/xsl/params/outer.region.content.properties.xml
new file mode 100644
index 000000000..43695c6bf
--- /dev/null
+++ b/xsl/params/outer.region.content.properties.xml
@@ -0,0 +1,47 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="outer.region.content.properties">
+<refmeta>
+<refentrytitle>outer.region.content.properties</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>outer.region.content.properties</refname>
+<refpurpose>Properties of running outer side content</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="outer.region.content.properties.frag">
+<xsl:attribute-set name="outer.region.content.properties">
+</xsl:attribute-set>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>The FO stylesheet supports optional side regions
+similar to the header and footer regions.
+Any attributes declared in this attribute-set 
+are applied to the fo:block in the side region
+on the outer side (opposite the binding side) of the page.
+This corresponds to the <literal>start</literal>
+region on odd-numbered pages and the <literal>end</literal>
+region on even-numbered pages.
+For single-sided output, it always corresponds to
+the <literal>start</literal> region.</para>
+
+<para>You can customize the template named 
+<literal>outer.region.content</literal> to specify
+the content of the outer side region.</para>
+
+<para>See also
+<parameter>region.outer.properties</parameter>,
+<parameter>page.margin.outer</parameter>, 
+<parameter>body.margin.outer</parameter>,
+and the corresponding <literal>inner</literal>
+parameters.</para>
+</refsection>
+</refentry>
diff --git a/xsl/params/region.inner.extent.xml b/xsl/params/region.inner.extent.xml
index 234848711..ab550cf6e 100644
--- a/xsl/params/region.inner.extent.xml
+++ b/xsl/params/region.inner.extent.xml
@@ -15,7 +15,7 @@
 
 <refsynopsisdiv>
 <src:fragment xml:id="region.inner.extent.frag">
-<xsl:param name="region.inner.extent">0.4in</xsl:param>
+<xsl:param name="region.inner.extent">0in</xsl:param>
 </src:fragment>
 </refsynopsisdiv>
 
@@ -40,5 +40,12 @@ be sure to also enlarge the <parameter>body.margin.inner</parameter>
 parameter to make room for its content, otherwise any text in
 the side region may overlap with the body text.</para>
 
+<para>See also <parameter>
+<parameter>region.outer.extent</parameter>,
+<parameter>body.margin.inner</parameter>,
+<parameter>body.margin.outer</parameter>,
+<parameter>side.region.precedence</parameter>.
+</para>
+
 </refsection>
 </refentry>
diff --git a/xsl/params/region.inner.properties.xml b/xsl/params/region.inner.properties.xml
new file mode 100644
index 000000000..44e8bb4ba
--- /dev/null
+++ b/xsl/params/region.inner.properties.xml
@@ -0,0 +1,51 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="region.inner.properties">
+<refmeta>
+<refentrytitle>region.inner.properties</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>region.inner.properties</refname>
+<refpurpose>Properties of running inner side region</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="region.inner.properties.frag">
+<xsl:attribute-set name="region.inner.properties">
+  <xsl:attribute name="border-width">0</xsl:attribute>
+  <xsl:attribute name="padding">0</xsl:attribute>
+  <xsl:attribute name="reference-orientation">90</xsl:attribute>
+</xsl:attribute-set>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>The FO stylesheet supports optional side regions
+similar to the header and footer regions.
+Any attributes declared in this attribute-set 
+are applied to the region element in the page master
+on the inner side (binding side) of the page.
+This corresponds to <literal>&lt;fo:regin-start&gt;</literal>
+on odd-numbered pages and <literal>&lt;fo:region-end&gt;</literal>
+on even-numbered pages.
+For single-sided output, it always corresponds to
+<literal>&lt;fo:regin-start&gt;</literal>.</para>
+
+<para>You can customize the template named 
+<literal>inner.region.content</literal> to specify
+the content of the inner side region.</para>
+
+<para>See also
+<parameter>inner.region.content.properties</parameter>,
+<parameter>page.margin.inner</parameter>, 
+<parameter>body.margin.inner</parameter>,
+and the corresponding <literal>outer</literal>
+parameters.</para>
+
+</refsection>
+</refentry>
diff --git a/xsl/params/region.outer.extent.xml b/xsl/params/region.outer.extent.xml
index 42cb218d3..338c2a184 100644
--- a/xsl/params/region.outer.extent.xml
+++ b/xsl/params/region.outer.extent.xml
@@ -15,7 +15,7 @@
 
 <refsynopsisdiv>
 <src:fragment xml:id="region.outer.extent.frag">
-<xsl:param name="region.outer.extent">0.4in</xsl:param>
+<xsl:param name="region.outer.extent">0in</xsl:param>
 </src:fragment>
 </refsynopsisdiv>
 
@@ -40,5 +40,11 @@ be sure to also enlarge the <parameter>body.margin.outer</parameter>
 parameter to make room for its content, otherwise any text in
 the side region may overlap with the body text.</para>
 
+<para>See also <parameter>
+<parameter>region.inner.extent</parameter>,
+<parameter>body.margin.inner</parameter>,
+<parameter>body.margin.outer</parameter>,
+<parameter>side.region.precedence</parameter>.
+</para>
 </refsection>
 </refentry>
diff --git a/xsl/params/region.outer.properties.xml b/xsl/params/region.outer.properties.xml
new file mode 100644
index 000000000..1ed1c5052
--- /dev/null
+++ b/xsl/params/region.outer.properties.xml
@@ -0,0 +1,51 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="region.outer.properties">
+<refmeta>
+<refentrytitle>region.outer.properties</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>region.outer.properties</refname>
+<refpurpose>Properties of running outer side region</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="region.outer.properties.frag">
+<xsl:attribute-set name="region.outer.properties">
+  <xsl:attribute name="border-width">0</xsl:attribute>
+  <xsl:attribute name="padding">0</xsl:attribute>
+  <xsl:attribute name="reference-orientation">90</xsl:attribute>
+</xsl:attribute-set>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>The FO stylesheet supports optional side regions
+similar to the header and footer regions.
+Any attributes declared in this attribute-set 
+are applied to the region element in the page master
+on the outer side (opposite the binding side) of the page.
+This corresponds to <literal>&lt;fo:regin-start&gt;</literal>
+on odd-numbered pages and <literal>&lt;fo:region-end&gt;</literal>
+on even-numbered pages.
+For single-sided output, it always corresponds to
+<literal>&lt;fo:regin-start&gt;</literal>.</para>
+
+<para>You can customize the template named 
+<literal>outer.region.content</literal> to specify
+the content of the outer side region.</para>
+
+<para>See also
+<parameter>outer.region.content.properties</parameter>,
+<parameter>page.margin.outer</parameter>, 
+<parameter>body.margin.outer</parameter>,
+and the corresponding <literal>inner</literal>
+parameters.</para>
+
+</refsection>
+</refentry>
diff --git a/xsl/params/side.region.precedence.xml b/xsl/params/side.region.precedence.xml
new file mode 100644
index 000000000..604a29ee9
--- /dev/null
+++ b/xsl/params/side.region.precedence.xml
@@ -0,0 +1,45 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="side.region.precedence"> 
+<refmeta> 
+<refentrytitle>side.region.precedence</refentrytitle> 
+<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> 
+</refmeta> 
+<refnamediv> 
+<refname>side.region.precedence</refname> 
+<refpurpose>Determines side region page layout precedence</refpurpose> 
+</refnamediv> 
+<refsynopsisdiv> <src:fragment xml:id="side.region.precedence.frag">
+<xsl:param name="side.region.precedence">false</xsl:param>
+</src:fragment> 
+</refsynopsisdiv> 
+<refsection><info><title>Description</title></info> 
+ 
+<para>If optional side regions on a page
+are established using parameters such as
+<parameter>body.margin.inner</parameter>, 
+<parameter>region.inner.extent</parameter>, etc., then this
+parameter determines what happens at the corners where the
+side regions meet the header and footer regions.</para>
+
+<para>If the value of this parameter is <literal>true</literal>,
+then the side regions have precedence and extend higher
+and lower, while the header and footer regions are narrower
+and fit inside the side regions.</para>
+
+<para>If the value of this parameter is <literal>false</literal>
+(the default value), then the header and footer regions 
+have precedence and extend over and below the side regions.
+Any value other than <literal>true</literal> or
+<literal>false</literal> is taken to be <literal>false</literal>.</para>
+
+<para>See also <parameter>
+<parameter>region.inner.extent</parameter>,
+<parameter>region.outer.extent</parameter>,
+<parameter>body.margin.inner</parameter>,
+<parameter>body.margin.outer</parameter>.
+</para>
+</refsection> </refentry>
-- 
2.40.0