<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter SYSTEM "gnc-gui-C.dtd">
<!--

      (Do not remove this comment block.)
  Version: 2.0.2
  Last modified: November 1st 2010
       modified: April 23th 2007
       modified: July 9th 2006
       modified: February 28th 2005
  Maintainers:
               Cristian Marchi <cri79@libero.it>
               Chris Lyttle <chris@wilddev.net>
               Neil Williams <linux@codehelp.co.uk>
  Author:
               Chris Lyttle <chris@wilddev.net>
  Translators:
               (translators put your name and email here)
-->
<chapter id="Getting-Help">
  <title>Using This Document &amp; Getting Help</title>

  <para>This document is organized in two dimensions:
    <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>
      </listitem>

      <listitem>
        <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:
          <itemizedlist>
            <listitem>
              <para>Account Actions - <xref linkend="setup-accounts"></xref>
              </para>
            </listitem>

            <listitem>
              <para>Transaction/Register Actions - <xref linkend="ch_Common_Trans_Ops"></xref>
              </para>
            </listitem>

            <listitem>
              <para>Tools and Assistants - <xref linkend="ch_AccRegTools"></xref>
              </para>
            </listitem>

            <listitem>
              <para>Reporting &amp; Charting - <xref linkend="Reports"></xref>
              </para>
            </listitem>

            <listitem>
              <para>Customization - <xref linkend="custom-gnucash"></xref>
              </para>
            </listitem>
          </itemizedlist>
        </para>
      </listitem>
    </itemizedlist>
  </para>

  <sect1 id="Help-Window">
    <title>Accessing Help</title>
<!--    -->
    <para>When &app; is running and this documentation is installed
      <footnote>
        <para>Our bundles for &flatpak;, &mac;, and &win; contain it, but under &lin; 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>
                <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 describes 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>&lin;</term>

        <listitem>
          <simpara>Gnome <application>Yelp</application>
          </simpara>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>&mac;</term>

        <listitem>
          <simpara>default web browser
          </simpara>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>&win;</term>

        <listitem>
          <simpara>&win; help viewer
          </simpara>
        </listitem>
      </varlistentry>
    </variablelist>

    <para>See their respective manuals to get help about help.
    </para>

    <sect2 id="tutorial">
      <title>&app; Tutorial and Concepts Guide</title>

      <para>The guide is the counterpart to this manual. It explains the concepts used in &app; and has a tutorial
        that takes you through using &app; to manage your accounts. It will appear if you choose
        <guibutton>Open the new user tutorial</guibutton> in the <guilabel>Welcome to
        &appname;!</guilabel> menu.
      </para>

      <para>To open that Guide at a later time go to &mc.help.guide;.
      </para>

      <important>
        <para>It is strongly recommended to read the Guide if you are new to &app; or unfamiliar with accounting
          concepts.
        </para>
      </important>
    </sect2>

    <sect2 id="wiki">
      <title>&app; Wiki</title>
<!-- 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 <emphasis>more recent</emphasis> documentation about as
        well usage as development of &app; is collected by the community in the
        <ulink url="&url-wiki;">&app; Wiki</ulink> ; the <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> or
          <ulink url="&url-wiki-category;">browse categories</ulink>.
        </para>
      </tip>
    </sect2>

    <sect2 id="website">
      <title>&app; Website</title>

      <para>The multilingual <ulink url="&url-www;">&app; website</ulink> contains:
        <variablelist spacing="compact">
          <varlistentry>
            <term>Announcements</term>

            <listitem>
              <simpara>of new releases or server maintenance – usually only in English;
              </simpara>
            </listitem>
          </varlistentry>

          <varlistentry>
            <term>Downloads</term>

            <listitem>
              <simpara>of the program or the documentation in several flavours;
              </simpara>
            </listitem>
          </varlistentry>

          <varlistentry>
            <term>Links</term>

            <listitem>
              <simpara>to file bugs or suggest enhancements and more.
              </simpara>
            </listitem>
          </varlistentry>
        </variablelist>
      </para>
    </sect2>

    <sect2 id="more_help">
      <title>&app; On-line Assistance</title>

      <bridgehead>
        Mailing Lists
      </bridgehead>
<!-- 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@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 your individual
        <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>In case you are old school there are <emphasis>3rd party services</emphasis> which convert some of
        the lists into other formats:
        <variablelist spacing="compact">
          <varlistentry>
            <term>Web Forum</term>

            <listitem>
              <simpara><ulink url="&url-mail-nabble;">Nabble</ulink>;
              </simpara>
            </listitem>
          </varlistentry>

          <varlistentry>
            <term>NNTP News Feed</term>

            <listitem>
              <simpara><ulink url="nntp://news.gmane.org/gmane.comp.gnome.apps.gnucash.user">Gmane</ulink>.
              </simpara>
            </listitem>
          </varlistentry>
        </variablelist>
      </para>

      <para>One must <ulink url="&url-mail-li;gnucash-user">subscribe</ulink> before posting, even if using
        Nabble or Gmane.
      </para>

      <bridgehead>
        Chat
      </bridgehead>
<!-- ToDo: Consider to join the following ulink with that in Guide's oview, but perhaps also the whole section. -->
      <para>Several of the developers and experienced users monitor the <ulink url='&url-irc;'>#gnucash channel
        at &srv-irc;</ulink>. They are usually busy with other tasks and of course are not always at
        their computers. Log in, ask your question, and stay logged in; it may take several hours
        before your question is noticed and responded.
        <itemizedlist>
          <listitem>
            <simpara>If you got disconnected <ulink url="&url-logs-irc;">check the IRC logs</ulink> to verify that you
              missed nothing related.
            </simpara>
          </listitem>

          <listitem>
            <simpara>Requirements, netiquette, and other details are explained in the <ulink url="&url-wiki-irc;">IRC
              wiki page</ulink>.
            </simpara>
          </listitem>
        </itemizedlist>
      </para>
    </sect2>
  </sect1>

  <sect1 id="Help-Mouse-Buttons">
    <title>Mouse Buttons</title>

    <para>This document refers to mouse buttons as Button1, Button2 etc.
    </para>

    <itemizedlist>
      <listitem>
        <simpara>Button1 is typically the left mouse button or the right button in a left-handed setup
        </simpara>
      </listitem>

      <listitem>
        <simpara>Button2 is typically the right mouse button or the left button in a left-handed setup
        </simpara>
      </listitem>
    </itemizedlist>
  </sect1>
</chapter>
