gnucash-docs maint: Minor improvements on Getting Help
Frank H.Ellenberger
fell at code.gnucash.org
Sun Apr 4 20:12:28 EDT 2021
Updated via https://github.com/Gnucash/gnucash-docs/commit/9e3fc7aa (commit)
from https://github.com/Gnucash/gnucash-docs/commit/143d2b9d (commit)
commit 9e3fc7aa6675aa58df2f90fb091fd200d8ffddc1
Author: Frank H. Ellenberger <frank.h.ellenberger at gmail.com>
Date: Mon Apr 5 00:46:34 2021 +0200
Minor improvements on Getting Help
found by review of the de translation
diff --git a/docbook/gnc-docbookx.dtd b/docbook/gnc-docbookx.dtd
index 9dd234d..9076eae 100644
--- a/docbook/gnc-docbookx.dtd
+++ b/docbook/gnc-docbookx.dtd
@@ -48,6 +48,11 @@ own entity definitions to use across all of our DocBook pages. -->
-->
<!ENTITY appname "GnuCash"> <!-- This should be used, where no further markup is desired, e.g. in GUI elements, URLs -->
<!ENTITY app "<application>GnuCash</application>"> <!-- This should be used in normal text -->
+ <!-- Operating Systems, Bundles: -->
+<!ENTITY linux "<systemitem class='osname'>Linux</systemitem>">
+<!ENTITY mac "<systemitem class='osname'>macOS</systemitem>"> <!-- They change their writing often -->
+<!ENTITY win "<systemitem class='osname'>Windows</systemitem>">
+<!ENTITY flatpak "<application>FlatPak</application>"> <!-- This should be used in normal text -->
<!--
2. Some common directories - change rarely.
@@ -84,6 +89,7 @@ own entity definitions to use across all of our DocBook pages. -->
<!ENTITY url-bug-search "https://bugs.gnucash.org/query.cgi">
<!ENTITY url-bug-browse "https://bugs.gnucash.org/describecomponents.cgi">
<!ENTITY url-irc "irc://irc.gnome.org/gnucash">
+<!ENTITY url-logs-irc "https://lists.gnucash.org/logs/"> <!-- for IRC. If someone needs build logs, scan https://code.gnucash.org/builds/ -->
<!ENTITY url-mail-ar "https://lists.gnucash.org/pipermail/"> <!-- Append <list>/<Year>-<Monthname>/<Number>.html -->
<!ENTITY url-mail-li "https://lists.gnucash.org/mailman/listinfo/"> <!-- Append the desired list -->
<!ENTITY url-mail-nabble "http://gnucash.1415818.n4.nabble.com/GnuCash-User-f1415819.html">
@@ -96,7 +102,7 @@ own entity definitions to use across all of our DocBook pages. -->
<!ENTITY url-wiki-bus-feat "https://wiki.gnucash.org/wiki/Business_Features_Issues">
<!ENTITY url-wiki-faq "https://wiki.gnucash.org/wiki/FAQ">
<!ENTITY url-wiki-faq-de "https://wiki.gnucash.org/wiki/De/FAQ">
-<!ENTITY url-wiki-faq-quot "http://wiki.gnucash.org/wiki/FAQ#Q:_How_do_I_fix_a_.22system_error.22_or_.22unknown_error.22_when_getting_stock_quotes.3F">
+<!ENTITY url-wiki-faq-quot "https://wiki.gnucash.org/wiki/FAQ#Q:_How_do_I_fix_a_.22system_error.22_or_.22unknown_error.22_when_getting_stock_quotes.3F">
<!ENTITY url-wiki-irc "https://wiki.gnucash.org/wiki/IRC">
<!ENTITY url-wiki-L12N "https://wiki.gnucash.org/wiki/Translation">
<!ENTITY url-wiki-L12N-tax "https://wiki.gnucash.org/wiki/Translation#How_to_create_localized_Income_Tax_Tables">
@@ -108,9 +114,9 @@ own entity definitions to use across all of our DocBook pages. -->
<!ENTITY url-wiki-ofx-banks "https://wiki.gnucash.org/wiki/OFX_Direct_Connect_Bank_Settings">
<!ENTITY url-wiki-qif "https://wiki.gnucash.org/wiki/Quicken_Migration">
<!ENTITY url-wiki-xslt "https://wiki.gnucash.org/wiki/De/export_to_excel_xls_transform">
+ <!-- wiki Special: translation is done by mediawiki: -->
+<!ENTITY url-wiki-category "https://wiki.gnucash.org/wiki/Special:Categories">
<!ENTITY url-wiki-search "https://wiki.gnucash.org/wiki/Special:Search">
-<!ENTITY url-logs-irc "https://lists.gnucash.org/logs/">
- <!-- for IRC. If someone needs build logs, scan https://code.gnucash.org/builds/ -->
<!-- b) Third party URLs: -->
<!ENTITY url-av "https://www.alphavantage.co/"> <!-- A F::Q source, which requires registration -->
<!ENTITY url-gh "https://github.com/"> <!-- we want to reference our libs, too. -->
diff --git a/help/C/Help_ch_GettingHelp.xml b/help/C/Help_ch_GettingHelp.xml
index de9b9dc..149379d 100644
--- a/help/C/Help_ch_GettingHelp.xml
+++ b/help/C/Help_ch_GettingHelp.xml
@@ -26,7 +26,7 @@
<itemizedlist>
<listitem>
<para>From the GUI (Graphical User Interface) explaining the available options and their functions,
- with links to deeper descriptions and usage. <xref linkend="GUIMenus"></xref></para>
+ with links to deeper descriptions and usage. <xref linkend="GUIMenus"></xref></para>
</listitem>
<listitem>
@@ -66,15 +66,19 @@
<!-- -->
- <para>When &app; is running and this documentation is installed, this window is accessed by <itemizedlist>
- <listitem><para>pressing the <keycap>F1</keycap> key or</para></listitem>
- <listitem><para>selecting from the menu
- <menuchoice><guimenu><accel>H</accel>elp</guimenu><guimenuitem><accel>C</accel>ontents</guimenuitem></menuchoice>.</para></listitem>
+ <para>When &app; is running and this documentation is installed<footnote>
+ <para>Our bundles for &flatpak;, &mac;, and &win; contain it, but under &linux; it is usually shipped as separate package <package>gnucash-docs</package>.</para>
+ </footnote>,<itemizedlist>
+ <listitem><para>this window is accessed by<itemizedlist>
+ <listitem><para>pressing the <keycap>F1</keycap> key or</para></listitem>
+ <listitem><para>selecting from the menu
+ <menuchoice><guimenu><accel>H</accel>elp</guimenu><guimenuitem><accel>C</accel>ontents</guimenuitem></menuchoice>.</para></listitem>
+ </itemizedlist></para></listitem>
<listitem><para><menuchoice><shortcut><keycombo action='simul'><keycap>Ctrl</keycap><keycap>H</keycap></keycombo></shortcut>
<guimenu><accel>H</accel>elp</guimenu><guimenuitem>Tutorial and Concepts Guide</guimenuitem></menuchoice>
will open the other part of this documentation.</para>
</listitem>
- <listitem><para>In most dialogs the <guibutton><accel>H</accel>elp</guibutton> button will lead you directly to the page which decribes that dialog.</para></listitem>
+ <listitem><para>In most dialogs the <guibutton><accel>H</accel>elp</guibutton> button will lead you directly to the page which describes that dialog.</para></listitem>
</itemizedlist></para>
<para>The complete help menu is explained in <xref linkend="AccTree-help-menu"></xref>.</para>
@@ -82,11 +86,11 @@
<title>Operating System and Help Viewer</title>
<para>Depending on your operating system we use different programs to display this help document:</para>
- <varlistentry><term><systemitem class="osname">Linux</systemitem></term>
+ <varlistentry><term>&linux;</term>
<listitem><simpara>Gnome <application>Yelp</application></simpara></listitem></varlistentry>
- <varlistentry><term><systemitem class="osname">MacOS</systemitem></term>
+ <varlistentry><term>&mac;</term>
<listitem><simpara>default web browser</simpara></listitem></varlistentry>
- <varlistentry><term><systemitem class="osname">Windows</systemitem></term>
+ <varlistentry><term>&win;</term>
<listitem><simpara>Windows help viewer</simpara></listitem></varlistentry>
</variablelist>
<para>See their respective manuals to get help about help.</para>
@@ -117,31 +121,36 @@
<ulink url="&url-wiki-faq;">Frequently Asked Questions</ulink>
page should be a first stop whenever you encounter difficulty using &app;.</para>
<tip><para>You should also try its
- <ulink url="&url-wiki-search;">search page</ulink>.</para></tip>
+ <ulink url="&url-wiki-search;">search page</ulink> or <ulink url="&url-wiki-category;">browse categories</ulink>.</para></tip>
</sect2>
<sect2 id="more_help">
<title>&app; On-line Assistance</title>
- <!-- Translators: if a mailing list in your language exists, add or replace the links in this section
- see https://lists.gnucash.org/mailman/listinfo/ -->
<bridgehead>Mailing Lists</bridgehead>
- <para>The primary source of user support is the <ulink
- url="mailto:gnucash-user at gnucash.org">user mailing list</ulink>. If English is not your primary language,
- see <ulink url="&url-wiki-ml;#User_Lists">wiki:user mailing lists</ulink> for local lists. If
- you prefer a web forum-like presentation, you can use it via <ulink
- url="&url-mail-nabble;">Nabble</ulink>. One must <ulink
- url="&url-mail-li;gnucash-user">subscribe</ulink>
+ <!-- Translators: If a mailing list in your language exists, add or replace the links in this section
+ see https://lists.gnucash.org/mailman/listinfo/ -->
+ <para>The primary source of user support is the
+ <ulink url="mailto:gnucash-user at gnucash.org">user mailing list</ulink>.
+ If English is not your primary language, see
+ <ulink url="&url-wiki-ml;#User_Lists">wiki:user mailing lists</ulink> for local lists.
+ That page has also other useful sections like
+ <ulink url="&url-wiki-ml;#Netiquette">Netiquette</ulink> or
+ <ulink url="&url-wiki-ml;#Mailing_List_Management">Mailing List Management</ulink>.</para>
+ <!-- Translators: Nabble has only a few Gnucash lists. Verify that your languages is supported. -->
+ <para>If you prefer a web forum-like presentation, you can use a 3rd party service like
+ <ulink url="&url-mail-nabble;">Nabble</ulink>.</para>
+ <para>One must <ulink url="&url-mail-li;gnucash-user">subscribe</ulink>
before posting, even if using Nabble.</para>
<bridgehead>IRC</bridgehead>
- <para>Several of the developers and experienced users
- monitor the <ulink url="&url-irc;">#gnucash channel at irc.gnome.org</ulink>.
+ <para>Several of the developers and experienced users monitor the
+ <ulink url="&url-irc;">#gnucash channel at irc.gnome.org</ulink>.
They're usually doing something else, too, and of course aren't always at their
computers. Log in, ask your question, and stay logged in; it may
- be several hours before your question is noticed and responded
- to. To see if you missed anything <ulink
- url="&url-logs-irc;">check the IRC logs</ulink>.
+ take several hours before your question is noticed and responded.
+ To see if you missed anything
+ <ulink url="&url-logs-irc;">check the IRC logs</ulink>.
Requirements, netiquette and other details are explained in the
<ulink url="&url-wiki-irc;">IRC wiki page</ulink>.</para>
</sect2>
Summary of changes:
docbook/gnc-docbookx.dtd | 12 ++++++---
help/C/Help_ch_GettingHelp.xml | 55 ++++++++++++++++++++++++------------------
2 files changed, 41 insertions(+), 26 deletions(-)
More information about the gnucash-changes
mailing list