From 0ee6734dbe1dc8a3496042eaa7b171d48cd4c629 Mon Sep 17 00:00:00 2001 From: Dave Peticolas Date: Tue, 5 Sep 2000 07:09:19 +0000 Subject: [PATCH] Doc updates. git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@2770 57a11ea4-9604-0410-9ed3-97b8803252fd --- src/doc/design/.cvsignore | 1 + src/doc/design/Makefile.in | 2 +- src/doc/design/user-preferences.texinfo | 9 +++++++-- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/src/doc/design/.cvsignore b/src/doc/design/.cvsignore index 3386d01813..f2363f3a77 100644 --- a/src/doc/design/.cvsignore +++ b/src/doc/design/.cvsignore @@ -2,4 +2,5 @@ Makefile version.texi stamp-vti *.info +*.info-* *.html diff --git a/src/doc/design/Makefile.in b/src/doc/design/Makefile.in index ac8c468867..c42d8c9167 100644 --- a/src/doc/design/Makefile.in +++ b/src/doc/design/Makefile.in @@ -116,7 +116,7 @@ VERSION = @VERSION@ l = @l@ info_TEXINFOS = gnucash-design.texinfo -gnucash_design_TEXINFOS = concept-index.texinfo engine.texinfo fdl.texinfo function-index.texinfo intro.texinfo register.texinfo reports.texinfo top-level.texinfo type-index.texinfo +gnucash_design_TEXINFOS = concept-index.texinfo engine.texinfo fdl.texinfo function-index.texinfo intro.texinfo register.texinfo reports.texinfo top-level.texinfo type-index.texinfo user-preferences.texinfo mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs CONFIG_HEADER = ../../../config.h diff --git a/src/doc/design/user-preferences.texinfo b/src/doc/design/user-preferences.texinfo index 2cfbd59917..2bb07f0041 100644 --- a/src/doc/design/user-preferences.texinfo +++ b/src/doc/design/user-preferences.texinfo @@ -1,5 +1,6 @@ @node User Preferences, Function Index, Reports, Top @chapter User Preferences +@cindex User Preferences The options system is used to obtain user preferences, both globally, and when displaying a report. A wide variety of option types are @@ -11,7 +12,8 @@ gnucash internals and GTK+/GNOME, it is not documented here. At present, users are most likely to come across the options system when designing custom reports, and are consequently mostly going to use the Scheme interface. There is also a C interface to much of the options -system which is used to access preferences for the UI, but it is not yet documented.. +system which is used to access preferences for the UI, but it is not yet +documented.. @menu * Option Databases:: @@ -21,7 +23,8 @@ system which is used to access preferences for the UI, but it is not yet documen @end menu @node Option Databases, Option Types, User Preferences, User Preferences -@section Options Databases +@section Option Databases +@cindex Option Databases The options for a particular report are placed in an @dfn{options database}. For doing a report, the option-generator function must @@ -102,6 +105,7 @@ preserved along with other preferences. @node Option Creation, Option Values, Option Types, User Preferences @section Option Creation +@cindex Option Creation To add an option to an options database, you first create that option, then register it with the database. For example, to create a simple @@ -264,6 +268,7 @@ to which the option will be displayed (FIXME:and rounded to?). Step-size specif @node Option Values, , Option Creation, User Preferences @section Option Values +@cindex Option Values To get the value of an option, you must first lookup the option in the options database.