]> git.stg.codes - stg.git/blob - doc/xslt/params/pgwide.properties.xml
Ticket 37. TariffChangelsAllowed function name changed to
[stg.git] / doc / xslt / params / pgwide.properties.xml
1 <refentry xmlns="http://docbook.org/ns/docbook"
2           xmlns:xlink="http://www.w3.org/1999/xlink"
3           xmlns:xi="http://www.w3.org/2001/XInclude"
4           xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
5           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
6           version="5.0" xml:id="pgwide.properties">
7 <refmeta>
8 <refentrytitle>pgwide.properties</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>pgwide.properties</refname>
13 <refpurpose>Properties to make a figure or table page wide.
14 </refpurpose>
15 </refnamediv>
16
17 <refsynopsisdiv>
18 <src:fragment xml:id="pgwide.properties.frag">
19 <xsl:attribute-set name="pgwide.properties">
20   <xsl:attribute name="start-indent">0pt</xsl:attribute>
21 </xsl:attribute-set>
22 </src:fragment>
23 </refsynopsisdiv>
24
25 <refsection><info><title>Description</title></info>
26
27 <para>This attribute set is used to set the properties
28 that make a figure or table "page wide" in fo output.
29 It comes into effect when an attribute <literal>pgwide="1"</literal>
30 is used.
31 </para>
32
33 <para>
34 By default, it sets <parameter>start-indent</parameter>
35 to <literal>0pt</literal>.
36 In a stylesheet that sets the parameter
37 <parameter>body.start.indent</parameter>
38 to a non-zero value in order to indent body text,
39 this attribute set can be used to outdent pgwide
40 figures to the start margin.
41 </para>
42
43 <para>If a document uses a multi-column page layout,
44 then this attribute set could try setting <parameter>span</parameter>
45 to a value of <literal>all</literal>.  However, this may
46 not work with some processors because a span property must be on an
47 fo:block that is a direct child of fo:flow.  It may work in
48 some processors anyway.
49 </para>
50
51 </refsection>
52 </refentry>