From: Michael Smith <xmldoc@users.sourceforge.net>
Date: Fri, 19 Jan 2007 11:40:50 +0000 (+0000)
Subject: Added doc for man.output.lang.in.name.enabled parameter. This
X-Git-Tag: release/1.79.1~6^2~2332
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=de0d27e259eb69daec5b8a565f7a0104aa7bbf13;p=docbook-dsssl

Added doc for man.output.lang.in.name.enabled parameter. This
checkin completes support for writing file/pathnames for man-pages
with $lang include in the names. Closes #1585967. knightly
accolades to Daniel Leidert for providing the feature request.
---

diff --git a/xsl/manpages/param.ent b/xsl/manpages/param.ent
index e80096e43..5e6915fa8 100644
--- a/xsl/manpages/param.ent
+++ b/xsl/manpages/param.ent
@@ -46,6 +46,7 @@
 <!ENTITY man.output.manifest.filename SYSTEM "../params/man.output.manifest.filename.xml">
 <!ENTITY man.output.encoding SYSTEM "../params/man.output.encoding.xml">
 <!ENTITY man.output.in.separate.dir SYSTEM "../params/man.output.in.separate.dir.xml">
+<!ENTITY man.output.lang.in.name.enabled SYSTEM "../params/man.output.lang.in.name.enabled.xml">
 <!ENTITY man.output.base.dir SYSTEM "../params/man.output.base.dir.xml">
 <!ENTITY man.output.subdirs.enabled SYSTEM "../params/man.output.subdirs.enabled.xml">
 <!ENTITY man.subheading.divider SYSTEM "../params/man.subheading.divider.xml">
diff --git a/xsl/manpages/param.xweb b/xsl/manpages/param.xweb
index 52f61b87e..731426e80 100644
--- a/xsl/manpages/param.xweb
+++ b/xsl/manpages/param.xweb
@@ -107,6 +107,7 @@
 &man.output.manifest.enabled;
 &man.output.manifest.filename;
 &man.output.in.separate.dir;
+&man.output.lang.in.name.enabled;
 &man.output.base.dir;
 &man.output.subdirs.enabled;
 &man.output.quietly;
@@ -162,6 +163,7 @@
 <src:fragref linkend="man.output.quietly.frag"/>
 <src:fragref linkend="man.output.encoding.frag"/>
 <src:fragref linkend="man.output.in.separate.dir.frag"/>
+<src:fragref linkend="man.output.lang.in.name.enabled.frag"/>
 <src:fragref linkend="man.output.base.dir.frag"/>
 <src:fragref linkend="man.output.subdirs.enabled.frag"/>
 <src:fragref linkend="man.string.subst.map.local.pre.frag"/>
diff --git a/xsl/params/man.output.lang.in.name.enabled.xml b/xsl/params/man.output.lang.in.name.enabled.xml
new file mode 100644
index 000000000..9022a7962
--- /dev/null
+++ b/xsl/params/man.output.lang.in.name.enabled.xml
@@ -0,0 +1,47 @@
+<refentry xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          id="man.output.lang.in.name.enabled">
+<refmeta>
+<refentrytitle>man.output.lang.in.name.enabled</refentrytitle>
+
+</refmeta>
+<refnamediv>
+<refname>man.output.lang.in.name.enabled</refname>
+<refpurpose>Include $LANG value in man-page filename/pathname?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment id='man.output.lang.in.name.enabled.frag'>
+<xsl:param name="man.output.lang.in.name.enabled" select="0"/>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+  <para>The <parameter>man.output.lang.in.name.enabled</parameter>
+  parameter specifies which controls whether a <literal>$lang</literal>
+  value is included in man-page filenames and pathnames.</para>
+
+  <para>If the value of
+  <parameter>man.output.lang.in.name.enabled</parameter> is non-zero,
+  man-page files are output with the <literal>$lang</literal> value
+  included in their filenames or pathnames as follows;
+
+  <itemizedlist>
+    <listitem>
+      <para>if <parameter>man.output.subdirs.enabled</parameter> is
+      non-zero, each file is output to, e.g., a
+      <filename>man/<replaceable>$lang</replaceable>/man8/foo.8</filename>
+      pathname</para>
+    </listitem>
+    <listitem>
+      <para>if <parameter>man.output.subdirs.enabled</parameter> is
+      zero, each file is output with a
+      <literal>foo.<replaceable>$lang</replaceable>.8</literal>
+      filename</para>
+    </listitem>
+  </itemizedlist>
+  </para>
+
+</refsect1>
+</refentry>
\ No newline at end of file