gnucash-docs master: Multiple changes pushed

Geert Janssens gjanssens at code.gnucash.org
Fri Aug 19 13:13:51 EDT 2022


Updated	 via  https://github.com/Gnucash/gnucash-docs/commit/acbc7782 (commit)
	 via  https://github.com/Gnucash/gnucash-docs/commit/caa84965 (commit)
	 via  https://github.com/Gnucash/gnucash-docs/commit/10b5d0dc (commit)
	 via  https://github.com/Gnucash/gnucash-docs/commit/8e5725c2 (commit)
	from  https://github.com/Gnucash/gnucash-docs/commit/80c951c1 (commit)



commit acbc77822bb29921231285592893762264a96a70
Author: Geert Janssens <geert at kobaltwit.be>
Date:   Mon Aug 15 19:02:44 2022 +0200

    Replace ghelp: links in the source documents themselves with help: links to refer to our new documentation locations

diff --git a/guide/C/appendixd.xml b/guide/C/appendixd.xml
index 52b7b184..7bc1360d 100644
--- a/guide/C/appendixd.xml
+++ b/guide/C/appendixd.xml
@@ -759,7 +759,7 @@ Blocking_Chars</literallayout>
                   </menuchoice>
                   for number source (transaction number or anchor-split action - see
                   <ulink type="help"
-                    url="ghelp:gnucash-help?num-action-book-option">Use
+                    url="help:gnucash-help?num-action-book-option">Use
                   Split Action Field for Number</ulink> in the Book Options section of the &app;
                   Help Manual).
                 </entry>
@@ -809,7 +809,7 @@ Blocking_Chars</literallayout>
                   </menuchoice>
                   for number source (transaction number or anchor-split action - see
                   <ulink
-                    type="help" url="ghelp:gnucash-help?num-action-book-option">
+                    type="help" url="help:gnucash-help?num-action-book-option">
                   Use Split Action Field for Number</ulink> in the Book Options section of the &app;
                   Help Manual). If number source for the book is specified as anchor-split action,
                   this field will instead print the transaction number field.
diff --git a/guide/C/ch_bus_features.xml b/guide/C/ch_bus_features.xml
index 263fa4ab..45c3ad35 100644
--- a/guide/C/ch_bus_features.xml
+++ b/guide/C/ch_bus_features.xml
@@ -1783,7 +1783,7 @@
               <guimenu>Reports</guimenu><guimenuitem>Account Report </guimenuitem>
             </menuchoice>
             . Further formatting or analysis may be done by copying and pasting the report into a
-            spreadsheet. See <ulink type="help" url="ghelp:gnucash-help?tool-find-txn">Find
+            spreadsheet. See <ulink type="help" url="help:gnucash-help?tool-find-txn">Find
             Transaction</ulink> in the &app; Help Manual.
           </para>
         </note>
diff --git a/guide/C/legal.xml b/guide/C/legal.xml
index ec40d11a..78b59e46 100644
--- a/guide/C/legal.xml
+++ b/guide/C/legal.xml
@@ -5,7 +5,7 @@
     Free Documentation License (GFDL), Version 1.1 or any later version published by the Free
     Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
     You can find a copy of the GFDL at this <ulink type="help"
-	  url="ghelp:fdl">link</ulink> or in
+	  url="help:fdl">link</ulink> or in
     the file COPYING-DOCS distributed with this manual.
   </para>
 
diff --git a/guide/de/appendixd.xml b/guide/de/appendixd.xml
index 7fca09f3..7b71bc82 100644
--- a/guide/de/appendixd.xml
+++ b/guide/de/appendixd.xml
@@ -762,7 +762,7 @@ Blocking_Chars</literallayout>
                   </menuchoice>
                   for number source (transaction number or anchor-split action - see
                   <ulink type="help"
-                    url="ghelp:gnucash-help?num-action-book-option">Use
+                    url="help:gnucash-help?num-action-book-option">Use
                   Split Action Field for Number</ulink> in the Book Options section of the &app;
                   Help Manual).
                 </entry>
@@ -812,7 +812,7 @@ Blocking_Chars</literallayout>
                   </menuchoice>
                   for number source (transaction number or anchor-split action - see
                   <ulink
-                    type="help" url="ghelp:gnucash-help?num-action-book-option">
+                    type="help" url="help:gnucash-help?num-action-book-option">
                   Use Split Action Field for Number</ulink> in the Book Options section of the &app;
                   Help Manual). If number source for the book is specified as anchor-split action,
                   this field will instead print the transaction number field.
diff --git a/guide/it/index.docbook b/guide/it/index.docbook
index 014e3957..f1a71c36 100644
--- a/guide/it/index.docbook
+++ b/guide/it/index.docbook
@@ -75,7 +75,7 @@
         Free Documentation License (GFDL), Version 1.1 or any later version published by the Free
         Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
         Texts. You can find a copy of the GFDL at this
-        <ulink type="help" url="ghelp:fdl">link</ulink> or in the file COPYING-DOCS distributed with
+        <ulink type="help" url="help:fdl">link</ulink> or in the file COPYING-DOCS distributed with
         this manual.
       </para>
 
@@ -16014,7 +16014,7 @@ Basic A/R and A/P Account Hierarchy:
                   <guimenu>Reports</guimenu><guimenuitem>Account Report </guimenuitem>
                 </menuchoice>
                 . Further formatting or analysis may be done by copying and pasting the report into
-                a spreadsheet. See <ulink type="help" url="ghelp:gnucash-help?tool-find-txn">Find
+                a spreadsheet. See <ulink type="help" url="help:gnucash-help?tool-find-txn">Find
                 Transaction</ulink> in the &app; Help Manual.
               </para>
             </note>
@@ -19849,7 +19849,7 @@ Blocking_Chars
                         <guimenu>File</guimenu><guimenuitem>Proprietà</guimenuitem>
                       </menuchoice>
                       for number source (transaction number or anchor-split action - see
-                      <ulink type="help" url="ghelp:gnucash-help?num-action-book-option">Use Split
+                      <ulink type="help" url="help:gnucash-help?num-action-book-option">Use Split
                       Action Field for Number</ulink> in the Book Options section of the &app; Help
                       Manual).
                     </entry>
@@ -19901,7 +19901,7 @@ Blocking_Chars
                         <guimenu>File</guimenu><guimenuitem>Proprietà</guimenuitem>
                       </menuchoice>
                       for number source (transaction number or anchor-split action - see
-                      <ulink type="help" url="ghelp:gnucash-help?num-action-book-option"> Use Split
+                      <ulink type="help" url="help:gnucash-help?num-action-book-option"> Use Split
                       Action Field for Number</ulink> in the Book Options section of the &app; Help
                       Manual). If number source for the book is specified as anchor-split action,
                       this field will instead print the transaction number field.
diff --git a/guide/it/it.po b/guide/it/it.po
index 0a277831..4f46fe5b 100644
--- a/guide/it/it.po
+++ b/guide/it/it.po
@@ -1536,14 +1536,14 @@ msgid ""
 "the terms of the GNU Free Documentation License (GFDL), Version 1.1 or any "
 "later version published by the Free Software Foundation with no Invariant "
 "Sections, no Front-Cover Texts, and no Back-Cover Texts. You can find a copy "
-"of the GFDL at this <ulink type=\"help\" url=\"ghelp:fdl\">link</ulink> or "
+"of the GFDL at this <ulink type=\"help\" url=\"help:fdl\">link</ulink> or "
 "in the file COPYING-DOCS distributed with this manual."
 msgstr ""
 "Permission is granted to copy, distribute and/or modify this document under "
 "the terms of the GNU Free Documentation License (GFDL), Version 1.1 or any "
 "later version published by the Free Software Foundation with no Invariant "
 "Sections, no Front-Cover Texts, and no Back-Cover Texts. You can find a copy "
-"of the GFDL at this <ulink type=\"help\" url=\"ghelp:fdl\">link</ulink> or "
+"of the GFDL at this <ulink type=\"help\" url=\"help:fdl\">link</ulink> or "
 "in the file COPYING-DOCS distributed with this manual."
 
 #: C/gnucash-guide.xml:12(para)
diff --git a/guide/ja/appendixd.xml b/guide/ja/appendixd.xml
index 8470ed16..516d0b75 100644
--- a/guide/ja/appendixd.xml
+++ b/guide/ja/appendixd.xml
@@ -764,7 +764,7 @@ Blocking_Chars</literallayout>
                   </menuchoice>
                   for number source (transaction number or anchor-split action - see
                   <ulink type="help"
-                    url="ghelp:gnucash-help?num-action-book-option">Use
+                    url="help:gnucash-help?num-action-book-option">Use
                   Split Action Field for Number</ulink> in the Book Options section of the &app;
                   Help Manual).
                 </entry>
@@ -814,7 +814,7 @@ Blocking_Chars</literallayout>
                   </menuchoice>
                   for number source (transaction number or anchor-split action - see
                   <ulink
-                    type="help" url="ghelp:gnucash-help?num-action-book-option">
+                    type="help" url="help:gnucash-help?num-action-book-option">
                   Use Split Action Field for Number</ulink> in the Book Options section of the &app;
                   Help Manual). If number source for the book is specified as anchor-split action,
                   this field will instead print the transaction number field.
diff --git a/guide/ja/legal.xml b/guide/ja/legal.xml
index 2bdc7153..1632dec7 100644
--- a/guide/ja/legal.xml
+++ b/guide/ja/legal.xml
@@ -5,7 +5,7 @@
     Free Documentation License (GFDL), Version 1.1 or any later version published by the Free
     Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
     You can find a copy of the GFDL at this <ulink type="help"
-	  url="ghelp:fdl">link</ulink> or in
+	  url="help:fdl">link</ulink> or in
     the file COPYING-DOCS distributed with this manual.
   </para>
 
diff --git a/guide/pt/appendixd.xml b/guide/pt/appendixd.xml
index 2cea33f5..4a4bcc87 100644
--- a/guide/pt/appendixd.xml
+++ b/guide/pt/appendixd.xml
@@ -766,7 +766,7 @@ Blocking_Chars</literallayout>
                   </menuchoice>
                   for number source (transaction number or anchor-split action - see
                   <ulink type="help"
-                    url="ghelp:gnucash-help?num-action-book-option">Use
+                    url="help:gnucash-help?num-action-book-option">Use
                   Split Action Field for Number</ulink> in the Book Options section of the &app;
                   Help Manual).
                 </entry>
@@ -816,7 +816,7 @@ Blocking_Chars</literallayout>
                   </menuchoice>
                   for number source (transaction number or anchor-split action - see
                   <ulink
-                    type="help" url="ghelp:gnucash-help?num-action-book-option">
+                    type="help" url="help:gnucash-help?num-action-book-option">
                   Use Split Action Field for Number</ulink> in the Book Options section of the &app;
                   Help Manual). If number source for the book is specified as anchor-split action,
                   this field will instead print the transaction number field.
diff --git a/guide/pt/legal.xml b/guide/pt/legal.xml
index 990629d3..4653f7dc 100644
--- a/guide/pt/legal.xml
+++ b/guide/pt/legal.xml
@@ -5,7 +5,7 @@
     Free Documentation License (GFDL), Version 1.1 or any later version published by the Free
     Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
     You can find a copy of the GFDL at this <ulink type="help"
-	  url="ghelp:fdl">link</ulink> or in
+	  url="help:fdl">link</ulink> or in
     the file COPYING-DOCS distributed with this manual.
   </para>
 
diff --git a/guide/ru/appendixd.xml b/guide/ru/appendixd.xml
index abe3e29b..593b8b6b 100644
--- a/guide/ru/appendixd.xml
+++ b/guide/ru/appendixd.xml
@@ -759,7 +759,7 @@ Blocking_Chars</literallayout>
                   </menuchoice>
                   for number source (transaction number or anchor-split action - see
                   <ulink type="help"
-                    url="ghelp:gnucash-help?num-action-book-option">Use
+                    url="help:gnucash-help?num-action-book-option">Use
                   Split Action Field for Number</ulink> in the Book Options section of the &app;
                   Help Manual).
                 </entry>
@@ -809,7 +809,7 @@ Blocking_Chars</literallayout>
                   </menuchoice>
                   for number source (transaction number or anchor-split action - see
                   <ulink
-                    type="help" url="ghelp:gnucash-help?num-action-book-option">
+                    type="help" url="help:gnucash-help?num-action-book-option">
                   Use Split Action Field for Number</ulink> in the Book Options section of the &app;
                   Help Manual). If number source for the book is specified as anchor-split action,
                   this field will instead print the transaction number field.
diff --git a/guide/ru/ch_bus_features.xml b/guide/ru/ch_bus_features.xml
index 6d419062..89f89ec8 100644
--- a/guide/ru/ch_bus_features.xml
+++ b/guide/ru/ch_bus_features.xml
@@ -1783,7 +1783,7 @@
               <guimenu>Reports</guimenu><guimenuitem>Account Report </guimenuitem>
             </menuchoice>
             . Further formatting or analysis may be done by copying and pasting the report into a
-            spreadsheet. See <ulink type="help" url="ghelp:gnucash-help?tool-find-txn">Find
+            spreadsheet. See <ulink type="help" url="help:gnucash-help?tool-find-txn">Find
             Transaction</ulink> in the &app; Help Manual.
           </para>
         </note>
diff --git a/guide/ru/legal.xml b/guide/ru/legal.xml
index 6d8cdf31..6ed8d1d3 100644
--- a/guide/ru/legal.xml
+++ b/guide/ru/legal.xml
@@ -5,7 +5,7 @@
     Free Documentation License (GFDL), Version 1.1 or any later version published by the Free
     Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
     You can find a copy of the GFDL at this <ulink type="help"
-	  url="ghelp:fdl">link</ulink> or in
+	  url="help:fdl">link</ulink> or in
     the file COPYING-DOCS distributed with this manual.
   </para>
 
diff --git a/manual/C/legal.xml b/manual/C/legal.xml
index 84cd6a6d..8e8bc418 100644
--- a/manual/C/legal.xml
+++ b/manual/C/legal.xml
@@ -5,7 +5,7 @@
     Free Documentation License (GFDL), Version 1.1 or any later version published by the Free
     Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
     You can find a copy of the GFDL at this <ulink type="help"
-	  url="ghelp:fdl">link</ulink> or in
+	  url="help:fdl">link</ulink> or in
     the file COPYING-DOCS distributed with this manual.
   </para>
 
diff --git a/manual/de/legal.xml b/manual/de/legal.xml
index cafba49f..596693f6 100644
--- a/manual/de/legal.xml
+++ b/manual/de/legal.xml
@@ -5,7 +5,7 @@
     Version 1.1 oder jeder späteren, von der Free Software Foundation veröffentlichten Version
     ohne unveränderbare Abschnitte sowie ohne Texte auf dem vorderen und hinteren Buchdeckel
     kopiert, verteilt und/oder modifiziert werden. Eine Kopie der GFDL finden Sie unter diesem
-    <ulink type="help" url="ghelp:fdl">Link</ulink> oder in der mit diesem Handbuch gelieferten
+    <ulink type="help" url="help:fdl">Link</ulink> oder in der mit diesem Handbuch gelieferten
     Datei COPYING-DOCs.
   </para>
 
diff --git a/manual/it/index.docbook b/manual/it/index.docbook
index 1c060411..819f018c 100644
--- a/manual/it/index.docbook
+++ b/manual/it/index.docbook
@@ -50,7 +50,7 @@
         Free Documentation License (GFDL), Version 1.1 or any later version published by the Free
         Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
         Texts. You can find a copy of the GFDL at this
-        <ulink type="help" url="ghelp:fdl">link</ulink> or in the file COPYING-DOCS distributed with
+        <ulink type="help" url="help:fdl">link</ulink> or in the file COPYING-DOCS distributed with
         this manual.
       </para>
 
diff --git a/manual/it/it.po b/manual/it/it.po
index 58986b4e..66dbd4e8 100644
--- a/manual/it/it.po
+++ b/manual/it/it.po
@@ -147,8 +147,8 @@ msgid "GnuCash Documentation Team"
 msgstr "Gruppo della documentazione di &appname;"
 
 #: C/gnucash-help.xml:2(para)
-msgid "Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License (GFDL), Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You can find a copy of the GFDL at this <ulink type=\"help\" url=\"ghelp:fdl\">link</ulink> or in the file COPYING-DOCS distributed with this manual."
-msgstr "Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License (GFDL), Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You can find a copy of the GFDL at this <ulink type=\"help\" url=\"ghelp:fdl\">link</ulink> or in the file COPYING-DOCS distributed with this manual."
+msgid "Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License (GFDL), Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You can find a copy of the GFDL at this <ulink type=\"help\" url=\"help:fdl\">link</ulink> or in the file COPYING-DOCS distributed with this manual."
+msgstr "Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License (GFDL), Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You can find a copy of the GFDL at this <ulink type=\"help\" url=\"help:fdl\">link</ulink> or in the file COPYING-DOCS distributed with this manual."
 
 #: C/gnucash-help.xml:12(para)
 msgid "This manual is part of a collection of GNOME manuals distributed under the GFDL. If you want to distribute this manual separately from the collection, you can do so by adding a copy of the license to the manual, as described in section 6 of the license."
diff --git a/manual/pt/legal.xml b/manual/pt/legal.xml
index eb1f04ff..471cbdf0 100644
--- a/manual/pt/legal.xml
+++ b/manual/pt/legal.xml
@@ -5,7 +5,7 @@
     Free Documentation License (GFDL), Version 1.1 or any later version published by the Free
     Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
     You can find a copy of the GFDL at this <ulink type="help"
-	  url="ghelp:fdl">link</ulink> or in
+	  url="help:fdl">link</ulink> or in
     the file COPYING-DOCS distributed with this manual.
   </para>
 

commit caa849650777fb171696a23aaa1fe3be4313eafb
Author: Geert Janssens <geert at kobaltwit.be>
Date:   Mon Aug 15 18:57:40 2022 +0200

    Rename all GHelp related parameters and variables to XdgHelp

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 4b3c8fc8..920d1576 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -39,13 +39,13 @@ unset(dist_files CACHE)
 # On any other platform chm and mobi are disabled by default
 
 if(NOT WIN32)
-    option (WITH_GHELP "Enable build rules for gnome help document format" ON)
+    option (WITH_XDGHELP "Enable build rules for gnome help document format" ON)
     option (WITH_HTML "Enable build rules for html document format" ON)
     option (WITH_PDF "Enable build rules for pdf document format" ON)
     option (WITH_EPUB "Enable build rules for epub document format" ON)
     option (WITH_CHM "Enable build rules for chm document format" OFF)
 else()
-    option (WITH_GHELP "Enable build rules for gnome help document format" OFF)
+    option (WITH_XDGHELP "Enable build rules for gnome help document format" OFF)
     option (WITH_HTML "Enable build rules for html document format" OFF)
     option (WITH_PDF "Enable build rules for pdf document format" OFF)
     option (WITH_EPUB "Enable build rules for epub document format" OFF)
@@ -150,11 +150,11 @@ add_custom_target(check)
 if (WITH_HTML)
     add_custom_target(html)
 endif()
-if (WITH_GHELP)
+if (WITH_XDGHELP)
   if (UNIX AND NOT APPLE)
-    add_custom_target(ghelp ALL)
+    add_custom_target(xdghelp ALL)
   else(UNIX AND NOT APPLE)
-    add_custom_target(ghelp)
+    add_custom_target(xdghelp)
   endif()
 endif()
 if (WITH_PDF)
diff --git a/cmake/AddGncDocTargets.cmake b/cmake/AddGncDocTargets.cmake
index a4f9d359..92c29bde 100644
--- a/cmake/AddGncDocTargets.cmake
+++ b/cmake/AddGncDocTargets.cmake
@@ -28,8 +28,8 @@ function (add_gnc_doc_targets docname entities)
     if (WITH_CHM)
       add_chm_target(${docname} ${lang} "${entities}" "${figures}")
     endif()
-    if (WITH_GHELP)
-      add_ghelp_target(${docname} ${lang} "${entities}" "${figures}")
+    if (WITH_XDGHELP)
+      add_xdghelp_target(${docname} ${lang} "${entities}" "${figures}")
     endif()
     if (WITH_HTML)
       add_html_target(${docname} ${lang} "${entities}" "${figures}")
diff --git a/cmake/AddXdgHelpTarget.cmake b/cmake/AddXdgHelpTarget.cmake
index c4692a6f..e49b1f99 100644
--- a/cmake/AddXdgHelpTarget.cmake
+++ b/cmake/AddXdgHelpTarget.cmake
@@ -8,7 +8,7 @@
 # - entities: list of all xml files this document is composed of
 # - figdir: name of the directory holding the images
 
-function (add_ghelp_target docname lang entities figures)
+function (add_xdghelp_target docname lang entities figures)
 
     set(BUILD_DIR "${DATADIR_BUILD}/help/${lang}/${docname}")
 
@@ -31,10 +31,10 @@ function (add_ghelp_target docname lang entities figures)
     endforeach()
 
     add_custom_command(
-      OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/ghelptrigger"
+      OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/xdghelptrigger"
       COMMAND ${CMAKE_COMMAND} -E make_directory "${BUILD_DIR}"
       COMMAND ${CMAKE_COMMAND} -E make_directory "${BUILD_DIR}/figures"
-      COMMAND touch "${CMAKE_CURRENT_BINARY_DIR}/ghelptrigger")
+      COMMAND touch "${CMAKE_CURRENT_BINARY_DIR}/xdghelptrigger")
 
 
     add_custom_command(
@@ -45,22 +45,22 @@ function (add_ghelp_target docname lang entities figures)
 
     # Copy figures for this document
     add_custom_command(
-        OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/ghelp_figtrigger"
+        OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/xdghelp_figtrigger"
         COMMAND ${CMAKE_COMMAND} -E copy ${figures} "${BUILD_DIR}/figures"
-        COMMAND touch "${CMAKE_CURRENT_BINARY_DIR}/ghelp_figtrigger"
-        DEPENDS ${figures} "${CMAKE_CURRENT_BINARY_DIR}/ghelptrigger")
+        COMMAND touch "${CMAKE_CURRENT_BINARY_DIR}/xdghelp_figtrigger"
+        DEPENDS ${figures} "${CMAKE_CURRENT_BINARY_DIR}/xdghelptrigger")
 
-    add_custom_target("${lang}-${docname}-ghelp"
-        DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/ghelptrigger"
+    add_custom_target("${lang}-${docname}-xdghelp"
+        DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/xdghelptrigger"
                  ${dest_files}
-                "${CMAKE_CURRENT_BINARY_DIR}/ghelp_figtrigger")
+                "${CMAKE_CURRENT_BINARY_DIR}/xdghelp_figtrigger")
 
-    add_dependencies(${docname}-ghelp "${lang}-${docname}-ghelp")
+    add_dependencies(${docname}-xdghelp "${lang}-${docname}-xdghelp")
 
     install(FILES ${source_files}
         DESTINATION "${CMAKE_INSTALL_DATADIR}/help/${lang}/${docname}"
-        COMPONENT "ghelp")
+        COMPONENT "xdghelp")
     install(FILES ${figures}
         DESTINATION "${CMAKE_INSTALL_DATADIR}/help/${lang}/${docname}/figures"
-        COMPONENT "ghelp")
+        COMPONENT "xdghelp")
 endfunction()
diff --git a/guide/CMakeLists.txt b/guide/CMakeLists.txt
index 548a36f4..5afe1ae3 100644
--- a/guide/CMakeLists.txt
+++ b/guide/CMakeLists.txt
@@ -8,9 +8,9 @@ if (WITH_HTML)
     add_dependencies(html ${docname}-html)
 endif()
 
-if (WITH_GHELP)
-    add_custom_target(${docname}-ghelp)
-    add_dependencies(ghelp ${docname}-ghelp)
+if (WITH_XDGHELP)
+    add_custom_target(${docname}-xdghelp)
+    add_dependencies(xdghelp ${docname}-xdghelp)
 endif()
 
 if (WITH_PDF)
diff --git a/manual/CMakeLists.txt b/manual/CMakeLists.txt
index 74f4d8dd..748a27be 100644
--- a/manual/CMakeLists.txt
+++ b/manual/CMakeLists.txt
@@ -8,9 +8,9 @@ if (WITH_HTML)
     add_dependencies(html ${docname}-html)
 endif()
 
-if (WITH_GHELP)
-    add_custom_target(${docname}-ghelp)
-    add_dependencies(ghelp ${docname}-ghelp)
+if (WITH_XDGHELP)
+    add_custom_target(${docname}-xdghelp)
+    add_dependencies(xdghelp ${docname}-xdghelp)
 endif()
 
 if (WITH_PDF)

commit 10b5d0dc4d6cb2fa125d1686de49238321471485
Author: Geert Janssens <geert at kobaltwit.be>
Date:   Mon Aug 15 18:39:55 2022 +0200

    Rename GHelp to XdgHelp - step 1
    
    This commit only renames the file cmake/AddGHelpTarget.cmake to keep
    bisecting simple. File content changes will be done in future commits.

diff --git a/CMakeLists.txt b/CMakeLists.txt
index c2b02f8e..4b3c8fc8 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -20,7 +20,7 @@ set (PACKAGE_PREFIX "${PROJECT_NAME}-${gnucash-docs_VERSION}")
 set (CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake;${CMAKE_MODULE_PATH}")
 include (AddChmTarget)
 include (AddEpubTarget)
-include (AddGHelpTarget)
+include (AddXdgHelpTarget)
 include (AddHtmlTarget)
 include (AddPdfTarget)
 include (AddGncDocTargets)
diff --git a/cmake/AddGHelpTarget.cmake b/cmake/AddXdgHelpTarget.cmake
similarity index 100%
rename from cmake/AddGHelpTarget.cmake
rename to cmake/AddXdgHelpTarget.cmake

commit 8e5725c2f0ee78f043f1b8dda64a5d8e9aa5e472
Author: Geert Janssens <geert at kobaltwit.be>
Date:   Sat Sep 7 13:06:00 2019 +0200

    Update ghelp target to install docs according to the xdg help specification
    
    The spec can be found here: https://www.freedesktop.org/wiki/Specifications/help-spec/
    "ghelp:" is hardly used still on linux. The new standard is well supported by yelp.
    
    What this does is
    * rename the primary documents from gnucash-guide.xml/gnucash-help.xml to index.docbook
    * update book id's for manuals to "index" (required for the spec)
    * reshuffle the target output directories from share/gnome/help/(docname)/lang to share/help/(lang)/(docname)

diff --git a/cmake/AddChmTarget.cmake b/cmake/AddChmTarget.cmake
index d6be1afb..50d1e325 100644
--- a/cmake/AddChmTarget.cmake
+++ b/cmake/AddChmTarget.cmake
@@ -20,7 +20,7 @@ function (add_chm_target docname lang entities figures)
            "-Dentities=\"${entities}\""
            -D HHC=${HHC}
            -P ${CMAKE_SOURCE_DIR}/cmake/MakeChm.cmake
-        DEPENDS ${entities} "${docname}.xml" "${CMAKE_SOURCE_DIR}/docbook/gnc-docbookx.dtd" ${figures}
+        DEPENDS ${entities} "index.docbook" "${CMAKE_SOURCE_DIR}/docbook/gnc-docbookx.dtd" ${figures}
         WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/htmlhelp")
 
     add_custom_target("${lang}-${docname}-chm"
diff --git a/cmake/AddEpubTarget.cmake b/cmake/AddEpubTarget.cmake
index 6dfcb0d4..b74f2906 100644
--- a/cmake/AddEpubTarget.cmake
+++ b/cmake/AddEpubTarget.cmake
@@ -17,11 +17,11 @@ function (add_epub_target docname lang entities figures)
                             --stringparam epub.oebps.dir OEBPS/
                             --stringparam fop1.extensions 1
                             "${CMAKE_SOURCE_DIR}/xsl/1.79.2/epub/docbook.xsl"
-                            "${CMAKE_CURRENT_SOURCE_DIR}/${docname}.xml"
+                            "${CMAKE_CURRENT_SOURCE_DIR}/index.docbook"
         COMMAND cmake -E copy_directory "${CMAKE_CURRENT_SOURCE_DIR}/figures" "${EPUB_TMPDIR}/OEBPS/figures"
         COMMAND ${CMAKE_COMMAND} -E make_directory "${BUILD_DIR}"
         COMMAND cd "${EPUB_TMPDIR}" && zip -X -r "${BUILD_DIR}/${epubfile}" mimetype META-INF OEBPS
-        DEPENDS ${entities} "${docname}.xml" "${CMAKE_SOURCE_DIR}/docbook/gnc-docbookx.dtd" ${figures})
+        DEPENDS ${entities} "index.docbook" "${CMAKE_SOURCE_DIR}/docbook/gnc-docbookx.dtd" ${figures})
 
     add_custom_target("${lang}-${docname}-epub"
         DEPENDS "${BUILD_DIR}/${epubfile}")
diff --git a/cmake/AddGHelpTarget.cmake b/cmake/AddGHelpTarget.cmake
index 840e5149..c4692a6f 100644
--- a/cmake/AddGHelpTarget.cmake
+++ b/cmake/AddGHelpTarget.cmake
@@ -10,10 +10,10 @@
 
 function (add_ghelp_target docname lang entities figures)
 
-    set(BUILD_DIR "${DATADIR_BUILD}/gnome/help/${docname}/${lang}")
+    set(BUILD_DIR "${DATADIR_BUILD}/help/${lang}/${docname}")
 
     set(source_files "")
-    foreach(xml_file ${entities} ${docname}.xml)
+    foreach(xml_file ${entities} index.docbook)
         list(APPEND source_files "${CMAKE_CURRENT_SOURCE_DIR}/${xml_file}")
     endforeach()
 
@@ -26,7 +26,7 @@ function (add_ghelp_target docname lang entities figures)
 
 
     set(dest_files "")
-    foreach(xml_file ${entities} ${docname}.xml gnc-docbookx.dtd)
+    foreach(xml_file ${entities} index.docbook gnc-docbookx.dtd)
         list(APPEND dest_files "${BUILD_DIR}/${xml_file}")
     endforeach()
 
@@ -40,7 +40,7 @@ function (add_ghelp_target docname lang entities figures)
     add_custom_command(
         OUTPUT ${dest_files}
         COMMAND ${CMAKE_COMMAND} -E copy ${source_files} "${BUILD_DIR}"
-        DEPENDS ${entities} "${docname}.xml" ${dtd_files}
+        DEPENDS ${entities} "index.docbook" ${dtd_files}
         WORKING_DIRECTORY "${BUILD_DIR}")
 
     # Copy figures for this document
@@ -58,9 +58,9 @@ function (add_ghelp_target docname lang entities figures)
     add_dependencies(${docname}-ghelp "${lang}-${docname}-ghelp")
 
     install(FILES ${source_files}
-        DESTINATION "${CMAKE_INSTALL_DATADIR}/gnome/help/${docname}/${lang}"
+        DESTINATION "${CMAKE_INSTALL_DATADIR}/help/${lang}/${docname}"
         COMPONENT "ghelp")
     install(FILES ${figures}
-        DESTINATION "${CMAKE_INSTALL_DATADIR}/gnome/help/${docname}/${lang}/figures"
+        DESTINATION "${CMAKE_INSTALL_DATADIR}/help/${lang}/${docname}/figures"
         COMPONENT "ghelp")
 endfunction()
diff --git a/cmake/AddGncDocTargets.cmake b/cmake/AddGncDocTargets.cmake
index ab5aa06b..a4f9d359 100644
--- a/cmake/AddGncDocTargets.cmake
+++ b/cmake/AddGncDocTargets.cmake
@@ -13,14 +13,14 @@ function (add_gnc_doc_targets docname entities)
                                 --xinclude
                                 --noout
                                 --path ${CMAKE_SOURCE_DIR}/docbook
-                                ${CMAKE_CURRENT_SOURCE_DIR}/${docname}.xml
+                                ${CMAKE_CURRENT_SOURCE_DIR}/index.docbook
             COMMAND  ${CMAKE_COMMAND}
                 -D XMLLINT=${XMLLINT}
                 -D GNC_SOURCE_DIR=${CMAKE_SOURCE_DIR}
                 -D GNC_CURRENT_SOURCE_DIR=${CMAKE_CURRENT_SOURCE_DIR}
                 -D docname=${docname}
                 -P ${CMAKE_SOURCE_DIR}/cmake/CheckFigures.cmake
-            DEPENDS ${entities} "${docname}.xml" "${CMAKE_SOURCE_DIR}/docbook/gnc-docbookx.dtd")
+            DEPENDS ${entities} "index.docbook" "${CMAKE_SOURCE_DIR}/docbook/gnc-docbookx.dtd")
         add_dependencies(${docname}-check "${lang}-${docname}-check")
     endif()
 
@@ -50,7 +50,7 @@ function (add_gnc_doc_targets docname entities)
 
     add_to_dist(
         CMakeLists.txt
-        ${docname}.xml
+        index.docbook
         ${entities}
         ${figures_dist})
 
diff --git a/cmake/AddHtmlTarget.cmake b/cmake/AddHtmlTarget.cmake
index 0c8e5fc5..1a056e13 100644
--- a/cmake/AddHtmlTarget.cmake
+++ b/cmake/AddHtmlTarget.cmake
@@ -27,9 +27,9 @@ function (add_html_target docname lang entities figures)
                              --param use.id.as.filename "1"
                              --stringparam chunker.output.encoding UTF-8
                              "${CMAKE_SOURCE_DIR}/xsl/general-customization.xsl"
-                             "${CMAKE_CURRENT_SOURCE_DIR}/${docname}.xml"
+                             "${CMAKE_CURRENT_SOURCE_DIR}/index.docbook"
         COMMAND touch "${CMAKE_CURRENT_BINARY_DIR}/htmltrigger"
-        DEPENDS ${entities} "${docname}.xml" "${CMAKE_SOURCE_DIR}/docbook/gnc-docbookx.dtd")
+        DEPENDS ${entities} "index.docbook" "${CMAKE_SOURCE_DIR}/docbook/gnc-docbookx.dtd")
 
     # Copy figures for this document
     add_custom_command(
diff --git a/cmake/AddPdfTarget.cmake b/cmake/AddPdfTarget.cmake
index cdb4ce6f..124ff125 100644
--- a/cmake/AddPdfTarget.cmake
+++ b/cmake/AddPdfTarget.cmake
@@ -27,8 +27,8 @@ function (add_pdf_target docname lang entities figures)
                             --stringparam variablelist.as.blocks 1
                             --stringparam glosslist.as.blocks 1
                             "${CMAKE_SOURCE_DIR}/xsl/1.79.2/fo/docbook.xsl"
-                            "${CMAKE_CURRENT_SOURCE_DIR}/${docname}.xml"
-        DEPENDS ${entities} "${docname}.xml" "${CMAKE_SOURCE_DIR}/docbook/gnc-docbookx.dtd")
+                            "${CMAKE_CURRENT_SOURCE_DIR}/index.docbook"
+        DEPENDS ${entities} "index.docbook" "${CMAKE_SOURCE_DIR}/docbook/gnc-docbookx.dtd")
 
     configure_file("${FOP_XCONF}" "${CMAKE_CURRENT_BINARY_DIR}/fop.xconf")
 
diff --git a/cmake/CheckFigures.cmake b/cmake/CheckFigures.cmake
index 1a6dfad1..c24b60fb 100644
--- a/cmake/CheckFigures.cmake
+++ b/cmake/CheckFigures.cmake
@@ -3,7 +3,7 @@ execute_process(
                        --xinclude
                        --path ${GNC_SOURCE_DIR}/docbook
                        --xpath "//imagedata/@fileref"
-                       ${GNC_CURRENT_SOURCE_DIR}/${docname}.xml
+                       ${GNC_CURRENT_SOURCE_DIR}/index.docbook
     RESULT_VARIABLE LINT_RESULT
     OUTPUT_VARIABLE xml_figures
 )
diff --git a/cmake/MakeChm.cmake b/cmake/MakeChm.cmake
index ef977f9b..e0ffe8c7 100644
--- a/cmake/MakeChm.cmake
+++ b/cmake/MakeChm.cmake
@@ -17,7 +17,7 @@ execute_process(
     COMMAND ${XSLTPROC} --path "${SRC_DIR}/docbook" --xinclude
                         --stringparam htmlhelp.chm ${chmfile}
                         "${SRC_DIR}/xsl/1.79.2/htmlhelp/htmlhelp.xsl"
-                        "${CURRENT_SRC_DIR}/${docname}.xml"
+                        "${CURRENT_SRC_DIR}/index.docbook"
     WORKING_DIRECTORY "${htmlhelpdir}")
 
 file(COPY "${CURRENT_SRC_DIR}/figures" DESTINATION "${htmlhelpdir}")
diff --git a/guide/C/gnucash-guide.xml b/guide/C/index.docbook
similarity index 100%
rename from guide/C/gnucash-guide.xml
rename to guide/C/index.docbook
diff --git a/guide/de/gnucash-guide.xml b/guide/de/index.docbook
similarity index 100%
rename from guide/de/gnucash-guide.xml
rename to guide/de/index.docbook
diff --git a/guide/it/CMakeLists.txt b/guide/it/CMakeLists.txt
index 9a53da33..d56889f6 100644
--- a/guide/it/CMakeLists.txt
+++ b/guide/it/CMakeLists.txt
@@ -1,5 +1,5 @@
 set (COMPONENTS
-        ${top_srcdir}/guide/C/gnucash-guide.xml
+        ${top_srcdir}/guide/C/index.docbook
         ${top_srcdir}/guide/C/fdl-appendix.xml
         ${top_srcdir}/guide/C/legal.xml
         ${top_srcdir}/guide/C/ch_oview.xml
@@ -24,8 +24,8 @@ set (COMPONENTS
         ${top_srcdir}/guide/C/appendixa.xml
         ${top_srcdir}/guide/C/appendixd.xml)
 
-#gnucash-guide.xml: ${COMPONENTS} ${srcdir}/it.po
-#        xml2po -e -p ${srcdir}/it.po -o $@ ${top_srcdir}/guide/C/gnucash-guide.xml
+#index.docbook: ${COMPONENTS} ${srcdir}/it.po
+#        xml2po -e -p ${srcdir}/it.po -o $@ ${top_srcdir}/guide/C/index.docbook
 #        if test "${srcdir}" != "${builddir}"; then mv $@ ${srcdir}; fi
 
 add_gnc_doc_targets(${docname} "")
diff --git a/guide/it/gnucash-guide.xml b/guide/it/index.docbook
similarity index 100%
rename from guide/it/gnucash-guide.xml
rename to guide/it/index.docbook
diff --git a/guide/ja/gnucash-guide.xml b/guide/ja/index.docbook
similarity index 100%
rename from guide/ja/gnucash-guide.xml
rename to guide/ja/index.docbook
diff --git a/guide/pt/gnucash-guide.xml b/guide/pt/index.docbook
similarity index 100%
rename from guide/pt/gnucash-guide.xml
rename to guide/pt/index.docbook
diff --git a/guide/ru/gnucash-guide.xml b/guide/ru/index.docbook
similarity index 100%
rename from guide/ru/gnucash-guide.xml
rename to guide/ru/index.docbook
diff --git a/manual/C/gnucash-help.xml b/manual/C/index.docbook
similarity index 99%
rename from manual/C/gnucash-help.xml
rename to manual/C/index.docbook
index 14b12824..3ead2217 100644
--- a/manual/C/gnucash-help.xml
+++ b/manual/C/index.docbook
@@ -9,7 +9,7 @@
   Translators:
                (translators put your name and email here)
 -->
-<book id="help" lang="en"
+<book id="index" lang="en"
       xmlns:xi="http://www.w3.org/2001/XInclude">
 <!-- please do not change the id; for translations, change lang to -->
 <!-- appropriate code -->
diff --git a/manual/de/gnucash-help.xml b/manual/de/index.docbook
similarity index 99%
rename from manual/de/gnucash-help.xml
rename to manual/de/index.docbook
index 37383b9e..aa3fe676 100644
--- a/manual/de/gnucash-help.xml
+++ b/manual/de/index.docbook
@@ -18,7 +18,7 @@
     Structure of translation adjusted to rev 19776
     Frank Ellenberger (f.ellenberger at online.de)
 -->
-<book id='help' lang="de"
+<book id='index' lang="de"
       xmlns:xi="http://www.w3.org/2001/XInclude">
 <!-- please do not change the id; for translations, change lang to -->
 <!-- appropriate code -->
diff --git a/manual/it/gnucash-help.xml b/manual/it/index.docbook
similarity index 99%
rename from manual/it/gnucash-help.xml
rename to manual/it/index.docbook
index 7bce5462..1c060411 100644
--- a/manual/it/gnucash-help.xml
+++ b/manual/it/index.docbook
@@ -16,7 +16,7 @@
   Translators:
                (translators put your name and email here)
 -->
-<book id="help" lang="it"
+<book id="index" lang="it"
       xmlns:xi="http://www.w3.org/2001/XInclude">
 <!-- please do not change the id; for translations, change lang to -->
 <!-- appropriate code -->
diff --git a/manual/pt/gnucash-help.xml b/manual/pt/index.docbook
similarity index 99%
rename from manual/pt/gnucash-help.xml
rename to manual/pt/index.docbook
index db093509..bf76f500 100644
--- a/manual/pt/gnucash-help.xml
+++ b/manual/pt/index.docbook
@@ -16,7 +16,7 @@
   Translators:
                (Pedro Albuquerque <palbuquerque73 at gmail.com>)
 -->
-<book id="help" lang="pt"
+<book id="index" lang="pt"
       xmlns:xi="http://www.w3.org/2001/XInclude">
 <!-- please do not change the id; for translations, change lang to -->
 <!-- appropriate code -->



Summary of changes:
 CMakeLists.txt                                     | 12 ++++----
 cmake/AddChmTarget.cmake                           |  2 +-
 cmake/AddEpubTarget.cmake                          |  4 +--
 cmake/AddGncDocTargets.cmake                       | 10 +++---
 cmake/AddHtmlTarget.cmake                          |  4 +--
 cmake/AddPdfTarget.cmake                           |  4 +--
 ...AddGHelpTarget.cmake => AddXdgHelpTarget.cmake} | 36 +++++++++++-----------
 cmake/CheckFigures.cmake                           |  2 +-
 cmake/MakeChm.cmake                                |  2 +-
 guide/C/appendixd.xml                              |  4 +--
 guide/C/ch_bus_features.xml                        |  2 +-
 guide/C/{gnucash-guide.xml => index.docbook}       |  0
 guide/C/legal.xml                                  |  2 +-
 guide/CMakeLists.txt                               |  6 ++--
 guide/de/appendixd.xml                             |  4 +--
 guide/de/{gnucash-guide.xml => index.docbook}      |  0
 guide/it/CMakeLists.txt                            |  6 ++--
 guide/it/{gnucash-guide.xml => index.docbook}      |  8 ++---
 guide/it/it.po                                     |  4 +--
 guide/ja/appendixd.xml                             |  4 +--
 guide/ja/{gnucash-guide.xml => index.docbook}      |  0
 guide/ja/legal.xml                                 |  2 +-
 guide/pt/appendixd.xml                             |  4 +--
 guide/pt/{gnucash-guide.xml => index.docbook}      |  0
 guide/pt/legal.xml                                 |  2 +-
 guide/ru/appendixd.xml                             |  4 +--
 guide/ru/ch_bus_features.xml                       |  2 +-
 guide/ru/{gnucash-guide.xml => index.docbook}      |  0
 guide/ru/legal.xml                                 |  2 +-
 manual/C/{gnucash-help.xml => index.docbook}       |  2 +-
 manual/C/legal.xml                                 |  2 +-
 manual/CMakeLists.txt                              |  6 ++--
 manual/de/{gnucash-help.xml => index.docbook}      |  2 +-
 manual/de/legal.xml                                |  2 +-
 manual/it/{gnucash-help.xml => index.docbook}      |  4 +--
 manual/it/it.po                                    |  4 +--
 manual/pt/{gnucash-help.xml => index.docbook}      |  2 +-
 manual/pt/legal.xml                                |  2 +-
 38 files changed, 79 insertions(+), 79 deletions(-)
 rename cmake/{AddGHelpTarget.cmake => AddXdgHelpTarget.cmake} (58%)
 rename guide/C/{gnucash-guide.xml => index.docbook} (100%)
 rename guide/de/{gnucash-guide.xml => index.docbook} (100%)
 rename guide/it/{gnucash-guide.xml => index.docbook} (99%)
 rename guide/ja/{gnucash-guide.xml => index.docbook} (100%)
 rename guide/pt/{gnucash-guide.xml => index.docbook} (100%)
 rename guide/ru/{gnucash-guide.xml => index.docbook} (100%)
 rename manual/C/{gnucash-help.xml => index.docbook} (99%)
 rename manual/de/{gnucash-help.xml => index.docbook} (99%)
 rename manual/it/{gnucash-help.xml => index.docbook} (99%)
 rename manual/pt/{gnucash-help.xml => index.docbook} (99%)



More information about the gnucash-changes mailing list