doc/xslt/params/writing.mode.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="writing.mode">
   7 <refmeta>
   8 <refentrytitle>writing.mode</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>writing.mode</refname>
  13 <refpurpose>Direction of text flow based on locale</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17 <src:fragment xml:id="writing.mode.frag">
  18 <xsl:param name="writing.mode">
  19   <xsl:call-template name="gentext">
  20     <xsl:with-param name="key">writing-mode</xsl:with-param>
  21     <xsl:with-param name="lang">
  22       <xsl:call-template name="l10n.language">
  23         <xsl:with-param name="target" select="/*[1]"/>
  24       </xsl:call-template>
  25     </xsl:with-param>
  26   </xsl:call-template>
  27 </xsl:param>
  28 </src:fragment>
  29 </refsynopsisdiv>
  30
  31 <refsection><info><title>Description</title></info>
  32
  33 <para>Sets direction of text flow and text alignment based on locale.
  34 The value is normally taken from the gentext file for the
  35 lang attribute of the document's root element, using the
  36 key name 'writing-mode' to look it up in the gentext file.
  37 But the param can also be
  38 set on the command line to override that gentext value.
  39 </para>
  40 <para>Accepted values are:
  41 <variablelist>
  42   <varlistentry>
  43     <term>lr-tb</term>
  44     <listitem>
  45       <para>Left-to-right text flow in each line, lines stack top to bottom.</para>
  46     </listitem>
  47   </varlistentry>
  48   <varlistentry>
  49     <term>rl-tb</term>
  50     <listitem>
  51       <para>Right-to-left text flow in each line, lines stack top to bottom.</para>
  52     </listitem>
  53   </varlistentry>
  54   <varlistentry>
  55     <term>tb-rl</term>
  56     <listitem>
  57       <para>Top-to-bottom text flow in each vertical line, lines stack right to left.
  58       Supported by only a few XSL-FO processors. Not supported in HTML output.</para>
  59     </listitem>
  60   </varlistentry>
  61   <varlistentry>
  62     <term>lr</term>
  63     <listitem>
  64       <para>Shorthand for lr-tb.</para>
  65     </listitem>
  66   </varlistentry>
  67   <varlistentry>
  68     <term>rl</term>
  69     <listitem>
  70       <para>Shorthand for rl-tb.</para>
  71     </listitem>
  72   </varlistentry>
  73   <varlistentry>
  74     <term>tb</term>
  75     <listitem>
  76       <para>Shorthand for tb-rl.</para>
  77     </listitem>
  78   </varlistentry>
  79 </variablelist>
  80 </para>
  81
  82 </refsection>
  83 </refentry>