]> git.stg.codes - stg.git/blob - doc/xslt/params/monospace.verbatim.font.width.xml
Added ability to optionally transfer resetable value to a real var.
[stg.git] / doc / xslt / params / monospace.verbatim.font.width.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="monospace.verbatim.font.width">
7 <refmeta>
8 <refentrytitle>monospace.verbatim.font.width</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>monospace.verbatim.font.width</refname>
13 <refpurpose>Width of a single monospace font character</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="monospace.verbatim.font.width.frag">
18 <xsl:param name="monospace.verbatim.font.width">0.60em</xsl:param>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24 <para>Specifies with em units the width of a single character
25 of the monospace font. The default value is <literal>0.6em</literal>.</para>
26
27 <para>This parameter is only used when a <tag>screen</tag>
28 or <tag>programlisting</tag> element has a 
29 <tag class="attribute">width</tag> attribute, which is
30 expressed as a plain integer to indicate the maximum character count
31 of each line.
32 To convert this character count to an actual maximum width
33 measurement, the width of the font characters must be provided.
34 Different monospace fonts have different character width,
35 so this parameter should be adjusted to fit the 
36 monospace font being used.
37 </para>
38
39 </refsection>
40 </refentry>