IntenseFinance/gnucash
3
0
Fork 0
mirror of https://github.com/Gnucash/gnucash.git synced 2024-11-26 02:40:43 -06:00
Code Issues Packages Projects Releases Wiki Activity

More work on key-value docs.

Browse Source 
git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@2724 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
Dave Peticolas 2000-08-29 07:08:36 +00:00
parent f64b506a5b
commit cddeb81532
2 changed files with 39 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
src/doc/design/engine.texinfo
View File

@ -44,17 +44,19 @@ user's ownership of a stock might need to store information about
retrieving price quotes online such as the ticker symbol and the
exchange.
The GnuCash accounting entities use Key-Value Pair Frames (hereafter
referred to as the datatype @code{kvp_frame}). A @code{kvp_frame} is
a set of associations between character strings (keys) and
@code{kvp_value} structures. A @code{kvp_value} is a union with
possible types enumerated in the @code{kvp_value_t} enum which
indicates the type of data stored in a @code{kvp_value} object.
To meet this need for varying data storage, the GnuCash accounting
entities use Key-Value Pair Frames (hereafter referred to as the
datatype @code{kvp_frame}). A @code{kvp_frame} is a set of associations
between character strings (keys) and @code{kvp_value} structures. A
@code{kvp_value} is a union with possible types enumerated in the
@code{kvp_value_t} enum which indicates the type of data stored in a
@code{kvp_value} object.
@menu
* kvp_frame::
* kvp_value::
* kvp_list::
* Key-Value Policy::
@end menu
@ -183,7 +185,7 @@ in the function, @code{NULL} is returned.
@end deftypefun
@node kvp_list, , kvp_value, Key-Value Pair Frames
@node kvp_list, Key-Value Policy, kvp_value, Key-Value Pair Frames
@subsection kvp_list
@tindex kvp_list
@ -226,6 +228,35 @@ the caller and should not be accessed after the function returns.
@end deftypefun
@node Key-Value Policy, , kvp_list, Key-Value Pair Frames
@subsection Key-Value Policy
@cindex Key-Value Policy
This section defines the policy that programmers should follow
when using key-value pairs to store information. Because of the
large amount of information which can potentially be stored using
this mechanism, it is important to follow these guidelines so
that order will be maintained.
The following rules should be followed for using key-value pairs:
@itemize
@item
The document @file{src/engine/kvp_doc.txt} should be used to document
the use of keys and values. Please consult this document before planning
any use of new keys.
@item
Key strings should be in all lower case with the @code{'_'} character
separating words. Example: @code{"bank_info"}
@item
Favor longer, descriptive key strings over short ones. Example:
@code{"online_banking_info"} is better than @code{"onln_bnk"}.
@end itemize
@node Sessions, Account Groups, Key-Value Pair Frames, Engine
@section Sessions
@tindex Session

1
src/doc/design/gnucash-design.texinfo
View File

@ -109,6 +109,7 @@ Key-Value Pair Frames
* kvp_frame::
* kvp_value::
* kvp_list::
* Key-Value Policy::
Register