[kde-doc-english] [kdoctools] src: Update book and man page templates

Burkhard Lück lueck at hube-lueck.de
Sun Aug 2 08:25:18 UTC 2015


Git commit ba96b49835b386956ed6911600625906beee1062 by Burkhard Lück.
Committed on 02/08/2015 at 08:24.
Pushed by lueck into branch 'master'.

Update book and man page templates
Add missing changelog from last RR to book template
Clarify instructions about date + releaseinfo
Use same naming scheme im man template for releaseinfo as in book template
Change naming scheme for productname
REVIEW:/124533

M  +14   -3    src/man-template.docbook
M  +12   -2    src/template.docbook

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

diff --git a/src/man-template.docbook b/src/man-template.docbook
index f88cc79..98b57f8 100644
--- a/src/man-template.docbook
+++ b/src/man-template.docbook
@@ -15,11 +15,22 @@
 <!--Date when this manpage was written, in the ISO 8601 format 'yyyy-mm-dd'-->
 <date>2015-04-03</date>
 <!--version information of application this manpage is valid for.
+Change date if
+   docbook is updated and verified to be valid for the current app version
+   docbook is proofreaded and verified to be valid for the current app version
 -->
-<releaseinfo>$applicationname xx.yy</releaseinfo>
+<releaseinfo>Frameworks xx.yy or Plasma xx.yy or Applications xx.yy or $applicationname xx.yy</releaseinfo>
 <!-- replace $applicationname with the application name; &kde; as prefix/namespace could
-be not needed, ask the promo team in case of doubt-->
-<productname>$applicationname</productname>
+be not needed, ask the promo team in case of doubt
+Example:
+Frameworks xx.yy for docbooks in frameworks
+Plasma xx.yy for docbooks in plasma
+Applications xx.yy for docbooks released as Applications
+$applicationname xx.yy (Applications xx.yy) for docbooks with own version released as Applications
+$applicationname xx.yy for applications with independent release schedule (extragear/playground)
+-->
+
+<productname>KDE Frameworks or KDE Plasma or KDE Applications</productname>
 </refentryinfo>
 
 <refmeta>
diff --git a/src/template.docbook b/src/template.docbook
index d7225be..3a22f5f 100644
--- a/src/template.docbook
+++ b/src/template.docbook
@@ -13,7 +13,13 @@
   <!-- Do not define any other entities; instead, use the entities
        from entities/general.entities and en/user.entities. -->
 ]>
-<!-- kdoctemplate v0.10.0 2014-04-02 ltoscano
+<!-- kdoctemplate v0.11.0 2015-04-03 lueck
+     updated instructions for date + releaseinfo
+     remove ENTITY package - not used anymore
+     add info about KDE Games special chapters
+     Appendix Installation is now optional
+
+     kdoctemplate v0.10.0 2014-04-02 ltoscano
      updated to KF5/kdoctools
      references to KDE reworded
 
@@ -94,6 +100,9 @@ and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element.
 <legalnotice>&FDLNotice;</legalnotice>
 
 <!-- Date of the documentation
+Change date if
+   docbook is updated and verified to be valid for the current app version
+   docbook is proofreaded and verified to be valid for the current app version
 Don't forget to include this last date.
 Please respect the format of the date (YYYY-MM-DD),it is used by scripts.
 -->
@@ -104,9 +113,10 @@ Example:
 Frameworks xx.yy for docbooks in frameworks
 Plasma xx.yy for docbooks in plasma workspace
 Applications xx.yy for docbooks released as Applications
+$applicationname xx.yy (Applications xx.yy) for docbooks with own version released as Applications
 $applicationname xx.yy for applications with independent release schedule (extragear/playground)
 -->
-<releaseinfo>Frameworks or Plasma or Applications or $applicationname xx.yy</releaseinfo>
+<releaseinfo>Frameworks xx.yy or Plasma xx.yy or Applications xx.yy or $applicationname xx.yy (Applications xx.yy) or $applicationname xx.yy</releaseinfo>
 
 <!-- Abstract about this handbook -->
 


More information about the kde-doc-english mailing list