r19692 - gnucash-docs/trunk/help/C - Separate getting-help chapter to validate getting-started xml file.

Cristian Marchi cmarchi at code.gnucash.org
Fri Oct 22 14:28:13 EDT 2010


Author: cmarchi
Date: 2010-10-22 14:28:13 -0400 (Fri, 22 Oct 2010)
New Revision: 19692
Trac: http://svn.gnucash.org/trac/changeset/19692

Added:
   gnucash-docs/trunk/help/C/Help_ch_GettingHelp.xml
Modified:
   gnucash-docs/trunk/help/C/gnucash-help.xml
Log:
Separate getting-help chapter to validate getting-started xml file.

Added: gnucash-docs/trunk/help/C/Help_ch_GettingHelp.xml
===================================================================
--- gnucash-docs/trunk/help/C/Help_ch_GettingHelp.xml	                        (rev 0)
+++ gnucash-docs/trunk/help/C/Help_ch_GettingHelp.xml	2010-10-22 18:28:13 UTC (rev 19692)
@@ -0,0 +1,139 @@
+<!--
+
+      (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 at libero.it>
+               Chris Lyttle <chris at wilddev.net>
+               Neil Williams <linux at codehelp.co.uk>
+  Author:
+               Chris Lyttle <chris at wilddev.net>
+  Translators:
+               (translators put your name and email here)
+-->
+
+<chapter id="Getting-Help">     
+ <title id="Using-Help">Using This Document &amp; Getting Help</title>
+
+   <para>This document is organized in two dimensions;</para>
+
+    <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;</para>
+
+       <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 Wizards - <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>
+
+     </listitem>
+
+    </itemizedlist>
+     
+  <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 toolbar for navigation. The toolbar 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>
+
+   </sect1>
+     
+   <sect1 id="tutorial">
+    <title><application>&app;</application> Tutorial and Concepts Guide</title>
+
+     <para>This guide is the counterpart to this help. It explains the concepts used in <application>&app;</application> and has a tutorial
+      that takes you through using <application>&app;</application> to manage your accounts. It will appear if you choose
+      <guibutton>Open the new user tutorial</guibutton> in the
+      <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>
+
+     <para>It is strongly recommended to read this guide if you are new to
+      <application>&app;</application> or unfamiliar with accounting concepts.</para>
+   </sect1>
+
+   <sect1 id="on-line-assistance">
+    <title><application>&app;</application> On-line Assistance</title>
+
+     <para>Quoting the Tip of the Day "The <application>&app;</application> developers are easy to contact."
+      <application>&app;</application> has several mailing lists;</para>
+
+      <itemizedlist>
+       <listitem>
+        <para><emphasis role='bold'>User List </emphasis>
+         <email>gnucash-user at gnucash.org</email> - User questions and discussions.  The
+         developers and many very helpful users "hang-out" here.</para>
+       </listitem>
+
+       <listitem>
+        <para><emphasis role='bold'>Development List </emphasis>
+         <email>gnucash-devel at gnucash.org</email> - Discussion of issues related to the design and development
+         of <application>&app;</application> and submission of patches.</para>
+       </listitem>
+
+       <listitem>
+        <para>You can chat live with the developers on IRC! Join them on #gnucash at irc.gnome.org.  Much more
+         at the <ulink url="http://www.gnucash.org"><application>&app;</application> web site </ulink> including links to WIKI and Bugzilla !!
+        </para>
+       </listitem>
+      </itemizedlist>
+    </sect1>
+</chapter>

Modified: gnucash-docs/trunk/help/C/gnucash-help.xml
===================================================================
--- gnucash-docs/trunk/help/C/gnucash-help.xml	2010-10-22 17:54:15 UTC (rev 19691)
+++ gnucash-docs/trunk/help/C/gnucash-help.xml	2010-10-22 18:28:13 UTC (rev 19692)
@@ -2,6 +2,7 @@
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 <!ENTITY intro SYSTEM "Help_ch_Intro.xml">
+<!ENTITY chGettingHelp SYSTEM "Help_ch_GettingHelp.xml">
 <!ENTITY chGettingStarted SYSTEM "Help_ch_GettingStarted.xml">
 <!ENTITY chGUIMenus SYSTEM "Help_ch_GUIMenus.xml">
 <!ENTITY chAccounts SYSTEM "Help_ch_Account-Actions.xml">
@@ -195,6 +196,7 @@
   </bookinfo>
 
 &intro;
+&chGettingHelp;
 &chGettingStarted;
 &chGUIMenus;
 &chAccounts;



More information about the gnucash-changes mailing list