Git commit ec3dba06390e448d098f78c61126d748e543213b by Burkhard Lück. Committed on 02/07/2015 at 18:43. Pushed by lueck into branch 'master'.
Update K5 docbook templates See thread in https://mail.kde.org/pipermail/kde-doc-english/2015-June/012204.html REVIEW:124167 M +6 -6 src/man-template.docbook M +34 -9 src/template.docbook http://commits.kde.org/kdoctools/ec3dba06390e448d098f78c61126d748e543213b diff --git a/src/man-template.docbook b/src/man-template.docbook index 3f05136..f88cc79 100644 --- a/src/man-template.docbook +++ b/src/man-template.docbook @@ -13,13 +13,13 @@ </personname> <email><!--Your email address--></email></author> <!--Date when this manpage was written, in the ISO 8601 format 'yyyy-mm-dd'--> -<date>2014-04-03</date> -<!--version information of the application this documentation is valid for. -for example 'xx.yy.zz'--> -<releaseinfo>5.1</releaseinfo> -<!-- replace Foo with the application name; &kde; as prefix/namespace could +<date>2015-04-03</date> +<!--version information of application this manpage is valid for. +--> +<releaseinfo>$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>&kde; &kappname;</productname> +<productname>$applicationname</productname> </refentryinfo> <refmeta> diff --git a/src/template.docbook b/src/template.docbook index e5b35d8..d7225be 100644 --- a/src/template.docbook +++ b/src/template.docbook @@ -5,9 +5,6 @@ <!ENTITY kmyapplication "<application>KMyApp</application>"> <!ENTITY kappname "&kmyapplication;"><!-- replace kmyapplication here do *not* replace kappname--> - <!ENTITY package "kde-module"><!-- kdebase, kdeadmin, etc. Leave - this unchanged if your - application is not maintained in KDE source archiv --> <!ENTITY % addindex "IGNORE"> <!ENTITY % English "INCLUDE"> <!-- ONLY If you are writing non-English original documentation, change @@ -91,7 +88,7 @@ and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element. </authorgroup> <copyright> -<year>2014</year> +<year>2015</year> <holder>George N. Ugnacious</holder> </copyright> <legalnotice>&FDLNotice;</legalnotice> @@ -100,12 +97,16 @@ and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element. Don't forget to include this last date. Please respect the format of the date (YYYY-MM-DD),it is used by scripts. --> -<date>2014-04-03</date> - -<!--version information of the application and kde this documentation is valid for. -for example 'xx.yy.zz' +<date>2015-04-03</date> + +<!--version information of Frameworks/Plasma/Applications this documentation is valid for. +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 for applications with independent release schedule (extragear/playground) --> -<releaseinfo>1.01.00</releaseinfo> +<releaseinfo>Frameworks or Plasma or Applications or $applicationname xx.yy</releaseinfo> <!-- Abstract about this handbook --> @@ -139,6 +140,24 @@ system. Any chapter labelled (OPTIONAL) may be left out at the author's discretion. Other chapters should not be left out in order to maintain a consistent documentation style across all KDE apps. --> + +<!-- KDE Games have special chapters + +Introduction + +How to play + +Game Rules, Strategies and Tips + +Interface Overview + +Frequently asked questions + +Credits and License + +Please use one of index.docbook files from kdegames + +--> <chapter id="introduction"> <title>Introduction</title> @@ -386,6 +405,12 @@ Documentation Copyright © 2012-2014 George N. Ugnacious <email>gnu at kde.org< </chapter> +<!-- Appendix Installation is optional, usually not required + +Entities &install.intro.documentation; + &install.compile.documentation; will be removed in later kdoctools + +--> + <appendix id="installation"> <title>Installation</title>
