diff --git a/doc/html/C/bofa-mym.html b/doc/html/C/bofa-mym.html index fb772070cd..bac16d000d 100644 --- a/doc/html/C/bofa-mym.html +++ b/doc/html/C/bofa-mym.html @@ -1,41 +1,46 @@ + - -Importing MYM Files - - -

Managing Your Money --> GnuCash

+ + -I have finally put the Perl script that allowed me to use GnuCash -up on a web site. I had a couple years of data in Managing Your -Money 2.x that I didn't want to reenter. The script will output a -single QIF file with all transactions, accounts, and categories. -(Currently only non-investment transactions are handled.) The QIF -file can be imported to xacc-1.0.18 if a small patch is applied to -QIFIO.c. The site is + Importing MYM Files + -

-MyMdump

+ +

Managing Your Money --> GnuCash

+ I have finally put the Perl script that allowed me to use + GnuCash up on a web site. I had a couple years of data in + Managing Your Money 2.x that I didn't want to reenter. The + script will output a single QIF file with all transactions, + accounts, and categories. (Currently only non-investment + transactions are handled.) The QIF file can be imported to + xacc-1.0.18 if a small patch is applied to QIFIO.c. The site is + -

Duplicate Transactions

+

+ MyMdump

-I also have a script that I use to remove duplicate transactions at -the QIF level. I use this script because Xacc is very strict about -duplicates (which is good) and because editing imported -transactions will cause a re-import of the same transactions to -produce duplicates. (I download the same month's transactions from -my bank several times each month, so each downloaded QIF -file--after the first--contains transactions I have already -imported. I don't want to rely on the bank sending me the -transactions in the same order or with the same formatting.) The -site is +

Duplicate Transactions

+ I also have a script that I use to remove duplicate + transactions at the QIF level. I use this script because Xacc + is very strict about duplicates (which is good) and because + editing imported transactions will cause a re-import of the + same transactions to produce duplicates. (I download the same + month's transactions from my bank several times each month, so + each downloaded QIF file--after the first--contains + transactions I have already imported. I don't want to rely on + the bank sending me the transactions in the same order or with + the same formatting.) The site is -

-qifuniq

+

+ qifuniq

-

I hope others find these scripts useful.

+

I hope others find these scripts useful.

-

Ken Yamaguchi October 1998

- +

Ken Yamaguchi October 1998

+ diff --git a/doc/html/C/projects.html b/doc/html/C/projects.html index ba2a39897f..8d6bd4491b 100644 --- a/doc/html/C/projects.html +++ b/doc/html/C/projects.html @@ -2,6 +2,8 @@ + + GnuCash Project Goals @@ -12,85 +14,83 @@

GnuCash Project Goals

-

The people behind GnuCash aim - to create a world-class GPL'ed Open Source Personal Financial - Application for GNU/Linux and other Unix's. This page reviews - some of the technical issues and development status surrounding - this project. It is a kind of an FAQ for developers and - contributors, providing status, and suggesting directions and - technologies for deploying new features. +

The people behind GnuCash + aim to create a world-class GPL'ed Open Source Personal + Financial Application for GNU/Linux and other Unix's. This page + reviews some of the technical issues and development status + surrounding this project. It is a kind of an FAQ for + developers and contributors, providing status, and suggesting + directions and technologies for deploying new features. If you + simply want to get a better idea of what GnuCash is and what it does, visit its + home page. The home page + contains screen shots, news items, and mailing list + archives.

- If you simply want to get a better idea of what - - GnuCash is and what it does, visit its home page. The home page contains - screen shots, news items, and mailing list archives. - -

There are currently several different versions of - GnuCash. We've adopted the kernel numbering scheme: - even minor relase numbers (1.2.x, 1.4.x) are considered to mark - stable releases, while odd numbers (1.3.x) mark development - releases. +

There are currently several different versions of GnuCash. + We've adopted the kernel numbering scheme: even minor relase + numbers (1.2.x, 1.4.x) are considered to mark stable releases, + while odd numbers (1.3.x) mark development releases.

-

The latest Gnome version, and latest versions in general, - are currently available only via CVS. Occasionally, some of the - more stable CVS versions are given a version number, and packaged - as a precompiled deb or rpm install package. +

The latest Gnome version, and latest versions in general, + are currently available only via CVS. Occasionally, some of the + more stable CVS versions are given a version number, and + packaged as a precompiled deb or rpm install package. Naive or + begining users should probably stick to version gnucash-1.2.5: + although this version is quite old and lacking in many + features, it is known to work. More adventurous users can try + one of the 1.3.x releases: these days, they are pretty stable, + and work pretty well. However, we cannot gaurentee that they + are flawless. We've tried to make sure that no matter how + broken these get, they won't mangle your data, but we can't + make promises.

- Naive or begining users should probably stick to version - gnucash-1.2.5: although this version is quite old and lacking in - many features, it is known to work. More adventurous users can try - one of the 1.3.x releases: these days, they are pretty stable, and - work pretty well. However, we cannot gaurentee that they are - flawless. We've tried to make sure that no matter how broken - these get, they won't mangle your data, but we can't make promises. -

- - -

This document is divided into several sections.

+

This document is divided into several sections.

  1. Architectural Goals
  2. Requirements
  3. +
  4. Sizings
  5. Features
-
+
+ -

Architectural Goals

- There are some over-reaching design principles - and philosophies that we intend to maintain. Some of these - concepts and terms are introduced in this section.
+ There are some over-reaching design principles and philosophies + that we intend to maintain. Some of these concepts and terms + are introduced in this section.

Separation of GUI and Data

First, we must maintain a clean separation between the data @@ -102,43 +102,37 @@ thought of as a representation of financial data, a Model. -
  • - The GUI that adds, modifies and deletes these should be - thought of as a manipulator of the data, a - Controller. - - Thus, the Motif or Gnome GUIs are merely two possible - manipulators of the data; others, based on e.g. - web/cgi-bin, Qt/KDE, emacs, Java applets or Java servlets - ought to be possible. -
  • +
  • The GUI that adds, modifies and deletes these should be + thought of as a manipulator of the data, a Controller. + Thus, the Motif or Gnome GUIs are merely two possible + manipulators of the data; others, based on e.g. + web/cgi-bin, Qt/KDE, emacs, Java applets or Java servlets + ought to be possible.
  • The View of the data is a subset or slice of the data described by the Model. The View may consist of only the transactions for the month of May, or only the account totals for certain accounts. The View is used in part to generate the reports and graphs, but it is also that which the - Controller interacts with. Views are generated by queries - to the data store.
  • + Controller interacts with. Views are generated by queries to + the data store. -

    GnuCash also needs to deal with multiple distributed data +

    GnuCash also needs to deal with multiple distributed data sources: stock quotations from the net or transaction confirmations from online banks and brokerage houses, or from more mundane sources, such as file imports, or merger of data - from several users. + from several users. Amongst these terms, the concept of a + global Model-View is dated, and somewhat inappropriate. Rather, + we need to be concerned about how data is represented in the + local address space of the GUI, how the GUI manipulates it, how + data is brought in and merged from external sources, and how + that data is again output, whether to a file or a local or + remote database.

    - Amongst these terms, the concept of a global Model-View is - dated, and somewhat inappropriate. Rather, we need to be - concerned about how data is represented in the local address - space of the GUI, how the GUI manipulates it, how data is - brought in and merged from external sources, and how that data - is again output, whether to a file or a local or remote - database.

    - -

    Thus, the View essentially represents a local data +

    Thus, the View essentially represents a local data cache of the data that is immediately present and being - displayed, reported, and manipulated. The Model is the + displayed, reported, and manipulated. The Model is the abstraction of that data that the GUI (the controller) can act on.

    @@ -149,28 +143,29 @@ the GUI (or a script, or even a clever command-line-addict) can use to manipulate the data. -

    Currently, the Engine is fairly poor, and is tightly tied - to the data structures that the GUI manipulates. These data +

    Currently, the Engine is fairly poor, and is tightly tied to + the data structures that the GUI manipulates. These data structures include:

    The Engine has a very simple apply/commit model, and a simple - query mechanism for generating reports and views. The goal of the - commit and query model is to aid/simplify the creation of & merger - with an SQL back-end. + query mechanism for generating reports and views. The goal of + the commit and query model is to aid/simplify the creation of + & merger with an SQL back-end. -

    The Engine currently handles only a small set of data +

    The Engine currently handles only a small set of data sources:

    -

    However, since the Engine is meant to be the interface +

    However, since the Engine is meant to be the interface between the GUI and the financial data, it is really intended to be able to do much more.

    -

    In particular, it should be possible to back the Engine - onto an SQL database, and thereby enable multiple users and/or +

    In particular, it should be possible to back the Engine onto + an SQL database, and thereby enable multiple users and/or interface to more complex accounting systems. The engine should also be expandable to handle other sources of data, such as OFX, Integrion GOLD, the Open Trading Protocol, the OMG CORBA @@ -197,31 +192,26 @@

    Modularity, Extensibility and Customization

    -

    The above structure should leads us to view GnuCash not so +

    The above structure should leads us to view GnuCash not so much as a tightly integrated application, but rather as a loose - confederation of component objects, libraries and - interfaces. + confederation of component objects, libraries and interfaces. + In order to facilitate the gluing together of these parts, as + well as simplify the questions of customizability, change and + rapid development, GnuCash makes use of the + Scheme extension language (as implemented in the FSF Guile + interpreter), to glue the pieces together. (Note that the + engine interface is also available with Perl interfaces, thanks to a SWIG + wrapper.

    +
    + - In order to facilitate the gluing together of these parts, - as well as simplify the questions of customizability, change - and rapid development, GnuCash makes use of the - - Scheme extension language (as implemented in the FSF - Guile - interpreter), to glue the pieces together. - (Note that the engine interface is also available with - Perl interfaces, thanks - to a - - SWIG wrapper. -

    - -
    - -

    Requirements

    +

    Requirements

    Implicit in this desire for extensibility is the need to build financial applications supporting two major classes of users: -
    - Another set of contradictory requirements has to do with the - back-end, and interfacing to other systems: + back-end, and interfacing to other systems: + -

    It may be that these will require completely +

    It may be that these will require completely different systems, and that GnuCash cannot be "all things to all people." This remains to be seen.

    +
    + - -
    - -

    Sizings

    - This section attempts to guesss how hard it would be to implement - certain features. -
    +

    Sizings

    + This section attempts to guesss how hard it would be to + implement certain features.

    Personal Financial Application

    Below are listed the technical work items needed to implement the features that home users might hope to have. They are listed in approximate order of priority. -

    The right hand column shows a sizing guesstimate. pm == - person-months. These sizings are meant to show 'effort needed to - complete', rather than 'total effort required'. Thus, half-finished - items have smaller sizings. -

    +

    The right hand column shows a sizing guesstimate. pm == + person-months. These sizings are meant to show 'effort needed + to complete', rather than 'total effort required'. Thus, + half-finished items have smaller sizings.

    - +
    @@ -565,8 +553,8 @@

    Small Business Features

    Features that small/medium businesses expect. -
    Feature
    +
    @@ -628,16 +616,14 @@
    FeatureLarge
    +
    + -
    - - -

    Features and Functions

    -This section reviews the current status of various features. -Some of these are 'in process', some are 'almost done', some are -'completely done'. This section thus provides status on both where -we've been, and where we're going. -
    +

    Features and Functions

    + This section reviews the current status of various features. + Some of these are 'in process', some are 'almost done', some + are 'completely done'. This section thus provides status on + both where we've been, and where we're going.
    @@ -650,134 +636,147 @@ we've been, and where we're going. country. This would include the printing of currency values in the local country conventions. -

    Current status: +

    Current status:

    -

    +
    +
    -
    Reports
    +
    Reports
    - A variety of reports, including Net Worth, Balance - Sheets, and Profit and Loss statements. These should be - printable: that is, exportable as HTML as well as print-ready - postscript. - These should be easy to customize. Ideally, even novice users - should be able to create custom reports. + A variety of reports, including Net Worth, Balance Sheets, + and Profit and Loss statements. These should be printable: + that is, exportable as HTML as well as print-ready + postscript. These should be easy to customize. Ideally, + even novice users should be able to create custom reports. -

    Other output format possibilities include SGML and Extensible +

    Other output format possibilities include SGML and Extensible Markup Language - XML. In the long run, these are - preferable to HTML, since DSSSL tools such as Jade (James DSSSL - Engine) can be used to convert to RTF, Postscript, - etc. - Add to this the consideration that XML is the basis for - the Document Object - Model, which is being integrated into many web-based - applications, and we can see that XML is an increasingly - significant format as we look to the future.

    + href="http://www.jclark.com/jade/">Jade (James DSSSL + Engine) can be used to convert to RTF, Postscript, etc. + Add to this the consideration that XML is the basis for the + Document Object Model, + which is being integrated into many web-based applications, + and we can see that XML is an increasingly significant + format as we look to the future.

    -

    The Report Generator should be a separate but - "dockable" subsystem of the whole. - That is, it should be possible to run the report generator - in a stand-alone, read-only fashion without having to start - up the main application. It should be possible to run reports - nightly from a command-line and/or cron job.

    +

    The Report Generator should be a separate but "dockable" + subsystem of the whole. That is, it should be possible to + run the report generator in a stand-alone, read-only + fashion without having to start up the main application. It + should be possible to run reports nightly from a + command-line and/or cron job.

    -

    One difficult aspect of reporting is designing a +

    One difficult aspect of reporting is designing a configurable interface, so that people can build custom - reports. The New + reports. The New Reporting Infrastructure is seeking to build this up using Guile.

    Generated reports should be exportable to other gnome - systems using bonbo. Reports should also be exportable to - the gnumeric spreadsheet (possibly by writing out gnumeric - file format??) + systems using bonbo. Reports should also be exportable to + the gnumeric spreadsheet (possibly by writing out gnumeric + file format??)

    Reports should make use of the 'action' field ...

    Relationship to budgeting not clear ... -

    Stock portfolio tools should include a Cost Averaging + +

    Stock portfolio tools should include a Cost Averaging report, Market Index report, Stock Option values, Estimation of capital gains tax liabilities.

    -

    Status: +

    Status:

    -

    +
    +
    -
    Graphs
    + +
    Graphs
    +
    -

    Graph portfolio value vs. cost

    -

    Graphs, charts, etc. too ...

    -

    Asset allocation pie chart.

    -

    The following graph packages are candidates: - GUPPI, - plotutils, - gnumeric/graph code. - The gnumeric/graphcode is already bonobo-ified. - -

    If gnumeric and gnucash are to use a common graph solution, - the following are gnumeric requirements: - -- interactive plot editing - -- each segment attributes totally settable/controllable - -- drag/move callbacks when segments are click-draged. +

    Graph portfolio value vs. cost

    +

    Graphs, charts, etc. too ...

    -

    Status: +

    Asset allocation pie chart.

    + +

    The following graph packages are candidates: GUPPI, plotutils, + gnumeric/graph code. The gnumeric/graphcode is already + bonobo-ified.

    + +

    If gnumeric and gnucash are to use a common graph + solution, the following are gnumeric requirements: -- + interactive plot editing -- each segment attributes totally + settable/controllable -- drag/move callbacks when segments + are click-draged.

    + +

    Status:

    -

    +
    +
    -
    Simplified Stock Ledger
    +
    Simplified Stock Ledger
    Stocks and Mutual funds are handled by placing them each in @@ -789,81 +788,67 @@ we've been, and where we're going. understand and use. A simplified but still powerful ledger window is desperately needed. -

    Question: How to most simply allow the user to +

    Question: How to most simply allow the user to enter loads and fees?

    -

    Answer: Through splits. Unfortunately, some - users may not properly understand splits, at least not - initially. Thus, a little popup is needed to allow the user - to type in the sales load or fee and such, and then - auto-create the needed splits.

    - -

    Note the current transfer window does NOT - allow a share price to be specified !! Needs fixing ...

    +

    Answer: Through splits. Unfortunately, some users + may not properly understand splits, at least not initially. + Thus, a little popup is needed to allow the user to type in + the sales load or fee and such, and then auto-create the + needed splits.

    +

    Note the current transfer window does NOT allow + a share price to be specified !! Needs fixing ...

    Documentation
    -
    - Need to add a 'meta keyword' tag to the documetnatin pages, - this will help the search engine (e.g. - htdig) better categorize - the help. - Mifluz might - be more embeddable ... - I am told that htdig-API is in good solid condition for this, but - undocumented. -

    -

    -
    - +
    Need to add a 'meta keyword' tag to the documetnatin + pages, this will help the search engine (e.g. htdig) better categorize the + help. Mifluz + might be more embeddable ... I am told that htdig-API is in + good solid condition for this, but undocumented.
    + +
    +
    Themes, Icons, Glitz
    -
    A variety of finer touches need work: -

    -
    - +
    +
    Books, Accounting Periods
    -
    - Ability to close the book at end of the fiscal year. - This consists of several steps: -

    -

    -

    -

    Status: -

    -

    + Ability to close the book at end of the fiscal year. This + consists of several steps: + +
    +
    + + +

    Status:

    + + +
    +
    - -
    Check Printing
    -
    +
    + +
    Check Printing
    + +
    + Create a check-printing ability. + +

    Status:

    -
    Create a check-printing ability. -

    Status:

    -

    +
    +
    User Preferences
    Create menu system and file format for manipulating user - preferences. - Preferences include things like default currency, - register layout and colors, etc. -

    - What are some of the comptitive preference-handling - technologies? Lets get some URL's here ... - Following the unix tradition, there is no global - prefernces registery. - Note that session management and preferences are related things - ... sort-of. Right now, we don't treat themn as such ... -

    -

    - Session management is not implemented; viz, we don't - remember where things were left at when the user shut down - the windowing system, and we don't restore the session - afterwords. This includes: which register windows - were left open, what sizes they were, what thier - placements on the screen were, etc. I beleive session - management needs to be coordinated with KDE and with - gnome, and all compliant window maangers will do the rest (?) -

    -

    - Independently of session management, the register windows should - remember how big they were last time they were poped up, and - they should pop up the same size, again. The app should - remember these sizes from invocation to invocation. - -

    + preferences. Preferences include things like default + currency, register layout and colors, etc. + +

    What are some of the comptitive preference-handling + technologies? Lets get some URL's here ... Following the + unix tradition, there is no global prefernces registery. + Note that session management and preferences are related + things ... sort-of. Right now, we don't treat themn as such + ...

    + +

    Session management is not implemented; viz, we don't + remember where things were left at when the user shut down + the windowing system, and we don't restore the session + afterwords. This includes: which register windows were left + open, what sizes they were, what thier placements on the + screen were, etc. I beleive session management needs to be + coordinated with KDE and with gnome, and all compliant + window maangers will do the rest (?)

    + +

    Independently of session management, the register + windows should remember how big they were last time they + were poped up, and they should pop up the same size, again. + The app should remember these sizes from invocation to + invocation.

    + +

    Status:

    -

    Status:

    -

    +
    +
    Extension Language Support
    @@ -1139,81 +1110,79 @@ we've been, and where we're going. created so that additional extensions may be added in a straightforward manner. -

    The overall architecture is envisioned thus:

    +

    The overall architecture is envisioned thus:

    -

    All code, including the transaction engine, the file - I/O routines, the menus, and the ledger, will be abstracted +

    All code, including the transaction engine, the file I/O + routines, the menus, and the ledger, will be abstracted into compact modules that can function independently of each other. At the highest level, there will be a infrastructure with extension language interfaces that will "wire together" the various modules.

    -

    Such "wiring together" will consist of a dispatch +

    Such "wiring together" will consist of a dispatch infrastructure that will allow arbitrary menu entries to be hooked to arbitrary modules. The configuration for menu entries, and their associated callbacks, will be specified in an extension-language configuration file. At the final - stages, it is highly desirable to be able to, in - some manner, import new modules without requiring + stages, it is highly desirable to be able to, in + some manner, import new modules without requiring that the application itself be recompiled and relinked.

    -

    Status: +

    Status:

    -

    - +
    +
    - +
    +
    401(k), RSP
    -
    401K, 403, IRA, Roth IRA, SEP, Keogh ... "Retirement Savigs - Plans" -

    - Retirement Savings Plans often do not put a high priority - on tracking costs, as the tax implication is that amounts are - taxable upon withdrawal, meaning that there is little - necessity to track capital gains. (huh??) -

    + Plans" + +

    Retirement Savings Plans often do not put a high + priority on tracking costs, as the tax implication is that + amounts are taxable upon withdrawal, meaning that there is + little necessity to track capital gains. (huh??)

    Annotate with News Stories
    - Download, save, annotate investment news and research. - Provide a way of storing news stories with accounts, and - possibly annotating individual transactions in the same - way. -

    -

    + Download, save, annotate investment news and research. +

    Provide a way of storing news stories with accounts, and + possibly annotating individual transactions in the same + way.

    -
    Loan and Mortgage Calculators
    +
    Loan and Mortgage + Calculators
    Provide a variety of simple GUI utilities to allow user to calculate the future value of loans, mortgage payments, interest payments, etc. -

    Status: +

    Status:

    -

    - +
    +
    Overdraft Alerts
    @@ -1221,37 +1190,51 @@ we've been, and where we're going.
    Overdraft alerts are popups that pop up whenever the user enters a transaction that would move an account below some - minimum balance, or above some max balance (for a bank account) - or an expense/spending limit is reached (on an expense account). - A similar but different alert can be implenmented for price highs - & lows. Note that these alerts do *not* require any sort of - calendering or recurring transaction support. -

    - Design requirements: implement multiple (not just two) alerts - for any account type. Alert should consist of (1) value point - or price point, (2) movement direction (3) 'is active' boolean - flag (i.e. Should be possible to 'turn off alert' without - deleting it) (4) memo text. -

    -

    Status: + minimum balance, or above some max balance (for a bank + account) or an expense/spending limit is reached (on an + expense account). A similar but different alert can be + implenmented for price highs & lows. Note that these + alerts do not require any sort of calendaring or + recurring transaction support. + +

    Design requirements: implement multiple (not just two) + alerts for any account type. Alert should consist of

    + + +
    +
    + + +

    Status:

    -

    - +
    +
    -
    - Recurring Transactions, Calander Alerts
    +
    Recurring Transactions, Calander + Alerts
    Add support for automatic, recurring transactions, e.g. mortgage payments, fixed-interest bonds, regular - salary checks, regular gas/phone/electric bills, etc. -

    - Loans & mortgages are one of the more complicated recurring - transactions. Consider the following dialogue layout: + salary checks, regular gas/phone/electric bills, + etc. + +

    Loans & mortgages are one of the more complicated + recurring transactions. Consider the following dialogue + layout:

     loan amount $_____________ currency _________ (pull-down menu)
     Remaining balance $___________
    @@ -1267,69 +1250,73 @@ payee ____________
     pay-from account __________________
     next due date mm/dd/yy
     
    - Note that in the above, not all fields are independent: - some can be calculated from others. - The other payment should bring up a mini-register, - allowing user to add any number of splits. -

    -

    - Recurring bills, salary income, etc. are simpler to handle, - since they don't have intersest rates, balloons, etc. They - do/will have multiple splits (e.g. payroll gross, fica, futa, - income taxes, payroll net). -

    -

    - Provide a calender-display of upcoming & past scheduled - payments. Clicking on a calander day should raise up - editable list of transactions. Calendering should include - generic red-lettering of important dates: taxes due, - insurance renewal dates, domain registration renewal dates, - ISP contract expiration date :-). These may or may not - be associated with transactions. Memoes should be possible. - Popups should happen when dates get close. Technology: - need to find/evaluate gnome-calender/dayplanner for - integration. -

    -

    - Provide list of upcoming & recently paid bills/scheduled - payments/scheduled deposits for the next 1,2,3,6,12 months. - Historical view shows payments crossed out (!?) -

    -

    Design Notes: - Most alerts & data storage should be driven out of the engine. - This will enable multi-user, distributed use. - Note: alerts should be piggy-backed on a general alert - infrastructure within the engine, viz, registered callbacks - when balances change, so that windows can be redrawn. - Not clear on if/how calander events might be server-ified. - (On the other hand, a good calander should be server-ified, - and thus viewable by secretaries, co-orkers, etc.) -

    -

    More complex financial instrucments may need a guile-based - extension mechanism to compute values .... simple - interest/mortgage calculators should be done in C in - the engine ... (e.g. depreciation schedules ... under us tax - law, a variety of different schedules are allowed ... ) -

    May need interfaces to email for emailed alerts.

    -

    Plot forcast graphs based on scheduled income & payments ... - is this tied into budgeting ???? -

    Status: + Note that in the above, not all fields are independent: + some can be calculated from others. The other + payment should bring up a mini-register, allowing user + to add any number of splits.
    +
    + + +

    Recurring bills, salary income, etc. are simpler to + handle, since they don't have intersest rates, balloons, + etc. They do/will have multiple splits (e.g. + payroll gross, fica, futa, income taxes, payroll net).

    + +

    Provide a calender-display of upcoming & past + scheduled payments. Clicking on a calander day should raise + up editable list of transactions. Calendering should + include generic red-lettering of important dates: taxes + due, insurance renewal dates, domain registration renewal + dates, ISP contract expiration date :-). These may or may + not be associated with transactions. Memoes should be + possible. Popups should happen when dates get close. + Technology: need to find/evaluate gnome-calender/dayplanner + for integration.

    + +

    Provide list of upcoming & recently paid + bills/scheduled payments/scheduled deposits for the next + 1,2,3,6,12 months. Historical view shows payments crossed + out (!?)

    + +

    Design Notes: Most alerts & data storage + should be driven out of the engine. This will enable + multi-user, distributed use. Note: alerts should be + piggy-backed on a general alert infrastructure within the + engine, viz, registered callbacks when balances change, so + that windows can be redrawn. Not clear on if/how calander + events might be server-ified. (On the other hand, a good + calander should be server-ified, and thus viewable by + secretaries, co-orkers, etc.)

    + +

    More complex financial instrucments may need a + guile-based extension mechanism to compute values .... + simple interest/mortgage calculators should be done in C in + the engine ... (e.g. depreciation schedules ... + under us tax law, a variety of different schedules are + allowed ... )

    + +

    May need interfaces to email for emailed alerts.

    + +

    Plot forcast graphs based on scheduled income & + payments ... is this tied into budgeting ????

    + +

    Status:

    -

    - +
    +
    Budgeting
    - Ability to create a budget (i.e. estimates of future - expenditures). Reconcile actual expenditures against future - expenditures. Create simple, step-by-step 'financial plan' - budgeting GUI's: + Ability to create a budget (i.e. - estimates of + future expenditures). Reconcile actual expenditures against + future expenditures. Create simple, step-by-step 'financial + plan' budgeting GUI's: +
    +
    Quicken(TM) Import
    - Ability to import Quicken QIF files. Both MSMoney and Quicken - use QIF files to export data. -

    Status: -

    -

    + Ability to import Quicken QIF files. Both MSMoney and + Quicken use QIF files to export data. +

    Status:

    + + +
    +
    Quicken(TM) Export
    Ability to export Quicken QIF files. -

    - Several design alternatives are available: 1) a special - 'report' that writes out qif could be created. This would use - the 'reports' infrastructure to generate qif's. 2) Its fairly - easy to traverse the data in the engine to write out qif files. - Just do it. -

    -

    - Status: not started -

    + +

    Several design alternatives are apparent:

    + + +
    +
    + + +

    Status: not started

    -
    Stock Quotes, Price Quotes
    +
    Stock Quotes, Price + Quotes
    - Add ability to download stock quotes, other price quotes. - Add ability to download historical prices as well. (e.g. - get 5-year history of mutual fund performance vs. djia). -

    - Right now, stock prices are stored with everything else, - in the main database, in the transaction table. This leads - to several aesthetic quandries. It bulks up the database - with 'less-than critical' information. Basically, transactions - are either 'critical' vix record the movement of money, or - are non-critical viz record things retreivable from the - historical record, e.g. prices. Shouldn't storage for - prices be moved to somewhere else? Hmmm ... what about - storage for valatility, shares traded, etc? Does indeed sound - like an alternate storage method would be useful. What about GUI - implications? + Add ability to download stock quotes, other price quotes. -

    Status: +

    Add ability to download historical prices as well. + (e.g. get 5-year history of mutual fund + performance vs. djia).

    + +

    Right now, stock prices are stored along with everything + else, in the main database, in the transaction table.

    + +

    This leads to several aesthetic quandries.

    + + + +

    Status:

    -

    + source-forge. +
  • Need to integrate with GUI. Right now, this is a + stand-alone perl script run from crontab. This + will be done by writing scheme wrappers for the module + (???)
  • + +
    +
    Technical Stock Analysis
    -
    - Provide technical sotck analysis graphs, e.g. volume, 90 moving - avg, beta, etc. See gstalker for example of how to do it ... -

    -

    -
    +
    Provide technical sotck analysis graphs, e.g. + volume, 90 moving avg, beta, etc. See gstalker for example of + how to do it ...
    -
    Depreciation, Sinking Funds
    -
    - Hmm ... some variation on the concept of loans? Need to support - different deprciation schedules (see IRS books for that). -
    +
    Depreciation, Sinking + Funds
    + +
    Hmm ... some variation on the concept of loans? Need to + support different deprciation schedules (see IRS books for + that).
    OFX support
    @@ -1465,18 +1489,17 @@ next due date mm/dd/yy providing, to retail customers. See below for OFX references. - OFX is an open spec from Microsoft, Intuit, and +

    OFX is an open spec from Microsoft, Intuit, and Checkfree, and which will be supported by Integrion. The OFX DTD's are included in the 1.1 distributions. See OFX Home Page for - details. + details.

    -

    There are two ways to build an OFX parser. One way is - to build a compile-time DTD parser that treats the DTD as - if it were an IDL, and generates C language stubs for a - parser. - This approach was attempted and abandoned because it - leads to fragile C code and a very large binary.

    +

    There are two ways to build an OFX parser. One way is to + build a compile-time DTD parser that treats the DTD as if + it were an IDL, and generates C language stubs for a + parser. This approach was attempted and abandoned because + it leads to fragile C code and a very large binary.

    +

    Historical References

    The following URL's are inactive, obsolete or otherwise wasting away, but are here for historical interest, in part to document - the way things used to be. Of archeological, nostalgic use only. + the way things used to be. Of archeological, nostalgic use + only. +
    - Draft version 0.37 -- May 2000 + Draft version 0.37 -- May 2000

    Linas Vepstas linas@linas.org

    -

    updates by Christopher Browne - cbbrowne@ntlug.org
    + +

    updates by Christopher Browne cbbrowne@ntlug.org

    diff --git a/doc/html/C/xacc-about.html b/doc/html/C/xacc-about.html index bbc4ef4eff..8b1742a6ba 100644 --- a/doc/html/C/xacc-about.html +++ b/doc/html/C/xacc-about.html @@ -2,7 +2,8 @@ - + About GnuCash @@ -11,11 +12,11 @@

    About GnuCash

    -

    GnuCash is a program to keep track of your finances. Its +

    GnuCash is a program to keep track of your finances. Its features include:

    Advanced Features

    -

    GnuCash offers some features not found in simpler - accounting programs.

    +

    GnuCash offers some features not found in simpler accounting + programs.

    • - Account Hierarchy + Account Hierarchy

      A master account can have a hierarchy of more detailed accounts arranged underneath it. This allows related account types (e.g. - Cash, Bank, Stock) to be - grouped under one master account ( e.g. - + grouped under one master account ( e.g. - Assets).

    • - Double Entry + Double Entry -

      Every transaction involves two accounts, and each +

      Every transaction involves two accounts, and each transaction is required to balance. This provides assurance that the overall set of books will add up correctly, and prevents out-of-balance errors @@ -113,63 +115,63 @@

    • - Income/Expense Account + Income/Expense Account Types -

      Intuit's Quicken - product has what they call "categories" that are used to - track incomes and expenses. These may be used to create +

      Intuit's Quicken product + has what they call "categories" that are used to track + incomes and expenses. These may be used to create Profit/Loss reports.

    • - General Ledger + General Ledger -

      Multiple accounts may be displayed in one register +

      Multiple accounts may be displayed in one register window at the same time. This can make it easier to track down data errors. It also provides a convenient way of viewing a portfolio of many stocks, by showing all transactions in that portfolio.

    • -
    • Handling of multiple +
    • Handling of multiple currencies

    Versioning

    -

    The versioning scheme for GnuCash parallels that of the +

    The versioning scheme for GnuCash parallels that of the Linux kernel, where "even" sub-versions indicate versions that are intended to be stable, only seeing maintenance to fix bugs, and "odd" sub-versions indicate an "experimental" stream that seeks to add enhancement.

    -

    The present "experimental" stream is gnucash-1.3.x, which - is somewhat unstable.

    +

    The present "experimental" stream is gnucash-1.3.x, which is + somewhat unstable.

    -

    The latest stable release is 1.2.x; if you don't intend to +

    The latest stable release is 1.2.x; if you don't intend to do development work, you should be using either this version, or an older 1.0.x version. These versions are fairly stable, with all currently known bugs fixed.

    -

    Once the 1.3.x series stabilizes, the next stable series +

    Once the 1.3.x series stabilizes, the next stable series will be 1.4.x, and experimentation will likely continue on 1.5.x.

    -

    If you wish to "hack" on the experimental version, you +

    If you wish to "hack" on the experimental version, you should first start by reading through the GnuCash Project Goals document in order to + "projects.html">GnuCash Project Goals document in order to get some perspective on the overall design.

    Lead Developers

    -
    Robin Clark
    +
    Robin Clark
    wrote the original X-Accountant in Motif as a school project, taking it to version 0.9 by October 1997.
    -
    Linas Vepstas
    +
    Linas Vepstas
    liked what he saw: the GUI was slick, the code was documented and well structured, and it was all GPL'ed. And so @@ -183,7 +185,7 @@ code completely redesigned and made mostly Motif-(and GUI-)independent. Did some prototype OFX work.
    -
    Jeremy +
    Jeremy Collins
    publicized the GnoMoney project widely and broadly, and @@ -191,335 +193,343 @@ gnucash.org web site, registered the domain, got the initial GTK/gnome code working.
    -
    Rob - Browning
    +
    Rob Browning
    -
    abused everyone for not using perl, and then after we added - perl support, dumped perl in favor of - guile/scheme support. Rob maintains the build infrastructure, - is handling the whole guile/perl extension language thing, - and is dealing with configuration and configurability.
    +
    abused everyone for not using perl, and then after we + added perl support, dumped perl in favor of guile/scheme + support. Rob maintains the build infrastructure, is handling + the whole guile/perl extension language thing, and is dealing + with configuration and configurability.
    -
    Dave +
    Dave Peticolas
    hacks obsessively on GnuCash. But he can stop anytime he wants to. Really.
    -
    Bill Gribble -
    +
    Bill + Gribble
    -
    works magic. If your checks print wrong, blame him. - If you don't like the amount printed on your checks, blame him. +
    works magic. If your checks print wrong, blame him. If + you don't like the amount printed on your checks, blame him. If you don't like your your bank balances, your bank, or your - life, blame him too. -
    + life, blame him too.

    Fixers and Patchers

    -

    The cast of thousands includes:

    +

    The cast of thousands includes:

    -
    Andrew +
    Andrew Arensburger
    for FreeBSD and other patches
    -
    Matt +
    Matt Armstrong
    for misc fixes
    -
    Fred Baube
    +
    Fred Baube
    for attempted Java port/MoneyDance
    -
    Dennis - Björklund
    +
    Dennis + Björklund
    Swedish translation
    -
    Per Bojsen
    +
    Per + Bojsen
    several core dump fixes
    -
    Simon Britnell
    +
    Simon + Britnell
    patch to RPM spec
    -
    Christopher B. +
    Christopher B. Browne
    for perl stock scripts, Guile-based QIF import code, lots - of changes to English documentation, and lots of guile code
    + of changes to English documentation, and lots of guile + code -
    Graham +
    Graham Chapman
    for the xacc-rpts addon package
    -
    George Chen
    +
    George Chen
    for MS-Money QIF support
    -
    Albert +
    Albert Chin-A-Young
    configure.in patch
    -
    Jeremey +
    Jeremey Collins
    for GnoMoney and GTK port
    -
    Matthew Condell
    +
    Matthew + Condell
    FreeBSD patch
    -
    Patrick +
    Patrick Condron
    for webserver and T1 connection.
    -
    Ciaran +
    Ciaran Deignan
    for AIX binary version
    -
    Tyson Dowd
    +
    Tyson Dowd
    for config/make patches and debian maintenance
    -
    Koen D'Hondt
    +
    Koen D'Hondt
    for Solaris patches to XmHTML
    -
    Bob Drzyzgula
    +
    Bob Drzyzgula
    for budgeting design notes
    -
    Paul Fenwick
    +
    Paul Fenwick
    ASX support
    -
    Hubert Figuiere
    +
    Hubert + Figuiere
    patch to gnc-prices
    -
    Jan-Uwe +
    Jan-Uwe Finck
    for German message translation
    -
    Ron Forrester
    +
    Ron Forrester
    for gnome patches
    -
    Dave +
    Dave Freese
    for leap-year fix
    -
    Bill Gribble
    +
    Bill + Gribble
    qif importation code
    -
    Otto +
    Otto Hammersmith
    for RedHat RPM packaging
    -
    Eric Hanchrow
    +
    Eric Hanchrow
    updated currency documentation
    -
    Alexandru +
    Alexandru Harsanyi
    for fixing miscellaneous core dumps and lockups.
    -
    John Hasler
    +
    John Hasler
    engine patch
    -
    Jon K}re +
    Jon K}re Hellan
    for fixing miscellaneous core dumps and lockups.
    -
    Prakash +
    Prakash Kailasa
    for gnome build fixes
    -
    Tom Kludy
    +
    Tom Kludy
    for SGI Irix port
    -
    Sven Kuenzler
    +
    Sven Kuenzler
    for SuSE README file
    -
    Bryan Larsen
    +
    Bryan + Larsen
    guile budget report
    -
    Ted +
    Ted Lemon
    for NetBSD port
    -
    Yannick Le +
    Yannick Le Ny
    pour la traduction en Français
    -
    Grant +
    Grant Likely
    gnome and engine patches
    -
    Heath +
    Heath Martin
    major work on the gnome register
    -
    Matt +
    Matt Martin
    guile error handling code
    -
    Robert Graham +
    Robert Graham Merkel
    reporting, gnome, and configuration patches.
    -
    Tim +
    Tim Mooney
    port to alpha-dec-osf4.0f
    -
    G. Allen Morris +
    G. Allen Morris III
    for QIF core dump fix
    -
    Brent Neal
    +
    Brent + Neal
    TIAA-CREF support.
    -
    Peter Norton
    +
    Peter Norton
    for a valiant attempt at a GTK port
    -
    +
    OmNiBuS
    web site graphics and content
    -
    Myroslav - Opyr
    +
    Myroslav Opyr
    for misc patches
    -
    Laurent +
    Laurent P{'e}lecq
    i18n patches with gettext
    -
    Alain +
    Alain Peyrat
    for configure.in patches
    -
    Peter +
    Peter Pointner
    motif and configuration patches
    -
    Gavin +
    Gavin Porter
    for euro style dates
    -
    Tomas Pospisek
    +
    Tomas Pospisek
    debian patches
    -
    Ron Record
    +
    Ron Record
    for SCO Unixware and OpenServer binaries
    -
    Keith Refson
    +
    Keith + Refson
    Solaris fixes
    -
    Dirk +
    Dirk Schoenberger
    began the Qt/KDE port
    -
    Jan +
    Jan Schrage
    documentation patches
    -
    Christopher +
    Christopher Seawood
    for XbaeMatrix core dump
    -
    Mike +
    Mike Simons
    -
    misc configure.in patches
    +
    misc configure.in patches
    -
    Richard +
    Richard Skelton
    for Solaris cleanup
    -
    Henning +
    Henning Spruth
    for German text and euro date rework
    -
    Robby +
    Robby Stephenson
    -
    register & file history patches
    +
    register & file history patches
    -
    Herbert Thoma
    +
    Herbert Thoma
    -
    gnome register & euro support patches
    +
    gnome register & euro support patches
    -
    Diane +
    Diane Trout
    scheme qif import patch
    -
    Richard Wackerbarth
    +
    Richard + Wackerbarth
    patch to gnc-prices
    -
    Rob Walker
    +
    Rob Walker
    guile and register patches
    -
    David Woodhouse
    +
    David + Woodhouse
    Great Britain translations
    -
    Ken +
    Ken Yamaguchi
    QIF import fixes; MYM import
    -
    Shimpei Yamashita
    +
    Shimpei + Yamashita
    Japanese translation
    -

    Supported Operating Systems

    @@ -544,15 +554,15 @@
  • NetBSD -- Intel
  • -

    - - - - - -

    + +

    History

    The table below shows some historical lines-of-code and @@ -562,7 +572,7 @@ @@ -607,7 +617,8 @@ - + @@ -633,7 +644,8 @@ - + @@ -659,7 +671,8 @@ - + @@ -697,55 +710,102 @@ (34.7) - - + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - Historical Development Stats + Historical Development Stats
    5 files
    (0.4)
    1 file
    (0.1)
    1 file
    + (0.1)
    40 files
    (8.8)
    9 files
    (0.8)
    1 file
    (0.1)
    1 file
    + (0.1)
    61 files
    (16.2)
    12 files
    (1.4)
    4 files
    (0.3)
    4 files
    + (0.3)
    68 files
    (18.3)
    gnucash-1.2.2
    Aug 99 -
    41 files
    (10.2+3.6) -
    28 files
    (5.5+1.7) -
    14 files
    (2.4+0.6) -
    26 files
    (8.7+0.5) -
    - - 14 files
    (1.4) -
    30 files
    (2.6) -
    15 files
    (1.8) -
    168 files
    (39.0) +
    gnucash-1.2.2
    + Aug 99
    gnucash-1.3.6
    April 2000 -
    41 files
    (12.9+4.0) -
    32 files
    (6.8+2.1) -
    19 files
    (4.0+0.8) -
    - - 78 files
    (32.2+3.0) -
    74 files
    (17.0) -
    33 files
    (7.8) -
    25 files
    (4.5) -
    302 files
    (95.1) +
    41 files
    + (10.2+3.6)
    28 files
    + (5.5+1.7)
    14 files
    + (2.4+0.6)
    26 files
    + (8.7+0.5)
    -14 files
    + (1.4)
    30 files
    + (2.6)
    15 files
    + (1.8)
    168 files
    + (39.0)
    gnucash-1.3.6
    + April 2000
    41 files
    + (12.9+4.0)
    32 files
    + (6.8+2.1)
    19 files
    + (4.0+0.8)
    -78 files
    + (32.2+3.0)
    74 files
    + (17.0)
    33 files
    + (7.8)
    25 files
    + (4.5)
    302 files
    + (95.1)
    -

    Each cell displays the following:
    +

    Each cell displays the following:

    number of *c and *.h files
    (KLOCS in *.c + KLOCS in *.h)

    -(unless its the scheme directories, in which case its *scm files, etc) + (unless its the scheme directories, in which case its *scm + files, etc) -

    where KLOC == kilo-lines-of-code, as reported by +

    where KLOC == kilo-lines-of-code, as reported by wc.

    -

    -

      -
    • engine -- contents of the src/engine and the include directories -
    • register -- contents of the register directory -
    • ledger -- *.c, *.h files in the src directory only -
    • motif -- contents of src/motif directory -
    • gnome -- src/gnome plus src/register/gnome -
    • scheme -- scheme and guile code -- src/scm plus src/guile -
    • docs -- english-only html docs (user documentation) -
    • txt -- internal README and *.txt documentation files in all subdirs -
    +
      +
    • engine -- contents of the src/engine and the include + directories
    • + +
    • register -- contents of the register directory
    • + +
    • ledger -- *.c, *.h files in the src directory only
    • + +
    • motif -- contents of src/motif directory
    • + +
    • gnome -- src/gnome plus src/register/gnome
    • + +
    • scheme -- scheme and guile code -- src/scm plus + src/guile
    • + +
    • docs -- english-only html docs (user documentation)
    • + +
    • txt -- internal README and *.txt documentation files in + all subdirs
    • +

    -

    Return to Main Documentation +

    Return to Main Documentation Page.

    diff --git a/doc/html/C/xacc-accountedit.html b/doc/html/C/xacc-accountedit.html index b1a77abbd9..d847423ebc 100644 --- a/doc/html/C/xacc-accountedit.html +++ b/doc/html/C/xacc-accountedit.html @@ -1,30 +1,38 @@ + + + Editing Account Parameters -

    Editing Account Parameters

    +

    Editing Account Parameters

    -

    The "Edit Account" dialog box lets you change the properties of - an account. You can access this via the "edit" button of the main - window toolbar, the "Accounts" menu, or via the keyboard - shortcuts. For a description of the uses of the various - properties, see the information about new accounts.

    +

    The "Edit Account" dialog box lets you change the properties + of an account. You can access this via the "edit" button of the + main window toolbar, the "Accounts" menu, or via the keyboard + shortcuts. For a description of the uses of the various + properties, see the information about new accounts.

    -

    Account information can be changed by typing in the appropriate - field. The account type cannot be changed.

    -

    A new Parent Account can be selected. Only those accounts that - can legally become the parent of the present account are shown.

    -

    The source for Stock Quotes can be selected. See - the ticker for more information.

    -

    Notes about the account can be edited.

    +

    Account information can be changed by typing in the + appropriate field. The account type cannot be changed.

    +

    A new Parent Account can be selected. Only those + accounts that can legally become the parent of the present + account are shown.

    -

    Return to Main Documentation +

    The source for Stock Quotes can be selected. See the ticker for more + information.

    + +

    Notes about the account can be edited.

    +
    + +

    Return to Main Documentation Page.

    - + diff --git a/doc/html/C/xacc-acctypes.html b/doc/html/C/xacc-acctypes.html index a1ba562593..7801e4fe69 100644 --- a/doc/html/C/xacc-acctypes.html +++ b/doc/html/C/xacc-acctypes.html @@ -11,9 +11,11 @@

    Account Types

    -GnuCash supports a number of different account types. You should always -choose the type that is appropriate for what you want to record. If -you're not sure, the explanations below should help you decide. + +

    GnuCash supports a number of different account types. You should +always choose the type that is appropriate for what you want to +record. If you're not sure, the explanations below should help you +decide.

    Cash
    @@ -27,7 +29,7 @@ you're not sure, the explanations below should help you decide.
    The Bank account type denotes a savings or checking account held at a bank or other financial institution. - Such accounts sometimes bear interest. +
    Such accounts sometimes bear interest.
    Credit
    @@ -37,7 +39,6 @@ you're not sure, the explanations below should help you decide. American Express that do not permit you to maintain continuing balances. -

    The introduction of Check Cards where payments are withdrawn directly from a @@ -47,6 +48,9 @@ you're not sure, the explanations below should help you decide. such an account, not really involving any granting of credit.
    +
    Note the ambiguity of AMEX and Check Cards. This shows that +deciding where to put accounts is not an exact science. +
    Asset, Liability
    Asset and Liability accounts are used for @@ -121,12 +125,12 @@ you're not sure, the explanations below should help you decide.
    Income and Expense account types are used to record income and expenses. - For example, if you deposit a paycheck in your bank account, you +
    For example, if you deposit a paycheck in your bank account, you should mark it as a transfer from an 'income' account type. -Marking income in this way helps balance the books: the change in your +
    Marking income in this way helps balance the books: the change in your net worth in the course of a few ekks, a few months, or a year, should exactly equal your income (minus expenses) for the same period. -The value stored in the bank account contributes to your 'net worth'; +
    The value stored in the bank account contributes to your 'net worth'; whereas the income contributes to your 'profits'.
    @@ -135,15 +139,23 @@ whereas the income contributes to your 'profits'.
    Equity accounts are used to store the opening balances when you first start using GnuCash -(or start a new accounting period). Assuming that you've had a bank +(or start a new accounting period). + + +
    Assuming that you've had a bank account far longer than you've been using GnuCash, and assuming you don't want to type in old transactions, you will want to type in a -non-zero 'opening balance' into your bank account. This opening balance +non-zero opening balance into your bank account. This opening balance should be marked as a transfer from an account of type 'equity'. -Alternately, if you close and reopen all your books at the end of every + +
    Alternately, if you close and reopen all your books at the end of every quarter/year, the 'equity' will be your net-worth at the begining of the -period: it equal all assets minus all liabilities. As time passes by, -you will have both income and expenses. At the end of the year, your net +period: it equal all assets minus all liabilities. + +
    As time goes by, +you will have both income and expenses. + +
    + + - New Account Window @@ -12,26 +14,26 @@

    New Account Window

    -

    This is what a new account window looks like:

    +

    This is what a new account window looks like:

    -

    +

    -

    Pick an Account +

    Pick an Account Type.

    -

    The Currency field should typically be a three-letter ISO currency code - (e.g. - USD for U.S. Dollars). The - Account Code is a number that determines the sort order of the account - when it appears in a report or in the Chart of Accounts.

    +

    The Currency field should typically be a three-letter ISO currency code + (e.g. - USD for U.S. Dollars). The Account + Code is a number that determines the sort order of the account when + it appears in a report or in the + Chart of Accounts.

    -

    The picture below shows an example for a stock or currency +

    The picture below shows an example for a stock or currency trading account. Note that the Security field is not grayed out, and that you can enter a value. That value is typically a - stock-ticker symbol, or a three-letter ISO currency + stock-ticker symbol, or a three-letter ISO currency code.


    @@ -39,7 +41,7 @@


    -

    Return to Main Documentation +

    Return to Main Documentation Page.

    diff --git a/doc/html/C/xacc-adjbwin.html b/doc/html/C/xacc-adjbwin.html index 892705e9a4..7a884762a2 100644 --- a/doc/html/C/xacc-adjbwin.html +++ b/doc/html/C/xacc-adjbwin.html @@ -2,8 +2,10 @@ + + - Adjust Balance Window @@ -15,10 +17,10 @@ dollar amount, and a register entry will be created that sets the balance to the new balance. -

    Add more documentation here.

    +

    Add more documentation here.


    -

    Return to Main Documentation +

    Return to Main Documentation Page.

    diff --git a/doc/html/C/xacc-apar.html b/doc/html/C/xacc-apar.html index 5be6ee9782..da76557320 100644 --- a/doc/html/C/xacc-apar.html +++ b/doc/html/C/xacc-apar.html @@ -2,7 +2,8 @@ - + Accounts Payable/Accounts Receivable @@ -11,46 +12,49 @@

    Accounts Payable and Accounts Receivable

    -

    A/R (Accounts Receivable) and A/P (Accounts Payable) are -advanced concepts that are used by businesses to record sales for which -they are not paid right away, or to record bills that they've received, -but might not pay until a little while later. These types of accounts -primarily when you've got a lot of bills and receipts flowing in and -out, and don't want to loose track of them just because you don't -pay/get paid right away. For almost all home users, A/R and A/P -are too complicated and confusing to be worth the effort. +

    A/R (Accounts Receivable) and A/P (Accounts Payable) are + advanced concepts that are used by businesses to record sales + for which they are not paid right away, or to record bills that + they have received, but might not pay until a little while + later.

    -

    +

    These types of accounts are used primarily when you've got a + lot of bills and receipts flowing in and out, and don't want to + loose track of them just because you don't pay/get paid right + away.

    -

    Accounts Receivable

    +

    For almost all home users, A/R and A/P are too complicated + and confusing to be worth the effort.

    -

    First, let us examine A/R. After all, we really shouldn't +

    Accounts Receivable

    + +

    First, let us examine A/R. After all, we really shouldn't really need to relate to A/P because we always pay our bills on time, don't we ? :-)

    -

    As a first approximation, let us assume we don't require - customers to pay instantly, in cash, but rather issue +

    As a first approximation, let us assume we don't require + customers to pay instantly, in cash, but rather issue them an invoice, and give them 30 days to pay the bills. (After 30 days, we can start charging interest and sending out harassing letters :-)).

    -

    When we make a sale, the two accounts affected are +

    When we make a sale, the two accounts affected are Sales (an income account) and Accounts Receivable. Accounts Receivable is an asset, but it's not "liquid," as you can't readily sell it, and it's certainly not cash.

    -

    Then when they come by to pay their bill, dropping off a +

    Then when they come by to pay their bill, dropping off a large sack of twenty-dollar bills (or, more likely, a check/cheque), we transfer the amount from A/R to Cash.

    -

    The reason we do this in two steps is that we have decided +

    The reason we do this in two steps is that we have decided we need to do our accounting on an accrual basis and not on a cash basis, because most of our transactions are not solely based on cash changing hands, but rather based on establishing obligations.

    -

    In more sophisticated operations, there may be a much - larger sequence of documents generated and tracked:

    +

    In more sophisticated operations, there may be a much more + complex sequence of documents generated and tracked:

    • A customer sends in a Purchase Order, thus @@ -63,26 +67,31 @@ are too complicated and confusing to be worth the effort. the customer
    • Once shipped, we issue an Invoice, representing - the request to pay
    • + the request to pay
    -

    We report sales in our sales figures as soon as we make +

    The fact of there being four documents leads to there being + considerable wads of paper, and having these and other such + processes explains why large organizations tend to have hefty + bureaucracies.

    + +

    We report sales in our sales figures as soon as we make them. Unfortunately, we may wind up selling some product to no-good shady operators that we didn't know were shady, and thus may get stuck with some "bad debts."

    -

    In order to determine which parts of Accounts Receivable +

    In order to determine which parts of Accounts Receivable appear to be most at risk, it is typical to arrange AR based on the "ages" of the debts, commonly segmenting it into several aging periods, of payments outstanding 0-30 days, those that outstanding 31-60 days, 61-90 days, and then those that are - way overdue.

    + way overdue.

    -

    At some point, it may become clear that a customer is never +

    At some point, it may become clear that a customer is never going to pay what they owe, and we have to write it off as a - Bad Debt.

    + Bad Debt.

    -

    At that point, it is typical to record an entry thus:

    +

    At that point, it is typical to record an entry thus:

    @@ -117,82 +126,80 @@ are too complicated and confusing to be worth the effort.
    -

    We could have reduced Sales Income instead, but +

    We could have reduced Sales Income instead, but companies tend to prefer to specifically track the amount that they're losing to bad customers.

    -

    Warning: Advanced Accounting Concept. Bad Debt - is an example of a "contra-account." That doesn't refer to +

    Warning: Advanced Accounting Concept. Bad Debt is + an example of a "contra-account." That doesn't refer to amounts paid to Nicaraguan rebels, but rather the notion that the account is an income account that is expected to hold a balance opposite to what is normally expected, to be - counteract the balance in another income account. Accumulated Depreciation, used - to diminish the value of an asset over time, is another example - of a contra-account.

    + counteract the balance in another income account. Accumulated Depreciation, used to + diminish the value of an asset over time, is another example of + a contra-account.

    -

    Accounts Payable

    +

    Accounts Payable

    -

    The scenario for Accounts Receivable, reversed, reflects - how Accounts Payables work; just switch customer with supplier, - and see how the roles reverse.

    +

    The scenario for Accounts Receivable, reversed, reflects how + Accounts Payables work; just switch customer with supplier, and + watch the roles reverse.

    • If we buy materials "on account," accrual accounting requires that we record that we incur the expense immediately, and rather than reducing cash, we put the - "credit" into the Accounts Payable account.
    • + "credit" into the Accounts Payable account.
    • Three weeks later, the invoice comes in, and we issue a - payment, and so Debit AP, Credit Cash.
      + payment, and so Debit AP, Credit Cash.

    -

    Prepaid Expenses

    +

    Prepaid Expenses

    -

    Analogous techniques are also used for expenses that are +

    Analogous techniques are also used for expenses that are pre-paid.

    -

    If you have to pay out down six months of rent in advance, +

    If you have to pay out down six months of rent in advance, that is treated as an "accrued asset."

    • - At the time of payment, you Debit Prepaid - Rent for the amount paid that is a Credit to - Cash. + At the time of payment, you Debit Prepaid + Rent for the amount paid that is a Credit to + Cash. -

      While this puts an unfortunate dent in the Cash - account, it does show on the books as an asset, - and there are no more payments to make for the next six - months.

      +

      While this puts an unfortunate dent in the Cash account, + it does show on the books as an asset, and there + are no more payments to make for the next six months.

    • -
    • Each month, the balance in Prepaid Rent would be - down via Debit Rent Expense, - Credit Prepaid Rent.
    • +
    • Each month, the balance in Prepaid Rent would be + down via Debit Rent Expense, Credit + Prepaid Rent.
    -

    Similarly, companies collect payroll taxes on behalf of +

    Similarly, companies collect payroll taxes on behalf of employees, and keep them in a special bank account.

      -
    • That money is not the company's, so there is a - Debit to the Cash account on one side, and a - Credit to an Accrued Liability, namely, Payroll +
    • That money is not the company's, so there is a + Debit to the Cash account on one side, and a + Credit to an Accrued Liability, namely, Payroll Taxes Payable, on the other side.
    • When the quarterly check to the Government so that they - can make their payroll, Payroll Taxes - Payable drops as does the balance in the Checking - Account.
      + can make their payroll, Payroll Taxes Payable + drops as does the balance in the Checking Account.


    -

    Return to Main Documentation +

    Return to Main Documentation Page.

    diff --git a/doc/html/C/xacc-apprdepr.html b/doc/html/C/xacc-apprdepr.html index e6a45e4be7..8942e30c0a 100644 --- a/doc/html/C/xacc-apprdepr.html +++ b/doc/html/C/xacc-apprdepr.html @@ -2,61 +2,61 @@ - + Depreciation and Capital Gains -

    Depreciation and Capital Gains

    +

    Depreciation and Capital Gains

    -

    This section provides a treatment of the handling of +

    This section provides a treatment of the handling of depreciation and appreciation of assets in GnuCash.

    -

    It also provides a brief introduction to the related tax +

    It also provides a brief introduction to the related tax issues.

    -

    Warning: Be aware that different countries can - have substantially different tax policies for handling +

    Warning: Be aware that different countries can + have substantially different tax policies for handling these things; all that this document can really provide is some of the underlying ideas to help you apply your "favorite" tax/depreciation policies.

    -

    Note that appreciation and depreciation of assets tend to - be treated somewhat differently:

    +

    Note that appreciation and depreciation of assets tend to be + treated somewhat differently:

    • - Depreciation is usually - recognized (the technical term is accrued) as an + Depreciation is usually + recognized (the technical term is accrued) as an expense on an ongoing basis, gradually reducing the value of an asset towards zero. -

      Depreciation tends to only get calculated on assets - that are used for professional or business purposes, because - governments - don't generally allow you to claim depreciation deductions - on personal assets, and it's pointless to bother with the - procedure if it's not deductible.

      +

      Depreciation tends to only get calculated on assets that + are used for professional or business purposes, because + governments don't generally allow you to claim depreciation + deductions on personal assets, and it's pointless to bother + with the procedure if it's not deductible.

    • - In contrast, Capital Gains, which - could be called asset value appreciation, are - typically not recognized until some time down the - road when the asset is sold, and at that instant, - the entire gain becomes income. + In contrast, Capital Gains, which could + be called asset value appreciation, are typically + not recognized until some time down the road when + the asset is sold, and at that instant, the entire + gain becomes income. -

      Unlike depreciation, governments tend to be quite +

      Unlike depreciation, governments tend to be quite interested in taxing capital gains in one manner or another.

      -

      (As always, there are exceptions. If you hold a bond +

      (As always, there are exceptions. If you hold a bond that pays all of its interest at maturity, tax authorities will often require that you recognize interest each year, and refuse this to be treated as a capital gain. The - phrases accrued interest, or imputed + phrases accrued interest, or imputed interest are often there to scare those that are sensitive to such things...)

    • @@ -65,30 +65,30 @@

      Capital Gains - Asset Appreciation

      -

      Appreciation of assets is, in general, a fairly tricky matter - to deal with. This is so because, for some sorts of assets, it - is difficult to correctly estimate an increase in value - until you actually sell the asset.

      +

      Appreciation of assets is, in general, a fairly tricky + matter to deal with. This is so because, for some sorts of + assets, it is difficult to correctly estimate an increase in + value until you actually sell the asset.

      -

      If you invest in securities +

      If you invest in securities that are traded on a daily basis on open markets such as stock exchanges, prices may be quite exact, and selling the asset at market prices may be as simple as calling a broker and issuing - a Market Order.

      + a Market Order.

      -

      On the other hand, homes in your neighborhood are sold +

      On the other hand, homes in your neighborhood are sold somewhat less often, such sales tend to involve expending considerable effort, and involve negotiations, which means that estimates are likely to be less precise. Similarly, selling a used automobile involves a negotiation process that makes pricing a bit less predictable.

      -

      Harder to estimate are values of collectible objects such - as jewelry, works of art, baseball cards, and "Beanie Babies." - The markets for such objects are somewhat less open than the +

      Harder to estimate are values of collectible objects such as + jewelry, works of art, baseball cards, and "Beanie Babies." The + markets for such objects are somewhat less open than the securities markets.

      -

      Worse still are one-of-a-kind assets. Factories often +

      Worse still are one-of-a-kind assets. Factories often contain presses and dies customized to build a very specific product that cost tens or hundreds of thousands of dollars; this equipment may be worthless outside of that very @@ -96,12 +96,12 @@ values might be attached to the asset, none of them unambiguously correct.

      -

      Let's suppose you buy an asset expected to increase in +

      Let's suppose you buy an asset expected to increase in value, say a Degas painting, and want to track this. (The insurance company will care about this, even if nobody else does.)

      -

      Properly tracking the continually-increasing value of the +

      Properly tracking the continually-increasing value of the Degas will require at least three, quite possibly the following four accounts (plus a bank or cash account where the money for the purchase comes from):

      @@ -122,20 +122,20 @@ asset.
    -

    The accrued gains likely won't affect your taxable - income for income tax purposes, although it could - have some effect on property taxes.

    +

    The accrued gains likely won't affect your taxable + income for income tax purposes, although it could have + some effect on property taxes.

    The handling of capital gains in GnuCash

    -

    The Acquisition

    +

    The Acquisition

    The first thing you have to do is to create the asset cost account, then transfer the sum you paid for this painting from your bank account to this asset account to record the purchase.

    -

    A month later, you have reason to suspect that the value of +

    A month later, you have reason to suspect that the value of your painting has increased by $1200. In order to record this you transfer $1200 from your accrued gains on asset income account to your asset account.

    @@ -148,25 +148,25 @@ Asset account after purchase and appreciation -

    While You Hold the Asset

    +

    While You Hold the Asset

    Asset appreciation is a sort of income but it is not cash in hand.

    -

    The people that got "rich" in 1999 from IPOs of +

    The people that got "rich" in 1999 from IPOs of Linux-related companies like Red Hat Software and VA Linux Systems could verify this. They hold options or stock that are - theoretically valued at millions of dollars USD.

    + theoretically valued at millions of dollars USD.

    -

    That doesn't mean that they are actually millionaires; the +

    That doesn't mean that they are actually millionaires; the principal participants have to hold their stock for at least - six months before selling any of it. The fact that + six months before selling any of it. The fact that they can't sell it means that while it may in theory be worth millions of dollars on paper, there is, as of late - 1999, no way for them to legally get those + 1999, no way for them to legally get those millions.

    -

    Selling the Asset

    +

    Selling the Asset

    Let´s say another month later prices for Degas paintings have gone up some more, in your case about $2500, you @@ -180,8 +180,8 @@ Your optimistic estimate of the painting´s value was correct. -

    The income account is left alone (or perhaps gets - transferred from an Accrued Gain income to a +

    The income account is left alone (or perhaps gets + transferred from an Accrued Gain income to a Realized Gain income account), and the recording is rather like:

    @@ -211,9 +211,9 @@ -

    And if any amounts had been accrued as Accrued +

    And if any amounts had been accrued as Accrued Gains, the asset amount should be closed out, offset - by a negative value for Accrued Gain + by a negative value for Accrued Gain income. If the total that had been accrued was $5000, then the transaction might look like the following:

    @@ -255,21 +255,21 @@ -

    Note that the two income accounts offset one another so - that the current income resulting from the +

    Note that the two income accounts offset one another so + that the current income resulting from the transaction is only $55. The remaining $5000 had previously - been recognized as Accrued Gain Income.

    + been recognized as Accrued Gain Income.

  • You were over-optimistic about the value of the painting. -

    Instead of the $16055 you thought the painting was - worth are only offered $15000. But you still decide to - sell, because you value $15000 more than you value the +

    Instead of the $16055 you thought the painting was worth + are only offered $15000. But you still decide to sell, + because you value $15000 more than you value the painting.

    -

    The numbers change a little bit, but not too +

    The numbers change a little bit, but not too dramatically.

    @@ -310,9 +310,9 @@
    -

    Note that the two income accounts offset one another so - that the current income resulting from the - transaction turns out to be a loss of $1000. +

    Note that the two income accounts offset one another so + that the current income resulting from the + transaction turns out to be a loss of $1000. That's fine, as you had previously recognized $5000 in income.

  • @@ -321,7 +321,7 @@ You manage to sell your painting for more than you thought in your wildest dreams. -

    The extra value is, again, recorded as a gain, +

    The extra value is, again, recorded as a gain, i.e. an income.

    @@ -364,8 +364,8 @@ -

    In practice, it truly is important to keep the Accrued - Gain Income separate from the Realized Gain +

    In practice, it truly is important to keep the Accrued + Gain Income separate from the Realized Gain Income, as the former is likely to be ignored by your tax authorities, who will only care to charge you on the Realized Gain.

    @@ -381,66 +381,66 @@ be difficult to correctly estimate the ``true'' value of an asset.

    -

    It is quite easy to count yourself rich based on +

    It is quite easy to count yourself rich based on questionable estimates that do not reflect "money in the bank."

    -

    Thus, when dealing with appreciation of assets,

    +

    Thus, when dealing with appreciation of assets,

    1. Be careful with your estimation of values. -

      Do not indulge in wishful thinking.

      +

      Do not indulge in wishful thinking.

    2. Never, ever, count on money you do not have in your bank or as cash. -

      Until you have actually sold your asset and got the +

      Until you have actually sold your asset and got the money, any numbers on paper (or magnetic patterns on your hard disk) are merely that.

      -

      If you could realistically convince a banker to lend - you money, using the assets as collateral, that is a pretty +

      If you could realistically convince a banker to lend you + money, using the assets as collateral, that is a pretty reasonable evidence that the assets have value, as lenders are professionally suspicious of dubious overestimations of value.

      -

      Be aware: all too many companies that appear +

      Be aware: all too many companies that appear "profitable" on paper go out of business as a result of - running out of cash, precisely because "valuable + running out of cash, precisely because "valuable assets" were not the same thing as cash.

    Taxation of Capital Gains

    -

    Taxation policies vary considerably between countries, so - it is virtually impossible to say anything that will be +

    Taxation policies vary considerably between countries, so it + is virtually impossible to say anything that will be universally useful.

    -

    However, it is common for income generated by +

    However, it is common for income generated by capital gains to not be subject to taxation until the date that the asset is actually sold, and sometimes not even then.

    -

    North American home owners usually find that when +

    North American home owners usually find that when they sell personal residences, capital gains that occur are exempt from taxation. It appears that other countries treat sale of homes differently, taxing people on such gains. German authorities, for example, tax those gains only if you owned the property for less than ten years.

    -

    I have one story - from my professional tax preparation days where a family sold a +

    I have one story from + my professional tax preparation days where a family sold a farm, and expected a considerable 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 dairy farm, with some - really peculiar resulting deductions.

    + and due to it being a dairy farm, with some really + peculiar resulting deductions.

    -

    In short, this presentation is fairly simple, but taxation +

    In short, this presentation is fairly simple, but taxation often gets terribly complicated...

    Depreciation of assets

    @@ -459,22 +459,21 @@ of use. -

    Since depreciation of assets is very often driven by tax +

    Since depreciation of assets is very often driven by tax policies, the discussion of depreciation will focus in that direction, on some of the more common depreciation calculation schemes.

    -

    While there has been some discussion about how to - accomplish automated calculation and creation of transactions - to handle things like depreciation, there is not yet any - working code, so for now, you will have to do calculations by - hand.

    +

    While there has been some discussion about how to accomplish + automated calculation and creation of transactions to handle + things like depreciation, there is not yet any working code, so + for now, you will have to do calculations by hand.

    Depreciation schemes

    Linear depreciation

    -

    Linear depreciation diminishes the value of an asset by a +

    Linear depreciation diminishes the value of an asset by a fixed amount each period until the net value is zero. This is the simplest calculation, as you estimate a useful lifetime, and simply divide the cost equally across that @@ -541,16 +540,15 @@

    Each period the asset is depreciated by a fixed percentage of its value in the previous period. In this scheme the rest value of an asset decreases exponentially leaving a value at - the end that is larger than zero ( i.e. - a resale + the end that is larger than zero ( i.e. - a resale value).

    -

    Beware: Tax authorities may require (or allow) a - larger percentage in the first period. On the other hand, - in Canada, this is reversed, as they permit only a - half share of "Capital Cost Allowance" in the first - year.

    +

    Beware: Tax authorities may require (or allow) a larger + percentage in the first period. On the other hand, in + Canada, this is reversed, as they permit only a half + share of "Capital Cost Allowance" in the first year.

    -

    The result of this approach is that asset value decreases +

    The result of this approach is that asset value decreases more rapidly at the beginning than at the end which is probably more realistic for most assets than a linear scheme. This is certainly true for automobiles.

    @@ -614,7 +612,7 @@ is the "sum of digits" method. Here is an illustration:

    Example: First you divide the asset value - by the sum of the years of use, e.g. for our example + by the sum of the years of use, e.g. for our example from above with an asset worth $1500 that is used over a period of five years you get 1500/(1+2+3+4+5)=100. Depreciation and asset value are then calculated as follows:

    @@ -678,7 +676,7 @@
  • An Asset Cost asset account to keep track of the original value;
  • -
  • An Accumulated Depreciation asset account in +
  • An Accumulated Depreciation asset account in which to collect the sum of all of the years' depreciation amounts;
  • @@ -703,13 +701,14 @@

    A word of caution

    Since depreciation and tax issues are closely related, you - may not always be free in choosing your preferred method. Fixing - wrong calculations will cost a whole lot more time and trouble - than getting the calculations right the first time, so if you - plan to depreciate assets, it is wise to make sure of the - schemes you will be permitted or required to use.

    + may not always be free in choosing your preferred method. + Fixing wrong calculations will cost a whole lot more time and + trouble than getting the calculations right the first time, so + if you plan to depreciate assets, it is wise to make sure of + the schemes you will be permitted or required to + use.

    -

    Return to Main Documentation +

    Return to Main Documentation Page.

    diff --git a/doc/html/C/xacc-bal_tracker.html b/doc/html/C/xacc-bal_tracker.html index b62444939b..996d16dfbc 100644 --- a/doc/html/C/xacc-bal_tracker.html +++ b/doc/html/C/xacc-bal_tracker.html @@ -1,17 +1,22 @@ + - - + + + + Balance Tracking Report

    Balance Tracking Report

    -

    FIXME: Document this report! -


    -

    Return to Main Documentation - Page.

    +

    FIXME: Document this report!

    +
    + +

    Return to Main Documentation + Page.

    + diff --git a/doc/html/C/xacc-balsheet.html b/doc/html/C/xacc-balsheet.html index daecaefe26..4f5c944320 100644 --- a/doc/html/C/xacc-balsheet.html +++ b/doc/html/C/xacc-balsheet.html @@ -1,21 +1,26 @@ + - + Balance Sheet - -

    Balance Sheet

    -

    This report summarizes your assets, liabilities, and equity.

    - -

    There are currently no options for this report, but the option - to specify a date for which the balance sheet is to be calculated - will be added soon.

    - -

    Return to Main Documentation - Page.

    + +

    Balance Sheet

    + +

    This report summarizes your assets, liabilities, and + equity.

    + +

    There are currently no options for this report, but the + option to specify a date for which the balance sheet is to be + calculated will be added soon.

    + +

    Return to Main Documentation + Page.

    + diff --git a/doc/html/C/xacc-currency.html b/doc/html/C/xacc-currency.html index 28a464ddfa..c03a8b9576 100644 --- a/doc/html/C/xacc-currency.html +++ b/doc/html/C/xacc-currency.html @@ -2,22 +2,24 @@ + + - Currency Handling and Double Entry Bookkeeping -

    Currency Handling and Double Entry Bookkeeping

    +

    Currency Handling and Double Entry Bookkeeping

    -

    A Double Entry bookkeeping +

    A Double Entry bookkeeping system stores both values, and requires that all - transactions balance, as described in the Double Entry Identity.

    + transactions balance, as described in the Double Entry Identity.

    -

    When we introduce the notion of having multiple currencies, +

    When we introduce the notion of having multiple currencies, or stocks that may vary in price, the identities get a little more complicated, and we introduce the following formulae:

    @@ -34,7 +36,7 @@
    • - SpendAcct: (an ordinary bank/cash acct valued in + SpendAcct: (an ordinary bank/cash acct valued in USD)
       Date      xfer from       memo                cost
      @@ -44,7 +46,7 @@
             
    • - JPYAcct: (a currency trading account valued in + JPYAcct: (a currency trading account valued in yen)
       Date      xfer from       memo                purchase   rate
      @@ -55,16 +57,16 @@
           

    The engine links together all three of these values - (1.0, 150, 0.00667) permanently and makes it impossible - to change one without changing another, so that the grand total - is always zero, thereby guaranteeing satisfaction of the double entry accounting + (1.0, 150, 0.00667) permanently and makes it impossible to + change one without changing another, so that the grand total is + always zero, thereby guaranteeing satisfaction of the double entry accounting identity.

    -

    ISO Currency Codes

    +

    ISO Currency Codes

    -

    More currencies than you thought possible...

    +

    More currencies than you thought possible...

    @@ -1202,7 +1204,7 @@

    -

    Return to Main Documentation +

    Return to Main Documentation Page.

    diff --git a/doc/html/C/xacc-date.html b/doc/html/C/xacc-date.html index da666a917a..52b80011d2 100644 --- a/doc/html/C/xacc-date.html +++ b/doc/html/C/xacc-date.html @@ -2,8 +2,10 @@ + + - Date Data Input @@ -14,31 +16,31 @@ The date cell handles the following accelerator keys:
      -
    • +, = increment day
    • +
    • +, = increment day
    • -
    • _ , - decrement day
    • +
    • _ , - decrement day
    • -
    • } , ] increment month
    • +
    • } , ] increment month
    • -
    • { , [ decrement month
    • +
    • { , [ decrement month
    • -
    • M , m beginning of month
    • +
    • M , m beginning of month
    • -
    • H , h end of month
    • +
    • H , h end of month
    • -
    • Y , y beginning of year
    • +
    • Y , y beginning of year
    • -
    • R , r end of year
    • +
    • R , r end of year
    • -
    • T , t today GnuCash can be compiled to use +
    • T , t today GnuCash can be compiled to use either European style dates or US Style dates.
    • -
    • Grep for UK_DATES in +
    • Grep for UK_DATES in dates.h

    -

    Return to Main Documentation +

    Return to Main Documentation Page.

    diff --git a/doc/html/C/xacc-double.html b/doc/html/C/xacc-double.html index e7609273a9..9609f755e5 100644 --- a/doc/html/C/xacc-double.html +++ b/doc/html/C/xacc-double.html @@ -2,8 +2,10 @@ + + - Understanding Double Entry Accounting @@ -11,88 +13,94 @@

    Why Use Double Entry Accounting?

    -

    If you are a beginner, a novice, you need double entry accounting -to help you avoid beginner mistakes. It will keep you from creating -an unauditable mess. It will make your life easier, and it will make -this software easier to understand and to use. -And if you are an experienced accountant, then you would only turn ill -at the thought of life without it. +

    If you are a novice to accounting, you need double + entry accounting to help you keep your accounts straight. It + will keep you from creating an unverifiable mess. It will make + your life easier, and it will make this software easier to + understand and to use.

    + +

    And if you are an experienced accountant, you would likely + feel ill at the thought of life without it.

    What is Double Entry Accounting?

    -

    Double entry bookkeeping is an accounting methodology +

    Double entry bookkeeping is an accounting methodology introduced in the 13th century to to make sure that each - accounts and indeed each transaction is properly + accounts and indeed each transaction is properly balanced.

    -

    When these are all required to balance, the likelihood of +

    When these are all required to balance, the likelihood of data-entry errors is greatly reduced. For large, complex sets of accounts with many transactions, it is distressingly easy to make errors that may go undetected for a long time, and be appallingly difficult to track down, even when double-entry bookkeeping is used.

    -

    A double-entry transaction is a transaction that contains +

    A double-entry transaction is a transaction that contains entries for two (or more) accounts that balance against one another. One account is debited by an amount exactly equal to what the other is credited. By ensuring that each transaction balances, a balanced set of accounts is guaranteed. This doesn't prevent you from having errors, but - certainly eliminates the large class of I forgot to enter + certainly eliminates the large class of I forgot to enter that part of the transaction errors.

    -

    Double-entry may be introduced in a more intuitive way via +

    Double-entry may be introduced in a more intuitive way via the notion of a transfer from one bank account to another, where an amount is taken out of one bank account and deposited in the other. This is effectively the "rule" of double entry accounting; if you add something in to one account, you have to have another component to that transaction to - balance this.

    + balance it.

    -

    Not-quite-an-aside: If you look at your bank +

    Not-quite-an-aside: If you look at your bank statements, they are typically written up from the - bank's perspective, which is exactly opposite to + bank's perspective, which is exactly opposite to yours. For instance, when you put money in, establishing a - deposit, this establishes a DEBT on their part.

    + deposit, this establishes a DEBT on their part.

    + As a result, "newcomers to accounting," who only see the terms + "Debit" and "Credit" on statements from their bank seem to get + fairly confused about this. -

    The perhaps less obvious extension is the notion that - double entry can be used to represent income and expenses as - well as bank transfers. See the +

    The perhaps less obvious extension is the notion that double + entry can be used to represent income and expenses as well as + bank transfers. See the Income/Expense page for a more detailed discussion of that.

    -

    In a traditional system that records +

    In a traditional system that records debits and credits separately, the identity that all - transactions are required to satisfy is that Total of + transactions are required to satisfy is that Total of Debits = Total of Credits.

    -

    The fact that the identity requires merely that the +

    The fact that the identity requires merely that the total balances means that it is a little bit misleading to - call this double-entry bookkeeping; it would be - somewhat more accurate to call it multiple-entry + call this double-entry bookkeeping; it would be + somewhat more accurate to call it multiple-entry bookkeeping. Unfortunately, there's 700 years of history of use - of the term, which sufficiently discourages changing it. (And - some people think that UNIX has some crufty old bits of - oddness. Hah!)

    + of the term, which sufficiently discourages changing it. (To + think some newcomers to UNIX think that it has some crufty old + bits of oddness. Hah! We've got UNIX beat by the better part of + a millennium!)

    -

    GnuCash treats "Debits" as positive values, and "Credits" - as negative values, so that this identity simplifies to +

    GnuCash treats "Debits" as positive values, and "Credits" as + negative values, so that this identity simplifies to value1 + value2 + value3 + ... = 0

    Using Double Entry

    -

    Creating Transactions

    +

    Creating Transactions

    -

    To create a double-entry transaction:

    +

    To create a double-entry transaction:

    • Click on a box in the column marked Transfer From on the left-hand side of the register. -

      A menu will drop down, listing all of the accounts from +

      A menu will drop down, listing all of the accounts from which a transfer may be made.

    • @@ -106,31 +114,31 @@ at the thought of life without it.
    -

    Changing Transactions

    +

    Changing Transactions

    -

    To change a double-entry transaction:

    +

    To change a double-entry transaction:

    -

    Simply edit the transaction in any window in which it +

    Simply edit the transaction in any window in which it appears.

    -

    Any changes made will be automatically reflected in both +

    Any changes made will be automatically reflected in both accounts and all windows displaying the transaction.

    -

    Similarly, when a double-entry transaction is deleted, the +

    Similarly, when a double-entry transaction is deleted, the "splits" will be deleted from both accounts, and balances will - automatically be recalculated for both accounts.

    + automatically be recalculated for both accounts.

    -

    To change the transfer account, simply select a new account +

    To change the transfer account, simply select a new account from the pull-down menu. When you record the transaction, it will automatically be selected from the old account, and inserted into the new account.

    Scrubbing Clean

    -

    GnuCash can be configured to be strict about double entry, +

    GnuCash may be configured to be strict about double entry, or you may configure it to be "loose."

    -

    In "loose" mode, you can create unbalanced +

    In "loose" mode, you can create unbalanced transactions, that is, transactions where the "splits" don't balance to zero. That discards the validation that comes from using the more strict double entry scheme, which is @@ -138,27 +146,36 @@ at the thought of life without it.

    • If you aren't sure of what you're doing, you likely do - not want to discard the validation of double entry, - as this helps you keep your accounts balanced even when - you're not perfectly clear on this.
    • + not want to discard the validation of double entry, as + this helps you keep your accounts balanced even when you're + not perfectly clear on this. -
    • If you are an accounting whiz, you'll know that - it's really important to keep things in balance, - and again will prefer double entry.
    • +
    • If you are an accounting whiz, you'll know that + it's really important to keep things in balance, and + again will prefer double entry.
    -

    But if you decide to "outsmart the system," and have a +

    But if you decide to "outsmart the system," and have a number of unbalanced transactions, you'll probably want to clean this up at some point. To clean up these unbalanced - transactions, you Scrub the account clean by choosing - Scrub from the window menu. This will examine each - transaction; if the transaction doesn't balance, a split entry - will be created and placed into an account named - Unbalanced. You may then review these splits and move them - to their proper accounts.

    + transactions, you Scrub the account clean by choosing + Scrub from the window menu.

    + +

    The process will examine each transaction; if the + transaction doesn't balance, a split entry will be created and + placed into an account named Unbalanced. You may then + review these splits and move them to their proper accounts.

    + +

    Warning: Functionality Changing...

    + +

    At present, control over whether GnuCash is "strict" or + "loose" is established at compile time, and defaults to + strict.

    + +

    In the future, there will be no option of "looseness."


    -

    Return to Main Documentation +

    Return to Main Documentation Page.

    diff --git a/doc/html/C/xacc-euro.html b/doc/html/C/xacc-euro.html index ddf79e1673..82328d8949 100644 --- a/doc/html/C/xacc-euro.html +++ b/doc/html/C/xacc-euro.html @@ -2,49 +2,54 @@ + + - GnuCash and the EURO -

    GnuCash and the EURO

    +

    GnuCash and the EURO

    -

    Introduction

    +

    Introduction

    On January 1, 1999, eleven European Union countries formed an economic and monetary union (EMU) and started using a single currency - the euro. These countries locked the exchange rates of their national currencies to the euro and are sharing the new currency.

    -

    However, euro notes and coins will not be available until + +

    However, euro notes and coins will not be available until January 1, 2001. Until then, the old national currency notes and coins (French francs, Deutschmarks etc) will continue to - circulate. But in law they are part of the euro. Their value - in euro is completely fixed. All kinds of cashless monetary + circulate. But in law they are part of the euro. Their value in + euro is completely fixed. All kinds of cashless monetary transactions like cheques or wire transfers are possible in euro

    -

    You can find more information about the euro at: - http://europa.eu.int/euro - .

    +

    You can find more information about the euro at: http://europa.eu.int/euro .

    -

    EMU Member Countries and Exchange Rates

    +

    EMU Member Countries and Exchange Rates

    + - - -

    The following table shows the EMU member countries and - the respective exchange rates of the euro to the old national - currencies. More countries are expected to join the EMU later.

    +

    The following table shows the EMU member countries and the + respective exchange rates of the euro to the old national + currencies. More countries are expected to join the EMU + later.

    + - - + + + + @@ -53,94 +58,128 @@ - - - + + + + + + + - - - + + + + + + + - - - + + + + + + + - - - + + + + + + + - - - + + + + + + + - - - + + + + + + + - - - + + + + + + + - - - + + + + + + + - - - + + + + + + + - - - + + + + + + + - - - + + + + + + +
    CountryISO CodeFull DescriptionExchange RateFull DescriptionExchange Rate
    AustriaATS - Austrian Schilling1 euro = 13.7603 SAustriaATSAustrian Schilling1 euro = 13.7603 S
    BelgiumBEF - Belgian Franc1 euro = 40.3399 bfrsBelgiumBEFBelgian Franc1 euro = 40.3399 bfrs
    FinlandFIM - Finnish Mark1 euro = 5.94573 FmkFinlandFIMFinnish Mark1 euro = 5.94573 Fmk
    FranceFRF - French Franc1 euro = 6.55957 FFFranceFRFFrench Franc1 euro = 6.55957 FF
    GermanyDEM - German Mark1 euro = 1.95538 DMGermanyDEMGerman Mark1 euro = 1.95538 DM
    IrelandIEP - Irish Pound1 euro = 0.787564 Ir. £IrelandIEPIrish Pound1 euro = 0.787564 Ir. £
    ItalyITL - Italian Lira1 euro = 1936.27 LitItalyITLItalian Lira1 euro = 1936.27 Lit
    LuxembourgLUF - Luxembourgian Franc1 euro = 40.3399 lfrsLuxembourgLUFLuxembourgian Franc1 euro = 40.3399 lfrs
    NetherlandsNLG - Dutch Guilder1 euro = 2.20371 hflNetherlandsNLGDutch Guilder1 euro = 2.20371 hfl
    PortugalPTE - Portuguese Escudo1 euro = 200.482 EscPortugalPTEPortuguese Escudo1 euro = 200.482 Esc
    SpainESP - Spanish Peseta1 euro = 166.386 PtasSpainESPSpanish Peseta1 euro = 166.386 Ptas
    -

    EURO support in GnuCash

    +

    EURO support in GnuCash

    You can enable euro support in GnuCash in the international category of the preferences - dialog box. If your system locale specifies one of the - EMU member currencies, euro support - is enabled by default.

    + dialog box. If your system locale specifies one of the EMU member currencies, euro support is + enabled by default.

    FIXME: Actual documentation with screenshots and so on

    -

    Return to Main Documentation +

    Return to Main Documentation Page.

    + diff --git a/doc/html/C/xacc-expense.html b/doc/html/C/xacc-expense.html index 4a5174f652..2fa5f77ad7 100644 --- a/doc/html/C/xacc-expense.html +++ b/doc/html/C/xacc-expense.html @@ -1,7 +1,9 @@ + - + Using Expense/Income Accounts @@ -10,53 +12,52 @@

    What are Incomes and Expenses?

    -

    The words "Income" and "Expense" are beguilingly simple; - everyone thinks they know what they mean; this - usually is that When I spend something, this is an +

    The words "Income" and "Expense" are beguilingly simple; + everyone thinks they know what they mean; this + usually is that When I spend something, this is an expense, and when I get money, this is an income.

    -

    This oversimplifies things somewhat; it is often a +

    This oversimplifies things somewhat; it is often a good-enough approximation when doing personal accounting, but when running a business, incomes and expenses often have be recognized as having occurred when some "critical event" takes place that may not perfectly correspond to "when cash comes in or goes out."

    -

    For instance, companies usually have to recognize income - when the sale occurs. That may mean that I have to - recognize a $100,000 sale at the moment I and the customer +

    For instance, companies usually have to recognize income + when the sale occurs. That may mean that I have to + recognize a $100,000 sale at the moment I and the customer shake hands on the deal.

    -

    Since the money hasn't come in, the sale has to be - estimated in other way; the way this is done is to - accrue a sale at that time, and in making the transaction - balance, rather than adding something in to cash, I'd add the - $100,000 sale to Accounts Receivable.

    +

    Since the money hasn't come in, the sale has to be estimated + in other way; the way this is done is to accrue a sale + at that time, and in making the transaction balance, rather + than adding something in to cash, I'd add the $100,000 sale to + Accounts Receivable.

    -

    In a double entry system, two kinds of accounts must be +

    In a double entry system, two kinds of accounts must be created: some of type "Income" and others of type "Expense." (There tend to be a lot more different kinds of expenses than there are of incomes.)

    -

    Income such as salary, wages, bank interest and stock +

    Income such as salary, wages, bank interest and stock dividends are then recorded as transfers from an income account to a bank (or, in general, some asset) account. Similarly, expenses are recorded as transfers from a credit card account (or, in general, a liability account).

    -

    Another way of describing the requirement for "double - entry" is that when you receive an income, two things - happen:

    +

    Another way of describing the requirement for "double entry" + is that when you receive an income, two things happen:

      -
    • You receive a sum of money, and must record - that effect on your bank account.
    • +
    • You receive a sum of money, and must record that + effect on your bank account.
    • You have received an income, and must record that effect on an income account.
    -

    When, for instance, salary is deposited in a bank account, +

    When, for instance, salary is deposited in a bank account, the bank account is credited, and the income account is debited, thus:

    @@ -137,72 +138,72 @@ -

    There may be a whole lot more than two entries in the +

    There may be a whole lot more than two entries in the transaction, but the total sum of the Debits, $1,600.00, still equals the total sum of the credits, $1,600.00.

    -

    If, as with GnuCash, everything is forced onto one - column, so that debits are represented by positive - values, and credits are represented by negative values, +

    If, as with GnuCash, everything is forced onto one + column, so that debits are represented by positive + values, and credits are represented by negative values, the income/expense accounts do a slightly non-intuitive thing - and you see incomes as negative values. That + and you see incomes as negative values. That appears contrary to intuition, but is nonetheless necessary in order for the - double-entry bookkeeping identity to hold true.

    + double-entry bookkeeping identity to hold true.

    -

    Another way in which income and expense accounts are - special is that their account totals do not directly appear on - a balance sheet. A balance sheet shows "Net Worth": the sum of +

    Another way in which income and expense accounts are special + is that their account totals do not directly appear on a + balance sheet. A balance sheet shows "Net Worth": the sum of all assets minus all liabilities.

    -

    Income and expenses are neither assets nor liabilities, and +

    Income and expenses are neither assets nor liabilities, and so do not appear on the balance sheet. What appears on the - balance sheet is their effects on equity.

    + balance sheet is their effects on equity.

    -

    There is a separate report, a "Profit and Loss" (P&L) +

    There is a separate report, a "Profit and Loss" (P&L) report, to analyze income and expenses. The total profit (or loss) is calculated as total income less total expenses. In a nicely symmetrical fashion, since assets and liabilities are - neither income or expenses, they correspondingly do + neither income or expenses, they correspondingly do not appear on a P&L statement.

    -

    Even though these accounts may be somewhat "special", you - do not need to do anything particularly special to use income - and expense accounts. GnuCash handles the values automatically, - so that if you record properly the effects of the transactions - on your bank account or credit card, the income/expense side of +

    Even though these accounts may be somewhat "special", you do + not need to do anything particularly special to use income and + expense accounts. GnuCash handles the values automatically, so + that if you record properly the effects of the transactions on + your bank account or credit card, the income/expense side of the transaction should also be handled correctly.

    -

    The time when things get "peculiar," and when you need to +

    The time when things get "peculiar," and when you need to more deeply understand this, is when amounts are transferred - between income/expense accounts. (The causes for such + between income/expense accounts. (The causes for such transfers tend to be somewhat peculiar, so it's pretty fair for this to be a pretty odd situation.)

    Using Income/Expense Accounts

    -

    To use an income/expense account, simply create one from - the "New Account" dialogue window, and then be sure to transfer +

    To use an income/expense account, simply create one from the + "New Account" dialogue window, and then be sure to transfer income/expenses to it as you record paychecks, interest, etc.

    -

    You will doubtless wish to create quite a number of income - and expense accounts; it may be worth looking at the Sample Chart of Accounts - for ideas.

    +

    You will doubtless wish to create quite a number of income + and expense accounts; it may be worth looking at the Sample Chart of Accounts for + ideas.

    -

    This partitioning of incomes and expenses is likely to - prove particularly useful for North Americans when income - tax time rolls around.

    +

    This partitioning of incomes and expenses is likely to prove + particularly useful for North Americans when income tax + time rolls around.

    -

    Use of Terminology In Other Software

    +

    Use of Terminology In Other Software

    -

    If you have used other personal finance software, be aware - that Quicken calls - them "Categories."

    +

    If you have used other personal finance software, be aware + that Quicken calls them + "Categories."


    -

    Return to Main Documentation +

    Return to Main Documentation Page.

    diff --git a/doc/html/C/xacc-find-transactions.html b/doc/html/C/xacc-find-transactions.html index 4df437b300..767a3c7496 100644 --- a/doc/html/C/xacc-find-transactions.html +++ b/doc/html/C/xacc-find-transactions.html @@ -33,30 +33,46 @@

    Overview

    The Find Transactions dialog allows you to search for -transactions which match criteria that you specify, including -account(s) affected by the transaction, the value of the transaction, -the date, the memo, the description, etc. You can bring up the Find -Transactions dialog by clicking on the "Find" button in the main -GnuCash window or any register display window. The results of your -search will be shown in a register display similar to the ones used to -display your accounts, with the window title "Search Results". +transactions which match criteria that you specify, including: +

      +
    • Account(s) affected by the transaction, +
    • Value of the transaction, +
    • Date +
    • Memo field +
    • Transaction description +
        +etc. + +

        You may bring up the Find Transactions dialog by clicking +on the "Find" button in the main GnuCash window or any register +display window. + +

        The results of your search will be shown in a register display +similar to the ones used to display your accounts, with the window +title "Search Results".

        Clicking the "Find" button again within a Search Results register window allows you to add additional terms to the query whose -results are displayed in that window. By combining multiple searches, -you can create very sophisticated queries to show you exactly the +results are displayed in that window.

        By combining multiple searches, +you may construct rather sophisticated queries to display exactly the subset of your transactions that you want to see. Table of Contents

        How to use the Find Transactions dialog

        -

        The Find Transactions dialog has two main parts. The upper +

        The Find Transactions dialog has two main parts. + +

          +
        • The upper part of the dialog is a Notebook with tabs that allow you to specify -the conditions of your search. See Setting up a -search for details on each search type. The lower part of the +the conditions of your search.

          See Setting up a +search for details on each search type. + +

        • The lower part of the dialog is a selector which allows you to specify how the results of the search are to be combined with any previous search. +

        If you get the Find Transactions dialog by clicking the Find button in the main GnuCash window or any normal account display @@ -107,9 +123,9 @@ accounts is to be displayed.

        If you select "All" accounts from the picker at the top of the tab, the only transactions that will be show are those which affect -all the selected accounts. For example, if you select "My Checking -Account" and "My VISA Account" and then choose "All", only transfers -from Checking to Visa will be shown. +all the selected accounts.

        For example, if you select My +Checking Account and My VISA Account and then choose +All, only transfers from Checking to Visa will be shown.

        If you select "Any" from the picker, transactions affecting any selected amount will be shown. For example, if you select "My @@ -121,15 +137,15 @@ together in the Search Results window.

        In the Date tab, you can specify a date range for the transactions you wish to find. The year, month, and day fields are in -the order you specify in Preferences:International:Date Format. +the order you specify in Preferences:International:Date Format.

        If you want to locate any transaction before a certain date, -specify your date in the second date entry and put a very early date -in the first date entry. The default date is January 1, 1900, which -should be early enough for most purposes. Similarly, if you want to -find any transaction after a certain date, put the date in the first -date entry and put a date after your last transaction in the second -entry. +specify your date in the second date entry and put a distant date in +the past in the first date entry. The default date is January 1, +1900, which should be distant enough for most peoples' purposes.

        +Similarly, if you want to find any transaction after a certain date, +put the date in the first date entry and put a date after your last +transaction in the second entry.

        Amount searches

        @@ -146,12 +162,12 @@ interested in debits, credits, or both.

        In the Description, Number, Memo, and Action tabs, you can specify a string which is matched against the respective fields of -splits and transactions. By default, the match used is a -case-insensitive substring match. If you select the "Case sensitive" -toggle button, the search is a case-sensitive substring match. If the +splits and transactions.

        • By default, the match used is a +case-insensitive substring match.
        • If you select the "Case sensitive" +toggle button, the search is a case-sensitive substring match.
        • If the "Regular expression" button is selected, the match interprets the string you enter as a POSIX extended regular expression; case -sensitivity is still determined by the "Case sensitive" button. +sensitivity is still determined by the "Case sensitive" button.
        Table of Contents diff --git a/doc/html/C/xacc-globalprefs.html b/doc/html/C/xacc-globalprefs.html index 235b6f218a..00a387a42f 100644 --- a/doc/html/C/xacc-globalprefs.html +++ b/doc/html/C/xacc-globalprefs.html @@ -1,42 +1,50 @@ + - + + Preferences -

        Preferences

        -

        You can customize the behavior of - GnuCash by changing the settings in this dialog box.All settings - are automatically saved so changes are preserved for future - sessions.

        +

        Preferences

        + +

        You can customize the behavior of GnuCash by changing the + settings in this dialog box.All settings are automatically + saved so changes are preserved for future sessions.

        To change settings, simply click to select the appropriate - page, then make appropriate changes, and click the "Apply" - button to see - your changes take effect. Clicking "OK" applies changes, then - closes the properties dialog box. - them. The "Close" button simply closes the dialog box without - applying the latest changes.

        + page, then make appropriate changes, and click the "Apply" + button to see your changes take effect. Clicking "OK" applies + changes, then closes the properties dialog box. them. The + "Close" button simply closes the dialog box without applying + the latest changes.

        The settings are grouped into the following categories:

        -
        • Account Fields: sets which fields are displayed in - the account list of the main window.
        • -
        • Account Types: sets which account types are displayed - in the main window.
        • + +
            +
          • Account Fields: sets which fields are displayed in + the account list of the main window.
          • + +
          • Account Types: sets which account types are + displayed in the main window.
          • +
          • General: anything that doesn't fit anywhere - else.
          • -
          • International: Options relating to date and time - display formats.
          • -
          • Register: Options relating to the default appearance - of account registers.
          • + else. + +
          • International: Options relating to date and time + display formats.
          • + +
          • Register: Options relating to the default + appearance of account registers.
          +
          - -

          Return to Main Documentation +

          Return to Main Documentation Page.

          - + diff --git a/doc/html/C/xacc-globalprops.html b/doc/html/C/xacc-globalprops.html index 235b6f218a..00a387a42f 100644 --- a/doc/html/C/xacc-globalprops.html +++ b/doc/html/C/xacc-globalprops.html @@ -1,42 +1,50 @@ + - + + Preferences -

          Preferences

          -

          You can customize the behavior of - GnuCash by changing the settings in this dialog box.All settings - are automatically saved so changes are preserved for future - sessions.

          +

          Preferences

          + +

          You can customize the behavior of GnuCash by changing the + settings in this dialog box.All settings are automatically + saved so changes are preserved for future sessions.

          To change settings, simply click to select the appropriate - page, then make appropriate changes, and click the "Apply" - button to see - your changes take effect. Clicking "OK" applies changes, then - closes the properties dialog box. - them. The "Close" button simply closes the dialog box without - applying the latest changes.

          + page, then make appropriate changes, and click the "Apply" + button to see your changes take effect. Clicking "OK" applies + changes, then closes the properties dialog box. them. The + "Close" button simply closes the dialog box without applying + the latest changes.

          The settings are grouped into the following categories:

          -
          • Account Fields: sets which fields are displayed in - the account list of the main window.
          • -
          • Account Types: sets which account types are displayed - in the main window.
          • + +
              +
            • Account Fields: sets which fields are displayed in + the account list of the main window.
            • + +
            • Account Types: sets which account types are + displayed in the main window.
            • +
            • General: anything that doesn't fit anywhere - else.
            • -
            • International: Options relating to date and time - display formats.
            • -
            • Register: Options relating to the default appearance - of account registers.
            • + else. + +
            • International: Options relating to date and time + display formats.
            • + +
            • Register: Options relating to the default + appearance of account registers.
            +
            - -

            Return to Main Documentation +

            Return to Main Documentation Page.

            - + diff --git a/doc/html/C/xacc-gpl.html b/doc/html/C/xacc-gpl.html index 491ba2c470..0a520e06d7 100644 --- a/doc/html/C/xacc-gpl.html +++ b/doc/html/C/xacc-gpl.html @@ -2,7 +2,8 @@ - + GNU General Public License @@ -17,14 +18,14 @@ Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave, Cambridge, MA 02139, USA -

            Everyone is permitted to copy and distribute verbatim +

            Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

            Preamble

            -

            The licenses for most software are designed to take away +

            The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is @@ -35,53 +36,53 @@ General Public License instead.) You can apply it to your programs, too.

            -

            When we speak of free software, we are referring to - freedom, not price. Our General Public Licenses are designed to - make sure that you have the freedom to distribute copies of - free software (and charge for this service if you wish), that - you receive source code or can get it if you want it, that you - can change the software or use pieces of it in new free - programs; and that you know you can do these things.

            +

            When we speak of free software, we are referring to freedom, + not price. Our General Public Licenses are designed to make + sure that you have the freedom to distribute copies of free + software (and charge for this service if you wish), that you + receive source code or can get it if you want it, that you can + change the software or use pieces of it in new free programs; + and that you know you can do these things.

            -

            To protect your rights, we need to make restrictions that +

            To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.

            -

            For example, if you distribute copies of such a program, +

            For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.

            -

            We protect your rights with two steps: (1) copyright the +

            We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.

            -

            Also, for each author's protection and ours, we want to - make certain that everyone understands that there is no - warranty for this free software. If the software is modified by - someone else and passed on, we want its recipients to know that - what they have is not the original, so that any problems - introduced by others will not reflect on the original authors' +

            Also, for each author's protection and ours, we want to make + certain that everyone understands that there is no warranty for + this free software. If the software is modified by someone else + and passed on, we want its recipients to know that what they + have is not the original, so that any problems introduced by + others will not reflect on the original authors' reputations.

            -

            Finally, any free program is threatened constantly by +

            Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.

            -

            The precise terms and conditions for copying, distribution +

            The precise terms and conditions for copying, distribution and modification follow.


            GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

            -

            0. This License applies to any program or other work which +

            0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a @@ -92,15 +93,15 @@ (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".

            -

            Activities other than copying, distribution and - modification are not covered by this License; they are outside - its scope. The act of running the Program is not restricted, - and the output from the Program is covered only if its contents +

            Activities other than copying, distribution and modification + are not covered by this License; they are outside its scope. + The act of running the Program is not restricted, and the + output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.

            -

            1. You may copy and distribute verbatim copies of the +

            1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of @@ -109,11 +110,11 @@ recipients of the Program a copy of this License along with the Program.

            -

            You may charge a fee for the physical act of transferring a +

            You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.

            -

            2. You may modify your copy or copies of the Program or any +

            2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these @@ -124,13 +125,13 @@ notices stating that you changed the files and the date of any change. -

            b) You must cause any work that you distribute or - publish, that in whole or in part contains or is derived from - the Program or any part thereof, to be licensed as a whole at - no charge to all third parties under the terms of this +

            b) You must cause any work that you distribute or publish, + that in whole or in part contains or is derived from the + Program or any part thereof, to be licensed as a whole at no + charge to all third parties under the terms of this License.

            -

            c) If the modified program normally reads commands +

            c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate @@ -155,17 +156,17 @@ whole, and thus to each and every part regardless of who wrote it. -

            Thus, it is not the intent of this section to claim rights +

            Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.

            -

            In addition, mere aggregation of another work not based on +

            In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.

            -

            3. You may copy and distribute the Program (or a work based +

            3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:

            @@ -176,7 +177,7 @@ the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, -

            b) Accompany it with a written offer, valid for at least +

            b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source @@ -184,7 +185,7 @@ above on a medium customarily used for software interchange; or,

            -

            c) Accompany it with the information you received as to +

            c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or @@ -192,7 +193,7 @@ b above.)

            -

            The source code for a work means the preferred form of the +

            The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, @@ -204,7 +205,7 @@ system on which the executable runs, unless that component itself accompanies the executable.

            -

            If distribution of executable or object code is made by +

            If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third @@ -220,7 +221,7 @@ licenses terminated so long as such parties remain in full compliance. -

            5. You are not required to accept this License, since you +

            5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this @@ -230,16 +231,16 @@ conditions for copying, distributing or modifying the Program or works based on it.

            -

            6. Each time you redistribute the Program (or any work - based on the Program), the recipient automatically receives a - license from the original licensor to copy, distribute or - modify the Program subject to these terms and conditions. You - may not impose any further restrictions on the recipients' - exercise of the rights granted herein. You are not responsible - for enforcing compliance by third parties to this License.

            +

            6. Each time you redistribute the Program (or any work based + on the Program), the recipient automatically receives a license + from the original licensor to copy, distribute or modify the + Program subject to these terms and conditions. You may not + impose any further restrictions on the recipients' exercise of + the rights granted herein. You are not responsible for + enforcing compliance by third parties to this License.

            -

            7. If, as a consequence of a court judgment or allegation - of patent infringement or for any other reason (not limited to +

            7. If, as a consequence of a court judgment or allegation of + patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of @@ -253,12 +254,12 @@ License would be to refrain entirely from distribution of the Program.

            -

            If any portion of this section is held invalid or +

            If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.

            -

            It is not the purpose of this section to induce you to +

            It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software @@ -273,7 +274,7 @@ This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. -

            8. If the distribution and/or use of the Program is +

            8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit @@ -282,13 +283,13 @@ not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.

            -

            9. The Free Software Foundation may publish revised and/or +

            9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

            -

            Each version is given a distinguishing version number. If +

            Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of @@ -297,7 +298,7 @@ you may choose any version ever published by the Free Software Foundation.

            -

            10. If you wish to incorporate parts of the Program into +

            10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, @@ -309,8 +310,8 @@

            NO WARRANTY

            -

            11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE - IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +

            11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS + NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, @@ -320,7 +321,7 @@ WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

            -

            12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED +

            12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, @@ -334,7 +335,7 @@

            END OF TERMS AND CONDITIONS


            -

            Return to Main Documentation +

            Return to Main Documentation Page.

            diff --git a/doc/html/C/xacc-groups.html b/doc/html/C/xacc-groups.html index 9189c2f127..c38aa811ea 100644 --- a/doc/html/C/xacc-groups.html +++ b/doc/html/C/xacc-groups.html @@ -2,7 +2,8 @@ - + Chart of Accounts and Account Numbering @@ -11,14 +12,14 @@

            Chart of Accounts

            -

            Typically accounts are arranged as a tree, in hierarchical +

            Typically accounts are arranged as a tree, in hierarchical form.

            -

            The main branches represent entire categories or groups, +

            The main branches represent entire categories or groups, while the leaves of the tree denote individual bank accounts or expense categories.

            -

            When a summary report is requested, typically only the main +

            When a summary report is requested, typically only the main branches are shown in the report, rather than the individual accounts. For example, a chart of accounts might look like the following:

            @@ -38,47 +39,47 @@ : : -

            Note that accounts not only have names; they have - codes, in order to provide order. When a report - is generated, the sort order is determined - by the numbering.

            +

            Note that accounts not only have names; they have + codes, in order to provide order. When a report is + generated, the sort order is determined by + the numbering.

            -

            A sensible hierarchy generally will have the "leaf" - accounts end in non-zero digits, whilst parent nodes have - increasing numbers of zeros. For instance, "cash" accounts - might logically be arranged thus:

            +

            A sensible hierarchy generally will have the "leaf" accounts + end in non-zero digits, whilst parent nodes have increasing + numbers of zeros. For instance, "cash" accounts might logically + be arranged thus:

            • - Overall Assets: 100 + Overall Assets: 100
              • - Overall Cash: 110 + Overall Cash: 110
                  -
                • Cash in Wallet: 111
                • +
                • Cash in Wallet: 111
                • -
                • Cash in Sock in Closet: 112
                • +
                • Cash in Sock in Closet: 112
                • -
                • Cash in Mattress: 113
                • +
                • Cash in Mattress: 113
                • -
                • Petty Cash Box: 114
                • +
                • Petty Cash Box: 114
              • - Overall Banking Assets 120 + Overall Banking Assets 120
                  -
                • Checking Account 121
                • +
                • Checking Account 121
                • -
                • Savings Account 122
                • +
                • Savings Account 122
              -

              When you create a new +

              When you create a new account, GnuCash offers a guess at what an appropriate account code might be; you are free to change this. GnuCash does not prevent duplicate numbering, although we would @@ -89,7 +90,7 @@

              A Sample Chart of Accounts

              -

              A "typical" chart of accounts is shown below. Each +

              A "typical" chart of accounts is shown below. Each account is of a given account type. This example is a combination of some typical business and personal accounts.

              @@ -369,7 +370,7 @@

            -

            Return to Main Documentation +

            Return to Main Documentation Page.

            diff --git a/doc/html/C/xacc-main.html b/doc/html/C/xacc-main.html index 350e7eacb2..471dc868f5 100644 --- a/doc/html/C/xacc-main.html +++ b/doc/html/C/xacc-main.html @@ -2,14 +2,15 @@ - + GnuCash Help Main Window -

            User Documentation Overview

            +

            User Documentation Overview

            For help on a specific topic: -

            Extended Help/System Documentation

            +

            Extended Help/System Documentation

            -

            The following documentation is about the - implementation of GnuCash as opposed to being user - documentation on how to use it.

            +

            The following documentation is about the + implementation of GnuCash as opposed to being user + documentation on how to use it.

            -

            Some of it represents preliminary documentation for +

            Some of it represents preliminary documentation for subsystems that are not yet sufficiently functional for use by end users.

              -
            • GnuCash Project Goals
            • +
            • GnuCash Project Goals
            • Printing and Web Serving
            • @@ -84,7 +89,7 @@
            • Reports -

              The reporting subsystem is presently undergoing active +

              The reporting subsystem is presently undergoing active development; documentation should eventually include:

                diff --git a/doc/html/C/xacc-mainwin.html b/doc/html/C/xacc-mainwin.html index 682ef8b06f..63c48c1441 100644 --- a/doc/html/C/xacc-mainwin.html +++ b/doc/html/C/xacc-mainwin.html @@ -2,7 +2,8 @@ - + Main Window @@ -11,20 +12,20 @@

                Main GnuCash Window

                -

                This is the main account window. You control your set of +

                This is the main account window. You control your set of accounts from here.

                -

                Below is a picture of the main window, with only the main - accounts shown. Note how Business Expenses has been selected by - highlighting. The box with a cross in it, - immediately to its left, shows that it has one - or more detail accounts that are not shown at present. - To show them, click on this box.

                +

                Below is a picture of the main window, with only the main + accounts shown. Note how Business Expenses has been + selected by highlighting. The box with a cross in it, + immediately to its left, shows that it has one or more detail + accounts that are not shown at present. To show them, click on + this box.

                -


                +


                -

                Here is the main window, with the detail accounts +

                Here is the main window, with the detail accounts showing.


                @@ -32,7 +33,7 @@


                -

                The Open Subaccounts menu item is interesting only +

                The Open Subaccounts menu item is interesting only if you choose an account with sub-accounts (detail accounts). Accounts with sub-accounts will always have a box on thier left. By choosing the Open Subaccounts menu item, a @@ -44,7 +45,7 @@ smaller space. Because of its increased complexity, it use is recommended only for accounting experts.

                -

                Return to Main Documentation +

                Return to Main Documentation Page.

                diff --git a/doc/html/C/xacc-pnl.html b/doc/html/C/xacc-pnl.html index 1f41177748..956b93787b 100644 --- a/doc/html/C/xacc-pnl.html +++ b/doc/html/C/xacc-pnl.html @@ -1,20 +1,25 @@ + - + Profit And Loss Statement - -

                Profit and Loss Statement

                -

                This report summarizes your sources of income and expenditure.

                - -

                There are currently no options for this report, but the option - to specify an accounting period will be added soon.

                - -

                Return to Main Documentation - Page.

                + +

                Profit and Loss Statement

                + +

                This report summarizes your sources of income and + expenditure.

                + +

                There are currently no options for this report, but the + option to specify an accounting period will be added soon.

                + +

                Return to Main Documentation + Page.

                + diff --git a/doc/html/C/xacc-print-check.html b/doc/html/C/xacc-print-check.html index 7c148ece69..c18d3d3e35 100644 --- a/doc/html/C/xacc-print-check.html +++ b/doc/html/C/xacc-print-check.html @@ -2,7 +2,8 @@ - + Printing Checks @@ -11,87 +12,91 @@

                Printing Checks

                -

                You may print a GnuCash transaction as a check by selecting +

                You may print a GnuCash transaction as a check by selecting "Print Check" from the Transaction menu in a register display - window. + window.

                -

                In the Print Check dialog, select the style of check form that - you wish to use, the position of the check on the page, and the - format for printing the date on the check. Clicking OK - will take you to the GnuCash Printing - dialog, which will allow you to preview the check, select a - printer and paper size, and start the print job. +

                In the Print Check dialog, select the style of check form + that you wish to use, the position of the check on the page, + and the format for printing the date on the check. Clicking + OK will take you to the + GnuCash Printing dialog, which will allow you to preview + the check, select a printer and paper size, and start the print + job.

                Check format

                -

                In order to print a check, it is necessary to know where the - pre-printed lines and boxes are on the check form. There are two - widely-used standard check formats: Quicken/QuickBooks (tm) - compatible, and Microsoft Money (tm) compatible. +

                In order to print a check, it is necessary to know where the + pre-printed lines and boxes are on the check form. There are + two widely-used standard check formats: Quicken/QuickBooks (tm) + compatible, and Microsoft Money (tm) compatible.

                -

                By default, the check format is Quicken/QuickBooks, - which prints to any Quicken-compatible check forms. +

                By default, the check format is Quicken/QuickBooks, + which prints to any Quicken-compatible check forms.

                Custom Check Format

                -

                If you wish to print to a type of check form that is not in - the Check Format option menu, select Custom in - the format menu and enter the positions of the various check - fields in the entry boxes below. +

                If you wish to print to a type of check form that is not in + the Check Format option menu, select Custom + in the format menu and enter the positions of the various check + fields in the entry boxes below.

                -

                Positions in the Custom Check Format entry area are specified - with x = 0 at the left edge of the check with x increasing to the - right, and y = 0 at the bottom edge of the check with y increasing - as you travel up. Numbers may be entered as integer or floating - point values. The length units specified in the Units - option menu are used to interpret all values entered in the custom - check format area. +

                Positions in the Custom Check Format entry area are + specified with x = 0 at the left edge of the check with x + increasing to the right, and y = 0 at the bottom edge of the + check with y increasing as you travel up. Numbers may be + entered as integer or floating point values. The length units + specified in the Units option menu are used to + interpret all values entered in the custom check format + area.

                -

                If you arrive at a working set of Custom Check Format +

                If you arrive at a working set of Custom Check Format parameters for a commercially-available printable check form, - please submit them to gnucash-devel@gnucash.org so we can - include them as standard in a future release. + please submit them to gnucash-devel@gnucash.org so we + can include them as standard in a future release.

                Check position

                -

                Printable check forms are available in several styles. In - general, each printable sheet is divided into three sections, and - each section can be either a check or a stub. The Check Position - option menu allows you to select which section of the page - contains the check you wish to print to. Top, - Middle, and Bottom should be defined correctly - for check forms using the paper size that you select in the - printing dialog. +

                Printable check forms are available in several styles. In + general, each printable sheet is divided into three sections, + and each section can be either a check or a stub. The Check + Position option menu allows you to select which section of the + page contains the check you wish to print to. Top, + Middle, and Bottom should be defined + correctly for check forms using the paper size that you select + in the printing dialog.

                Custom check position

                -

                If the preset check positions do not work correctly for your +

                If the preset check positions do not work correctly for your check forms, you may choose Custom from the Check Position option menu and enter a position for the check in the - Check Position entry. Enter the distance along the left - edge of the paper from the lower left-hand corner of the page to - the lower left-hand corner of the check. The units of this - measurement are those selected in the "Units" option menu. + Check Position entry. Enter the distance along the + left edge of the paper from the lower left-hand corner of the + page to the lower left-hand corner of the check. The units of + this measurement are those selected in the "Units" option + menu.

                Date format

                - -

                Select your preferred date format from the picker. The picker - shows a sample date of "December 31, 2000" for all formats, but - your date will be substituted when printing. -

                The "MM/DD/YY" and "DD/MM/YY" formats are available, but they - are strongly discouraged since they cannot always be - distinguished from each other. Please use a format with a full - or abbreviated month name instead of a number. - +

                Select your preferred date format from the picker. The + picker shows examples using the date of December 31, + 2000 for all formats, but your date will be substituted + when printing.

                + +

                The MM/DD/YY and DD/MM/YY formats are + available, but they are strongly discouraged since they cannot + always be distinguished from each other. Please use a format + with a full or abbreviated month name instead of a number.

                +

                Custom date format

                - -

                If you wish to use another date format besides those available - in the picker, select Custom and enter a - date-formatting string in the Date Format entry in the - custom settings area. If custom date format is selected, this - string is passed to strftime(3) as a format specifier. +

                If you wish to use another date format besides those + available in the picker, select Custom and enter a + date-formatting string in the Date Format entry in the + custom settings area. If custom date format is selected, this + string is passed to strftime(3) as a format + specifier.

                diff --git a/doc/html/C/xacc-print.html b/doc/html/C/xacc-print.html index 4e85d84e49..67d891d01d 100644 --- a/doc/html/C/xacc-print.html +++ b/doc/html/C/xacc-print.html @@ -2,7 +2,8 @@ - + Printing and Web Serving @@ -11,33 +12,33 @@

                Printing

                -

                At present, the only type of printing directly supported by - GnuCash is check printing. - Other types of printing are expected to be supported soon. +

                At present, the only type of printing directly supported by + GnuCash is check printing. + Other types of printing are expected to be supported soon.

                -

                You may create a printout of the register - window contents by opening a register window and selecting - Print... To File from the File menu. - Reports can also be - exported as HTML. +

                You may create a printout of the register window contents by + opening a register window and selecting Print... To + File from the File menu. Reports can also be exported as HTML.

                -

                GnuCash as Web Server

                +

                GnuCash as Web Server

                -

                Following the latest fashionable trends of Internet +

                Following the latest fashionable trends of Internet Hype, GnuCash can also act as a cheesy web server!

                • From an open register window, select Print ... To - WWW from the File menu.
                • + WWW from the File menu. -
                • Then aim your browser at http://localhost:1080/ - or http://yourmachinename.com:1080/and you will see +
                • Then aim your browser at http://localhost:1080/ + or http://yourmachinename.com:1080/and you will see your register window.

                • -
                • But, remember, we said cheesy; in order to view - the page a second time, you have to pick the menu item +
                • But, remember, we said cheesy; in order to view + the page a second time, you have to pick the menu item again to "reload" things and allow prepare it for another data dump.

                  @@ -45,7 +46,7 @@

                -

                Return to Main Documentation +

                Return to Main Documentation Page.

                diff --git a/doc/html/C/xacc-qif-import.html b/doc/html/C/xacc-qif-import.html index f90ee1a721..400a2e892c 100644 --- a/doc/html/C/xacc-qif-import.html +++ b/doc/html/C/xacc-qif-import.html @@ -45,40 +45,62 @@ of keeping up with what people want the program to do. keep a Windows partition on their machine just so they can run Quicken and the latest shoot-em-up games. So of course we want to give you a way to suck all your Quicken data into GnuCash and remove one more -barrier to putting a nice ext2 filesystem on that Windows partition. +barrier to putting a nice ext2 filesystem on that Windows +partition.

                The problem is that GnuCash is a real double-entry accounting system and Quicken has a pretty simplistic view about what an account -is, what a transaction is, and what to save in data files. In short, -QIF files just don't contain enough information to completely and -accurately reconstruct your Quicken account hierarchy in the GnuCash -double entry system without some guessing by the import code and some -hand-holding by you. QIF files omit small things that can be easily -guessed (for instance, are numbers in decimal-radix [1,000.00 == 1000] -form or European comma-radix form [1.000,00 == 1000]? Are dates m/d/y -or y/m/d?) and big things that can't be easily guessed, like, for -example, what currency the file is denominated in, or what account the -file describes. +is, what a transaction is, and, most critically, is severely flawed in its datamodel, that is, what it saves in +data files. -

                For the most part, GnuCash's QIF importer does a good job of -figuring this stuff out, but you do have to keep an eye on it. The -system is designed so that you can correct problems BEFORE you make -changes to your GnuCash accounts; nothing is done to your GnuCash -accounts until you click the final "OK" button. +

                Briefly, QIF files just don't contain enough information to +completely and accurately reconstruct your Quicken account hierarchy +in the GnuCash double entry system without some educated guessing by +the import code as well as some guidance, provided by you. +

                  + +
                • QIF files omit small things that may be fairly accurately inferred by +examining the data. + +

                  For instance, are numbers in decimal-radix [1,000.00 == +1000] form or European comma-radix form [1.000,00 == 1000]? +

                  Or are +dates m/d/y or y/m/d? + + More problematic are major things where there is little way of +guessing. + +

                  For instance, determining the currency the file is denominated in. + +

                  Or what account the file describes. + +

                  GnuCash's QIF importer does a remarkably good job of guessing what +it can, but you do have to keep an eye on it. Fortunately, +the system is designed so that you can correct problems before + you changes are dropped into your GnuCash accounts. Nothing is +done to your GnuCash accounts until you click the final "OK" button.

                  In the next section, I'll give an overview of the QIF file and -its "features". This may seem unnecessarily technical, but if you -will at least glance through it you will be much better able to -understand what's going on if you are having to jump through hoops to -make things work right, and how you might be able to jump right in and -edit the QIF file to fix really tough problems. +its "features". This may seem unnecessarily technical, but if you at +least glance through it you will be much better able to understand +what's going on if you are having to jump through hoops to make make a +problematic file work right, and how you might be able to jump right +in and edit the QIF file to fix really tough problems.

                  There are two major "paths" for using the GnuCash QIF importer. -One is the "I am a Quicken user just migrating to GnuCash" path; the -other is the "I am downloading some updates from my bank as a QIF -file" path. This document mainly focuses on the former case, since -new users are likely to need the most help and you can't get started -using GnuCash until you can get your old records in. +

                    + +
                  • One is the "I am a Quicken user just migrating to GnuCash" path. + +
                  • The other is the "I am downloading some updates from my bank as a +QIF file" path. + +
                  + +

                  This document mainly focuses on the former case, since new users +are likely to need the most help and you really can't get started +using GnuCash until you can get your old records in. Fortunately, +once you learn to do the former, the latter should be a piece of cake.

                  Table of Contents @@ -87,18 +109,19 @@ using GnuCash until you can get your old records in.

                  QIF files are plain text files formatted as "tag-value" pairs. At the beginning of each line there is a single character "tag" followed immediately by the "value", which extends to the end of the -line. Don't be afraid to pop up a QIF file in "less" or the text -editor of your choice if you are having problems getting some Quicken -data imported correctly; chances are a simple search-and-replace will -fix just about any problem you might have with a QIF file. And a -regexp search-and-replace will get the rest. +line. +

                  Don't be afraid to pop up a QIF file using less +or the text editor of your choice if you are having problems getting +some Quicken data imported correctly; chances are a simple +search-and-replace can fix just about any problem you might have with +a QIF file. And a regexp search-and-replace will get the rest.

                  Collections of tag-value pairs form records of various types. There are records to store the names and descriptions of your accounts and of expense and income categories that you have defined in Quicken. There are records to define Quicken "classes" (sort of like sub-accounts, sort of like categories, but not exactly like either). -And there are records to describe transactions. +And there are records to describe transactions.

                  Here's a typical Quicken transaction record:

                  @@ -170,11 +193,12 @@ of all the $ fields in a transaction record should equal the T field.
                   
                         

                  Note that nowhere in the transaction record, nor anywhere else in the file, does Quicken store the name of the account that the -file describes. Don't ask me, I don't know why either. Microsoft -Money (which also can save QIF files) started doing a "trick" to get -the information in the file. If the very first Bank transaction in -the file has a payee of "Opening Balance", the L line contains the -name of the account that the file describes: +file describes. Don't ask me why not, I don't know either. Microsoft +Money (which also can save QIF files) uses a "trick" to get the +information in the file. If the very first Bank transaction in the +file has a payee of "Opening Balance", the L line contains the name of +the account that the file describes: +

                         !Type:Bank
                         D12/03/95
                  @@ -184,36 +208,38 @@ name of the account that the file describes:
                         L[New Bank]
                         ^
                       
                  -

                  Opening Balance records are handled specially, since they don't -mean what they appear to mean (if you interpret the record literally, -as a transfer of $4706.57 from [New Bank] to [New Bank], your new -balance is a whopping $0.00). In the -Accounts Tab section there's a discussion + +

                  Opening Balance records are handled specially, since they don't +mean what the data appear to indicate (if you interpret the record +literally, as a transfer of $4706.57 from [New Bank] to [New Bank], +your new balance is a whopping $0.00). In the Accounts Tab section there's a discussion of what we do with them.

                  Multi-account Quicken exports

                  -

                  Quicken and some other programs who use QIF as an export format +

                  Quicken and some other programs who use QIF as an export format know how to put the history of multiple accounts into a single QIF -file. They do this by prepending an "!Account" record before the -set of transactions to/from that account. +file. They do this by prepending an "!Account" record before the set +of transactions to/from that account. -

                  The QIF Importer should be able to handle these files fine. -You may notice that the "Default QIF Account" seems somewhat -arbitrary; for multiple-account exports, the guessed account is the -first one with an Opening Balance record. However, since Quicken -explicitly lists the account for every transaction in multi-account -exports, you aren't likely to get any transactions in the default -account other than those that are supposed to be there. +

                  The QIF Importer should be able to handle these files fine. You +may notice that the "Default QIF Account" seems somewhat arbitrary; +for multiple-account exports, the guessed account is the first one +with an Opening Balance record. However, since Quicken explicitly +lists the account for every transaction in multi-account exports, you +aren't likely to get any transactions in the default account other +than those that are supposed to be there.

                  Table of Contents

                  How to use the QIF Import dialog

                  -

                  The "Quick Start" guide: To load your files, click the "Select -..." button in the Files tab to find the file, then click the "Load -File" button at the bottom of the Files tab to actually load it. -Repeat this until all your files are loaded (read the explanation +

                  The "Quick Start" guide: To load your files, click the "Select ..." +button in the Files tab to find the file, then click the "Load File" +button at the bottom of the Files tab to actually load it. + +

                  Repeat this until all your files are loaded (read the explanation below to see why you should load all your files at the same time). Check the Accounts and Categories dialogs and make corrections if necessary. Then click the big OK button. @@ -230,7 +256,7 @@ will show up in multiple accounts. This means that if you aren't smart about catching duplicate transactions you will end up with wrong balances in GnuCash. Definitely a bad thing. -

                  In order to get the best possible replication of your Quicken +

                  In order to get the best possible replication of your Quicken account tree, export everything you can from Quicken and then import it all in one session, either as a single QIF file representing all your accounts together or as a single file for each account. The @@ -240,7 +266,7 @@ currency, Quicken account name, and so on are right for each one. The importer can do a really good job of catching cross-references (which and marking them. -

                  The importer is written mostly in Guile, and it can be a little +

                  The importer is written mostly in Guile, and it can be a little slow on large QIF files. Load File takes 5-6 seconds for a QIF file with 1000 or so transactions on my machine. @@ -250,7 +276,7 @@ href="#dialog-categories">Categories tab, and check that the importer is going to put your Quicken transactions in the right place. You can click to pop up a dialog and change the GnuCash destination account name/type for any QIF account. Don't be afraid to change -these destination accounts; they are only guesses by the importer +these destination accounts; they are merely guesses by the importer based on the name and type of the QIF account. Mappings of Quicken account to GnuCash account are written to a preferences file when you click "OK", so if you import other Quicken files describing these same @@ -453,7 +479,7 @@ point if someone tells me how it's supposed to work.

                  Brokerage accounts

                  -

                  Brokerage accounts are really confusing to me. Basically, my +

                  Brokerage accounts are really confusing to me. Basically, my thinking is that the brokerage account itself should probably be a Bank account. The only weirdness is in stuff like dividends paid from securities to the brokerage account. If you're using a Dividend diff --git a/doc/html/C/xacc-quicken.html b/doc/html/C/xacc-quicken.html index 2c3cac9c34..f767d2246c 100644 --- a/doc/html/C/xacc-quicken.html +++ b/doc/html/C/xacc-quicken.html @@ -2,7 +2,8 @@ - + A Guide for Former Users of Quicken @@ -11,14 +12,14 @@

                  Quicken (TM) User's Guide

                  -

                  Not all accounting systems use the same words to describe +

                  Not all accounting systems use the same words to describe the same concepts. The following are some notes that may be helpful to users accustomed to Intuit's products.

                  Quicken Categories

                  -

                  What Quicken calls Categories are really just What Quicken calls Categories are really just Income/Expense accounts. Thus, if you are used to specifying a category in Quicken, just create an income/expense account of the same name in GnuCash, and use @@ -29,33 +30,33 @@ Import Files (QIF). (Note: Only Quicken Version 3.0 QIF has been formally tested so far.) -

                  Note that the QIF format is representative of a somewhat +

                  Note that the QIF format is representative of a somewhat peculiar data model that is not as expressive as one might wish; it requires dumping out a separate data file for each account, rather than permitting you to have one file that - represents all of the accounts you might have had in + represents all of the accounts you might have had in Quicken.

                  -

                  Furthermore, while there are plans to do so in the future, +

                  Furthermore, while there are plans to do so in the future, there is not, at this point, a way of mapping the account or - category names used in Quicken to a different set of + category names used in Quicken to a different set of account names that you might be using in GnuCash.

                  -

                  As a result, please read this section carefully. You may be +

                  As a result, please read this section carefully. You may be somewhat disappointed with the results of a QIF import; this will at least give you some more accurate expectations as to what will happen.

                  -

                  Creating QIF Files

                  +

                  Creating QIF Files

                  -

                  To create a set of Quicken QIF files, perform the +

                  To create a set of Quicken QIF files, perform the following procedure:

                  • Start Quicken. -

                    It works on Wine, +

                    It works on Wine, Caldera's Wabi, and doubtless on VMWare, so this may not forcibly require that you run Windows.

                  • @@ -63,10 +64,10 @@
                  • Select the account that you wish to export. -

                    Quicken can only export one account to each data file, +

                    Quicken can only export one account to each data file, which means that if you have many accounts, this may prove to be a somewhat tedious process. (On the other hand, it - should be a whole lot less tedious than entering + should be a whole lot less tedious than entering the data from scratch.)

                  • @@ -74,24 +75,24 @@ Choose the menu File and select the Export... menu entry. -

                    This will provide a dialog that requests a filename, +

                    This will provide a dialog that requests a filename, effective dates, as well as a series of checkboxes, including Transactions, Accounts List, - Category List, and so forth.

                    + Category List, and so forth.

                    -

                    For best results, you should make sure that those three +

                    For best results, you should make sure that those three are checked.

                    -

                    If you do not check the Accounts - List box, then the name of your account will likely be - lost, and that will cause problems when you try to import - the data into GnuCash later.

                    +

                    If you do not check the Accounts List + box, then the name of your account will likely be lost, and + that will cause problems when you try to import the data + into GnuCash later.

                  Now you have a set of .QIF files, and should run GnuCash. -

                  Loading QIF files into GnuCash

                  +

                  Loading QIF files into GnuCash

                  • To import a Quicken QIF file, choose the menu @@ -105,22 +106,22 @@
                  -

                  Things To Note About QIF Import

                  +

                  Things To Note About QIF Import

                  • - Duplicate Entry Scanning + Duplicate Entry Scanning -

                    Note that during merge, a scan is made for duplicate +

                    Note that during merge, a scan is made for duplicate transactions, and duplicates are removed. A duplicate transaction is one where the date, description (payee), memo, quantity, share price, and debited/credited accounts - or categories match exactly. Thus, the merge + or categories match exactly. Thus, the merge should be safe unless you have multiple transactions on the same date, to the same account, for the same amount, with the same description and memo.

                    -

                    This unfortunately can occur, the typical +

                    This unfortunately can occur, the typical scenario involving where you make multiple withdrawals of identical amounts from ATM machines on the same day.

                  • @@ -140,32 +141,32 @@
                  • - QIF Mark II An ongoing project is to build an + QIF Mark II An ongoing project is to build an alternative import utility in Guile that will be more flexible, and which, by virtue of being stored as a set of Scheme scripts, may be modified without needing to recompile the whole application. -

                    At this point, it successfully parses QIF +

                    At this point, it successfully parses QIF files; what remains is the (rather complex task) of determine appropriate correspondences between the Quicken - Categories and the GnuCash equivalents. That is one + Categories and the GnuCash equivalents. That is one of the most significant weaknesses with the present QIF import scheme.

                  • - More about QIF + More about QIF -

                    Further details about the QIF Interchange Format may be - found Further details about the QIF Interchange Format may be + found here.


                  -

                  Return to Main Documentation +

                  Return to Main Documentation Page.

                  diff --git a/doc/html/C/xacc-recnwin.html b/doc/html/C/xacc-recnwin.html index 00a0d3d8d4..db69371a86 100644 --- a/doc/html/C/xacc-recnwin.html +++ b/doc/html/C/xacc-recnwin.html @@ -2,7 +2,8 @@ - + Reconciliation Window @@ -11,29 +12,29 @@

                  Reconciliation Window

                  -

                  The Reconciliation window is used to reconcile cleared +

                  The Reconciliation window is used to reconcile cleared transactions from a bank statement. Enter a dollar amount from - your last bank statement in the box, and then click - OK . The window will then show all unreconciled - transactions since your last bank statement. The reconcile - window looks like this:

                  + your last bank statement in the box, and then click OK + . The window will then show all unreconciled transactions since + your last bank statement. The reconcile window looks like + this:



                  -

                  The Reconciliation window is used to reconcile the user's +

                  The Reconciliation window is used to reconcile the user's records at the end of the month. This involves validating the transactions in GnuCash against the transactions indicated on your bank statement.

                  -

                  For example, when you write a check for something, you +

                  For example, when you write a check for something, you should enter the transaction into GnuCash.

                  -

                  At the end of the month, you receive your bank statement, - perhaps including canceled checks. At that point, - you should "reconcile" the account, that is, agree your - personal records to the documentation provided by the bank.

                  +

                  At the end of the month, you receive your bank statement, + perhaps including canceled checks. At that point, you + should "reconcile" the account, that is, agree your personal + records to the documentation provided by the bank.

                  • Open the reconcile window, and GnuCash will prompt you to @@ -48,13 +49,13 @@
                  • Now, examine each item on the bank statement. -

                    If a check has cleared, as indicated by your bank +

                    If a check has cleared, as indicated by your bank statement, you should click the field between the description and payment fields, and it will then change from n to c, indicating the transaction has ccleared.

                    -

                    You then repeat this for each item that appears on the +

                    You then repeat this for each item that appears on the bank statement, verifying that the amounts match with the amounts in GnuCash, and marking off transactions in GnuCash as they are reconciled.

                    @@ -83,16 +84,16 @@ unwise should pop up, but this doesn't seem to happen anymore.

                    -

                    Also, the "cleared" total at the bottom seems to display +

                    Also, the "cleared" total at the bottom seems to display $0.00 regardless of what transactions are cleared or reconciled.

                    -

                    The "cleared" total should display the total of only the +

                    The "cleared" total should display the total of only the transactions that have been cleared (c) or reconciled (y).


                    -

                    Return to Main Documentation +

                    Return to Main Documentation Page.

                    diff --git a/doc/html/C/xacc-regwin.html b/doc/html/C/xacc-regwin.html index e99695afbe..a25a0f5299 100644 --- a/doc/html/C/xacc-regwin.html +++ b/doc/html/C/xacc-regwin.html @@ -2,7 +2,8 @@ - + Register Window @@ -10,95 +11,122 @@

                    Register Window

                    - -

                    This is the "Register" or the "Ledger" window. Transactions are entered here.

                    -

                    To enter a new transaction, just type into the last blank transaction. - Use the mouse or the Register Keyboard Shortcutsto move between fields, and hit the Enter key or click record to - record the transaction:

                    - -

                    Notice how a the transaction has been recorded and a new, blank - transaction has been created.

                    -

                    You can edit existing transactions in a similar manner. GnuCash - will prompt you to confirm any changes you make.

                    + + +

                    This is the "Register" or the "Ledger" window. Transactions + are entered here.

                    + +

                    To enter a new transaction, just type into the last blank + transaction. Use the mouse or the Register Keyboard Shortcutsto move + between fields, and hit the Enter key or click record to record + the transaction:

                    + + +

                    Notice how a the transaction has been recorded and a new, + blank transaction has been created.

                    + +

                    You can edit existing transactions in a similar manner. + GnuCash will prompt you to confirm any changes you make.

                    Manipulating transactions

                    -

                    You can manipulate transactions with the toolbar or the "Transaction" - menu: -

                    • Delete: you can delete a transaction or an individual - split.
                    • -
                    • Cancel: this reverts any changes you have made to the - transaction you are currently entering/changing
                    • + +

                      You can manipulate transactions with the toolbar or the + "Transaction" menu:

                      + +
                        +
                      • Delete: you can delete a transaction or an + individual split.
                      • + +
                      • Cancel: this reverts any changes you have made to + the transaction you are currently entering/changing
                      • +
                      • New: this moves the cursor to the last line of the - register where new transactions are entered
                      • -
                      • Jump: When placed over an existing transaction, it takes - you to the corresponding register entry in the other register entry - that this - transaction appears in
                      • -
                      • Transfer:This is an alternative way to enter a transaction. - You can do a transfer between any two accounts without opening - up other registers.
                      • -
                      • Close:Closes this register
                      + register where new transactions are entered + +
                    • Jump: When placed over an existing transaction, it + takes you to the corresponding register entry in the other + register entry that this transaction appears in
                    • + +
                    • Transfer:This is an alternative way to enter a + transaction. You can do a transfer between any two accounts + without opening up other registers.
                    • + +
                    • Close:Closes this register
                    • +

                    Viewing Transactions

                    - +

                    The register can show transactions in a variety of different - ways, controlled by entries on the "Register" menu.

                    + ways, controlled by entries on the "Register" menu.

                    +

                    The register can display transactions in several different - styles:

                    -
                    • single-line mode: transactions are displayed on a single line.
                    • -
                    • double-line mode: transactions are displayed over two lines, - with more information about each transaction shown.
                    • -
                    • multi-line mode: transactions are displayed over multiple - lines, allowing the display of multiple entries. This allows you - to enter multi-split transactions (for instance, when you pay multiple bills with one check).
                    • -
                    • auto-single and auto-double modes are like single and - double-line modes, except that the currently-edited transaction - is displayed in multi-line form. This is a very convenient way - of entering multi-account transactions.
                    + styles:

                    -

                    To change the display style, to go the "Register" menu and select - "style".

                    +
                      +
                    • single-line mode: transactions are displayed on a + single line.
                    • + +
                    • double-line mode: transactions are displayed over + two lines, with more information about each transaction + shown.
                    • + +
                    • multi-line mode: transactions are displayed over + multiple lines, allowing the display of multiple entries. + This allows you to enter multi-split transactions (for + instance, when you pay multiple bills with one check).
                    • + +
                    • auto-single and auto-double modes are like single + and double-line modes, except that the currently-edited + transaction is displayed in multi-line form. This is a very + convenient way of entering multi-account transactions.
                    • +
                    + +

                    To change the display style, to go the "Register" menu and + select "style".

                    + +

                    Existing transactions are normally displayed in date order, + but this can also be changed with "Sort Order". You can also + select a date rate from which transactions will be displayed + with "Date Range".

                    -

                    Existing transactions are normally displayed in date order, but - this can also be changed with "Sort Order". - You can also select a date rate from which transactions will be - displayed with "Date Range".

                    Reconciliation

                    -

                    Transactions are typically checked against bank statements - a - process known as "reconciliation". GnuCash keeps track of - the reconciliation status of each transaction.

                    -

                    The reconciliation status of a transaction is shown by the - reconciliation (R) field. 'c' indicates that a transaction - has been reconciled, 'n' indicates that it has not. You can - change the reconciliation status by clicking on a the 'r' field - of the transaction.

                    -

                    At the bottom of the account window, there are two running + +

                    Transactions are typically checked against bank statements - + a process known as "reconciliation". GnuCash keeps track of the + reconciliation status of each transaction.

                    + +

                    The reconciliation status of a transaction is shown by the + reconciliation (R) field. 'c' indicates that a transaction has + been reconciled, 'n' indicates that it has not. You can change + the reconciliation status by clicking on a the 'r' field of the + transaction.

                    + +

                    At the bottom of the account window, there are two running balances, the "cleared and reconciled" balance, and the "total" balance... the "cleared and reconciled" balance should correspond to how much money the bank thinks you have in your account, and the "total" balance includes outstanding transactions.

                    -

                    Reconciliation can be done in the Reconciliation can be done in the Reconcile Window

                    - -

                    Stock Portfolios

                    -

                    You can do stock transactions either from a single-stock +

                    You can do stock transactions either from a single-stock window, or from a portfolio-view window, shown below.

                    -


                    +


                    -

                    The portfolio ledger can seem a bit daunting at first +

                    The portfolio ledger can seem a bit daunting at first sight.

                    -

                    If you have trouble understanding it, then you may wish to +

                    If you have trouble understanding it, then you may wish to create an account for each stock you wish to track.

                    -

                    Some important points to remember about the portfolio +

                    Some important points to remember about the portfolio window:

                      @@ -106,14 +134,14 @@ It shows all stocks in your portfolio, not just one. -

                      The share amounts shown are for each particular +

                      The share amounts shown are for each particular stock.

                    • Note that it uses a two line display. -

                      Debited accounts and debited amounts are on the upper +

                      Debited accounts and debited amounts are on the upper line, and credited amounts and accounts are on the lower line.

                    • @@ -141,7 +169,7 @@ window may be provided.
                    -

                    Return to Main Documentation +

                    Return to Main Documentation Page.

                    diff --git a/doc/html/C/xacc-reports.html b/doc/html/C/xacc-reports.html index d0c7b484ba..5ffd0888ad 100644 --- a/doc/html/C/xacc-reports.html +++ b/doc/html/C/xacc-reports.html @@ -2,7 +2,8 @@ - + Reports @@ -11,58 +12,87 @@

                    Reports

                    -

                    A variety of financial reports can be selected on the "Extensions" - menu": -

                    • Balance Sheet:shows Assets, - Liabilities and Equity.
                    • -
                    • Profit And Loss State:shows Income - and expenses over a selectable period well, it will when - I get around to adding period support -
                    • Transaction Reportshows - transactions in an account, presented in a variety of ways.
                    • -
                    • Balance Tracker tracks - the balance of one or more accounts over time, and supports - graphical output (if you have gnuplot installed).
                    +

                    A variety of financial reports can be selected on the + "Extensions" menu":

                    + +
                      +
                    • Balance Sheet:shows + Assets, Liabilities and Equity.
                    • + +
                    • Profit And Loss State:shows + Income and expenses over a selectable period well, it + will when I get around to adding period support
                    • + +
                    • Transaction + Reportshows transactions in an account, presented in a + variety of ways.
                    • + +
                    • Balance Tracker + tracks the balance of one or more accounts over time, and + supports graphical output (if you have gnuplot + installed).
                    • +

                    The Report Window

                    - Once you select a report, a report window will appear: -

                    -

                    The report is displayed in a resizable, scrollable window. To - control the report, you can use the toolbar buttons at the - top of the window: -

                    • Back and Forward allow you to view the previous - contents of the window, just like a web browser
                    • -
                    • Parameters pops up a dialog box allowing you to change the - information presented in the report: -

                      -

                      See the help for the individual reports for details of options - available.

                    • -
                    • Export allows you to export the contents of the report - as a HTML file for later viewing or printing.
                    • -
                    • Close closes the report window.
                    -

                    Constructing custom reports

                    + Once you select a report, a report window will appear: - 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. -

                    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. -

                    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. -

                    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). -

                    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 gnucash-devel@gnucash.org. +

                    + +

                    The report is displayed in a resizable, scrollable window. + To control the report, you can use the toolbar buttons at the + top of the window:

                    + +
                      +
                    • Back and Forward allow you to view the + previous contents of the window, just like a web browser
                    • + +
                    • + Parameters pops up a dialog box allowing you to + change the information presented in the report: + +

                      + +

                      See the help for the individual reports for details of + options available.

                      +
                    • + +
                    • Export allows you to export the contents of the + report as a HTML file for later viewing or printing.
                    • + +
                    • Close closes the report window.
                    • +
                    + +

                    Constructing custom reports

                    + 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. + +

                    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.

                    + +

                    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.

                    + +

                    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).

                    + +

                    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 + gnucash-devel@gnucash.org.


                    -

                    Return to Main Documentation + +

                    Return to Main Documentation Page.

                    diff --git a/doc/html/C/xacc-ticker.html b/doc/html/C/xacc-ticker.html index 7d0ed04c9e..1d4b3bf875 100644 --- a/doc/html/C/xacc-ticker.html +++ b/doc/html/C/xacc-ticker.html @@ -2,11 +2,12 @@ + Stock Ticker - @@ -33,36 +34,39 @@
                  • Select a quote source from the pull-down menu. Currently supported quote sources include Yahoo, Yahoo - Europe, Fidelity Investments, T. Rowe Price, - the Vanguard Group, the Australian Stock + Europe, Fidelity Investments, T. Rowe + Price, the Vanguard Group, the Australian Stock Exchange (ASX) and TIAA-CREF. Note that Yahoo will provide price quotes for many mutual funds including - Fidelity, T.Rowe Price and Vanguard, and that the quoted prices - at Yahoo should be identical to those that may be found - at the source sites (otherwise, somebody's reporting wrong - information!). If you choose Yahoo Europe, you should append the - market code for the security, such as PA for Paris, BE for - Berlin, etc. Example: 12150.PA (a Peugeot security in the Paris - market). + Fidelity, T.Rowe Price and Vanguard, and that the quoted + prices at Yahoo should be identical to those that may + be found at the source sites (otherwise, somebody's reporting + wrong information!). If you choose Yahoo Europe, you should + append the market code for the security, such as PA for + Paris, BE for Berlin, etc. Example: 12150.PA (a Peugeot + security in the Paris market).
                  • + +
                  • + Ensure that the currency of the account matches the source + of the stock you have selected. This means: -
                  • Ensure that the currency of the account matches the source - of the stock you have selected. This means:
                      -
                    • Quotes from the Australian Stock Exchange (ASX) - should be in Australian dollars (AUD).
                    • - -
                    • Quotes from Yahoo Europe should be in Euros (ECU)
                    • +
                    • Quotes from the Australian Stock Exchange + (ASX) should be in Australian dollars (AUD).
                    • -
                    • Quotes from Yahoo, Fidelity Investments, - T. Rowe Price and the Vanguard Group - should be in US Dollars (USD).
                    • +
                    • Quotes from Yahoo Europe should be in Euros + (ECU)
                    • + +
                    • Quotes from Yahoo, Fidelity + Investments, T. Rowe Price and the Vanguard + Group should be in US Dollars (USD).
                    - +
                  @@ -196,58 +200,82 @@ + + + + + + + + + + + + + + + + + + + + + + + +
                  - Code list for European markets + Code list for European markets
                  Pseudo-symbols that can be used for TIAA-CREF quotes.
                  NamePseudo-symbol
                  StockCREFstok
                  Money MarketCREFmony
                  Equity IndexCREFequi
                  Inflation-Linked BondCREFinfb
                  Bond MarketCREFbond
                  TIAA Real EstateTIAAreal
                  Social ChoiceCREFsoci
                  Teachers PA Stock IndexTIAAsndx
                  Global EquitiesCREFglob
                  Teachers PA Select StockTIAAsele
                  GrowthCREFgrow

                  A sample image is shown below:
                  - Sample Diagram

                  + Sample Diagram

                  To update the prices stored in a gnucash account file, run the command line command gnc-price, specifying the @@ -279,10 +307,11 @@

                  After running gnc-prices for a few days, your accounts will begin to resemble the following:
                  - Later Ticker Listing

                  + Later Ticker Listing


                  Return to Main Documentation Page.

                  + diff --git a/doc/html/C/xacc-trans_report.html b/doc/html/C/xacc-trans_report.html index 7bf0033934..c4f218b98f 100644 --- a/doc/html/C/xacc-trans_report.html +++ b/doc/html/C/xacc-trans_report.html @@ -1,33 +1,46 @@ + - - + + + Transaction Report - +

                  Transaction Report

                  - -

                  Transaction reports list details for transactions in a specified - account over a specified period, in a convenient format for - viewing and exporting.

                  + +

                  Transaction reports list details for transactions in a + specified account over a specified period, in a convenient + format for viewing and exporting.

                  +

                  Options specifiable for this report include:

                  -
                  • Account: the account to do the report on.
                  • -
                  • Date To and Date From: the date range for the report - to cover.
                  • + +
                      +
                    • Account: the account to do the report on.
                    • + +
                    • Date To and Date From: the date range for the + report to cover.
                    • +
                    • Primary Sort Key: the field to sort on first.
                    • -
                    • Primary Sort Order: the order in which to sort. "Ascending" - specifies smallest/largest, alphabetical ordering, earliest->latest, - or smallest amounts first. Descending produces the opposite effects.
                    • -
                    • Secondary Sort Key: the field to sort on if the primary - sort keys are equal
                    • -
                    • Secondary Sort Order: the ordering on which to sort the - secondary key. + +
                    • Primary Sort Order: the order in which to sort. + "Ascending" specifies smallest/largest, alphabetical + ordering, earliest->latest, or smallest amounts first. + Descending produces the opposite effects.
                    • + +
                    • Secondary Sort Key: the field to sort on if the + primary sort keys are equal
                    • + +
                    • Secondary Sort Order: the ordering on which to + sort the secondary key.

                    -

                    Return to Main Documentation + +

                    Return to Main Documentation Page.

                    + diff --git a/doc/html/C/xacc-y2k.html b/doc/html/C/xacc-y2k.html index ef16947461..f2b2b6722d 100644 --- a/doc/html/C/xacc-y2k.html +++ b/doc/html/C/xacc-y2k.html @@ -2,7 +2,8 @@ - + GnuCash Y2K Readiness @@ -11,42 +12,42 @@

                    GnuCash Y2K Readiness

                    -

                    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 too many orders of magnitude outside +

                    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 too many orders of magnitude outside cosmologists' estimations of the age of the universe.

                    -

                    The file format for version 1.1.25 and later stores dates - in the above-described fashion.

                    +

                    The file format for version 1.1.25 and later stores dates in + the above-described fashion.

                    -

                    Some internal routines use the time_t type to +

                    Some internal routines use the time_t 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 - time_t will migrate to the use of 64 bit values by + time_t will migrate to the use of 64 bit values by that time.

                    -

                    Backup and log files are time-stamped using the standard +

                    Backup and log files are time-stamped using the standard Unix ctime() routine, which takes a time_t 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.

                    -

                    Note that GnuCash also correctly recognizes February 29th, +

                    Note that GnuCash also correctly recognizes February 29th, 2000 as a "leap day," another of the "critical Y2K dates."

                    -

                    This is all highly suggestive that GnuCash should cope +

                    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...

                    -

                    Y2K issues are described in more detail at Linux and Year +

                    Y2K issues are described in more detail at Linux and Year 2000.


                    -

                    Return to Main Documentation +

                    Return to Main Documentation Page.