Hello community, here is the log from the commit of package kdoctools for openSUSE:Factory checked in at 2016-07-03 12:21:47 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Comparing /work/SRC/openSUSE:Factory/kdoctools (Old) and /work/SRC/openSUSE:Factory/.kdoctools.new (New) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "kdoctools" Changes: -------- --- /work/SRC/openSUSE:Factory/kdoctools/kdoctools.changes 2016-05-19 12:07:09.000000000 +0200 +++ /work/SRC/openSUSE:Factory/.kdoctools.new/kdoctools.changes 2016-07-03 12:21:48.000000000 +0200 @@ -1,0 +2,12 @@ +Mon Jun 6 21:24:52 UTC 2016 - [email protected] + +- Update to 5.23.0 + * Add commonly used entities for keys to en/user.entities + * Update man-docbook template + * Update book template + man template + add arcticle template + * Call kdoctools_create_handbook only for index.docbook + (kde#357428) + * For more details please see: + https://www.kde.org/announcements/kde-frameworks-5.23.0.php + +------------------------------------------------------------------- Old: ---- kdoctools-5.22.0.tar.xz New: ---- kdoctools-5.23.0.tar.xz ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Other differences: ------------------ ++++++ kdoctools.spec ++++++ --- /var/tmp/diff_new_pack.IDOcfT/_old 2016-07-03 12:21:49.000000000 +0200 +++ /var/tmp/diff_new_pack.IDOcfT/_new 2016-07-03 12:21:49.000000000 +0200 @@ -17,9 +17,9 @@ %bcond_without lang -%define _tar_path 5.22 +%define _tar_path 5.23 Name: kdoctools -Version: 5.22.0 +Version: 5.23.0 Release: 0 %define kf5_version %{version} BuildRequires: cmake >= 2.8.12 ++++++ kdoctools-5.22.0.tar.xz -> kdoctools-5.23.0.tar.xz ++++++ diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kdoctools-5.22.0/CMakeLists.txt new/kdoctools-5.23.0/CMakeLists.txt --- old/kdoctools-5.22.0/CMakeLists.txt 2016-05-07 17:12:14.000000000 +0200 +++ new/kdoctools-5.23.0/CMakeLists.txt 2016-06-06 13:33:27.000000000 +0200 @@ -4,7 +4,7 @@ # ECM setup include(FeatureSummary) -find_package(ECM 5.22.0 NO_MODULE) +find_package(ECM 5.23.0 NO_MODULE) set_package_properties(ECM PROPERTIES TYPE REQUIRED DESCRIPTION "Extra CMake Modules." URL "https://projects.kde.org/projects/kdesupport/extra-cmake-modules";) feature_summary(WHAT REQUIRED_PACKAGES_NOT_FOUND FATAL_ON_MISSING_REQUIRED_PACKAGES) @@ -15,8 +15,8 @@ include(ECMMarkNonGuiExecutable) include(ECMPackageConfigHelpers) -set(KF5_VERSION "5.22.0") # handled by release scripts -set(KF5_DEP_VERSION "5.22.0") # handled by release scripts +set(KF5_VERSION "5.23.0") # handled by release scripts +set(KF5_DEP_VERSION "5.23.0") # handled by release scripts ecm_setup_version(${KF5_VERSION} VARIABLE_PREFIX KDOCTOOLS VERSION_HEADER "${CMAKE_CURRENT_BINARY_DIR}/kdoctools_version.h" PACKAGE_VERSION_FILE "${CMAKE_CURRENT_BINARY_DIR}/KF5DocToolsConfigVersion.cmake" diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kdoctools-5.22.0/KF5DocToolsMacros.cmake new/kdoctools-5.23.0/KF5DocToolsMacros.cmake --- old/kdoctools-5.22.0/KF5DocToolsMacros.cmake 2016-05-07 17:12:14.000000000 +0200 +++ new/kdoctools-5.23.0/KF5DocToolsMacros.cmake 2016-06-06 13:33:27.000000000 +0200 @@ -41,24 +41,25 @@ # Search for docbook files in <podir> and install them to the standard # location. # This is a convenience function which relies on all docbooks being kept in -# <podir>/<lang>/docs, where <lang> is the language the docbooks are written -# in. +# <podir>/<lang>/docs/<project>, where <lang> is the language the docbooks +# for <project> are written in. # # Within this directory, files ending with .[0-9].docbook are installed using # KDOCTOOLS_CREATE_MANPAGE, other .docbook files are installed using -# KDOCTOOLS_CREATE_HANDBOOK. +# KDOCTOOLS_CREATE_HANDBOOK if index.docbook is available. # # For example, given the following directory structure: # # po/ # fr/ # docs/ -# kioslave5/ -# fooslave/ -# index.docbook -# footool.1.docbook -# footool.conf.5.docbook -# index.docbook +# foo/ +# kioslave5/ +# fooslave/ +# index.docbook +# footool.1.docbook +# footool.conf.5.docbook +# index.docbook # # KDOCTOOLS_INSTALL(po) does the following: # - Create man pages from footool.1.docbook and footool.conf.5.docbook, @@ -224,14 +225,13 @@ INSTALL_DESTINATION ${MAN_INSTALL_DIR}/${lang} ) else() - string(REGEX MATCH "docs/(.*)/.*.docbook" match ${docbook}) + string(REGEX MATCH "docs/(.*)/index.docbook" match ${docbook}) if (match) - set(extra_args SUBDIR ${CMAKE_MATCH_1}) + kdoctools_create_handbook(${docbook} + INSTALL_DESTINATION ${HTML_INSTALL_DIR}/${lang} + SUBDIR ${CMAKE_MATCH_1} + ) endif() - kdoctools_create_handbook(${docbook} - INSTALL_DESTINATION ${HTML_INSTALL_DIR}/${lang} - ${extra_args} - ) endif() endforeach() endforeach() diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kdoctools-5.22.0/metainfo.yaml new/kdoctools-5.23.0/metainfo.yaml --- old/kdoctools-5.22.0/metainfo.yaml 2016-05-07 17:12:14.000000000 +0200 +++ new/kdoctools-5.23.0/metainfo.yaml 2016-06-06 13:33:27.000000000 +0200 @@ -8,3 +8,7 @@ deprecated: false release: true cmakename: KF5DocTools + +public_lib: true +group: Frameworks +subgroup: Tier 2 diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kdoctools-5.22.0/src/article-template.docbook new/kdoctools-5.23.0/src/article-template.docbook --- old/kdoctools-5.22.0/src/article-template.docbook 1970-01-01 01:00:00.000000000 +0100 +++ new/kdoctools-5.23.0/src/article-template.docbook 2016-06-06 13:33:27.000000000 +0200 @@ -0,0 +1,67 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" +"dtd/kdedbx45.dtd" [ +<!ENTITY i18n-translatable-entity "<application>Translatable Entity</application>"> +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<!-- +Use this template for kioslave, systemsettings (kcontrol) modules and simple/short application docbooks +Otherwise use use template.docbook for application docbooks +Rename this template to index.docbook and place into the directory doc/[kcontrol|kioslave5] +--> + +<article id="foo" lang="&language;"> +<articleinfo> +<title>Foo</title> +<authorgroup> +<author> +<!-- This is just put in as an example. For real documentation, please + define a general entity in entities/contributor.entities, e.g. +<!ENTITY George.N.Ugnacious "<personname><firstname>George</firstname><othername>N.</othername><surname>Ugnacious</surname></personname>"> +<!ENTITY George.N.Ugnacious.mail "<email>[email protected]</email>"> +and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element. + --> +<personname> +<firstname>George</firstname> +<othername>N.</othername> +<surname>Ugnacious</surname> +</personname> +<email>[email protected]</email> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<!-- 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. +--> +<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 +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 xx.yy or Plasma xx.yy or Applications xx.yy or xx.yy (Applications xx.yy) or $applicationname xx.yy</releaseinfo> + +<keywordset> +<keyword>KDE Applications</keyword> +<keyword>foo</keyword> +<keyword>bar</keyword> +<keyword>baz</keyword> +</keywordset> +</articleinfo> + +<para>First para</para> + +<para>second para</para> + +</article> diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kdoctools-5.22.0/src/customization/en/user.entities new/kdoctools-5.23.0/src/customization/en/user.entities --- old/kdoctools-5.22.0/src/customization/en/user.entities 2016-05-07 17:12:14.000000000 +0200 +++ new/kdoctools-5.23.0/src/customization/en/user.entities 2016-06-06 13:33:27.000000000 +0200 @@ -8,19 +8,25 @@ <!ENTITY Alt "<keycap>Alt</keycap>"> <!ENTITY applications "<productname>Applications</productname>"> -<!ENTITY Backspace "<keycap>Backspace</keycap>"> +<!ENTITY Backspace "<keysym>Backspace</keysym>"> <!ENTITY cdrom '<hardware>CD-ROM drive</hardware>'> <!ENTITY Ctrl "<keycap>Ctrl</keycap>"> +<!ENTITY Del "<keycap>Del</keycap>"> +<!ENTITY Down "<keysym>Down</keysym>"> <!-- Cursor key--> <!ENTITY dpi '<acronym>dpi</acronym>'> <!ENTITY eg "<abbrev>e.g.</abbrev>"> -<!ENTITY Enter "<keycap>Enter</keycap>"> +<!ENTITY End "<keycap>End</keycap>"> +<!ENTITY Enter "<keysym>Enter</keysym>"> <!ENTITY Esc "<keycap>Esc</keycap>"> <!ENTITY etc "<abbrev>etc.</abbrev>"> <!ENTITY FAQ '<acronym>FAQ</acronym>'> +<!ENTITY Home "<keycap>Home</keycap>"> <!ENTITY ie "<abbrev>i.e.</abbrev>"> <!ENTITY infocenter "<application>Info Center</application>"> +<!ENTITY Ins "<keycap>Ins</keycap>"> <!ENTITY kde-frameworks "<productname>&kde; Frameworks</productname>"> <!ENTITY kf5-full "&kde-frameworks; <productnumber>5</productnumber>"> +<!ENTITY Left "<keysym>Left</keysym>"> <!-- Cursor key--> <!ENTITY LMB "<mousebutton>left</mousebutton> mouse button"> <!ENTITY MMB "<mousebutton>middle</mousebutton> mouse button"> <!ENTITY OS "operating system"><!-- <acronym>OS</acronym>--> @@ -30,12 +36,16 @@ <!ENTITY plasma-netbook "<productname>&kde; Plasma Netbook</productname>"> <!ENTITY plasma-desktop "<productname>&kde; Plasma Desktop</productname>"> <!ENTITY plasma-workspaces "<productname>&kde; Plasma Workspaces</productname>"> -<!ENTITY plasmapa "<productname>&kde; Plasma Pulseaudio</productname>"> +<!ENTITY plasmapa "<productname>&kde; Plasma Pulseaudio</productname>"> +<!ENTITY PgUp "<keysym>PgUp</keysym>"> +<!ENTITY PgDn "<keysym>PgDn</keysym>"> +<!ENTITY Right "<keysym>Right</keysym>"> <!-- Cursor key--> <!ENTITY RMB "<mousebutton>right</mousebutton> mouse button"> <!ENTITY Shift "<keycap>Shift</keycap>"> <!ENTITY systemsettings "<application>System Settings</application>"> <!ENTITY systemtray "<application>system tray</application>"> <!ENTITY Tab "<keycap>Tab</keycap>"> +<!ENTITY Up "<keysym>Up</keysym>"> <!-- Cursor key--> <!-- Deprecated, will be removed at a future time, do not use --> <!ENTITY kcontrolcenter "<application>&kde; Control Center</application>"> diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kdoctools-5.22.0/src/man-template.docbook new/kdoctools-5.23.0/src/man-template.docbook --- old/kdoctools-5.22.0/src/man-template.docbook 2016-05-07 17:12:14.000000000 +0200 +++ new/kdoctools-5.23.0/src/man-template.docbook 2016-06-06 13:33:27.000000000 +0200 @@ -3,6 +3,10 @@ <!ENTITY % English "INCLUDE"> ]> +<!--Rename this template to man-$applicationname.x.docbook, +where x is the manual section, see https://en.wikipedia.org/wiki/Man_page#Manual_sections +--> + <refentry lang="&language;"> <refentryinfo> <!-- replace Foo with the application name--> @@ -26,11 +30,12 @@ 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 +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> +<!-- no productname in man pages for extragear applications --> </refentryinfo> <refmeta> @@ -61,7 +66,15 @@ <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> @@ -84,16 +97,19 @@ <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> diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kdoctools-5.22.0/src/template.docbook new/kdoctools-5.23.0/src/template.docbook --- old/kdoctools-5.22.0/src/template.docbook 2016-05-07 17:12:14.000000000 +0200 +++ new/kdoctools-5.23.0/src/template.docbook 2016-06-06 13:33:27.000000000 +0200 @@ -5,15 +5,27 @@ <!ENTITY kmyapplication "<application>KMyApp</application>"> <!ENTITY kappname "&kmyapplication;"><!-- replace kmyapplication here do *not* replace kappname--> + <!ENTITY i18n-translatable-entity "<application>Translatable Entity</application>"> <!ENTITY % addindex "IGNORE"> <!ENTITY % English "INCLUDE"> <!-- ONLY If you are writing non-English original documentation, change the language here --> - <!-- Do not define any other entities; instead, use the entities from entities/general.entities and en/user.entities. --> ]> -<!-- kdoctemplate v0.11.0 2015-04-03 lueck + +<!-- +Use this template for application docbooks +For kioslave, systemsettings (kcontrol) modules and simple/short application docbooks use article-template.docbook +Rename this template to index.docbook and place into the directory doc/ or doc/appname if you have several applications in one doc directory +--> + +<!-- kdoctemplate v0.12.0 2016-04-23 lueck + add translatable entities + remove help.menu.documentation entity + and add some examples how to use the common menus Settings and Help + + 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 @@ -106,17 +118,17 @@ Don't forget to include this last date. Please respect the format of the date (YYYY-MM-DD),it is used by scripts. --> -<date>2015-04-03</date> +<date>2016-04-23</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 (Applications xx.yy) for docbooks with own version released as Applications +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 xx.yy or Plasma xx.yy or Applications xx.yy or $applicationname xx.yy (Applications xx.yy) or $applicationname xx.yy</releaseinfo> +<releaseinfo>Frameworks xx.yy or Plasma xx.yy or Applications xx.yy or xx.yy (Applications xx.yy) or $applicationname xx.yy</releaseinfo> <!-- Abstract about this handbook --> @@ -277,7 +289,8 @@ </menuchoice></term> <listitem><para><action>Creates a new document</action></para></listitem> </varlistentry> -<varlistentry> + +<varlistentry id="file-save"> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> @@ -287,7 +300,8 @@ </menuchoice></term> <listitem><para><action>Saves the document</action></para></listitem> </varlistentry> -<varlistentry> + +<varlistentry id="file-quit"> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> @@ -302,16 +316,40 @@ </sect2> -<sect2> -<title>The Help Menu</title> +<!-- Examples how to use the common menus Settings and Help --> -<!-- Assuming you have a standard help menu (help, what's this, about --> -<!-- &kmyapplication;, about KDE) then the documentation is already written. --> -<!-- The following entity is valid anywhere that a variablelist is --> -<!-- valid. --> +<sect2 id="settings-help-menu"> +<title>The Settings and Help Menu</title> +<para> +&kmyapplication; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu> +menu items, for more information read the sections about the <ulink url="help:/fundamentals/ui.html#menus-settings" +>Settings Menu</ulink> and <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink> +of the &kde; Fundamentals. +</para> +</sect2> + +<sect2 id="help-menu1"> +<title>The Help Menu</title> +<para> +&kmyapplication; has the common &kde; <guimenu>Help</guimenu> menu item, for more information read the section +about the <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink> of the &kde; Fundamentals. +</para> +</sect2> -&help.menu.documentation; +<sect2 id="menu-commands"> +<title>Menu Items</title> +<para>Apart from the common &kde; menus described in the <ulink url="help:/fundamentals/ui.html#menus">Menu</ulink> +chapter of the &kde; Fundamentals documentation &kmyapplication; has these application specific menu entries: +</para> +<!-- variablelist --> +</sect2> +<sect2 id="help-menu2"> +<title>The Help Menu</title> +<para>&kmyapplication; has a default &kde; <guimenu>Help</guimenu> menu as described in the +<ulink url="help:/fundamentals/ui.html#menus-help">&kde; Fundamentals</ulink> +with two additional entries:</para> +<!-- variablelist --> </sect2> </sect1>
