IntenseFinance/gnucash
3
0
Fork 0
mirror of https://github.com/Gnucash/gnucash.git synced 2024-11-22 08:57:17 -06:00
Code Issues Packages Projects Releases Wiki Activity

Christopher Browne's update to the sgml docs.

Browse Source 
git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@2718 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
Dave Peticolas 2000-08-27 08:53:11 +00:00
parent 19ed223ff6
commit 93a6911a14
10 changed files with 385 additions and 408 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/sgml/C/Makefile.am
View File

@ -2,6 +2,7 @@ gnucash_helpdir = $(datadir)/gnome/help/gnucash/C
GNUCASH_SGML_FILES = \
bofa-mym.sgml \
gnucash.sgml \
xacc-about.sgml \
xacc-accountedit.sgml \
xacc-acctypes.sgml \
@ -13,6 +14,7 @@ GNUCASH_SGML_FILES = \
xacc-currencyhandling.sgml \
xacc-dateinput.sgml \
xacc-depreciation.sgml \
xacc-dochack.sgml \
xacc-doubleentry.sgml \
xacc-euro.sgml \
xacc-gpl.sgml \

2
doc/sgml/C/Makefile.in
View File

@ -117,7 +117,7 @@ l = @l@
gnucash_helpdir = $(datadir)/gnome/help/gnucash/C
GNUCASH_SGML_FILES = bofa-mym.sgml xacc-about.sgml xacc-accountedit.sgml xacc-acctypes.sgml xacc-adjbalwin.sgml xacc-apar.sgml xacc-balancereport.sgml xacc-balancesheet.sgml xacc-chartofaccts.sgml xacc-currencyhandling.sgml xacc-dateinput.sgml xacc-depreciation.sgml xacc-doubleentry.sgml xacc-euro.sgml xacc-gpl.sgml xacc-incomeexpense.sgml xacc-locatingtxns.sgml xacc-mainwin.sgml xacc-newacctwin.sgml xacc-pnl.sgml xacc-portfolio-report.sgml xacc-preferences.sgml xacc-preferences2.sgml xacc-print-check.sgml xacc-print.sgml xacc-qif-import.sgml xacc-quicken.sgml xacc-recnwin.sgml xacc-regwin-kbd.sgml xacc-regwin.sgml xacc-reports.sgml xacc-ticker.sgml xacc-trans-report.sgml xacc-userdocs.sgml xacc-y2k.sgml
GNUCASH_SGML_FILES = bofa-mym.sgml gnucash.sgml xacc-about.sgml xacc-accountedit.sgml xacc-acctypes.sgml xacc-adjbalwin.sgml xacc-apar.sgml xacc-balancereport.sgml xacc-balancesheet.sgml xacc-chartofaccts.sgml xacc-currencyhandling.sgml xacc-dateinput.sgml xacc-depreciation.sgml xacc-dochack.sgml xacc-doubleentry.sgml xacc-euro.sgml xacc-gpl.sgml xacc-incomeexpense.sgml xacc-locatingtxns.sgml xacc-mainwin.sgml xacc-newacctwin.sgml xacc-pnl.sgml xacc-portfolio-report.sgml xacc-preferences.sgml xacc-preferences2.sgml xacc-print-check.sgml xacc-print.sgml xacc-qif-import.sgml xacc-quicken.sgml xacc-recnwin.sgml xacc-regwin-kbd.sgml xacc-regwin.sgml xacc-reports.sgml xacc-ticker.sgml xacc-trans-report.sgml xacc-userdocs.sgml xacc-y2k.sgml
EXTRA_DIST = $(GNUCASH_SGML_FILES)

33
doc/sgml/C/bofa-mym.sgml
View File

@ -4,32 +4,27 @@
</ARTHEADER>
<SECT1>
<TITLE> Managing Your Money to GnuCash Conversion </TITLE>
<PARA> Ken Yamaguchi has kindly made available a Perl script that
allows <APPLICATION>Managing Your Money 2.x</APPLICATION> data to be converted into QIF
format, which can then be imported into <APPLICATION>GnuCash</APPLICATION>. It has been
tested with 1.3.99 and works well. The script is available
from:
allows <APPLICATION>Managing Your Money 2.x</APPLICATION> data
to be converted into QIF format, which can then be imported into
<APPLICATION>GnuCash</APPLICATION>. It has been tested with 1.3.99 and
works well. The script is available from: </PARA>
</PARA>
<PARA><ULINK URL="http://www-cad.eecs.berkeley.edu/~gooch/mymdump.html"> http://www-cad.eecs.berkeley.edu/~gooch/mymdump.html</ULINK>
<PARA><ULINK URL="http://www-cad.eecs.berkeley.edu/~gooch/mymdump.html">
http://www-cad.eecs.berkeley.edu/~gooch/mymdump.html</ULINK> </PARA>
</PARA>
</SECT1>
<SECT1 ID="XACC-DUPETXNS">
<TITLE> Duplicate Transactions</TITLE>
<PARA> Ken has also written a script that removes duplicate
transactions at the QIF level. GnuCash is very strict about
duplicates, and this script is useful for successfully
importing a succession of QIF files provided by a bank for
overlapping time periods, for instance. This script is
available from:
</PARA>
<PARA><ULINK URL="http://www-cad.eecs.berkeley.edu/~gooch/qifuniq.html"> "http://www-cad.eecs.berkeley.edu/~gooch/qifuniq.html</ULINK>
<PARA> Ken has also written a script that removes duplicate transactions
at the QIF level. GnuCash is very strict about duplicates, and this
script is useful for successfully importing a succession of QIF files
provided by a bank for overlapping time periods, for instance. This
script is available from: </PARA>
<PARA><ULINK URL="http://www-cad.eecs.berkeley.edu/~gooch/qifuniq.html">
http://www-cad.eecs.berkeley.edu/~gooch/qifuniq.html</ULINK>
</PARA>
</SECT1>

503
doc/sgml/C/xacc-about.sgml
View File

File diff suppressed because it is too large Load Diff

21
doc/sgml/C/xacc-depreciation.sgml
View File

@ -515,19 +515,18 @@
property for less than ten years.
</PARA>
<PARA><ULINK URL="mailto:cbbrowne@hex.net">I have</ULINK> one story from
my professional tax preparation days where a family sold a
farm, and expected a <EMPHASIS>considerable</EMPHASIS> tax bill that turned
out to be virtually nil due to having owned the property before
1971 (wherein lies a critical "Valuation Day" date in Canada)
and due to it being a <EMPHASIS>dairy</EMPHASIS> farm, with some <EMPHASIS>really
peculiar</EMPHASIS> resulting deductions.
</PARA>
<PARA>In short, this presentation is fairly simple, but taxation
often gets terribly complicated...
<PARA><ULINK URL="mailto:cbbrowne@hex.net">I have</ULINK> one story
from my professional tax preparation days where a family sold a farm,
and expected a <EMPHASIS>considerable</EMPHASIS> tax bill that turned
out to be virtually nil due to having owned the property before 1971
(wherein lies a critical "Valuation Day" date in Canada) and due to it
being a <EMPHASIS>dairy</EMPHASIS> farm, with some <EMPHASIS>really
peculiar</EMPHASIS> resulting deductions. </PARA>
<PARA>The point of this story is that while the presentation here is
fairly simple, taxation often gets terribly complicated... </PARA>
</PARA>
</SECT2>
</SECT1>
<SECT1 ID="XACC-DEPR">

32
doc/sgml/C/xacc-dochack.sgml
View File

@ -27,21 +27,19 @@ The Definitive Guide (online)</ULINK>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA> <ULINK
URL="http://www.oasis-open.com/davenport/dbdoc/">References for the
DocBook DTD </ULINK> </PARA>
</LISTITEM>
<LISTITEM> <PARA> <ULINK URL=
"http://www.oasis-open.com/davenport/dbdoc/">References for the
DocBook DTD </ULINK> </PARA> </LISTITEM>
<LISTITEM> <PARA><ULINK URL=
"http://www.oasis-open.org/docbook/documentation/index.html"> DocBook
- Documentation</ULINK></PARA> </LISTITEM>
<LISTITEM>
<PARA><ULINK
URL="http://www.oasis-open.org/docbook/documentation/index.html">
DocBook - Documentation</ULINK></PARA>
<PARA><ULINK URL="http://www.oasis-open.org/docbook/">DocBook -
DocBook</ULINK></PARA>
</LISTITEM>
<LISTITEM>
<PARA><ULINK URL="http://www.oasis-open.org/docbook/">DocBook - DocBook</ULINK></PARA>
</LISTITEM>
<LISTITEM>
<PARA> <ULINK URL="http://fallout.campusview.indiana.edu/~jfieber/docbook/doc/over/index.html"> DocBook
Overview </ULINK> </PARA>
@ -130,7 +128,7 @@ be consulted to make up the body of the document, each file
representing one of the ARTICLEs. </PARA>
<para> Note that filenames for the HTML output files are generated in
three notable ways:
three ways:</para>
<itemizedlist>
@ -143,14 +141,18 @@ it is the first SECT1 in an ARTICLE;</para></listitem>
<listitem><para> If you create a new ARTICLE or SECT1 without an ID
tag, filenames will be generated with names like
<filename>t1234.html</filename>, <filename>x892.html</filename>, and
such. They will look quite random. </para></listitem>
such. They will look quite random. </para>
<PARA> This is a bad thing; make sure you assign an ID tag to the
ARTICLE or SECT1. </para>
</listitem>
</itemizedlist>
</para>
<para> Styling is controlled by the DSSSL document,
<filename>mysheet.dsl</filename>, using the conventions documented in
the <link linkend="MODSTYLE"> Modular DocBook Stylesheets </link></para>
the <link linkend="MODSTYLE"> Modular DocBook Stylesheets
</link></para>
<para> Components that need to be installed in order for the command
<command>jade -ioutput.html -d mysheet.dsl -t sgml

48
doc/sgml/C/xacc-reports.sgml
View File

@ -1,4 +1,3 @@
<ARTICLE ID="XACC-REPORTS">
<ARTHEADER>
<TITLE>Reports</TITLE>
@ -102,38 +101,37 @@
</PARA>
</SECT1>
<SECT1 ID="XACC-CUSTOMREPORTS">
<TITLE> Constructing custom reports</TITLE>
<PARA> It is possible to write your own reports to meet your own
needs, if you can program a little. You will need to know
Scheme (a LISP-like programming language), and it is an
excellent idea to have a copy of the Gnucash source code
available.
</PARA>
<PARA>The reporting interface is presently undocumented, but you
can get a good idea of how it works by examining the file
src/scm/report/hello-world.scm in the GnuCash source
distribution.
<PARA> It is possible to write your own reports to meet your own
needs, if you can program a little. You will need to know Scheme (a
LISP-like programming language), and it is an excellent idea to have a
copy of the <application>GnuCash</application> source code available.
</PARA>
<PARA>The reporting interface is presently undocumented, but you can
get a good idea of how it works by examining the file <filename>
src/scm/report/hello-world.scm </filename> in the
<application>GnuCash</application> source distribution.
</PARA>
</PARA>
<PARA>You will also need to access data from the "engine" to get
information for your report. This is performed by a set of
Scheme wrapper functions that are documented in the file
src/g-wrap/gnc.html. You may wish to examine some of the other
reports in src/scm/report for an indication of how they are
used.
information for your report. This is performed by a set of Scheme
wrapper functions that are documented in the file<filename>
src/g-wrap/gnc.html</filename>. You may wish to examine some of the
other reports in <filename> src/scm/report </filename> for an
indication of how they are used.
</PARA>
</PARA>
<PARA>At present, reports are produced by internally creating HTML
and rendering this with a HTML widget. (Future versions of
GnuCash will hopefully support a more flexible system).
<PARA>At present, reports are produced by internally creating HTML and
rendering this with a HTML widget. (Future versions of GnuCash will
hopefully support a more flexible system). </PARA>
</PARA>
<PARA>If you need more information, or have developed a new report
that may be of use to others, please contact the GnuCash
development mailing list at <ULINK URL="mailto:gnucash-devel@gnucash.org"> gnucash-devel@gnucash.org</ULINK>.
that may be of use to others, please contact the GnuCash development
mailing list at <email> gnucash-devel@gnucash.org </email>.
</PARA>
</SECT1>

8
doc/sgml/C/xacc-trans-report.sgml
View File

@ -5,7 +5,7 @@
</ARTHEADER>
<SECT1 ID="XACC-TXNREPORTS">
<TITLE> Transaction Report</TITLE>
<PARA> </PARA>
<PARA>Transaction reports list details for transactions in a
specified account over a specified period, in a convenient
format for viewing and exporting.
@ -14,9 +14,9 @@
<PARA>Options specifiable for this report include:
<ITEMIZEDLIST>
<LISTITEM>
<PARA> <EMPHASIS>Display:</EMPHASIS>Select fields to display in the report. The
choices include:
<LISTITEM><PARA> <EMPHASIS>Display:</EMPHASIS>Select fields to display
in the report. The choices include:
<ITEMIZEDLIST>
<LISTITEM>

78
doc/sgml/C/xacc-userdocs.sgml
View File

@ -1,73 +1,74 @@
<ARTICLE ID="XACC-USERDOCS">
<ARTHEADER>
<TITLE>GnuCash Help Main Window</TITLE>
</ARTHEADER>
<SECT1>
<TITLE> User Documentation Overview</TITLE>
<PARA> For help on a specific topic:
<ITEMIZEDLIST>
<PARA> For help on a specific topic:
<ITEMIZEDLIST>
<LISTITEM>
<PARA><LINK LINKEND="XACC-ABOUT">About GnuCash</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-ACCTYPES">Account Types</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-APAR">Accounts Payable and Accounts
Receivable</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-CHARTOFACCTS">Chart of Accounts</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-NEWACCTWIN">Creating a new
account</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="DATE">Date Input</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-DEPRECIATION">Depreciation and Capital
Gains</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-CURRENCYHANDLING">Foreign Currency
Accounts</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-EURO">GnuCash and the EURO</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><ULINK URL="bofa-mym.html">Importing MYM (Managing Your
Money) Files</ULINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-QIF-IMPORT">A Guide for Former Users
of Quicken(TM)</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA> <LINK LINKEND="XACC-GPL">License - GPL</LINK>
@ -75,92 +76,93 @@
<ITEMIZEDLIST>
<LISTITEM>
<PARA><LINK LINKEND="SEC003">Warranty</LINK>
</PARA>
</PARA>
</LISTITEM>
</ITEMIZEDLIST>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-MAINWIN">The Main Window</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-RECNWIN">The Reconcile Window</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-REGWIN">The Register Window</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-TICKER">Stock Ticker</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-DOUBLEENTRY">Using Double Entry</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-INCOMEEXPENSE">Using Income/Expense
Accounts</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-PREFERENCES">Personalising
Gnucash</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-ACCOUNTEDIT">Changing Account
Properties</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-Y2K">Y2K Considerations</LINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-REPORTS">Reports</LINK>
</PARA>
</PARA>
</LISTITEM>
</ITEMIZEDLIST>
</PARA>
</PARA>
</SECT1>
<SECT1 ID="XACC-EXTHELP">
<TITLE> Extended Help/System Documentation</TITLE>
<PARA> </PARA>
<PARA>The following documentation is about the <EMPHASIS> implementation</EMPHASIS> of GnuCash as opposed to being <EMPHASIS>user
documentation</EMPHASIS> on how to <EMPHASIS>use</EMPHASIS> it.
</PARA>
<PARA>Some of it represents preliminary documentation for
subsystems that are not yet sufficiently functional for use by
end users.
<PARA>The following documentation is about the <EMPHASIS>
implementation</EMPHASIS> of GnuCash as opposed to being
<EMPHASIS>user documentation</EMPHASIS> on how to
<EMPHASIS>use</EMPHASIS> it.
</PARA>
<ITEMIZEDLIST>
<PARA>Some of it represents preliminary documentation for subsystems
that are not yet sufficiently functional for use by end users.
<ITEMIZEDLIST>
<LISTITEM>
<PARA><ULINK URL="projects.html">GnuCash Project Goals</ULINK>
</PARA>
</PARA>
</LISTITEM>
<LISTITEM>
<PARA><LINK LINKEND="XACC-PRINT">Printing</LINK>
</PARA>
</PARA>
</LISTITEM>
</ITEMIZEDLIST>
</PARA>
</PARA>
</SECT1>
</ARTICLE>

66
doc/sgml/C/xacc-y2k.sgml
View File

@ -4,47 +4,39 @@
</ARTHEADER>
<SECT1>
<TITLE> GnuCash Y2K Readiness</TITLE>
<PARA> </PARA>
<PARA>GnuCash versions 1.1.25 and later store all dates as seconds
and nanoseconds, where the seconds are stored in a 64-bit
signed integer. This should suffice to store dates into both
the distant past as well as the distant future, so long as they
fall not <EMPHASIS>too</EMPHASIS> many orders of magnitude outside
cosmologists' estimations of the age of the universe.
</PARA>
<PARA>The file format for version 1.1.25 and later stores dates in
the above-described fashion.
<PARA>GnuCash versions 1.1.25 and later store all dates as seconds and
nanoseconds, where the seconds are stored in a 64-bit signed
integer. This should suffice to store dates into both the distant past
as well as the distant future, so long as they fall not
<EMPHASIS>too</EMPHASIS> many orders of magnitude outside
cosmologists' estimations of the age of the universe. </PARA>
</PARA>
<PARA>Some internal routines use the <FUNCTION>time_t</FUNCTION> type to
express seconds. Note that on most OSes, this is a 32-bit
quantity, and is thus limited to the Unix epoch, roughly
December 1901 thru Jan 2038. It is reasonable to expect that
<FUNCTION>time_t</FUNCTION> will migrate to the use of 64 bit values by
that time.
</PARA>
<PARA>Backup and log files are time-stamped using the standard
Unix <FUNCTION>ctime()</FUNCTION> routine, which takes a <FUNCTION>time_t</FUNCTION>
argument. Thus, the backup and log mechanism may experience
trouble in 2038, assuming your present Unix continues to be in
service at that time without any remediation.
</PARA>
<PARA>Note that GnuCash also correctly recognizes February 29th,
2000 as a "leap day," another of the "critical Y2K dates."
</PARA>
<PARA>This is all highly suggestive that GnuCash should cope
reasonably well with the transition to the new millennium,
whether that take place in 2000 or in 2001...
</PARA>
<PARA>Y2K issues are described in more detail at <ULINK URL="http://www.ntlug.org/~cbbrowne/linuxy2k.html">Linux and Year
2000.</ULINK>
<PARA>The file format for version 1.1.25 and later stores dates in the
above-described fashion. </PARA>
<PARA>Some internal routines use the <FUNCTION>time_t</FUNCTION> type
to express seconds. Note that on most OSes, this is a 32-bit quantity,
and is thus limited to the Unix epoch, roughly December 1901 thru Jan
2038. It is reasonable to expect that <FUNCTION>time_t</FUNCTION> will
migrate to the use of 64 bit values by that time. </PARA>
<PARA>Backup and log files are time-stamped using the standard Unix
<FUNCTION>ctime()</FUNCTION> routine, which takes a
<FUNCTION>time_t</FUNCTION> argument. Thus, the backup and log
mechanism may experience trouble in 2038, assuming your present Unix
continues to be in service at that time without any remediation.
</PARA>
<PARA>Note that GnuCash also correctly recognizes February 29th, 2000
as a "leap day," another of the "critical Y2K dates." </PARA>
<PARA>This is all highly suggestive that GnuCash should cope
reasonably well with the transition to the new millennium, whether you
consider that takes place in 2000 or in 2001... </PARA>
<PARA>Y2K issues are described in more detail at <ULINK URL=
"http://www.ntlug.org/~cbbrowne/linuxy2k.html">Linux and Year
2000.</ULINK> </PARA>
</SECT1>
</ARTICLE>