From e9f775bf5ce0b71e1428eee8ca459440182cb659 Mon Sep 17 00:00:00 2001 From: Alex Roitman Date: Fri, 21 Mar 2003 05:53:36 +0000 Subject: [PATCH] Finished Reports svn: r1377 --- doc/gramps-manual/C/gramps.html | 561 +++++++++++++++++++------------- doc/gramps-manual/C/gramps.xml | 134 +++++--- 2 files changed, 426 insertions(+), 269 deletions(-) diff --git a/doc/gramps-manual/C/gramps.html b/doc/gramps-manual/C/gramps.html index 778805db7..c4070c9f5 100644 --- a/doc/gramps-manual/C/gramps.html +++ b/doc/gramps-manual/C/gramps.html @@ -5,7 +5,7 @@ >GRAMPS Manual V2.0GRAMPS Manual V2.0 Manual V2.0

   

   

1. Introduction1. Introduction

The 1.1. Why GRAMPS??

2. Getting Started2. Getting Started

2.1. To Start GRAMPS

You can start gramps filename.gedfilename.ged

where where filename.gedfilename.ged is the name of the file you want to open/import.

2.2. Running GRAMPS for the first time for the first time

[ FIXME: NEED TO RUN Getting Started DRUID to document this section ] @@ -836,8 +840,8 @@ CLASS="sect3" CLASS="sect3" >2.2.1. Choosing a database on startup2.2.1. Choosing a database on startup

If 2.2.2. Optional ZODB support2.2.2. Optional ZODB support

If either StandaloneZODB or Zope is installed on your system, 3. Main Window3. Main Window

When you open a database (either existing or brand new), the following window is displayed.

Menubar.
Menubar

The menubar provides access to all features of @@ -968,7 +972,7 @@ CLASS="application" > through its menus.

Toolbar.
Toolbar

The toolbar provides access to the most frequently @@ -986,7 +990,7 @@ CLASS="guilabel" dialog.

Progress bar.
Progress bar

The progress bar is located in the lower left corner @@ -999,7 +1003,7 @@ CLASS="application" web-sites, etc.

Statusbar.
Statusbar

The statusbar is located to the right of the progress @@ -1022,7 +1026,7 @@ CLASS="guilabel" > dialog.

Display area.
Display area

The largest area in the center of the @@ -1031,35 +1035,44 @@ CLASS="application" >GRAMPS window is the display area. It shows certain aspects of genealogical information, depending on the - currently selected View. There are six Views available + currently selected View. The following six Views are available in GRAMPS: Section 3.1.2, - Section 3.1.3, Section 3.1.4, - Section 3.1.5, Section 3.1.6, - and Section 3.1.7.

: +

  • People View

  • Family View

  • Pedigree View

  • Sources View

  • Places View

  • Media View

+

3.1. Views3.1. Views

Views are the various ways to display different aspects of genealogical information, as described below. Since the relevant @@ -1086,8 +1099,8 @@ CLASS="sect3" CLASS="sect3" >3.1.1. Switching Views and Viewing Modes3.1.1. Switching Views and Viewing Modes

Depending on the state of the 3.1.2. People View3.1.2. People View

When GRAMPS opens a database, - the View is set to the People View. People View lists individuals + the View is set to the People View (Figure 4 + and Figure 5). People View lists individuals whose data is stored in the database. People View displays people's 3.1.2.1. Filters3.1.2.1. Filters

Genealogical databases may contain huge numbers of people. Since the long lists are hard for humans to handle, @@ -1340,8 +1360,8 @@ CLASS="sect4" CLASS="sect4" >3.1.2.2. Alphabetical Tabs3.1.2.2. Alphabetical Tabs

3.1.3. Family View3.1.3. Family View

Family View displays the Family information of a currently selected (or Active) person. Specifically, this view shows the @@ -1493,8 +1513,8 @@ CLASS="sect3" CLASS="sect3" >3.1.4. Pedigree View3.1.4. Pedigree View

3.1.5. Sources View3.1.5. Sources View
3.1.6. Places View3.1.6. Places View
3.1.7. Media View3.1.7. Media View
4. Usage4. Usage

As commonly encountered in everyday life, in 4.1. Opening Database4.1. Opening Database

To open a database, either choose 4.2. Starting New Database4.2. Starting New Database

To start a new database, choose 4.3. Saving Database4.3. Saving Database

To save changes made to your database, choose on the Toolbar. The Status line will then display Saving Saving filenamefilename... message, and the progress bar will advance as the saving progresses.

4.4. Importing GEDCOM Data4.4. Importing GEDCOM Data

Importing GEDCOM data allows you to incorporate the data created in other genealogical programs into your currently open 4.5. Exporting GEDCOM Data4.5. Exporting GEDCOM Data

Exporting GEDCOM data allows you to share any portion of your 4.6. Importing and Exporting GRAMPS Packages Packages

4.7. Editing Data: Quick Start4.7. Editing Data: Quick Start

Editing any portion of data allows you to amend and/or modify information stored in the database. The available editing @@ -2110,13 +2132,13 @@ CLASS="sect3" CLASS="sect3" >4.7.1. To Add a Person4.7.1. To Add a Person

To add a person to the database, switch to the People View (Section 3.1.1Section 3.1.2) and then click 4.7.2. To Specify a Relationship4.7.2. To Specify a Relationship

To specify a relationship, first switch to the Family View (Section 3.1.1Section 3.1.3). Then click +4.7.3. To Specify Parents4.7.3. To Specify Parents

To specify parents of an active person, first switch to the Family View (Section 3.1.1Section 3.1.3). Then click 4.7.4. To Specify Children4.7.4. To Specify Children

To specify children of an active person, switch to the Family View (Section 3.1.1Section 3.1.3) and then click 4.7.5. To Add Images4.7.5. To Add Images

You can add images (as well as other media objects) to individual people, events, sources, places, as well as images @@ -2276,8 +2298,8 @@ NAME="gramps-add-img" >

To add images related to a single person, switch to the People View (Section 3.1.1Section 3.1.2), select a person, and then click

To add images related to a relationship (e.g. marriage), switch to the Family View (Section 3.1.1Section 3.1.3) and then double click on the Spouse box invoke to add an image.

To add images related to a source or a place, first switch to - the Sources View or Places View, respectively - (Section 3.1.1). Then select the appropriate source or - place and then either double click on it or click - Section 3.1.5) or Places + View (Section 3.1.6), respectively. Then select the + appropriate source or place and then either double click on it + or click Edit on the toolbar to invoke @@ -2359,8 +2384,8 @@ CLASS="guibutton" > Finally, to add images that are generally related to the database but not limited to any person, relationship, source, or place in particular, switch to the Media View (Section 3.1.1Section 3.1.7). Then click 4.7.6. To Edit Sources and Places4.7.6. To Edit Sources and Places

To add a source or a place to the database, switch to - the appropriate Sources or Places View (Section 3.1.1Section 3.1.5) or + Places View (Section 3.1.6). Then click 4.8. Editing Data: Complete Description4.8. Editing Data: Complete Description

This section provides a complete description of all editing options for all pieces of data in the 4.8.1. Edit Personal Information4.8.1. Edit Personal Information

Editing of personal data can be performed in the following ways.

4.8.2. Edit Relationship Data4.8.2. Edit Relationship Data

Editing of relationship data is performed in the following 4.8.3. Edit Source Data4.8.3. Edit Source Data

To edit source data, switch to the Sources View and select the desired entry in the list of sources. Double-click on that entry or @@ -3551,8 +3580,8 @@ CLASS="sect3" CLASS="sect3" >4.8.4. Edit Place Data4.8.4. Edit Place Data

To edit place data, switch to the Places View and select the desired entry in the list of places. Double-click on that entry or @@ -3885,8 +3914,8 @@ CLASS="sect3" CLASS="sect3" >4.8.5. Edit Media Data4.8.5. Edit Media Data

To edit media data, switch to the Media View and select the desired entry in the list of sources. Double-click on that entry or @@ -4103,8 +4132,8 @@ CLASS="sect3" CLASS="sect3" >4.8.6. Edit Events4.8.6. Edit Events

Events are edited through the following 4.8.7. Edit Source Information4.8.7. Edit Source Information

When adding source references to events, places, etc., the following dialog appears:

4.8.8. Edit Alternate Names4.8.8. Edit Alternate Names

Alternate names are edited through the following 4.8.9. Edit Attributes4.8.9. Edit Attributes

Attributes are edited through the following 4.8.10. Edit Addresses4.8.10. Edit Addresses

Addresses are edited through the following 4.8.11. Edit Witnesses4.8.11. Edit Witnesses

Witnesses are edited through the following 4.9. Navigation4.9. Navigation

As long as any database is open, 4.9.1. Using People View4.9.1. Using People View

The most intuitive way to select an active person is to use the People View. When in the People View, just select the @@ -5027,8 +5056,8 @@ CLASS="sect3" CLASS="sect3" >4.9.2. Using Family View4.9.2. Using Family View

When in the Family View, you can easily navigate between the members of the displayed family as follows:

4.9.3. Using Pedigree View4.9.3. Using Pedigree View

Pedigree View also allows you to move along the family tree. The benefits of this method is that you can see more than one @@ -5119,8 +5148,8 @@ CLASS="sect3" CLASS="sect3" >4.9.4. Setting Default Person4.9.4. Setting Default Person

One and only one person in the database can be selected as the default person. Once the default person is selected, moving to that @@ -5149,8 +5178,8 @@ CLASS="sect3" CLASS="sect3" >4.9.5. Bookmarking People4.9.5. Bookmarking People

Similarly to the default person, you can bookmark other people from the database to simplify further navigation. To bookmark a person, @@ -5171,9 +5200,11 @@ CLASS="guisubmenu" >Go to bookmark->Person's namePerson's name.

4.10. Generating Reports4.10. Generating Reports

Reports are the most common form of the output produced by genealogical research. Majority of genealogical software puts a lot @@ -5246,16 +5277,20 @@ CLASS="guimenu" >Reports->Report TypeReport Type->Particular - Report. Alternatively, you can browse the complete selection of available reports along @@ -5275,8 +5310,8 @@ CLASS="sect3" CLASS="sect3" >4.10.1. Graphical Reports4.10.1. Graphical Reports

Graphical reports represent information in forms of charts and graphs. The following graphical reports are currently @@ -5374,8 +5409,8 @@ CLASS="sect3" CLASS="sect3" >4.10.2. Text Reports4.10.2. Text Reports

Text reports represent the desired information as formatted text. The following text reports are currently available @@ -5429,43 +5464,64 @@ CLASS="variablelist" >Individual Summary

This report produces a detailed summary on the + active person. The report includes all the facts known to the + database about that person.

Family Group Report

This creates a family group report, showing + information on a set of parents and their children. Specific + options: the spouse (available only if the active person has more + than one spouse).

Detailed Descendant Report

This report covers in detail the descendants of the + active person. It includes vital (birth and death) as well as + marriages. Specific options: number of forward generations + to consider.

Detailed Ancestral Report

This report covers in detail the ancestors of the + active person. It includes vital (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.

Descendant Report

This report produces brief description + of descendants of the active person. Specific options: number + of forward generations to consider.

Complete Individual Report

This report provides individual summaries similar to + that of the Individual Summary report. The advantage of this report + is the specific filter option. Depending on the filter choice (active + person only, his or her descendants, his or her ancestors, or entire + database), the report may contain from one to many individual + summaries. Another option for this report is the inclusion of + source information when listing events.

Ahnentafel Report

[ FIXME: Someone who know exactly what this is has to fill it in. ] +

4.10.3. View4.10.3. View

View reports represent overall summaries of the database + information available immediately for on-screen viewing. + The following view reports are currently available in GRAMPS:

Number of ancestors

This report displays the number of ancestors of the + active person.

Summary of the database

This report displays the overall statistics concerning + number of individuals of each gender, various incomplete entries + statistics, as well as family and media statistics.

4.10.4. Web Page4.10.4. Web Page

This report generates web pages, either for a selected + individual (active person) or a set of individuals. The options + for this report are broken down into contents, privacy, and advanced + options. The contents options include the filter (determine the + scope of the database to consider), number of generations to consider, + destination directory for the images, and a link to the index page. + Privacy options allow you to omit private records, restrict + information on living people, to skip images (either all or those of + living people), and to omit comments and text in source information. + Finally, the advanced options allow to include optional GRAMPS ID, + create a GENDEX index, and specify the extension of the resulting + files.

4.11. Running Tools4.11. Running Tools

4.11.1. Analysis and Exploration4.11.1. Analysis and Exploration

4.11.2. Database Processing4.11.2. Database Processing

4.11.3. Utilities4.11.3. Utilities

5. Settings5. Settings

To configure 5.1. Usage5.1. Usage

5.1.1. Find5.1.1. Find

5.1.2. Report Preferences5.1.2. Report Preferences

5.1.3. Researcher Information5.1.3. Researcher Information

5.1.4. Data Guessing5.1.4. Data Guessing

5.2. Display5.2. Display

5.2.1. General5.2.1. General

5.2.2. Dates and Calendar5.2.2. Dates and Calendar

5.2.3. Tool and Status Bars5.2.3. Tool and Status Bars

5.3. Database5.3. Database

5.3.1. General5.3.1. General

5.3.2. Media Objects5.3.2. Media Objects

5.3.3. GRAMPS internal IDs internal IDs

5.3.4. Revision Control5.3.4. Revision Control

6. About GRAMPS

GRAMPS was written by Donald N. Allingham - (>). To find more information about The &app; window contains the following elements: - Menubar. + Menubar The menubar provides access to all features of &app; through its menus. - Toolbar. + Toolbar The toolbar provides access to the most frequently used functions of &app;. The appearance of the toolbar can be adjusted in Preferences dialog. - Progress bar. + Progress bar The progress bar is located in the lower left corner of the &app; window. It displays the progress of time consuming operations, such as opening and saving large data bases, importing and exporting to other formats, generating web-sites, etc. - Statusbar. + Statusbar The statusbar is located to the right of the progress bar, on the very bottom of the &app; window. It displays information about current &app; @@ -341,15 +341,22 @@ The behavior of the Status line can be adjusted in Preferences dialog. - Display area. + Display area The largest area in the center of the &app; window is the display area. It shows certain aspects of genealogical information, depending on the - currently selected View. There are six Views available - in &app;: , - , , - , , - and . + currently selected View. The following six Views are available + in &app;: + + People View + Family View + Pedigree View + Sources View + Places View + Media View + + + @@ -415,7 +422,8 @@ People View When &app; opens a database, - the View is set to the People View. People View lists individuals + the View is set to the People View ( + and ). People View lists individuals whose data is stored in the database. People View displays people's Names, &app; ID numbers, Gender, and @@ -578,7 +586,7 @@ The two lines that converge on the box represent ties with the person's Father (top line) and mother (bottom line). Solid lines represent birth relations, while dashed lines represent non-birth - relations (such as adoption, step-parentship, guardianship, etc.). + relations (such as adoption, step-parenthood, guardianship, etc.). When the mouse moves over the white box, it expands to display the corresponding person's dates of birth and death. When the mouse is placed over the family line, the line changes color to indicate an @@ -857,7 +865,7 @@ To Add a Person To add a person to the database, switch to the People View - () and then click + () and then click Add on the toolbar. Enter any data you know about this person into the Edit Person Dialog (see @@ -870,7 +878,7 @@ To Specify a Relationship To specify a relationship, first switch to the Family View - (). Then click + + (). Then click + button on the right of the spouse box. Select a spouse/partner from the list and specify their relationship using the menu at the bottom. If necessary, you can add a person to the list by clicking @@ -884,7 +892,7 @@ To Specify Parents To specify parents of an active person, first switch to the - Family View (). Then click + Family View (). Then click + button on the right of the active person's parents list-box. Select the parents from two lists and specify the parents' relationships to the active person using menus at the bottom. @@ -910,7 +918,7 @@ To Specify Children To specify children of an active person, switch to the - Family View () and then + Family View () and then click + button on the right of the children list-box. Select a child from the list and specify child's relationship with father and mother using menus @@ -932,7 +940,7 @@ generally related to the database (e.g. group family photos). To add images related to a single person, switch to the - People View (), select a person, and + People View (), select a person, and then click Edit on the toolbar to invoke the Edit Person Dialog (). Then, select the @@ -945,23 +953,23 @@ done. To add images related to a relationship (e.g. marriage), - switch to the Family View () and then + switch to the Family View () and then double click on the Spouse box invoke Marriage/Relationship editor dialog. Select the Gallery tab and click Add... to add an image. To add images related to a source or a place, first switch to - the Sources View or Places View, respectively - (). Then select the appropriate source or - place and then either double click on it or click - Edit on the toolbar to invoke + the Sources View () or Places + View (), respectively. Then select the + appropriate source or place and then either double click on it + or click Edit on the toolbar to invoke Source Editor (or Place Editor) dialog. Select the Gallery tab and click Add... to add an image. Finally, to add images that are generally related to the database but not limited to any person, relationship, source, or place - in particular, switch to the Media View (). + in particular, switch to the Media View (). Then click Add on the toolbar to add an image. If you have already added any images to any individual galleries, you will also find the listed in the Media View. @@ -981,7 +989,8 @@ To Edit Sources and Places To add a source or a place to the database, switch to - the appropriate Sources or Places View (). + the appropriate Sources View () or + Places View (). Then click Add on the toolbar to add a source/place. Enter the information into the Source Editor (or Place Editor) dialog. @@ -2400,31 +2409,53 @@ Individual Summary - + This report produces a detailed summary on the + active person. The report includes all the facts known to the + database about that person. Family Group Report - + This creates a family group report, showing + information on a set of parents and their children. Specific + options: the spouse (available only if the active person has more + than one spouse). Detailed Descendant Report - + This report covers in detail the descendants of the + active person. It includes vital (birth and death) as well as + marriages. Specific options: number of forward generations + to consider. Detailed Ancestral Report - + This report covers in detail the ancestors of the + active person. It includes vital (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. Descendant Report - + This report produces brief description + of descendants of the active person. Specific options: number + of forward generations to consider. Complete Individual Report - + This report provides individual summaries similar to + that of the Individual Summary report. The advantage of this report + is the specific filter option. Depending on the filter choice (active + person only, his or her descendants, his or her ancestors, or entire + database), the report may contain from one to many individual + summaries. Another option for this report is the inclusion of + source information when listing events. Ahnentafel Report - + + [ FIXME: Someone who know exactly what this is has to fill it in. ] + @@ -2435,22 +2466,47 @@ Instead, HTML options includes the choice of the HTML template, either available in &app; or custom template defined by you. - View - + View reports represent overall summaries of the database + information available immediately for on-screen viewing. + The following view reports are currently available in &app;: - + + + Number of ancestors + This report displays the number of ancestors of the + active person. + + + Summary of the database + This report displays the overall statistics concerning + number of individuals of each gender, various incomplete entries + statistics, as well as family and media statistics. + + + + Web Page - + + This report generates web pages, either for a selected + individual (active person) or a set of individuals. The options + for this report are broken down into contents, privacy, and advanced + options. The contents options include the filter (determine the + scope of the database to consider), number of generations to consider, + destination directory for the images, and a link to the index page. + Privacy options allow you to omit private records, restrict + information on living people, to skip images (either all or those of + living people), and to omit comments and text in source information. + Finally, the advanced options allow to include optional &app; ID, + create a GENDEX index, and specify the extension of the resulting + files. @@ -2461,6 +2517,10 @@ Running Tools + + Analysis and Exploration