From a5dcc7b16e91ba2a31c9549d7ab0a5bbefa8f23f Mon Sep 17 00:00:00 2001 From: Alex Roitman Date: Sun, 23 Mar 2003 06:20:49 +0000 Subject: [PATCH] Almost done with the first draft svn: r1386 --- doc/gramps-manual/C/gramps.html | 487 ++++++++++++++++++++++++++++++-- doc/gramps-manual/C/gramps.xml | 280 ++++++++++++++++-- 2 files changed, 723 insertions(+), 44 deletions(-) diff --git a/doc/gramps-manual/C/gramps.html b/doc/gramps-manual/C/gramps.html index 7457d0771..04ab67f5d 100644 --- a/doc/gramps-manual/C/gramps.html +++ b/doc/gramps-manual/C/gramps.html @@ -5567,7 +5567,7 @@ CLASS="variablelist" >

This report covers in detail the ancestors of the - active person. It includes vital (birth and death) as well as + active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options on what exactly contents to include.

Ahnentafel Report

[ FIXME: Someone who know exactly what this is has to fill it in. ] +>This report lists the active person and his or her + ancestors along with their vital data. The people are numbered in a + special way which is an established standard called Ahnentafel. + The active person is given number 1. His or her father and mother + have numbers 2 and 3, respectively. This rule holds for every person + while going back in generations: father's parents are numbered 4 and 5, + and mother's parents are numbered 6 and 7, fathers always numbered + with even and mothers with odd numbers. Therefore, for any person + having number N in this tree, the numbers of father and mother + are 2N and 2N+1, respectively.

Common options for text reports are the filename of the output, the format of the output, selected style, and page size and orientation. For HTML reports, there is no page information. - Instead, HTML options includes the choice of the HTML template, + Instead, HTML options include the choice of the HTML template, either available in GRAMPS or custom template defined by you.

or a custom template defined by you.

->Preferences.

. + The Preferences dialog contains the following + categories:

5.1. Usage

This category contains preferences relevant to the + general usage of GRAMPS. It has the following subcategories:

5.1.1. Find

Enable autocompletion

If this box is checked, GRAMPS will attempt to complete + the text as you type it into text entry fields such as family name, + place of birth, etc. Completion is attempted based on the match + between the beginning of the text being typed and the corresponding + data already stored in the database. +

5.1.2. Report Preferences

Preferred text format

Select the preferred format for text reports + from the available formats listed in this menu. +

Preferred graphical format

Select the preferred format for graphical reports + from the available formats listed in this menu. +

Preferred paper size

Select the preferred paper size used for reports + from the available sizes listed in this menu. +

Default report directory

Choose the default directory for the reports using + Browse... button or type it in the text entry + field.

Default web site directory

Choose the default directory for the web site using + Browse... button or type it in the text entry + field.

5.1.3. Researcher Information

Researcher information

Enter your personal information in the corresponding + text entry fields. Although GRAMPS requests information about you, + this information is used only so that it can create valid GEDCOM + output files. A valid GEDCOM file requires information about the files + creator. If you choose, you may leave the information empty, however + all the GEDCOM files you export will not be valid. +

5.1.4. Data Guessing

Surname guessing

Select the surname guessing method which is used +[ FIXME: where exactly is this used ? ] +

5.2. Display

This category contains preferences relevant to + displaying database records and controls in GRAMPS. + It has the following subcategories:

5.2.1. General

Always display the LDS ordinance tabs

Check this box to have LDS ordinance tabs displayed. + If you do not know what LDS is then you probably should not check it. +

Show index numbers in child list

+[ FIXME: where exactly is this used ? ] +

5.2.2. Dates and Calendar

Display: Date format

Select the display format for the dates + from the available formats listed in this menu. +

Name format

Select the display format for the names + from the available formats listed in this menu. +

Entry: Date format

Select the entry format for the dates + from the available formats listed in this menu. +

Show calendar format selection menu

Check this box to enable calendar format selection menu +[ FIXME: where exactly? ] +

5.2.3. Tool and Status Bars

Toolbar

Select the desired appearance of the toolbar icons + using the radio buttons. +

Status bar

Select the desired contents displayed in the + statusbar using the radio buttons. +

5.3. Database

This category contains preferences relevant to the + database itself. It has the following subcategories:

5.3.1. General

Automatically load last database

Check this box to automatically load the last open + database on startup.

Do not compress XML data file

Check this box to disable compression of the XML + data file. Compression significantly reduces the file size. +

Capitalize surnames

Check this box to capitalize surnames entered into the + database.

Autosave interval

Set the interval (in minutes) after which GRAMPS will + automatically save your database. Zero interval completely disables + autosave.

Default database directory

Choose the default directory in which GRAMPS starts + looking when saving the database using Browse.. + or type its path into the text entry field.

5.3.2. Media Objects

Drag and drop from an external source

Choose between a reference and a local copy made when + the object is dropped into the gallery. The reference saves disk + space as it does not copy the object. The local copy makes your + database portable as it does not depend on an external file. Consult + your need to make best choice.

Check Display global properties editor when object is + dropped box to invoke global properties editor after you + drop an external object into the gallery. +

Drag and drop from an internal source

Check Display local properties editor when + object is dropped box to invoke local properties editor + after you drop an internal object into the gallery. +

GRAMPS internal IDs

GRAMPS ID prefixes

Enter ID prefixes for various kinds of database + entries into the corresponding text entry fields. +

Allow internal GRAMPS ID numbers to be + edited

Check this box to enable editing of the internal GRAMPS + ID numbers. Unless you know what you are doing, leave it unchecked. +

5.3.4. Revision Control

Use revision control

Check this box to enable GRAMPS to use revision control + system for your database. If you choose this option, select the + particular revision control system from the menu. +

Prompt for comment on save

Check this box to instruct GRAMPS to prompt you to enter + the comment when you save the database. +

Detailed Ancestral Report This report covers in detail the ancestors of the - active person. It includes vital (birth and death) as well as + active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options on what exactly contents to include. @@ -2524,8 +2524,16 @@ Ahnentafel Report - - [ FIXME: Someone who know exactly what this is has to fill it in. ] + This report lists the active person and his or her + ancestors along with their vital data. The people are numbered in a + special way which is an established standard called Ahnentafel. + The active person is given number 1. His or her father and mother + have numbers 2 and 3, respectively. This rule holds for every person + while going back in generations: father's parents are numbered 4 and 5, + and mother's parents are numbered 6 and 7, fathers always numbered + with even and mothers with odd numbers. Therefore, for any person + having number N in this tree, the numbers of father and mother + are 2N and 2N+1, respectively. @@ -2534,8 +2542,8 @@ Common options for text reports are the filename of the output, the format of the output, selected style, and page size and orientation. For HTML reports, there is no page information. - Instead, HTML options includes the choice of the HTML template, - either available in &app; or custom template defined by you. + Instead, HTML options include the choice of the HTML template, + either available in &app; or a custom template defined by you. @@ -2728,39 +2736,115 @@ Settings To configure &app;, choose Settings - Preferences. - + Preferences. + The Preferences dialog contains the following + categories: + + + + + + + Usage - - - + This category contains preferences relevant to the + general usage of &app;. It has the following subcategories: Find - + + + + Enable autocompletion + If this box is checked, &app; will attempt to complete + the text as you type it into text entry fields such as family name, + place of birth, etc. Completion is attempted based on the match + between the beginning of the text being typed and the corresponding + data already stored in the database. + + + + + Report Preferences - + + + + Preferred text format + Select the preferred format for text reports + from the available formats listed in this menu. + + + + Preferred graphical format + Select the preferred format for graphical reports + from the available formats listed in this menu. + + + + Preferred paper size + Select the preferred paper size used for reports + from the available sizes listed in this menu. + + + + Default report directory + Choose the default directory for the reports using + Browse... button or type it in the text entry + field. + + + Default web site directory + Choose the default directory for the web site using + Browse... button or type it in the text entry + field. + + + + Researcher Information - + + + + Researcher information + Enter your personal information in the corresponding + text entry fields. Although GRAMPS requests information about you, + this information is used only so that it can create valid GEDCOM + output files. A valid GEDCOM file requires information about the files + creator. If you choose, you may leave the information empty, however + all the GEDCOM files you export will not be valid. + + + + + Data Guessing - + + + + Surname guessing + Select the surname guessing method which is used +[ FIXME: where exactly is this used ? ] + + + + + @@ -2768,24 +2852,82 @@ Display - + This category contains preferences relevant to + displaying database records and controls in &app;. + It has the following subcategories: General - + + + + Always display the LDS ordinance tabs + Check this box to have LDS ordinance tabs displayed. + If you do not know what LDS is then you probably should not check it. + + + + Show index numbers in child list + +[ FIXME: where exactly is this used ? ] + + + + Dates and Calendar - + + + + Display: Date format + Select the display format for the dates + from the available formats listed in this menu. + + + + Name format + Select the display format for the names + from the available formats listed in this menu. + + + + Entry: Date format + Select the entry format for the dates + from the available formats listed in this menu. + + + + Show calendar format selection menu + Check this box to enable calendar format selection menu +[ FIXME: where exactly? ] + + + + Tool and Status Bars - + + + Toolbar + Select the desired appearance of the toolbar icons + using the radio buttons. + + + + Status bar + Select the desired contents displayed in the + statusbar using the radio buttons. + + + + @@ -2793,30 +2935,118 @@ Database - + This category contains preferences relevant to the + database itself. It has the following subcategories: General - + + + + Automatically load last database + Check this box to automatically load the last open + database on startup. + + + Do not compress XML data file + Check this box to disable compression of the XML + data file. Compression significantly reduces the file size. + + + + Capitalize surnames + Check this box to capitalize surnames entered into the + database. + + + Autosave interval + Set the interval (in minutes) after which &app; will + automatically save your database. Zero interval completely disables + autosave. + + + Default database directory + Choose the default directory in which &app; starts + looking when saving the database using Browse.. + or type its path into the text entry field. + + + Media Objects - + + + + Drag and drop from an external source + Choose between a reference and a local copy made when + the object is dropped into the gallery. The reference saves disk + space as it does not copy the object. The local copy makes your + database portable as it does not depend on an external file. Consult + your need to make best choice. + + Check Display global properties editor when object is + dropped box to invoke global properties editor after you + drop an external object into the gallery. + + + + Drag and drop from an internal source + Check Display local properties editor when + object is dropped box to invoke local properties editor + after you drop an internal object into the gallery. + + + + &app; internal IDs - + + + + GRAMPS ID prefixes + Enter ID prefixes for various kinds of database + entries into the corresponding text entry fields. + + + + Allow internal GRAMPS ID numbers to be + edited + Check this box to enable editing of the internal &app; + ID numbers. Unless you know what you are doing, leave it unchecked. + + + + Revision Control - + + + + Use revision control + Check this box to enable &app; to use revision control + system for your database. If you choose this option, select the + particular revision control system from the menu. + + + + Prompt for comment on save + Check this box to instruct &app; to prompt you to enter + the comment when you save the database. + + + + +