Skip to content

Commit

Permalink
Merge branch 'maint'
Browse files Browse the repository at this point in the history
  • Loading branch information
@jralls
jralls committed Sep 29, 2018
2 parents 9d75de8 + 2e96770 commit 5c66e62
Show file tree
Hide file tree
Showing 34 changed files with 502 additions and 119 deletions.
15 changes: 15 additions & 0 deletions .travis.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Test
sudo: required
language: c++
compiler: gcc
env:
- BUILDENV=ubuntu-14.04 BUILDTYPE=autotools-make
services:
- docker
install:
- docker --version
- echo BUILDENV="$BUILDENV"
- docker build -f util/ci/${BUILDENV}-docker -t ${BUILDENV}-gnucashbuild util/ci
script:
- echo BUILDTYPE="$BUILDTYPE"
- docker run -v "$(pwd)":/gnucash-docs:rw --env="BUILDTYPE=$BUILDTYPE" --rm ${BUILDENV}-gnucashbuild
1 change: 1 addition & 0 deletions AUTHORS
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Frank H. Ellenberger
Mike Evans
Chris Good
Geert Janssens
Chris Lam
John Ralls
David T.

Expand Down
10 changes: 10 additions & 0 deletions NEWS
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
Version History
---------------
3.3 - 20 September 2018
o Bug 791169 - Add Reconciliation definition to glossary.
o Bug 796800 - None of the "GnuCash Tutorial and Concepts Guide"
graphics (.png files) display.
o Bug 796820 - References to "Gnome Bugzilla" should be changed
to "GnuCash Bugzilla".
o Bug 777893 - Add information to Guide about file formats, esp. SQL.
o Add travis continuous integration to docs.
o Add tax tables to documentation.
o Document Filter/Closing transactions feature.
3.2 - 24 June 2018
o Bug 796098 - V 3.1 Missing images in Tutorial and Concepts Guide in
PDF and Online Help pages.
Expand Down
13 changes: 8 additions & 5 deletions chm.make
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Create CHM help files for Win32
# Copyright 2017 John Ralls <jralls@ceridwen.us>
# Procedure lifted from make_chm() in gnucash-on-windows.git:install-impl.sh,
# originally written by Andreas Köhler.
# originally written by Andreas Köhler.

chmfile=$(docname).chm
mapfile=$(docname).hhmap
Expand All @@ -20,6 +20,9 @@ install-chm-local: $(chmfile) $(mapfile)

.xml.chm:
${XSLTPROC} ${htmlhelp_xsl} ${srcdir}/$(docname).xml
if test ! -d ${builddir}/figures ; then \
ln -s ${srcdir}/figures ${builddir} ; \
fi
count=0
echo >> htmlhelp.hhp
echo "[ALIAS]" >> htmlhelp.hhp
Expand All @@ -28,10 +31,10 @@ install-chm-local: $(chmfile) $(mapfile)
echo "[Map]" > htmlhelp.hhmap
echo "Searching for anchors ..."
for id in `cat ${srcdir}/*.xml | sed '/sect.*id=/!d;s,.*id=["'\'']\([^"'\'']*\)["'\''].*,\1,'` ; do \
files=`grep -l "[\"']${id}[\"']" *.html` || continue; \
echo "IDH_$((++count))=${files}#${id}" >> htmlhelp.hhp; \
echo "#define IDH_${count} ${count}" >> mymaps; \
echo "${id}=${count}" >> htmlhelp.hhmap; \
files=`grep -l "[\"']$${id}[\"']" *.html` || continue; \
echo "IDH_$$((++count))=$${files}#$${id}" >> htmlhelp.hhp; \
echo "#define IDH_$${count} $${count}" >> mymaps; \
echo "$${id}=$${count}" >> htmlhelp.hhmap; \
done
echo >> htmlhelp.hhp
echo "[MAP]" >> htmlhelp.hhp
Expand Down
6 changes: 3 additions & 3 deletions guide/C/appendixb.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@

<sect2 id="appendixb_general_newFeatures">
<title>Q: I really want feature XYZ but <application>&app;</application> doesn&rsquo;t have it. How do I get it added?</title>
<para>A: Ask nicely. :-) You can file an enhancement request at <ulink url="http://bugzilla.gnome.org/enter_bug.cgi?product=&app;"></ulink>. Please bear in mind to describe your proposed enhancement as verbosely as possible. The trick here is to learn how to give the best information to the programmers about what your proposed new feature should do. If you want to speed up development significantly, consider donating some money as described on <application>&app;</application>Development.</para>
<para>A: Ask nicely. :-) You can file an enhancement request at <ulink url="http://bugs.gnucash.org/enter_bug.cgi?product=&app;"></ulink>. Please bear in mind to describe your proposed enhancement as verbosely as possible. The trick here is to learn how to give the best information to the programmers about what your proposed new feature should do. If you want to speed up development significantly, consider donating some money as described on <application>&app;</application>Development.</para>
</sect2>

<sect2 id="appendixb_software_web">
Expand All @@ -95,8 +95,8 @@

<sect2 id="appendixb_software_bugs">
<title>Q: I think I found a bug. How do I report it?</title>
<para>A: First of all, try to verify that it is indeed a bug and that it has not been reported before. Search the mail list archives (see FAQ above). Then search the <ulink url="http://bugzilla.gnome.org">Gnome Bugzilla</ulink> database.</para>
<para>If you feel you have indeed found a bug, you can then report it at <ulink url="http://bugzilla.gnome.org/enter_bug.cgi?product=&app;"></ulink>. Please bear in mind to report your bug as verbosely as possible. The trick here is to learn how to give the best information to the programmers about how to reproduce bugs. A Programmer will usually only be able to fix a bug they can see, if you can&rsquo;t make the programmer see your bug, it won&rsquo;t get fixed!</para>
<para>A: First of all, try to verify that it is indeed a bug and that it has not been reported before. Search the mail list archives (see FAQ above). Then search the <ulink url="http://bugs.gnucash.org">&app; Bugzilla</ulink> database.</para>
<para>If you feel you have indeed found a bug, you can then report it at <ulink url="http://bugs.gnucash.org/enter_bug.cgi?product=&app;"></ulink>. Please bear in mind to report your bug as verbosely as possible. The trick here is to learn how to give the best information to the programmers about how to reproduce bugs. A Programmer will usually only be able to fix a bug they can see, if you can&rsquo;t make the programmer see your bug, it won&rsquo;t get fixed!</para>
</sect2>

</sect1>
Expand Down
135 changes: 130 additions & 5 deletions guide/C/ch_basics.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -619,11 +619,136 @@

<sect1 id="basics-files1">
<title>Storing your financial data</title>

<para><application>&app;</application> is able to <link linkend="basics-store-data">store</link>
your financial data in files or <acronym>SQL</acronym> databases so that they can be
<link linkend="basics-open-data">opened</link> and modified at a later time.
But first you need to <link linkend="basics-create-data">create</link> a container for your data.</para>
<sect2 id="basics-files1-overview">
<title>Overview</title>

<para><application>&app;</application> offers several formats for storing
your financial data. The default file storage format is <acronym>XML</acronym>,
while <acronym>SQL</acronym> storage is available in SQLite, MySQL, and PostgreSQL
formats. Users can choose a file format for new files from <menuchoice><guimenu>File</guimenu>
<guimenuitem>Save </guimenuitem></menuchoice> and for existing files from <menuchoice><guimenu>File</guimenu>
<guimenuitem>Save As...</guimenuitem></menuchoice> dialogs.</para>

<para>The <acronym>XML</acronym> storage format is a text file that by default is compressed,
which is a preference that is set at <menuchoice><guimenu>Edit</guimenu>
<guimenuitem>Preferences</guimenuitem></menuchoice> <guilabel>General</guilabel>
<guilabel>Compress files</guilabel>. SQLite storage is also available, and stores
your data in a single file on your system, like the <acronym>XML</acronym> format. However,
internally, an SQLite file is managed as a database. The MySQL and PostgreSQL storage options
require access to a MySQL or PostgreSQL database server and the installation of
additional database drivers on your machine.</para>

<tip>
<para>Users can change the format at any time by using <menuchoice><guimenu>File</guimenu>
<guimenuitem>Save As...</guimenuitem></menuchoice>. This will create a copy of
the data file in the selected format.</para>
</tip>
</sect2>

<sect2 id="basics-files-storage-comparison">
<title>Storage Comparison and Recommendations</title>
<para>Each storage format has benefits and shortcomings that users should
consider for their needs and abilities. See the
<link linkend='basics-storage-comparison-table' endterm="basics-storage-comparison-tbltitle"/> below
for further details.</para>

<para>The <acronym>XML</acronym> format is the most stable and established,
and for this reason, it is recommended for most users. <acronym>SQL</acronym>
storage was added for the 2.4 release and has become an increasingly popular
choice for users. The SQLite format allows users to realize the benefits of
<acronym>SQL</acronym> storage without the overhead of installing or managing
a full <acronym>DBMS</acronym>. MySQL and PostgreSQL require the installation
of MySQL and PostgreSQL <acronym>DBMS</acronym>, respectively, and are best
maintained only by experienced database administrators.</para>

<note>
<para>Use of a <acronym>SQL</acronym> back end for storage implies to many
that <application>&app;</application> has fully implemented <acronym>DBMS</acronym>
features, including multi-user and incremental data manipulation. However,
<application>&app;</application> does not currently implement these features,
although it is a long term goal of the development team. </para>
</note>
</sect2>
<sect2 id="basics-storage-comparison-tblsect">
<title>Storage Comparison Table</title>
<table frame="topbot" id="basics-storage-comparison-table">
<title id="basics-storage-comparison-tbltitle">Storage Comparison</title>

<tgroup align="left" cols="5">
<colspec colname="c1item" ></colspec>
<colspec colname="c2xml" ></colspec>
<colspec colname="c3sqlite" ></colspec>
<colspec colname="c4mysql" ></colspec>
<colspec colname="c5pgsql" ></colspec>

<thead>
<row>
<entry> </entry>
<entry align="center">XML</entry>
<entry align="center">SQLite</entry>
<entry align="center">MySQL</entry>
<entry align="center">PostgreSQL</entry>
</row>
</thead>

<tbody>
<row>
<entry namest="c1item" >Availability</entry>
<entry align="center" namest="c2xml" > Built-in </entry>
<entry align="center" namest="c3sqlite" nameend="c5pgsql" > Depends on packaging<footnote>
<para>SQLite relies on an additional package and driver (called libdbi
and libdbd-sqlite3, respectively), which are installed by
default on Mac OS and Windows. Linux users may need to manually
install these for SQLite.</para>
<para>MySQL and PostgreSQL may require the installation of additional software drivers
(libdbd-mysql and libdbd-pgsql).</para>
</footnote>
</entry>
</row>

<row>
<entry namest="c1item" >File extension</entry>
<entry align="center" namest="c2xml" nameend="c3sqlite" > gnucash </entry>
<entry align="center" namest="c4mysql" nameend="c5pgsql" > N/A<footnote>
<para>MySQL and PostgreSQL place data within their own storage system.</para></footnote></entry>
</row>

<row>
<entry namest="c1item" >Additional software</entry>
<entry align="center" namest="c2xml" nameend="c3sqlite" > None </entry>
<entry align="center" namest="c4mysql" > MySQL </entry>
<entry align="center" namest="c5pgsql" > PostgreSQL </entry>
</row>

<row>
<entry namest="c1item" >Additional expertise</entry>
<entry align="center" namest="c2xml" nameend="c3sqlite" > None </entry>
<entry align="center" namest="c4mysql" nameend="c5pgsql" > Database Administrator </entry>
</row>

<row>
<entry namest="c1item" >Compression</entry>
<entry align="center" namest="c2xml" > gzip </entry>
<entry align="center" namest="c3sqlite" nameend="c5pgsql" > N/A </entry>
</row>

<row>
<entry namest="c1item" >File Save</entry>
<entry align="center" namest="c2xml" > On command </entry>
<entry align="center" namest="c3sqlite" nameend="c5pgsql" > On commit </entry>
</row>

<row>
<entry namest="c1item" >Multi-user</entry>
<entry align="center" namest="c2xml" > No </entry>
<entry align="center" namest="c3sqlite" > No </entry>
<entry align="center" namest="c4mysql" > No </entry>
<entry align="center" namest="c5pgsql" > No </entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>

<sect2 id="basics-create-data">
<title>Creating a file</title>
Expand Down
128 changes: 128 additions & 0 deletions guide/C/ch_bus_features.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,134 @@ Basic A/R and A/P Account Hierarchy:
<para><emphasis>If unsure about tax law requirements, get professional advice. </emphasis></para>
</listitem>
</itemizedlist>

<para>The following charts illustrate sample tax tables and
may be used as starting points to determine the setup
appropriate for a particular jurisdiction.</para>

<table frame='all'>
<title>Sample Tax Table Entries for EC country (e.g. 21% / 6%
/ 0% Belgium, 20% / 5% / 0% UK etc.) (2017)</title>
<tgroup cols='3' align='left' colsep='1' rowsep='1'>
<thead>
<row>
<entry>Tax Table</entry>
<entry>Tax Table Entries [Asset/Liability]</entry>
<entry>Percentage or Amount</entry>
</row>
</thead>
<tbody>
<row>
<entry>Standard VAT Sales</entry>
<entry>VAT:Sales:Standard [L]</entry>
<entry>21%</entry>
</row>
<row>
<entry>Reduced VAT Sales</entry>
<entry>VAT:Sales:Reduced [L]</entry>
<entry>6%</entry>
</row>
<row>
<entry>Zero-Rated VAT Sales</entry>
<entry>VAT:Sales:Zero [L]</entry>
<entry>0%</entry>
</row>
<row>
<entry morerows='1'>EC Sales</entry>
<entry>VAT:Sales:EC [L]</entry>
<entry>21%</entry>
</row>
<row>
<entry>VAT:Sales:Reverse EC [L]</entry>
<entry>-21%</entry>
</row>
<row>
<entry>Standard VAT Purchases</entry>
<entry>VAT:Purchases:Standard [A]</entry>
<entry>21%</entry>
</row>
<row>
<entry>Reduced VAT Purchases</entry>
<entry>VAT:Purchases:Reduced [A]</entry>
<entry>6%</entry>
</row>
<row>
<entry>Zero-Rated VAT Purchases</entry>
<entry>VAT:Purchases:Zero [A]</entry>
<entry>0%</entry>
</row>
</tbody>
</tgroup>
</table>

<table frame='all'>
<title>Sample Tax Table Entries for Australia (2017)
</title>
<tgroup cols='3' align='left' colsep='1' rowsep='1'>
<thead>
<row>
<entry>Tax Table</entry>
<entry>Tax Table Entries [Asset/Liability]</entry>
<entry>Percentage or Amount</entry>
</row>
</thead>
<tbody>
<row>
<entry>Standard GST Sales</entry>
<entry>GST:Sales:Standard [L]</entry>
<entry>10%</entry>
</row>
<row>
<entry>GST-free Sales</entry>
<entry>GST:Sales:Zero [L]</entry>
<entry>0%</entry>
</row>
<row>
<entry>Standard GST Purchases</entry>
<entry>GST:Purchases:Standard [A]</entry>
<entry>10%</entry>
</row>
<row>
<entry>GST-free Purchases</entry>
<entry>GST:Purchases:Zero [A]</entry>
<entry>0%</entry>
</row>
</tbody>
</tgroup>
</table>

<table frame='all'>
<title>Sample Tax Table Entries for Cook County, Illinois (2017)</title>
<tgroup cols='3' align='left' colsep='1' rowsep='1'>
<thead>
<row>
<entry>Tax Table</entry>
<entry>Tax Table Entries [Asset/Liability]</entry>
<entry>Percentage or Amount</entry>
</row>
</thead>
<tbody>
<row>
<entry morerows='3'>Chicago Sales Taxes</entry>
<entry>Taxes:Sales:State [L]</entry>
<entry>6.25%</entry>
</row>
<row>
<entry>Taxes:Sales:City [L]</entry>
<entry>1.25%</entry>
</row>
<row>
<entry>Taxes:Sales:County [L]</entry>
<entry>1.75%</entry>
</row>
<row>
<entry>Taxes:Sales:Region [L]</entry>
<entry>1%</entry>
</row>
</tbody>
</tgroup>
</table>

</sect2>

<sect2 id="bus-setupcname">
Expand Down
Loading

0 comments on commit 5c66e62

Please sign in to comment.