[kde-doc-english] [kdoctools] src: Update man-docbook template

Burkhard Lück lueck at hube-lueck.de
Sat Jun 4 19:51:10 UTC 2016


Git commit ecadd71634c97be6081fe741047a58edfa4b2fcc by Burkhard Lück.
Committed on 04/06/2016 at 19:50.
Pushed by lueck into branch 'master'.

Update man-docbook template

no productname in man pages for extragear applications
use simplelist for See Also
use 'man:/' for man pages
add kf5options(1) for gui apps
add commented qt5options() for gui apps
add empty <variablelist> for use with copy and paste
REVIEW:128022

M  +20   -8    src/man-template.docbook

http://commits.kde.org/kdoctools/ecadd71634c97be6081fe741047a58edfa4b2fcc

diff --git a/src/man-template.docbook b/src/man-template.docbook
index 9cd6c32..770f032 100644
--- a/src/man-template.docbook
+++ b/src/man-template.docbook
@@ -35,6 +35,7 @@ $applicationname xx.yy for applications with independent release schedule (extra
 -->
 
 <productname>KDE Frameworks or KDE Plasma or KDE Applications</productname>
+<!-- no productname in man pages for extragear applications -->
 </refentryinfo>
 
 <refmeta>
@@ -65,7 +66,15 @@ do.--> </para>
 
 <refsect1>
 <title>Options</title>
-<para>App options, in a variablelist</para>
+<!--App options, in a variablelist-->
+<variablelist>
+<varlistentry>
+<term><option></option></term>
+<listitem><para>
+</para></listitem>
+</varlistentry>
+
+</variablelist>
 
 </refsect1>
 
@@ -88,16 +97,19 @@ to remove them, probably in a variablelist.--></para>
 
 <refsect1>
 <title>See Also</title>
-<para><!--foo(1)-style references, use a simplelist for these--></para>
-
-<para>More detailed user documentation is available from <ulink
+<simplelist>
+<member>More detailed user documentation is available from <ulink
 url="help:/ --commandname-- ">help:/<!--command--></ulink>
 (either enter this &URL; into &konqueror;, or run
 <userinput><command>khelpcenter</command>
-<parameter>help:/<!--command--></parameter></userinput>).</para>
-
-<para>There is also further information available at <!--link to
-website if applicable--></para>
+<parameter>help:/<!--command--></parameter></userinput>).</member>
+<!--for man pages replace "help:/" with "man:/" in this member-->
+<member>kf5options(1)</member> <!-- only for application with a GUI-->
+<!--<member>qt5options(1)</member>  only for application with a GUI FIXME use if we have an updated man page qt5options-->
+<!--<member>foo(1)</member> more man page references if applicable-->
+<member>There is also further information available at <!--link to
+website if applicable--></member>
+</simplelist>
 </refsect1>
 
 <refsect1>


More information about the kde-doc-english mailing list