]> git.stg.codes - stg.git/blob - doc/xslt/params/man.hyphenate.computer.inlines.xml
Ticket 26. The std::string modulePath variable definition moved after
[stg.git] / doc / xslt / params / man.hyphenate.computer.inlines.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="man.hyphenate.computer.inlines">
7 <refmeta>
8 <refentrytitle>man.hyphenate.computer.inlines</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>man.hyphenate.computer.inlines</refname>
13 <refpurpose>Hyphenate computer inlines?</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="man.hyphenate.computer.inlines.frag">
18 <xsl:param name="man.hyphenate.computer.inlines">0</xsl:param></src:fragment>
19 </refsynopsisdiv>
20
21 <refsection><info><title>Description</title></info>
22
23 <para>If zero (the default), hyphenation is suppressed for
24 <quote>computer inlines</quote> such as environment variables,
25 constants, etc. This parameter current affects output of the following
26 elements:
27 <simplelist type="inline">
28   <?dbchoice choice="and" ?>
29   <member><tag>classname</tag></member>
30   <member><tag>constant</tag></member>
31   <member><tag>envar</tag></member>
32   <member><tag>errorcode</tag></member>
33   <member><tag>option</tag></member>
34   <member><tag>replaceable</tag></member>
35   <member><tag>userinput</tag></member>
36   <member><tag>type</tag></member>
37   <member><tag>varname</tag></member>
38 </simplelist>
39 </para>
40
41 <note>
42   <para>If hyphenation is already turned off globally (that is, if
43   <parameter>man.hyphenate</parameter> is zero, setting the
44   <parameter>man.hyphenate.computer.inlines</parameter> is not
45   necessary.</para>
46 </note>
47
48 <para>If <parameter>man.hyphenate.computer.inlines</parameter> is
49 non-zero, computer inlines will not be treated specially and will be
50 hyphenated like other words when needed.</para>
51
52 </refsection>
53 </refentry>