gnucash-docs maint: Bug 784638 - sect1 Help-Window in Help_ch_GettingHelp describes an outdated version of yelp's GUI
Frank H.Ellenberger
fell at code.gnucash.org
Thu Mar 15 05:38:25 EDT 2018
Updated via https://github.com/Gnucash/gnucash-docs/commit/5cbccec5 (commit)
from https://github.com/Gnucash/gnucash-docs/commit/ec5aed74 (commit)
commit 5cbccec5062d38b5ee17f680457bdd7f99add238
Author: fell <frank.h.ellenberger at gmail.com>
Date: Thu Oct 5 03:21:31 2017 +0200
Bug 784638 - sect1 Help-Window in Help_ch_GettingHelp describes an
outdated version of yelp's GUI
and further review of that chapter
diff --git a/help/C/Help_ch_GettingHelp.xml b/help/C/Help_ch_GettingHelp.xml
index 8228472..d940810 100644
--- a/help/C/Help_ch_GettingHelp.xml
+++ b/help/C/Help_ch_GettingHelp.xml
@@ -19,8 +19,7 @@
<chapter id="Getting-Help">
<title id="Using-Help">Using This Document & Getting Help</title>
- <para>This document is organized in two dimensions;</para>
-
+ <para>This document is organized in two dimensions:
<itemizedlist>
<listitem>
<para>From the GUI (Graphical User Interface) explaining the available options and their functions,
@@ -31,9 +30,7 @@
<para>By classifying Operations, Tasks, or Functions based on whether it is an Account, Transaction,
Reporting or other oriented operation. <!--Examples are <xref linkend="setup-accounts"></xref>,
<xref linkend="ch_Common_Trans_Ops"></xref>, <xref linkend="Reports"></xref> .-->
- Examples are;</para>
-
- <itemizedlist>
+ Examples are: <itemizedlist>
<listitem>
<para> Account Actions - <xref linkend="setup-accounts"></xref></para>
</listitem>
@@ -54,44 +51,40 @@
<para> Customization - <xref linkend="custom-gnucash"></xref></para>
</listitem>
</itemizedlist>
-
+ </para>
</listitem>
</itemizedlist>
+ </para>
+
<sect1 id="Help-Window">
<title>Accessing Help</title>
-<!-- <para>The <application>&app;</application> Help Window uses YELP to display DOCBOOK versions of the help documents that are installed
- with <application>&app;</application>.</para>-->
-
- <para>This window is accessed by going to the <guimenu>Help</guimenu> menu and selecting either the <guimenuitem>Tutorial and Concepts
- Guide</guimenuitem> or the <guimenuitem>Contents (F1)</guimenuitem>. <xref linkend="AccTree-help-menu"></xref></para>
-
- <para>The Help Window has a <emphasis>Toolbar</emphasis> for navigation. The <emphasis>Toolbar</emphasis> is described below;</para>
-
- <itemizedlist>
- <listitem>
- <para><guibutton>Back</guibutton> Used to navigate to topics previously viewed. </para>
- </listitem>
-
- <listitem>
- <para><guibutton>Forward</guibutton> Used to navigate to topics previously viewed.</para>
- </listitem>
-
- <listitem>
- <para><guibutton>Help</guibutton> Used to access various GNOME Help files.</para>
- </listitem>
-
- <listitem>
- <para><guibutton>Search</guibutton> Enter search term to search GNOME Help files. Does not search <application>&app;</application>
- Help file.</para>
- </listitem>
- </itemizedlist>
-
- <para>The right side of the Help Window displays the currently opened help page. The left side of the Help
- Window contains the help Topics list tab. Selecting one of the help topics will load that page on the right
- side.</para>
+<!-- -->
+
+ <para>When <application>&app;</application> 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>
+ <listitem><para><menuchoice><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>
+ </itemizedlist></para>
+ <para>The complete help menu is explained in <xref linkend="AccTree-help-menu"></xref>.</para>
+
+ <variablelist spacing="compact">
+ <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>
+ <listitem><simpara>Gnome <application>Yelp</application></simpara></listitem></varlistentry>
+ <varlistentry><term><systemitem class="osname">MacOS</systemitem></term>
+ <listitem><simpara>default web browser</simpara></listitem></varlistentry>
+ <varlistentry><term><systemitem class="osname">Windows</systemitem></term>
+ <listitem><simpara>Windows help viewer</simpara></listitem></varlistentry>
+ </variablelist>
+ <para>See their respective manuals to get help about help.</para>
<sect2 id="tutorial">
<title><application>&app;</application> Tutorial and Concepts Guide</title>
@@ -102,14 +95,18 @@
<guilabel>Welcome to &app;!</guilabel> menu.</para>
<para>To open this Guide manually go to <menuchoice><guimenu>Help</guimenu>
- <guimenuitem>Tutorial and Concepts Guide</guimenuitem></menuchoice>.</para>
+ <guimenuitem>Tutorial and Concepts Guide</guimenuitem></menuchoice> or press
+ <keycombo action='simul'><keycap>Ctrl</keycap><keycap>H</keycap></keycombo>.</para>
- <para>It is strongly recommended to read this guide if you are new to
- <application>&app;</application> or unfamiliar with accounting concepts.</para>
+ <important><para>It is strongly recommended to read this guide if you are new to
+ <application>&app;</application> or unfamiliar with accounting concepts.</para></important>
</sect2>
+
<sect2 id="wiki">
<title><application>&app;</application> Wiki</title>
- <para>An immense amount of less-formal documenation, both of
+ <!-- Translators: if wiki pages in your language exist, add or replace the links in this section
+ see also https://wiki.gnucash.org/wiki/Special:Categories for your language or region code -->
+ <para>An immense amount of less-formal, but often more recent documenation, both of
<application>&app;</application> itself and its maintenance and
development may be found in the <ulink
url="https://wiki.gnucash.org/wiki"><application>&app;</application>
@@ -122,17 +119,20 @@
<sect2 id="more_help">
<title><application>&app;</application> 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 List</bridgehead><para>The primary source of user support is the <ulink
- url="mailto:gnucash-user at gnucash.org">user mailing list</ulink>. If
+ url="mailto:gnucash-user at gnucash.org">user mailing list</ulink>. If English is not your primary language,
+ see <ulink url="https://wiki.gnucash.org/wiki/Mailing_Lists#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="http://gnucash.1415818.n4.nabble.com/GnuCash-User-f1415819.html">Nabble</ulink>. One must <ulink
url="https://lists.gnucash.org/mailman/listinfo/gnucash-user">subscribe</ulink>
before posting, even if using Nabble.</para>
- <bridgehead>IRC</bridgehead><para>Several of the developers
- monitor the #gnucash channel at irc.gnome.org. They're usually
- doing something else, too, and of course aren't always at their
+ <bridgehead>IRC</bridgehead><para>Several of the developers and experienced users
+ monitor the <ulink url="irc://irc.gnome.org#gnucash">#gnucash channel at irc.gnome.org</ulink>.
+ They're usuall 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
Summary of changes:
help/C/Help_ch_GettingHelp.xml | 88 +++++++++++++++++++++---------------------
1 file changed, 44 insertions(+), 44 deletions(-)
More information about the gnucash-changes
mailing list