diff --git a/doc/Makefile.in b/doc/Makefile.in index 597e2322e..5ae37e334 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -70,16 +70,13 @@ AWK = @AWK@ BINSH = @BINSH@ CC = @CC@ DEPDIR = @DEPDIR@ -DISABLE_SCROLLKEEPER = @DISABLE_SCROLLKEEPER@ GNOMEHELP = @GNOMEHELP@ GNOMEINC = @GNOMEINC@ GNOMELIB = @GNOMELIB@ GPREF = @GPREF@ -HAVE_JW = @HAVE_JW@ HAVE_PKG_CONFIG = @HAVE_PKG_CONFIG@ INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ INTLLIBS = @INTLLIBS@ -JW = @JW@ LANGUAGES = @LANGUAGES@ LIBS = @LIBS@ MOFILES = @MOFILES@ @@ -97,7 +94,8 @@ PYTHON_PLATFORM = @PYTHON_PLATFORM@ PYTHON_PREFIX = @PYTHON_PREFIX@ PYTHON_VERSION = @PYTHON_VERSION@ RELEASE = @RELEASE@ -SCROLLKEEPER_REQUIRED = @SCROLLKEEPER_REQUIRED@ +SCROLLKEEPER_BUILD_REQUIRED = @SCROLLKEEPER_BUILD_REQUIRED@ +SK_CONFIG = @SK_CONFIG@ STRIP = @STRIP@ SWIG = @SWIG@ VERSION = @VERSION@ @@ -111,12 +109,12 @@ pkgpythondir = @pkgpythondir@ pyexecdir = @pyexecdir@ pythondir = @pythondir@ -SUBDIRS = gramps-manual extending-gramps +SUBDIRS = gramps-manual man_IN_FILES = gramps.1.in man_MANS = ${man_IN_FILES:.1.in=.1} -EXTRA_DIST = $(man_MANS) $(man_IN_FILES) sgmldocs.make +EXTRA_DIST = $(man_MANS) $(man_IN_FILES) xmldocs.make omf.make subdir = doc mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs CONFIG_CLEAN_FILES = diff --git a/doc/gramps-manual/C/gramps-manual/index.html b/doc/gramps-manual/C/gramps-manual/index.html deleted file mode 100644 index 0e1d66245..000000000 --- a/doc/gramps-manual/C/gramps-manual/index.html +++ /dev/null @@ -1,222 +0,0 @@ - -GRAMPS User Manual

GRAMPS User Manual

Copyright © 2001 by Donald N. Allingham


Table of Contents
Introduction
Running GRAMPS for the first time.
Getting Started
People View
Editing a person's data
- - - - - - -

Introduction

-

GRAMPS is an acronym for the - Genealogical Research and Analysis Management Programming System. - It was conceived under the concept that most genealogy programs - were designed to provide the researcher the capability to input - information related to a particular family tree. Most of these - programs have allowed for the arranging and storing of information - consistent with the GEDCOM standards. They usually provide a - means for displaying descendant or ancestral relationships by - means of graphical displays, charts, or reports. These may be - augmented with pictures or other media to enhance the data. Most - provide for inputting data on unconnected individuals/families - that may or may not have a relationship to the primary surname - being researched. Various other enhancements may also be provided - in the genealogical program that allows for different degrees of - importing and exporting data from other programs and printing of - the data contained in the various reports. GRAMPS, on the other - hand, attempts to provide all of the common capabilities of these - programs, but, more importantly, to provide a capability not - common to these programs. This is the ability to input any bits - and pieces of information directly into GRAMPS and - rearrange/manipulate any/all data events in the entire data base - (in any order or sequence) to assist the user in doing research, - analysis and correlation with the potential of filling - relationship gaps. In short, a tool that provides a way to input - all your research into one place and do your analysis and - correlation using the speed, power, and accuracy of your computer - instead of pencils and unmanageable reams of paper. -

-

To run GRAMPS, select - ->Programs+ -+ ->Applications+ -+ ->gramps+ -+ + + + + + - from the Main Menu, or type - gramps on the command line. -

-

This document describes version 0.7.3 of - GRAMPS. -

-
- - - - - - - - - - - -

  Next >>>
  Running GRAMPS for the first time.
\ No newline at end of file diff --git a/doc/gramps-manual/C/gramps-manual/ln7.html b/doc/gramps-manual/C/gramps-manual/ln7.html deleted file mode 100644 index 603ce59c6..000000000 --- a/doc/gramps-manual/C/gramps-manual/ln7.html +++ /dev/null @@ -1,133 +0,0 @@ - -
GRAMPS User Manual

Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation - License, Version 1.1 or any later version - published by the Free Software Foundation with no Invariant Sections, - no Front-Cover Texts, and no Back-Cover Texts. A copy of the license - can be found here. -

-

Many of the names used by companies to distinguish their products and - services are claimed as trademarks. Where those names appear in any - GNOME documentation, and those trademarks are made aware to the members - of the GNOME Documentation Project, the names have been printed in caps - or initial caps. -

-


 Home 
 Up 
\ No newline at end of file diff --git a/doc/gramps-manual/C/gramps-manual/stylesheet-images/caution.gif b/doc/gramps-manual/C/gramps-manual/stylesheet-images/caution.gif deleted file mode 100644 index 542232911..000000000 Binary files a/doc/gramps-manual/C/gramps-manual/stylesheet-images/caution.gif and /dev/null differ diff --git a/doc/gramps-manual/C/gramps-manual/stylesheet-images/home.gif b/doc/gramps-manual/C/gramps-manual/stylesheet-images/home.gif deleted file mode 100644 index 55e1d5993..000000000 Binary files a/doc/gramps-manual/C/gramps-manual/stylesheet-images/home.gif and /dev/null differ diff --git a/doc/gramps-manual/C/gramps-manual/stylesheet-images/important.gif b/doc/gramps-manual/C/gramps-manual/stylesheet-images/important.gif deleted file mode 100644 index 8793ff2b1..000000000 Binary files a/doc/gramps-manual/C/gramps-manual/stylesheet-images/important.gif and /dev/null differ diff --git a/doc/gramps-manual/C/gramps-manual/stylesheet-images/next.gif b/doc/gramps-manual/C/gramps-manual/stylesheet-images/next.gif deleted file mode 100644 index ceb93e120..000000000 Binary files a/doc/gramps-manual/C/gramps-manual/stylesheet-images/next.gif and /dev/null differ diff --git a/doc/gramps-manual/C/gramps-manual/stylesheet-images/note.gif b/doc/gramps-manual/C/gramps-manual/stylesheet-images/note.gif deleted file mode 100644 index 45fe08649..000000000 Binary files a/doc/gramps-manual/C/gramps-manual/stylesheet-images/note.gif and /dev/null differ diff --git a/doc/gramps-manual/C/gramps-manual/stylesheet-images/prev.gif b/doc/gramps-manual/C/gramps-manual/stylesheet-images/prev.gif deleted file mode 100644 index 0894d9ecb..000000000 Binary files a/doc/gramps-manual/C/gramps-manual/stylesheet-images/prev.gif and /dev/null differ diff --git a/doc/gramps-manual/C/gramps-manual/stylesheet-images/tip.gif b/doc/gramps-manual/C/gramps-manual/stylesheet-images/tip.gif deleted file mode 100644 index 025819548..000000000 Binary files a/doc/gramps-manual/C/gramps-manual/stylesheet-images/tip.gif and /dev/null differ diff --git a/doc/gramps-manual/C/gramps-manual/stylesheet-images/toc-blank.gif b/doc/gramps-manual/C/gramps-manual/stylesheet-images/toc-blank.gif deleted file mode 100644 index 6c65e3a19..000000000 Binary files a/doc/gramps-manual/C/gramps-manual/stylesheet-images/toc-blank.gif and /dev/null differ diff --git a/doc/gramps-manual/C/gramps-manual/stylesheet-images/toc-minus.gif b/doc/gramps-manual/C/gramps-manual/stylesheet-images/toc-minus.gif deleted file mode 100644 index 40ebe61e4..000000000 Binary files a/doc/gramps-manual/C/gramps-manual/stylesheet-images/toc-minus.gif and /dev/null differ diff --git a/doc/gramps-manual/C/gramps-manual/stylesheet-images/toc-plus.gif b/doc/gramps-manual/C/gramps-manual/stylesheet-images/toc-plus.gif deleted file mode 100644 index 3e9e7d55a..000000000 Binary files a/doc/gramps-manual/C/gramps-manual/stylesheet-images/toc-plus.gif and /dev/null differ diff --git a/doc/gramps-manual/C/gramps-manual/stylesheet-images/up.gif b/doc/gramps-manual/C/gramps-manual/stylesheet-images/up.gif deleted file mode 100644 index 603c4ce24..000000000 Binary files a/doc/gramps-manual/C/gramps-manual/stylesheet-images/up.gif and /dev/null differ diff --git a/doc/gramps-manual/C/gramps-manual/stylesheet-images/warning.gif b/doc/gramps-manual/C/gramps-manual/stylesheet-images/warning.gif deleted file mode 100644 index 9c1104c2b..000000000 Binary files a/doc/gramps-manual/C/gramps-manual/stylesheet-images/warning.gif and /dev/null differ diff --git a/doc/gramps-manual/C/gramps-manual/t1.html b/doc/gramps-manual/C/gramps-manual/t1.html deleted file mode 100644 index 0e1d66245..000000000 --- a/doc/gramps-manual/C/gramps-manual/t1.html +++ /dev/null @@ -1,222 +0,0 @@ - -GRAMPS User Manual

GRAMPS User Manual

Copyright © 2001 by Donald N. Allingham


Table of Contents
Introduction
Running GRAMPS for the first time.
Getting Started
People View
Editing a person's data
- - - - - - -

Introduction

-

GRAMPS is an acronym for the - Genealogical Research and Analysis Management Programming System. - It was conceived under the concept that most genealogy programs - were designed to provide the researcher the capability to input - information related to a particular family tree. Most of these - programs have allowed for the arranging and storing of information - consistent with the GEDCOM standards. They usually provide a - means for displaying descendant or ancestral relationships by - means of graphical displays, charts, or reports. These may be - augmented with pictures or other media to enhance the data. Most - provide for inputting data on unconnected individuals/families - that may or may not have a relationship to the primary surname - being researched. Various other enhancements may also be provided - in the genealogical program that allows for different degrees of - importing and exporting data from other programs and printing of - the data contained in the various reports. GRAMPS, on the other - hand, attempts to provide all of the common capabilities of these - programs, but, more importantly, to provide a capability not - common to these programs. This is the ability to input any bits - and pieces of information directly into GRAMPS and - rearrange/manipulate any/all data events in the entire data base - (in any order or sequence) to assist the user in doing research, - analysis and correlation with the potential of filling - relationship gaps. In short, a tool that provides a way to input - all your research into one place and do your analysis and - correlation using the speed, power, and accuracy of your computer - instead of pencils and unmanageable reams of paper. -

-

To run GRAMPS, select - ->Programs+ -+ ->Applications+ -+ ->gramps+ -+ + + + + + - from the Main Menu, or type - gramps on the command line. -

-

This document describes version 0.7.3 of - GRAMPS. -

-
- - - - - - - - - - - -

  Next >>>
  Running GRAMPS for the first time.
\ No newline at end of file diff --git a/doc/gramps-manual/C/gramps-manual/x129.html b/doc/gramps-manual/C/gramps-manual/x129.html deleted file mode 100644 index 7c1a96b23..000000000 --- a/doc/gramps-manual/C/gramps-manual/x129.html +++ /dev/null @@ -1,355 +0,0 @@ - -Editing a person's data
GRAMPS User Manual
<<< Previous 

Editing a person's data

-

A person's personal information can be edited in the - Edit Person dialog. -

-

General Information Tab

-
- -

- -

Figure 5. General Information Tab

-

The General Information tab contains the basic information about - the person. This includes the person's name, gender, birth - information, and death information. -

-

If images have been associated with the person, the primary - image is displayed on the right side of the window. -

-
-

Alternate Names Tab

-
- -

- -

Figure 6. Alternate Names Tab

-

It is possible for people to use more than one name during their - lifetime. These may be legal name changes, or just informal - names. An example would be a person changing his or her name due - to marriage or adoption. GRAMPS - allows multiple alternate names to be specified for each person. -

-

The Alternate Names tab allows additional - names to be added or removed from list. Clicking the - Add button allows a new name to be added - to the list. The Edit/View allows the - selected alternate name to be edited. The - Delete button removes the selected name. -

-
-

Events Tab

-

The Events tab allows information about - various events in a person's life to be - recorded. GRAMPS provides a list of - common events, but allows you to name an event anything that you - choose. -

-

An event consists of the name of an event (such as "Baptism" or - "Education"), a date or date range on which the event occurred, - the place where the event occurred, and a description of the - event. A note or a source may also be attached to the event. -

-
- -

- -

Figure 7. Events Tab

-

The Event tab displays information about - the currently selected event at the top of the window. Below - this information is a list of the events that have been - previously entered. Clicking on one of the events in the list - selects the event, and displays its information at the top of - the window. -

-

An event may be added by clicking the Add - button. This displays a form that allows you to enter the - information about the particular event. The - Edit/View button allows to view or to - alter the information of the currently displayed event. The - Delete button allows you to delete the - currently displayed event. -

-
-

Attributes Tab

-

Attributes are similar to events, but are for information items - that do not necessarily have the concept of a place or a - date. An example would be a person's Social Security Number or - national origin. Attributes consist of an attribute name and its - value. -

-

Like events, attributes may also have a note, source, privacy - marker, and confidence level associated with them. -

-
- -

- -

Figure 8. Attributes Tab

-

The Attribute tab displays information - about the currently selected attribute at the top of the - window. Below this information is a list of the attributes that - have been previously entered. Clicking on one of the attributes - in the list selects the attribute, and displays its information at - the top of the window. -

-


<<< PreviousHome 
People View  
\ No newline at end of file diff --git a/doc/gramps-manual/C/gramps-manual/x28.html b/doc/gramps-manual/C/gramps-manual/x28.html deleted file mode 100644 index fad114536..000000000 --- a/doc/gramps-manual/C/gramps-manual/x28.html +++ /dev/null @@ -1,181 +0,0 @@ - -Running GRAMPS for the first time.
GRAMPS User Manual
<<< PreviousNext >>>

Running GRAMPS for the first time.

-

The first time you run the program, - GRAMPS will display its Getting Started - screens. -

-
- -

- -

Figure 1. Getting Started screen, page 1

-

GRAMPS will guide you through a few pages - that prompt you for some setup information. The information it requests - includes information about yourself and your preferences. -

-

Although GRAMPS requests information about - your, 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 chose, you may leave the information empty. -

-

<<< PreviousHomeNext >>>
GRAMPS User Manual Getting Started
\ No newline at end of file diff --git a/doc/gramps-manual/C/gramps-manual/x41.html b/doc/gramps-manual/C/gramps-manual/x41.html deleted file mode 100644 index 7f093481a..000000000 --- a/doc/gramps-manual/C/gramps-manual/x41.html +++ /dev/null @@ -1,306 +0,0 @@ - -Getting Started
GRAMPS User Manual
<<< PreviousNext >>>

Getting Started

-

Starting GRAMPS opens the - Main window, shown in . You will be prompted to either open an - existing database, or to create a new - database. GRAMPS requires that a - database always be open. -

-
- -

- -

Figure 2. GRAMPS Main Window

-

Importing data

-

If you already have a family file created using another - genealogy program you can import your GEDCOM file into GRAMPS. - To do this you select +File+ -+ + + + + + ->Import+ ->Import from - GEDCOM+ . The GEDCOM - Import box will open. Select New - Database and click the - Browse... button to select your saved - GEDCOM file (filename.ged). Click - OK to select the file and then click - OK to import the file. The - GEDCOM Import Status will tell you what - the importer is doing and a little bit about your file (file - location, which program created it, the version, Encoding, - Number of Families, Number of People, and the Number of Errors). - Once the Importer is done, you can click - Close and start editing/adding to your - file. -

-
-

Entering Data

-

If you have never used a genealogy program or you do not have a - GEDCOM file to import, you can start creating your database - right away. From the main window click the Add - Person button and the Edit - Person dialog will open. Enter in the information - you have on the first person. Start with their general - information (Name, Birth and Death Date/Place) and then move on - to the Names, - Events, - Attributes, - Addresses, Notes, - Gallery, and - Internet tabs and fill in the known - information you have. Some of the information you enter has a - Source button and/or a - Note button. These buttons are there to - add more information (Source button to - add the source of where you acquired the information and the - Note button to add more detail to the - information) -

-
-

<<< PreviousHomeNext >>>
Running GRAMPS for the first time. People View
\ No newline at end of file diff --git a/doc/gramps-manual/C/gramps-manual/x84.html b/doc/gramps-manual/C/gramps-manual/x84.html deleted file mode 100644 index 321eb135d..000000000 --- a/doc/gramps-manual/C/gramps-manual/x84.html +++ /dev/null @@ -1,334 +0,0 @@ - -People View
GRAMPS User Manual
<<< PreviousNext >>>

People View

-

The People View window is the initial view seen on the main - window. It displays the name, gender, birth date, and death - date of all individuals in the database. At any time, you can - return to this view either by pressing the - People button at the top of the screen, or - by choosing the - + + + + + + + +View+ -+ + + + + + + + ->People+ + -+ + + + + + - entry from the menus. -

-
- -

- -

Figure 3. People View

-

Selecting and Editing Individuals

-

The People View lists the individuals in the database. An - individual can be selected as the active person by clicking on - an entry in the list. Once a person has been selected as the - active person, the person's name appears in the status bar in - the lower left hand corner of the window. -

-

Once the active person has been selected, pressing the - Edit Person button will display the - Edit Person dialog allowing you to edit - the individual's personal information. If the Edit - Person button is pressed without an active person - being set, a blank Edit Person dialog is - presented, allowing you to enter a new person. -

-

Double-clicking on a entry in the list will set the active - person and bring up the individual in the Edit - Person dialog. -

-

Pressing the Add Person button will - display a blank Edit Person dialog, - allowing you to add a new person to the database. -

-

If the Delete Person button is pressed, - the active person and all of the personal information related to - the active person are removed from the database. -

-
-

Applying Filters

-

GRAMPS allows you to apply filters to - the People View. When a filter is applied, the People View will - only display the entries matching the filter. All of the entries - remain in the database, but some entries may be temporarily hidden. -

-

There are up to three parts to a filter. The first part is the - selection of the filter to be applied. A filter is selected from - the option menu directly above the People View. The second part - is an optional argument. This qualifier provides more specific - information for the filter. Many filters do not require the - argument, and it will not be displayed if it is not needed. If - the argument is required, a text box with a descriptive label - will appear. The third part of the filter is the invert - selection. When this option is selected, - GRAMPS will display the entries that - do not match the filter. -

-
- -

- -

Figure 4. Filter that requires an argument

-

A filter is not applied until the Apply - button is pressed. The filter will remain in effect until the - next time the Apply button is pressed. -

-
-

Sorting

-

Four columns are shown in the People View display. The entries - in the list can be sorted by three of the fields: Name, Birth - Date, or Death Date. Clicking on the column label will cause - the list to be re-sorted by that column. Arrows on the label - indicate whether the list is sorted by ascending or descending - order. -

-

If the list is already sorted by a particular column, clicking - on the same column label will switch the sorting order. For - example, if the list is currently sorted in ascending order by - Name, clicking on the Name column header will re-sort the list - in descending order. -

-
-

<<< PreviousHomeNext >>>
Getting Started Editing a person's data
\ No newline at end of file diff --git a/doc/gramps-manual/Makefile.in b/doc/gramps-manual/Makefile.in index 405b7a4f8..d3f5a34ac 100644 --- a/doc/gramps-manual/Makefile.in +++ b/doc/gramps-manual/Makefile.in @@ -70,16 +70,13 @@ AWK = @AWK@ BINSH = @BINSH@ CC = @CC@ DEPDIR = @DEPDIR@ -DISABLE_SCROLLKEEPER = @DISABLE_SCROLLKEEPER@ GNOMEHELP = @GNOMEHELP@ GNOMEINC = @GNOMEINC@ GNOMELIB = @GNOMELIB@ GPREF = @GPREF@ -HAVE_JW = @HAVE_JW@ HAVE_PKG_CONFIG = @HAVE_PKG_CONFIG@ INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ INTLLIBS = @INTLLIBS@ -JW = @JW@ LANGUAGES = @LANGUAGES@ LIBS = @LIBS@ MOFILES = @MOFILES@ @@ -97,7 +94,8 @@ PYTHON_PLATFORM = @PYTHON_PLATFORM@ PYTHON_PREFIX = @PYTHON_PREFIX@ PYTHON_VERSION = @PYTHON_VERSION@ RELEASE = @RELEASE@ -SCROLLKEEPER_REQUIRED = @SCROLLKEEPER_REQUIRED@ +SCROLLKEEPER_BUILD_REQUIRED = @SCROLLKEEPER_BUILD_REQUIRED@ +SK_CONFIG = @SK_CONFIG@ STRIP = @STRIP@ SWIG = @SWIG@ VERSION = @VERSION@ diff --git a/doc/gramps.sgml b/doc/gramps.sgml deleted file mode 100644 index 3f2beee0d..000000000 --- a/doc/gramps.sgml +++ /dev/null @@ -1,793 +0,0 @@ - -]> - - - - - - - - - -
- - - gramps User Manual - - 2001 - Donald N. Allingham - - - - - - - - - - - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation - License, Version 1.1 or any later version - published by the Free Software Foundation with no Invariant Sections, - no Front-Cover Texts, and no Back-Cover Texts. A copy of the license - can be found here. - - - Many of the names used by companies to distinguish their products and - services are claimed as trademarks. Where those names appear in any - GNOME documentation, and those trademarks are made aware to the members - of the GNOME Documentation Project, the names have been printed in caps - or initial caps. - - - - - - - - - - - - - - - - - - - - This is version 1.0 of the gramps manual. - - - - - - - - - Introduction - - - gramps is an acronym for the Genealogical Research and Analysis - Management Programming System. It was conceived under the concept - that most genealogy programs were designed to provide the - researcher the capability to input information related to a - particular family tree. Most of these programs have allowed for - the arranging and storing of information consistent with the - GEDCOM standards. They usually provide a means for displaying - descendant or ancestral relationships by means of graphical - displays, charts, or reports. These may be augmented with - pictures or other media to enhance the data. Most provide for - inputting data on unconnected individuals/families that may or may - not have a relationship to the primary surname being researched. - Various other enhancements may also be provided in the - genealogical program that allows for different degrees of - importing and exporting data from other programs and printing of - the data contained in the various reports. gramps, on the other - hand, attempts to provide all of the common capabilities of these - programs, but, more importantly, to provide a capability not - common to these programs. This is the ability to input any bits - and pieces of information directly into gramps and - rearrange/manipulate any/all data events in the entire data base - (in any order or sequence) to assist the user in doing research, - analysis and correlation with the potential of filling - relationship gaps. In short, a tool that provides a way to input - all your research into one place and do your analysis and - correlation using the speed, power, and accuracy of your computer - instead of pencils and unmanageable reams of paper. - - - To run gramps, select - - Programs - Applications - gramps - - from the Main Menu, or type - gramps on the command line. - - - gramps is included in the - gramps package, which is part of the - GNOME desktop environment. This document describes version - &version; of gramps. - - - - - - - - Using gramps - - gramps is a genealogy program. - This section describes basic usage of - gramps. - - - - - Running gramps for the first time. - - This section should discuss the start up druid. - - - - - Main Window - - Starting gramps opens the - Main window, shown in . The window is at first empty. - - -
- gramps Main Window - - gramps Main Window - - - -
- -
-
- - - - Person List - - The Person List window is the initial view seen on the main - window. It displays the name, gender, birth date, and death - date of all individuals in the database. At any time, you can - return to the this view either by pressing the People button at - the top of the screen, or by choosing the - - View - Person List - - entry from the menus. - - - Selecting and Editing Individuals - - The Person List view lists the individuals in the database. A - individual can be selected as the active person by clicking on - an entry in the list. Once a person has been selected as the active - person, the person's name appears in the status bar in the lower - left hand corner of the window. - - - Once the active person has been selected, pressing the Edit - Person button will display the Edit Person dialog allowing you - to edit the individual's personal information. If the Edit - Person button is pressed without an active person being set, a - blank Edit Person dialog is presented, allowing you to enter a - new person. Double-clicking on a entry will set the active - person and bring up the individual in the Edit Person dialog. - - - Pressing the Add Person button will display a blank Edit Person - dialog, allowing you to add a new person to the database. - - - If the Delete Person button is pressed, the active person and - all of the personal information related to the active person are - removed from the database. - - - - Applying Filters - - gramps allows you to apply filters to - the Person List. When a filter is applied, the Person List will - only display the entries matching the filter. All of the entries - remain in the database, but are temporarily hidden. - - - There are three parts to a filter. The first part is the - selection of the filter to be applied. A filter is selected from - the option menu directly above the Person List. The second part - is an option qualifier. This qualifier provides more specific - information for the filter. Many filters do not require the - qualifier, and it will be grayed out if not needed. The third - part of the filter is the invert selection. When this option is - selected, gramps will display the - entries that do not match the filter. - - - A filter is not applied until the Apply button is pressed. The - filter will remain in effect until the next time the Apply - button is pressed. - - - - Sorting - - Four columns are shown in the Person List display. The entries in - the list can be sorted by three of the field: Name, Birth Date, or - Death Date. Clicking on the column label will cause the list to - be resorted by that column. Arrows on the label indicate whether - the list is sort by ascending or descending order. - - - If the list is already sorted by a particular column, clicking on - the same column label will switch sorting order. For example, if - the list is currently sorted in ascending order by Name, clicking - on the Name column header will resort the list in descending order. - - - - - - - Family View - - The Family View window displays the spouses, parents, and children - of the active person. At any time, you can return to the this view - either by pressing the Family button at the top of the screen, or - by choosing the - - View - Family View - - entry from the menus. - - - This section should describe the family view. - - - - - Pedegree View - - The Pedegree View window displays the active person, the active - person's parents, and the active parent's grandparents in a somewhat - graphical manner. At any time, you can return to the this view - either by pressing the Pedegree button at the top of the screen, or - by choosing the - - View - Pedgree - - entry from the menus. - - - This section should describe the pedegree view. - - - - - Source List - - The Source List window displays the different sources which have been - entered into the database. At any time, you can return to the this view - either by pressing the Sources button at the top of the screen, or - by choosing the - - View - Sources - - entry from the menus. - - - This section should describe the source list. - - - - - - - Customization - - To change the application settings, select - - Settings - Preferences... - . This opens the - Preferences dialog, shown in . - - -
- Preferences Dialog - - Preferences Dialog - - - -
- - - - -
- - - - - Generating Reports - - gramps can produce a wide variety of - reports. New report generators can be written by the user without - modifying the main program. For this reason, there may be more - reports available than are documented by this manual - - - Unlike many genealogy programs, gramps - does not directly print reports. Instead, - gramps produces reports in formats that - are understood by other programs. These formats include OpenOffice, - AbiWord, PDF, and HTML, among others. This allows the generated - reports to be modified after they are generated, stored for use - later, or emailed to another person. - - - Using HTML templates - - Many programs exist to convert GEDCOM files into HTML files that - can be viewed in a web browser. Most of these programs generate - HTML files according to their own predefined style. Since most - people have a style that they prefer, they are left with the option - of modifying hundreds of files by hand. - - - To solve this problem, gramps allows the - user to specify a template to be used for generating HTML files. At - the time the report is generated, if HTML is selected as the target - format, the user can select an HTML template to be used. Since the - template is chosen at report generation time, a different template - may be chosen each time, allowing the user to change the appearence - of the generated files at any time. Nearly any existing HTML file - can be used as an HTML template for - gramps. - - - When a file has been established as the HTML template file, - gramps uses the template for each file - that it generates. gramps starts each - file by copying data from the template until it reaches an HTML - comment uses as a marker. At that point, - gramps inserts its data into the output - file. gramps the continues reading the - until it reaches a second comment that tells it to resume copying - from the template. - - - gramps uses the string <!-- - START --> to indicate where it should start inserting - its information, and the string <!-- STOP - --> to indicate where it should resume copying data - from the template. The effect is that - gramps will create a new document, - replacing everything between the <!-- START - --> and <!-- STOP --> comments - with the report information. - - - The comment markers should be at the beginning of a line in the HTML - template file. Adding the comments to an existing HTML document will - not affect the original HTML document in any way. - - - If no HTML template is specified, or if the specified template - cannot be read, gramps will use a - default, predefined template. - - -
- Sample HTML Template Example - -<HTML> -<HEAD> -<TITLE> -This is my Title -</TITLE> -</HEAD> -<BODY BGCOLOR="#FFFFFF"> -<P> -This is a simple template. This text will appear in the html output. -</P> -<!-- START --> -<P> -This is where gramps will place its report information. Any -information between the two comments, including this paragraph, -will not appear in the gramps generated output. -</P> -<!-- STOP --> -<P> -This text, since it appears after the stop comment, will also -appear in every gramps generated file. -</P> -</BODY> -</HTML> - -
-
-
- -
- - - - - Writing Filters - - Users can create their own filters and add them to - gramps. By adding the filter to the - user's private filter directory - (~/.gramps/filters), - the filter will be automatically - recognized the next time that the program is started. - - - Creating a filter - - Filters are written in the python - language. Each filter is initialized with the qualifier string. - The qualifier string passes an additional text string to the - filter. This string can be used to further qualify the filter. - For example, if the filter is used to match names, the qualifier - would be used to provide the name that is being compared against. - - - Each filter is a python class, and should be in its own separate - module (file). The module should consist of the filter class - definition, and three functions — - create, need_qualifier, - and get_name. - - - The create function takes a string as its - only argument, returns a instance of the filter class. The string - argument is the qualifier string used to provide more specific - information. - - - The need_qualifier function takes no - arguments, and returns either a 0 or 1 to indicate if a qualifier - string is needed by the filter. Regardless of what - need_qualifier indicates, a text string is - always passed to the filter and the create - function. The value returned by - need_qualifier indicates to the program - whether or not the qualifier field in the display should be - enabled or disabled. - - - The get_name function is used to provide a - description for the filter. This description is entered into - filter selection menus. If the filter is intended to be used by - others, it should be prepared for internationalization. This is - accomplished by importing the intl module, - add defining _ to be - intl.gettext. The string returned by - get_name should be passed through the - _ function to allow for conversion to the - target langauge. - - - All filters must be derived from the - Filter.Filter class. The - __init__ task may be overridden, but if so, - should call the __init__ function on the - Filter.Filter class. The parent class - provides the variable self.text, which - contains the text string passed as the qualifier. - - - All filter classes must define a match - function. The function takes one argument (other than - self), which is an object of type - Person to compare against. The function - should return a 1 if the person matches the filter, or a zero if - the person does not. - -
- Sample filter implementation - -import Filter -import string -import intl -_ = intl.gettext - -# class definition - -class SubString(Filter.Filter): - - def match(self,person): - name = person.getPrimaryName().getName() - return string.find(name,self.text) >= 0 - -# module functions - -def get_name(s): - return _("Names that contain a substring") - -def create(text): - return SubString(text) - -def need_qualifier(): - return 1 - -
-
-
- - - - - Writing Reports - - Users can create their own report generators and add them to - gramps. By adding the report generator - to the user's private filter directory (~/.gramps/plugins), the report - generator filter will be automatically recognized the next time - that the program is started. - - - Creating a report generator - - Like filters, report generators are written in the - python language. Fewer restrictions - are made on report generators than on filters. The report - generator is passed the current gramps - database and the active person. The generator needs to take - special care to make sure that it does not alter the database in - anyway. - - - The function get_name is used to provide the - name of the the report generator. As with a filter definition, - this string should support internationalization via the - intl module. The returned string consists of - two parts, separated by a forward slash. The first part of the - string is the category of the report generator. - gramps uses this part to group similar - reports together in the interface. The second part of the string - is the actual name of the reprot generator, and will be displayed - in the report menu. - - - A report generator module must supply the - report function, and can optionally define - the get_description and - get_xpm_data functions. The - report takes two arguments — a database - (of type RelDataBase) and the currently - selected person (of type Person). The - report is reponsible for generating the - actual report. - - - If the get_description is defined, it is used - to provide a more detailed description of the report. The - description is used to provide the user with more information in - the report selection window. The function takes no arguments, and - should return a text string. - - - If the get_xpm_data is defined, it is used to - provide an graphic logo for the report in the report selection - window. The function takes no arguments, and should return a list - of strings containing the XPM file data. The XPM image should be - 48x48 pixels in size. - -
- Sample report implementation - -import intl -_ = intl.gettext - -def report(database,person): - ... actual code ... - -def get_description(): - return "A detailed text description of what the report generator does" - -def get_name(): - return _("Category/report name") - -def get_xpm_image(): - return [ - "... XPM image data" - ] - -
-
- - A little help - Format Interfaces - - gramps provides some help with writing - reports. Several generic python classes exist that aid in the - writing of report generators. These classes provide an abstract - interface for a type of document, such as a drawing, word - processor document, or a spreadsheet. From these core classes, - gramps derives interfaces to various - document formats. This means that by coding to the generic word - processing class (TextDoc), a report - generator can instant access to multiple file formats (such as - HTML, OpenOffice, and AbiWord). - - - This scheme of deriving a output format from a generic base class - also makes it easier to add new formats. Creating a new - derivied class targeting a different format (such as - KWord or - LaTeX) makes it easy for existing - report generators to use the new formats. - - -
- - - - - Writing Tools - - - - - - - - - - - - - - Known Bugs and Limitations - - This application has no known bugs. - - - - - - - - Authors - - gramps was written by Donald N. Allingham - (donaldallingham@home.com). To find more information about - gramps, please visit the gramps Web - page. - - - - This manual was written by Donald N. Allingham - (donaldallingham@home.com) and Lawrence L. Allingham - (llkla@erinet.com). - - - - - - - - - - - License - - This program is free software; you can redistribute it and/or - modify it under the terms of the - GNU General Public License as - published by the Free Software Foundation; - either version 2 of the License, or (at your option) any later - version. - - - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - - A copy of the GNU General Public License is - included as an appendix to the GNOME Users - Guide. You may also obtain a copy of the - GNU General Public License from the Free - Software Foundation by visiting their Web site or by writing to -
- Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307 - USA -
-
-
-
- - - - - - - - - diff --git a/doc/sgmldocs.make b/doc/sgmldocs.make deleted file mode 100644 index a5e087a5f..000000000 --- a/doc/sgmldocs.make +++ /dev/null @@ -1,155 +0,0 @@ -# To use this template: -# 1) Define: figs, docname, lang, omffile, sgml_ents although figs, -# omffile, and sgml_ents may be empty in your Makefile.am which -# will "include" this one -# 2) Figures must go under figures/ and be in PNG format -# 3) You should only have one document per directory -# -# Note that this makefile forces the directory name under -# $prefix/share/gnome/help/ to be the same as the SGML filename -# of the document. This is required by GNOME. eg: -# $prefix/share/gnome/help/fish_applet/C/fish_applet.sgml -# ^^^^^^^^^^^ ^^^^^^^^^^^ -# Definitions: -# figs A list of screenshots which will be included in EXTRA_DIST -# Note that these should reside in figures/ and should be .png -# files, or you will have to make modifications below. -# docname This is the name of the SGML file: .sgml -# lang This is the document locale -# omffile This is the name of the OMF file. Convention is to name -# it -.omf. -# sgml_ents This is a list of SGML entities which must be installed -# with the main SGML file and included in EXTRA_DIST. -# eg: -# figs = \ -# figures/fig1.png \ -# figures/fig2.png -# docname = scrollkeeper-manual -# lang = C -# omffile=scrollkeeper-manual-C.omf -# sgml_ents = fdl.sgml -# include $(top_srcdir)/help/sgmldocs.make -# dist-hook: app-dist-hook -# - -docdir = $(datadir)/gnome/help/$(docname)/$(lang) - -doc_DATA = index.html - -sgml_files = $(sgml_ents) $(docname).sgml - -omf_dir=$(top_srcdir)/omf-install - -EXTRA_DIST = $(sgml_files) $(doc_DATA) $(omffile) $(figs) - -CLEANFILES = omf_timestamp - -# when doing a distclean, we also want to clear out html files: -CONFIG_CLEAN_FILES = index.html $(docname)/*.html $(docname)/stylesheet-images/*.gif - -all: index.html omf - -omf: omf_timestamp - -omf_timestamp: $(omffile) - -for file in $(omffile); do \ - scrollkeeper-preinstall $(docdir)/$(docname).sgml $$file $(omf_dir)/$$file; \ - done - touch omf_timestamp - -index.html: $(docname)/index.html - -cp $(docname)/index.html . - - -# The weird srcdir trick is because the db2html from the Cygnus RPMs -# cannot handle relative filenames. -# The t1 test is for certain versions of jw that create cryptic -# html pages, o fwhich the index is called "t1". Also, the jw -# script from docbook-utils 0.6.9 does not copy the template -# stylesheet-images directory like the db2html script does, so -# we give it a little help (at least for now) - -$(docname)/index.html: $(docname).sgml - -srcdir=`cd $(srcdir) && pwd`; \ - if test "$(HAVE_JW)" = 'yes' ; then \ - if test -f /usr/share/sgml/docbook/dsssl-stylesheets/images/next.gif ; then \ - mkdir -p $$srcdir/$(docname)/stylesheet-images ; \ - cp /usr/share/sgml/docbook/dsssl-stylesheets/images/*.gif $$srcdir/$(docname)/stylesheet-images/ ; \ - fi; \ - jw -c /etc/sgml/catalog $$srcdir/$(docname).sgml -o $$srcdir/$(docname); \ - else \ - db2html $$srcdir/$(docname).sgml; \ - fi - if test -f $(docname)/t1.html; then \ - cd $(srcdir)/$(docname) && cp t1.html index.html; \ - cd $(srcdir); \ - fi - -$(docname).sgml: $(sgml_ents) - -ourdir=`cd . && pwd`; \ - cd $(srcdir); \ - cp $(sgml_ents) $$ourdir - -app-dist-hook: index.html - -$(mkinstalldirs) $(distdir)/$(docname)/stylesheet-images - -$(mkinstalldirs) $(distdir)/figures - -cp $(srcdir)/$(docname)/*.html $(distdir)/$(docname) - -for file in $(srcdir)/$(docname)/*.css; do \ - basefile=`echo $$file | sed -e 's,^.*/,,'`; \ - cp $$file $(distdir)/$(docname)/$$basefile ; \ - done - -for file in $(srcdir)/$(docname)/stylesheet-images/*.gif; do \ - basefile=`echo $$file | sed -e 's,^.*/,,'`; \ - cp $$file $(distdir)/$(docname)/stylesheet-images/$$basefile ; \ - done - -if [ -e topic.dat ]; then \ - cp $(srcdir)/topic.dat $(distdir); \ - fi - -install-data-am: index.html omf - -$(mkinstalldirs) $(DESTDIR)$(docdir)/stylesheet-images - -$(mkinstalldirs) $(DESTDIR)$(docdir)/figures - -cp $(srcdir)/$(sgml_files) $(DESTDIR)$(docdir) - -for file in $(srcdir)/$(docname)/*.html $(srcdir)/$(docname)/*.css; do \ - basefile=`echo $$file | sed -e 's,^.*/,,'`; \ - $(INSTALL_DATA) $$file $(DESTDIR)$(docdir)/$$basefile; \ - done - -for file in $(srcdir)/figures/*.png; do \ - basefile=`echo $$file | sed -e 's,^.*/,,'`; \ - $(INSTALL_DATA) $$file $(DESTDIR)$(docdir)/figures/$$basefile; \ - done - -for file in $(srcdir)/$(docname)/stylesheet-images/*.gif; do \ - basefile=`echo $$file | sed -e 's,^.*/,,'`; \ - $(INSTALL_DATA) $$file $(DESTDIR)$(docdir)/stylesheet-images/$$basefile; \ - done - -if [ -e $(srcdir)/topic.dat ]; then \ - $(INSTALL_DATA) $(srcdir)/topic.dat $(DESTDIR)$(docdir); \ - fi - -$(docname).ps: $(srcdir)/$(docname).sgml - -srcdir=`cd $(srcdir) && pwd`; \ - db2ps $$srcdir/$(docname).sgml - -$(docname).rtf: $(srcdir)/$(docname).sgml - -srcdir=`cd $(srcdir) && pwd`; \ - db2ps $$srcdir/$(docname).sgml - -uninstall-local: - -for file in $(srcdir)/$(docname)/stylesheet-images/*.gif; do \ - basefile=`echo $$file | sed -e 's,^.*/,,'`; \ - rm -f $(docdir)/stylesheet-images/$$basefile; \ - done - -for file in $(srcdir)/figures/*.png; do \ - basefile=`echo $$file | sed -e 's,^.*/,,'`; \ - rm -f $(docdir)/figures/$$basefile; \ - done - -for file in $(srcdir)/$(docname)/*.html $(srcdir)/$(docname)/*.css; do \ - basefile=`echo $$file | sed -e 's,^.*/,,'`; \ - rm -f $(DESTDIR)$(docdir)/$$basefile; \ - done - -for file in $(sgml_files); do \ - rm -f $(DESTDIR)$(docdir)/$$file; \ - done - -rmdir $(DESTDIR)$(docdir)/stylesheet-images - -rmdir $(DESTDIR)$(docdir)/figures - -rmdir $(DESTDIR)$(docdir)