From 60a5a938e6657250d228742b8367f8dbe7dd28d4 Mon Sep 17 00:00:00 2001 From: Manuel Canales Esparcia Date: Sat, 21 Jul 2007 15:00:15 +0000 Subject: Merged r8226 from new-xsl branch. git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@8228 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689 --- .../docbook-xsl-snapshot/common/refentry.xsl | 105 +++++++++------------ 1 file changed, 47 insertions(+), 58 deletions(-) (limited to 'stylesheets/lfs-xsl/docbook-xsl-snapshot/common/refentry.xsl') diff --git a/stylesheets/lfs-xsl/docbook-xsl-snapshot/common/refentry.xsl b/stylesheets/lfs-xsl/docbook-xsl-snapshot/common/refentry.xsl index 4373e4849..892b9fb72 100644 --- a/stylesheets/lfs-xsl/docbook-xsl-snapshot/common/refentry.xsl +++ b/stylesheets/lfs-xsl/docbook-xsl-snapshot/common/refentry.xsl @@ -16,36 +16,25 @@ ******************************************************************** --> - - + + + Common » Refentry Metadata Template Reference $Id$ - The DocBook Project - - 2005-2007 - The DocBook Project - - - Refentry Metadata-Gathering Template Reference - - + + + Introduction - - This is technical reference documentation for the "refentry - metadata gathering" templates in the DocBook XSL Stylesheets. - + This is technical reference documentation for the “refentry + metadata” templates in the DocBook XSL Stylesheets. This is not intended to be user documentation. It is provided - for developers writing customization layers for the - stylesheets. - + for developers writing customization layers for the stylesheets. Currently, only the manpages stylesheets make use of these templates. They are, however, potentially useful elsewhere. - - @@ -56,27 +45,27 @@ etc., is sometimes viewed in isolation from its greater "context". For example, users view Unix man pages as, well, individual pages, not as part of a "book" of some kind. Therefore, it is sometimes necessary to - embed "context" information in output for each refentry. + embed "context" information in output for each refentry. However, one problem is that different users mark up that context information in different ways. Often (usually), the context information is not actually part of the content of the - refentry itself, but instead part of the content of a - parent or ancestor element to the the refentry. And + refentry itself, but instead part of the content of a + parent or ancestor element to the the refentry. And even then, DocBook provides a variety of elements that users might potentially use to mark up the same kind of information. One user - might use the productnumber element to mark up version + might use the productnumber element to mark up version information about a particular product, while another might use - the releaseinfo element. + the releaseinfo element. Taking all that in mind, the get.refentry.metadata template tries to gather - metadata from a refentry element and its ancestor + metadata from a refentry element and its ancestor elements in an intelligent and user-configurable way. The basic mechanism used in the XPath expressions throughout this stylesheet is to select the relevant metadata from the *info element that is - closest to the actual refentry – either on the - refentry itself, or on its nearest ancestor. + closest to the actual refentry – either on the + refentry itself, or on its nearest ancestor. The get.refentry.metadata @@ -91,13 +80,13 @@ refname - The first refname in the refentry + The first refname in the refentry info - A set of info nodes (from a refentry + A set of info nodes (from a refentry element and its ancestors) @@ -194,23 +183,23 @@ The man(7) man page describes this as "the title of the man page (e.g., MAN). This differs - from refname in that, if the refentry has a - refentrytitle, we use that as the title; - otherwise, we just use first refname in the first - refnamediv in the source. + from refname in that, if the refentry has a + refentrytitle, we use that as the title; + otherwise, we just use first refname in the first + refnamediv in the source. refname - The first refname in the refentry + The first refname in the refentry - Returns a title node. + Returns a title node. @@ -232,8 +221,8 @@ The man(7) man page describes this as "the section number the man page should be placed in (e.g., - 7)". If we do not find a manvolnum - specified in the source, and we find that the refentry is + 7)". If we do not find a manvolnum + specified in the source, and we find that the refentry is for a function, we use the section number 3 ["Library calls (functions within program libraries)"]; otherwise, we default to using 1 ["Executable programs or shell @@ -244,7 +233,7 @@ refname - The first refname in the refentry + The first refname in the refentry @@ -323,13 +312,13 @@ refname - The first refname in the refentry + The first refname in the refentry info - A set of info nodes (from a refentry + A set of info nodes (from a refentry element and its ancestors) @@ -342,7 +331,7 @@ - Returns a date node. + Returns a date node. @@ -495,13 +484,13 @@ refname - The first refname in the refentry + The first refname in the refentry info - A set of info nodes (from a refentry + A set of info nodes (from a refentry element and its ancestors) @@ -515,7 +504,7 @@ - Returns a source node. + Returns a source node. @@ -611,13 +600,13 @@ refname - The first refname in the refentry + The first refname in the refentry info - A set of info nodes (from a refentry + A set of info nodes (from a refentry element and its ancestors) @@ -795,13 +784,13 @@ refname - The first refname in the refentry + The first refname in the refentry info - A set of info nodes (from a refentry + A set of info nodes (from a refentry element and its ancestors) @@ -981,13 +970,13 @@ refname - The first refname in the refentry + The first refname in the refentry info - A set of info nodes (from a refentry + A set of info nodes (from a refentry element and its ancestors) @@ -1001,7 +990,7 @@ - Returns a manual node. + Returns a manual node. @@ -1140,25 +1129,25 @@ Gets user preferences for refentry metadata gathering The DocBook XSL stylesheets include several user-configurable - global stylesheet parameters for controlling refentry + global stylesheet parameters for controlling refentry metadata gathering. Those parameters are not read directly by the - other refentry metadata-gathering + other refentry metadata-gathering templates. Instead, they are read only by the get.refentry.metadata.prefs template, which assembles them into a structure that is then passed to - the other refentry metadata-gathering + the other refentry metadata-gathering templates. So the, get.refentry.metadata.prefs template is the only interface to collecting stylesheet parameters for - controlling refentry metadata gathering. + controlling refentry metadata gathering. There are no local parameters for this template; however, it does rely on a number of global parameters. - Returns a manual node. + Returns a manual node. @@ -1223,7 +1212,7 @@ refname - The first refname in the refentry + The first refname in the refentry -- cgit v1.2.3-54-g00ecf