gnucash-docs maint: Guide: Hotfix of appendix A

Frank H.Ellenberger fell at code.gnucash.org
Sat Mar 7 03:56:45 EST 2020


Updated	 via  https://github.com/Gnucash/gnucash-docs/commit/9edbf251 (commit)
	from  https://github.com/Gnucash/gnucash-docs/commit/4b8578b8 (commit)



commit 9edbf2513c5d762be952e276d885f49aae57fa57
Author: Frank H. Ellenberger <frank.h.ellenberger at gmail.com>
Date:   Sat Mar 7 07:36:09 2020 +0100

    Guide: Hotfix of appendix A
    
    Replace empty pages by links;
    Replace "See .." by xrefs;
    Link contributed XSLTs
    
    New ENTITYs url-wiki-qif, url-wiki-xslt
    
    Thread: https://lists.gnucash.org/pipermail/gnucash-user/2020-March/089623.html

diff --git a/docbook/gnc-docbookx.dtd b/docbook/gnc-docbookx.dtd
index 6a8cdbd..cc19b98 100644
--- a/docbook/gnc-docbookx.dtd
+++ b/docbook/gnc-docbookx.dtd
@@ -50,7 +50,7 @@ own entity definitions to use across all of our DocBook pages. -->
 <!ENTITY app "<application>GnuCash</application>">  <!-- This should be used in normal text -->
 
 <!-- 
-  2. Some common dicectories - change rarely.
+  2. Some common directories - change rarely.
   FIXME: OS independed?
 -->
 <!ENTITY dir-conf "~/.conf/gnucash/">
@@ -103,6 +103,8 @@ own entity definitions to use across all of our DocBook pages. -->
 <!ENTITY url-wiki-ml-de "https://wiki.gnucash.org/wiki/De/Feedback#Auf_der_Mailingliste">
 <!ENTITY url-wiki-pmt-term "https://wiki.gnucash.org/wiki/Payment_Terms">
 <!ENTITY url-wiki-ofx "https://wiki.gnucash.org/wiki/Setting_up_OFXDirectConnect">
+<!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">
 <!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/ -->
diff --git a/guide/C/appendixa.xml b/guide/C/appendixa.xml
index 6ea5671..700b097 100644
--- a/guide/C/appendixa.xml
+++ b/guide/C/appendixa.xml
@@ -5,6 +5,8 @@
       (Do not remove this comment block.)
   Version: 2.0.0
   Last modified: July 9th 2006
+  Replaced empty pages 2020-03-07 by Frank H. Ellenberger
+
   Maintainers:
                Chris Lyttle <chris at wilddev.net>
   Author:
@@ -21,88 +23,124 @@ This appendix is to help current users of other financial software packages in t
 
 <sect1 id="appendixa_accts_vs_cats1">
 <title>Using Accounts vs. Categories</title>
+<para> If you are familiar with other personal finance programs, you are already accustomed to
+  tracking your income and expenses as categories. Since &app; is a double-entry system (see
+  <xref linkend="basics-accounting1" />),
+  income and expenses are tracked in accounts. The basic concept is the same, but the account
+  structure allows more consistency with accepted business practices. So, if you are a business user
+  as well as a home user, &app; makes it easy to keep track of your business as well as your
+  personal accounts.</para>
 <para>
-If you are familiar with other personal finance programs, you are already accustomed to tracking your income and expenses as categories. Since &app; is a double-entry system (refer to section 2.1), income and expenses are tracked in accounts. The basic concept is the same, but the account structure allows more consistency with accepted business practices. So, if you are a business user as well as a home user, &app; makes it easy to keep track of your business as well as your personal accounts.
-</para>
-<para>
-Income and expense accounts give you the same information you would get with categories, but they also give you more flexibility in entering your transactions.    In &app;, you have the option to enter transactions directly into income and expense accounts through their account registers.   Other programs that use categories do not offer this option, because there is no <quote>account register</quote> for a category.
+  Income and expense accounts give you the same information you would get with categories, but they
+  also give you more flexibility in entering your transactions. In &app;, you have the option to
+  enter transactions directly into income and expense accounts through their account registers.
+  Other programs that use categories do not offer this option, because there is no
+  <quote>account register</quote> for a category.
 </para>
 <para>
-You also have the option in &app; to treat income and expense accounts exactly as you would treat categories, if you are more comfortable with that method.  In <trademark class="registered">Quicken</trademark> and similar programs,  transactions require an account and a category.   Substitute an income or expense account name in &app; where you would normally enter a category name in the other programs, and the result should be the same.   We will discuss transaction entry in Chapter 4 in greater detail.
+  You also have the option in &app; to treat income and expense accounts exactly as you would treat
+  categories, if you are more comfortable with that method. In
+  <trademark class="registered">Quicken</trademark>
+  and similar programs, transactions require an account and a category. Substitute an income or
+  expense account name in &app; where you would normally enter a category name in the other
+  programs, and the result should be the same. We will discuss transaction entry in
+  <xref linkend="basics-transactions2" /> in greater detail.
 </para>
 </sect1>
 
- <sect1 id="appendixa_qif1">
- <title>Organization of <acronym>QIF</acronym> Files (Discussion)</title>
- <para>
+<sect1 id="appendixa_import">
+  <title>Importing Data</title>
+  <para>
+    If you want to import data from your previous application, you should distinguish between
+    financial data and other data. Probably the best way to import financial data is the
+    <quote>Quicken Interchange Format</quote> <acronym>QIF</acronym> .
+    It is a specific format for financial data, which most financial applications for the private
+    sector know and can use for export.</para>
+  <para>
+    For other data we suggest the use of the <quote>Comma Separated Value</quote>
+    <acronym>CSV</acronym> format.
   </para>
- </sect1>
- <sect1 id="appendixa_entercharge1">
- <title>Common Duplication Issues (Discussion)</title>
- <para>
- </para>
- </sect1>
- <sect1 id="appendixa_enterpay1">
- <title>Checking <acronym>QIF</acronym> Data (Discussion)</title>
- <para>
- </para>
- </sect1>
+  <sect2 id="appendixa_qif1">
+    <title>Import of Financial Data by <acronym>QIF</acronym> Files</title>
+    <para>
+      See <ulink url="&url-wp-en;Quicken_Interchange_Format" /> for it's details.
+    </para>
+    <para>Some &app; users collected their knowledge about the best use in our
+      <ulink url="&url-wiki-qif;"></ulink>.
+    </para>
+    <para>For other formats and more details see <xref linkend="chapter_importing"/>.</para>
+  </sect2>
+  <sect2 id="appendixa_business">
+    <title>Import of Business Data by <acronym>CSV</acronym> Files</title>
+    <para>
+      If you want to import customers and vendors or bills and invoices see
+      <xref linkend="ch_import_bus_data" />.
+    </para>
+  </sect2>
+</sect1>
 
 <sect1 id="appendixa_xmlconvert1">
 <title>Converting <acronym>XML</acronym> &app; File</title>
  <para>The &app; <acronym>XML</acronym> data file can be transformed to almost any other data
-format (e.g., <acronym>QIF</acronym>, <acronym>CSV</acronym>...) quite easily if one is familiar with <acronym>XSLT</acronym>.
+format (e.g., <acronym>QIF</acronym>, <acronym>CSV</acronym>...) quite easily if one is familiar
+with the <quote>Extensible Stylesheet Language Transformations</quote> <ulink url="&url-wp-en;XSLT"><acronym>XSLT</acronym></ulink>.
 The &app; data file is well-formed <acronym>XML</acronym>, and it can therefore be run
 through an <acronym>XSLT</acronym> parser with an associated stylesheet.  This allows one
 to transform the file to just about any format that can be designed,
 given a properly written stylesheet.</para>
 
-  <para>A few steps need to be followed.  The writing of a stylesheet is a task
+  <para>A few steps need to be followed. The writing of a stylesheet is a task
 for a different time, but if you can get one written, here’s what you
 need to do:</para>
   <orderedlist>
   <listitem>
     <para>Copy the &app; <acronym>XML</acronym> data file to a working file.</para>
-    <note>
-      <para>If the file was last modified by a version of &app; older than 2.0, then
-before to continue to the next step you will need to modify the working file’s <gnc-v2>
-tag to read something like this:</para>
-    <literallayout>
+    <important>
+      <para>If the file was last modified by a version of &app; older than 2.0, then before you
+        continue to the next step you will need to modify the working file’s <gnc-v2> tag
+        to read something like this:
+        <literallayout>
 <gnc-v2 xmlns:cd="http://www.gnucash.org/XML/cd"
-        xmlns:book="http://www.gnucash.org/XML/book"
-        xmlns:gnc="http://www.gnucash.org/XML/gnc"
-        xmlns:cmdty="http://www.gnucash.org/XML/cmdty"
-        xmlns:trn="http://www.gnucash.org/XML/trn"
-        xmlns:split="http://www.gnucash.org/XML/split"
-        xmlns:act="http://www.gnucash.org/XML/act"
-        xmlns:price="http://www.gnucash.org/XML/price"
-        xmlns:ts="http://www.gnucash.org/XML/ts"
-        xmlns:slot="http://www.gnucash.org/XML/kvpslot"
-        xmlns:cust="http://www.gnucash.org/XML/cust"
-        xmlns:entry="http://www.gnucash.org/XML/entry"
-        xmlns:lot="http://www.gnucash.org/XML/lot"
-        xmlns:invoice="http://www.gnucash.org/XML/invoice"
-        xmlns:owner="http://www.gnucash.org/XML/owner"
-        xmlns:job="http://www.gnucash.org/XML/job"
-        xmlns:billterm="http://www.gnucash.org/XML/billterm"
-        xmlns:bt-days="http://www.gnucash.org/XML/bt-days"
-        xmlns:sx="http://www.gnucash.org/XML/sx"
-        xmlns:fs="http://www.gnucash.org/XML/fs"
-        xmlns:addr="http://www.gnucash.org/XML/custaddr">
-    </literallayout>
-    <para>You can put pretty much anything you want behind the equal signs, but a <acronym>URL</acronym>
-is what is typically used.</para>
+  xmlns:book="http://www.gnucash.org/XML/book"
+  xmlns:gnc="http://www.gnucash.org/XML/gnc"
+  xmlns:cmdty="http://www.gnucash.org/XML/cmdty"
+  xmlns:trn="http://www.gnucash.org/XML/trn"
+  xmlns:split="http://www.gnucash.org/XML/split"
+  xmlns:act="http://www.gnucash.org/XML/act"
+  xmlns:price="http://www.gnucash.org/XML/price"
+  xmlns:ts="http://www.gnucash.org/XML/ts"
+  xmlns:slot="http://www.gnucash.org/XML/kvpslot"
+  xmlns:cust="http://www.gnucash.org/XML/cust"
+  xmlns:entry="http://www.gnucash.org/XML/entry"
+  xmlns:lot="http://www.gnucash.org/XML/lot"
+  xmlns:invoice="http://www.gnucash.org/XML/invoice"
+  xmlns:owner="http://www.gnucash.org/XML/owner"
+  xmlns:job="http://www.gnucash.org/XML/job"
+  xmlns:billterm="http://www.gnucash.org/XML/billterm"
+  xmlns:bt-days="http://www.gnucash.org/XML/bt-days"
+  xmlns:sx="http://www.gnucash.org/XML/sx"
+  xmlns:fs="http://www.gnucash.org/XML/fs"
+  xmlns:addr="http://www.gnucash.org/XML/custaddr">
+        </literallayout>
+      </para>
+    </important>
+    <note><para>You can put pretty much anything you want behind the equal signs, but a unique
+    <acronym>URL</acronym> is what is typically used.</para>
     </note>
   </listitem>
   <listitem>
   <para>Create an <acronym>XSLT</acronym> stylesheet containing the transformation your desire,
-or obtain one that’s already written (AFAIK, there aren’t any, but I’m
-working on a <acronym>CSV</acronym> one).</para>
+or obtain one that’s already written.</para>
+<itemizedlist><title>User Contributed XSLT Stylesheets</title>
+<listitem><para>in our repository: <ulink url="&url-src-maint;contrib/xslt"></ulink></para></listitem>
+<listitem><para>in our wiki: <ulink url="&url-wiki-xslt;"></ulink></para>
+</listitem>
+</itemizedlist>
   </listitem>
   <listitem>
 <para>Install an <acronym>XSLT</acronym> processor such as Saxon
-(http://saxon.sourceforge.net/) or Xalan-J  (http://xml.apache.org/).
-Any conforming processor will do, really...</para>
+(<ulink url="&url-wp-en;Saxon_XSLT" />) or Xalan (<ulink url="&url-wp-en;Apache_Xalan" />).
+Any <ulink url="&url-wp-en;Category:XSLT_processors">conforming processor</ulink> will do, really...</para>
   </listitem>
   <listitem>
 <para>Run the work file and the stylesheet through the processor according



Summary of changes:
 docbook/gnc-docbookx.dtd |   4 +-
 guide/C/appendixa.xml    | 144 ++++++++++++++++++++++++++++++-----------------
 2 files changed, 94 insertions(+), 54 deletions(-)



More information about the gnucash-changes mailing list