<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="man.th.extra2.max.length"> <refmeta> <refentrytitle>man.th.extra2.max.length</refentrytitle> <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> </refmeta> <refnamediv> <refname>man.th.extra2.max.length</refname> <refpurpose>Maximum length of extra2 in header/footer</refpurpose> </refnamediv> <refsynopsisdiv> <src:fragment xml:id="man.th.extra2.max.length.frag"> <xsl:param name="man.th.extra2.max.length">30</xsl:param> </src:fragment> </refsynopsisdiv> <refsection><info><title>Description</title></info> <para>Specifies the maximum permitted length of the <literal>extra2</literal> part of the man-page part of the <literal>.TH</literal> title line header/footer. If the <literal>extra2</literal> content exceeds the maxiumum specified, it is truncated down to the maximum permitted length.</para> <para>The content of the <literal>extra2</literal> field is usually displayed in the left footer of the page and is typically "source" data indicating the software system or product that the item documented in the man page belongs to, often in the form <replaceable>Name</replaceable> <replaceable>Version</replaceable>; for example, "GTK+ 1.2" (from the <literal>gtk-options(7)</literal> man page).</para> <para>The default value for this parameter is reasonable but somewhat arbitrary. If you are processing pages with long "source" information, you may want to experiment with changing the value in order to achieve the correct aesthetic results.</para> </refsection> </refentry>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#1 | 13895 | Paul Allen | Copying using p4convert-docbook | ||
//guest/perforce_software/doc_build/main/docbook-xsl-ns-1.78.1/params/man.th.extra2.max.length.xml | |||||
#1 | 12728 | eedwards |
Upgrade ANT doc build infrastructure to assemble PDFs: - remove non-namespaced DocBook source and add namespaced DocBook source. - add Apache FOP 1.1 - copy fonts, images, XSL into _build, establishing new asset structure. The original structure remains until all guides using it can be upgraded, and several other issues can be resolved. - updated build.xml to allow for per-target build properties. - upgraded the P4SAG to use the new infrastructure. - tweaked admonition presentation in PDFs to remove admonition graphics, and resemble closely the presentation used in the new HTML layout, including the same colors. With these changes, building PDFs involves using a shell, navigating into the guide's directory (just P4SAG for now), and executing "ant pdf". Issues still to be resolved: - PDF generation encounters several warnings about missing fonts (bold versions of Symbol and ZapfDingbats), and a couple of locations where the page content exceeds the defined content area. - Due to issues within Apache FOP, PDF generation emits a substantial amount of output that is not easily suppressed without losing important warning information. - Apache FOP's interface to ANT does not expose a way to set the font base directory. The current configuration does work under Mac OSX, but further testing on Windows will need to be done to determine if the relative paths defined continue to work. The workaround is for Windows users to customize the fop-config.xml to provide absolute system paths to the required fonts. - HTML generation needs further browser testing, and exhibits broken navigation on iOS browsers within the TOC sidebar. - A number of PDF and HTML presentation tweaks still need to be made, for example: sidebars, gui* DocBook tags, whitespace, section separation, etc. |