<!DOCTYPE article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
<!ENTITY version "0.7.3"> <!-- replace with application version -->
]>
<!-- =============Document Header ============================= -->
<article id="index"> <!-- please do not change the id -->
<artheader>
<title>GRAMPS User Manual</title>
<copyright>
<year>2001</year>
<holder>Donald N. Allingham</holder>
</copyright>
<!-- translators: uncomment this:
<copyright>
<year>2001</year>
<holder>ME-THE-TRANSLATOR (Latin translation)</holder>
</copyright>
-->
<!-- do not put authorname in the header except in copyright - use
section "authors" below -->
<!-- Use this legal notice for online documents which depend on -->
<!-- core GNOME packages. -->
<legalnotice id="legalnotice">
<para>
Permission is granted to copy, distribute and/or modify this document
under the terms of the <ulink type="help"
url="gnome-help:fdl"><citetitle>GNU Free Documentation
License</citetitle></ulink>, 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 <ulink type="help" url="gnome-help:fdl">here</ulink>.
</para>
<para>
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.
</para>
</legalnotice>
<!-- Use this legal notice for documents which are placed on -->
<!-- the web, shipped in any way other than online documents -->
<!-- (eg. PS, PDF, or RTF), or which do not depend on the -->
<!-- core GNOME distribution. -->
<!-- -->
<!-- If you use this version, you must place the following -->
<!-- line in the document declaration at the top of your -->
<!-- document: -->
<!-- <!ENTITY FDL SYSTEM "fdl.sgml"> -->
<!-- and the following line at the bottom of your document -->
<!-- after the last </sect1>. -->
<!-- &FDL; -->
<!--
<legalnotice id="legalnotice">
<para>
Permission is granted to copy, distribute and/or modify this document
under the terms of the <link linkend="fdl"><citetitle>GNU
Free Documentation License</citetitle></link>, 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 in <xref linkend="fdl">.
</para>
<para>
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.
</para>
</legalnotice>
-->
<!-- This is the manual version, not application version. -->
<releaseinfo>
This is version 1.1 of the GRAMPS manual.
</releaseinfo>
</artheader>
<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
<sect1 id="intro">
<title>Introduction</title>
<para>
<application>GRAMPS</application> 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.
</para>
<para>
To run <application>GRAMPS</application>, select
<menuchoice>
<guisubmenu>Programs</guisubmenu>
<guisubmenu>Applications</guisubmenu>
<guimenuitem>gramps</guimenuitem>
</menuchoice>
from the <guimenu>Main Menu</guimenu>, or type
<command>gramps</command> on the command line.
</para>
<para>
This document describes version &version; of
<application>GRAMPS</application>.
</para>
</sect1>
<!-- ================ Usage ================================ -->
<!-- This section should describe basic usage of the application. -->
<sect1 id="firsttime">
<title>Running GRAMPS for the first time.</title>
<para>
The first time you run the program,
<application>GRAMPS</application> will display its Getting Started
screens.
</para>
<figure id="druidpg1">
<title>Getting Started screen, page 1</title>
<screenshot>
<screeninfo>Getting Started screen, page 1</screeninfo>
<graphic fileref="figures/druidpg1" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
<application>GRAMPS</application> 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.
</para>
<para>
Although <application>GRAMPS</application> 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 file"s
creator. If you chose, you may leave the information empty.
</para>
</sect1>
<sect1 id="gettingstarted">
<title>Getting Started</title>
<para>
Starting <application>GRAMPS</application> opens the
<interface>Main window</interface>, shown in <xref
linkend="mainwindow-fig">. You will be prompted to either open an
existing database, or to create a new
database. <application>GRAMPS</application> requires that a
database always be open.
</para>
<figure id="mainwindow-fig">
<title>GRAMPS Main Window</title>
<screenshot>
<screeninfo>GRAMPS Main Window</screeninfo>
<graphic fileref="figures/mainwin" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<sect2 id="startimport">
<title>Importing data</title>
<para>
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 <menuchoice> <guimenu>File</guimenu>
<guisubmenu>Import</guisubmenu> <guimenuitem>Import from
GEDCOM</guimenuitem> </menuchoice>. The <interface>GEDCOM
Import</interface> box will open. Select <guibutton>New
Database</guibutton> and click the
<guibutton>Browse...</guibutton> button to select your saved
GEDCOM file (<replaceable>filename.ged</replaceable>). Click
<guibutton>OK</guibutton> to select the file and then click
<guibutton>OK</guibutton> to import the file. The
<interface>GEDCOM Import Status</interface> 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
<guibutton>Close</guibutton> and start editing/adding to your
file.
</para>
</sect2>
<sect2 id="noimport">
<title>Entering Data</title>
<para>
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 <guibutton>Add
Person</guibutton> button and the <interface>Edit
Person</interface> 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 <interface>Names</interface>,
<interface>Events</interface>,
<interface>Attributes</interface>,
<interface>Addresses</interface>, <interface>Notes</interface>,
<interface>Gallery</interface>, and
<interface>Internet</interface> tabs and fill in the known
information you have. Some of the information you enter has a
<guibutton>Source</guibutton> button and/or a
<guibutton>Note</guibutton> button. These buttons are there to
add more information (<guibutton>Source</guibutton> button to
add the source of where you acquired the information and the
<guibutton>Note</guibutton> button to add more detail to the
information)
</para>
</sect2>
</sect1>
<!-- ========= Basic Usage =========================== -->
<sect1 id="personlist">
<title>People View</title>
<para>
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
<guibutton>People</guibutton> button at the top of the screen, or
by choosing the
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>People</guimenuitem>
</menuchoice>
entry from the menus.
</para>
<figure id="peopleview-fig">
<title>People View</title>
<screenshot>
<screeninfo>People View</screeninfo>
<graphic fileref="figures/peoplelist" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<sect2 id="seleditindv">
<title>Selecting and Editing Individuals</title>
<para>
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.
</para>
<para>
Once the active person has been selected, pressing the
<guibutton>Edit Person</guibutton> button will display the
<interface>Edit Person</interface> dialog allowing you to edit
the individual's personal information. If the <guibutton>Edit
Person</guibutton> button is pressed without an active person
being set, a blank <interface>Edit Person</interface> dialog is
presented, allowing you to enter a new person.
</para>
<para>
Double-clicking on a entry in the list will set the active
person and bring up the individual in the <interface>Edit
Person</interface> dialog.
</para>
<para>
Pressing the <guibutton>Add Person</guibutton> button will
display a blank <interface>Edit Person</interface> dialog,
allowing you to add a new person to the database.
</para>
<para>
If the <guibutton>Delete Person</guibutton> button is pressed,
the active person and all of the personal information related to
the active person are removed from the database.
</para>
</sect2>
<sect2>
<title>Applying Filters</title>
<para>
<application>GRAMPS</application> 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.
</para>
<para>
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,
<application>GRAMPS</application> will display the entries that
do not match the filter.
</para>
<figure id="filter-fig">
<title>Filter that requires an argument</title>
<screenshot>
<screeninfo>Filter that requires an argument</screeninfo>
<graphic fileref="figures/filter" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
A filter is not applied until the <guibutton>Apply</guibutton>
button is pressed. The filter will remain in effect until the
next time the <guibutton>Apply</guibutton> button is pressed.
</para>
</sect2>
<sect2>
<title>Sorting</title>
<para>
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.
</para>
<para>
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.
</para>
</sect2>
</sect1>
<sect1 id="editpersondata">
<title>Editing a person's data</title>
<para>
A person's personal information can be edited in the
<interface>Edit Person</interface> dialog.
</para>
<sect2>
<title>General Information Tab</title>
<figure id="ep-general-fig">
<title>General Information Tab</title>
<screenshot>
<screeninfo>General Information Tab</screeninfo>
<graphic fileref="figures/ep-general" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
The General Information tab contains the basic information about
the person. This includes the person's name, gender, birth
information, and death information.
</para>
<para>
If images have been associated with the person, the primary
image is displayed on the right side of the window.
</para>
</sect2>
<sect2>
<title>Alternate Names Tab</title>
<figure id="ep-names-fig">
<title>Alternate Names Tab</title>
<screenshot>
<screeninfo>Alternate Names Tab</screeninfo>
<graphic fileref="figures/ep-altname" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
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. <application>GRAMPS</application>
allows multiple alternate names to be specified for each person.
</para>
<para>
The <interface>Alternate Names</interface> tab allows additional
names to be added or removed from list. Clicking the
<guibutton>Add</guibutton> button allows a new name to be added
to the list. The <guibutton>Edit/View</guibutton> allows the
selected alternate name to be edited. The
<guibutton>Delete</guibutton> button removes the selected name.
</para>
</sect2>
<sect2 id="eventtab">
<title>Events Tab</title>
<para>
The <interface>Events</interface> tab allows information about
various events in a person's life to be
recorded. <application>GRAMPS</application> provides a list of
common events, but allows you to name an event anything that you
choose.
</para>
<para>
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.
</para>
<figure id="ep-event-fig">
<title>Events Tab</title>
<screenshot>
<screeninfo>Events Tab</screeninfo>
<graphic fileref="figures/ep-event" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
The <interface>Event</interface> 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.
</para>
<para>
An event may be added by clicking the <guibutton>Add</guibutton>
button. This displays a form that allows you to enter the
information about the particular event. The
<guibutton>Edit/View</guibutton> button allows to view or to
alter the information of the currently displayed event. The
<guibutton>Delete</guibutton> button allows you to delete the
currently displayed event.
</para>
</sect2>
<sect2 id="attrtab">
<title>Attributes Tab</title>
<para>
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.
</para>
<para>
Like events, attributes may also have a note, source, privacy
marker, and confidence level associated with them.
</para>
<figure id="ep-attributes-fig">
<title>Attributes Tab</title>
<screenshot>
<screeninfo>Attributes Tab</screeninfo>
<graphic fileref="figures/ep-attributes" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
The <interface>Attribute</interface> 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.
</para>
<para>
An attribute may be added by clicking the
<guibutton>Add</guibutton> button. This displays a form that
allows you to enter the information about the particular
attribute. The <guibutton>Edit/View</guibutton> button allows to
view or to alter the information of the currently displayed
attribute. The <guibutton>Delete</guibutton> button allows you to
delete the currently displayed attribute.
</para>
</sect2>
<sect2 id="addrtab">
<title>Addresses Tab</title>
<para>
Addresses are used to record information about where a person
has lived. Addresses are different from
<application>GRAMPS'</application> concept of a place. An
address, as <application>GRAMPS</application> sees, it consists
of an equivalent of a mailing address and the date or date range
when the person lived at the address.
</para>
<para>
Like events and attributes, addresses may also have a note,
source, privacy marker, and confidence level associated with
them.
</para>
<figure id="ep-address-fig">
<title>Addresses Tab</title>
<screenshot>
<screeninfo>Addresses Tab</screeninfo>
<graphic fileref="figures/ep-address" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
The <interface>Address</interface> tab displays information
about the currently selected address at the top of the
window. Below this information is a list of the addresses that
have been previously entered. Clicking on one of the addresses
in the list selects the address, and displays its information at
the top of the window.
</para>
<para>
An address may be added by clicking the
<guibutton>Add</guibutton> button. This displays a form that
allows you to enter the information about the particular
address. The <guibutton>Edit/View</guibutton> button allows to
view or to alter the information of the currently displayed
address. The <guibutton>Delete</guibutton> button allows you to
delete the currently displayed address.
</para>
</sect2>
<sect2 id="notestab">
<title>Notes Tab</title>
<para>
In addition to the notes that may be attached to any particular
event, attribute, or address, <application>GRAMPS</application>
has a generic note attached to the person.
</para>
<figure id="ep-notes-fig">
<title>Notes Tab</title>
<screenshot>
<screeninfo>Notes Tab</screeninfo>
<graphic fileref="figures/ep-notes" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
The note window is a free-form edit window, allowing you to
enter any information that you want.
</para>
</sect2>
<sect2 id="gallerytab">
<title>Gallery Tab</title>
<para>
The <interface>Gallery</interface> tab allows you to associate
files (known in <application>GRAMPS</application> as media
objects) with a particular person. These files are typically
images or photographs, but may be of any file type, such as (but
not limited to) sound files and word processing documents.
</para>
<figure id="ep-gallery-fig">
<title>Gallery Tab</title>
<screenshot>
<screeninfo>Gallery Tab</screeninfo>
<graphic fileref="figures/ep-gallery" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
<application>GRAMPS</application> provides a central repository
for all media objects in the Media View. This allows the same
media object to appear in multiple galleries. Adding a media
object to a gallery actually adds the object to the Media View,
and makes a local reference in the gallery.
</para>
<para>
While each media object can have a note and attributes attached
to it, each gallery can add its own notes and attributes to the
reference in its gallery. This allows media objects to have
global and local properties. For example, a photo of a family
reunion may have many people in it. A global note may describe
the picture in general, identifying the place and date. When
this object is added to a gallery, you can attach a note to the
reference in the gallery adding some specific information, such
as "Aunt Martha is the third person from the right in the
second row". Clicking the <guibutton>Edit
Properties</guibutton> allows you to edit the local properties.
</para>
<figure id="localmedia">
<title>Local Media Properties</title>
<screenshot>
<screeninfo>Local Media Properties</screeninfo>
<graphic fileref="figures/localmedia" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
The first object in the gallery is considered to be the primary
image. If this object is an image, it will appear on the
<interface>General Information</interface> tab, and will be the
primary image used by report generators. An image can be made
the default at any time by selecting the thumbnail image and
dragging it to the first position in the gallery. In this same
manner, the order of the images can be changed using the same
drag and drop technique.
</para>
<para>
Objects may be added to the gallery in several ways. By clicking
the <guibutton>Add Media Object</guibutton> button, a dialog box
is presented which allows you to choose an object from the file
system. This method adds a new object to the Media View and
creates a reference in the gallery. Objects may also be added
by either dragging and dropping from one gallery to another, or
by dragging from the Media View to a gallery. In this case, a
new media object is not created, but a reference to an existing
media object is made in the gallery, sharing the same media
object between galleries. Finally, new objects may be added to a
gallery and the Media View by dragging and dropping from a file
manager (such as <application>Nautilus</application> or
<application>Konqueror</application>) or a web browser (such as
<application>Galeon</application>,
<application>Mozilla</application>, or
<application>Konqueror</application>) into a gallery.
</para>
<para>
Media objects can be removed from a gallery by clicking the
<guibutton>Delete Media Object</guibutton> button. This action
only removes the reference to the current gallery. It does not
remove the media object from the Media View or from any other
galleries that are referencing it.
</para>
<para>
Right clicking on a selected object brings up a menu.
</para>
<variablelist><title>Menu options</title>
<varlistentry>
<term>View in default viewer</term>
<listitem>
<para>
Allows you to view an object image using GNOME's default
viewer for the file type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Edit with the GIMP</term>
<listitem>
<para>
Launches the <application>gimp</application> program,
allowing you to edit the image. This option only shows up
if the media object is an image.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Edit Object Properties</term>
<listitem>
<para>
Allows you to change the attributes and note attached to the
media object.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Convert to local copy</term>
<listitem>
<para>
This option is only displayed if the media is a reference
to a file that is not controlled by
<application>GRAMPS</application>. Selecting the option
causes <application>GRAMPS</application> to make its own
copy of the media object.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 id="internettab">
<title>Internet Tab</title>
<para>
Frequently, information about a person is available on the
internet, frequently on someone else's web site. With multiple
people researching the same family, it is desirable to keep track
of internet sites that contain information about someone in your
database. This allows you to keep track of the web sites you
can periodically check them for any addition information.
</para>
<figure id="ep-internet-fig">
<title>Internet Tab</title>
<screenshot>
<screeninfo>Internet Tab</screeninfo>
<graphic fileref="figures/ep-internet" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
The <interface>Internet</interface> tab displays information about
the currently selected internet address at the top of the window. Below
this information is a list of the internet address 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.
</para>
<para>
Clicking on the internet address displayed at the top part of
the window will cause <application>GRAMPS</application> to attempt
to display the site using the GNOME default browser.
</para>
<para>
An internet address may be added by clicking on the
<guibutton>Add</guibutton> button. This displays a form that
allows you to enter the information about the internet
address. This information consists of the web address (URL) and
a description of the location. The
<guibutton>Edit/View</guibutton> button allows to view or alter
the information of the currently displayed internet address. The
<guibutton>Delete</guibutton> button allows you to delete the
currently displayed internet address.
</para>
</sect2>
<sect2 id="ldstab">
<title>LDS Tab</title>
<para>
If you have chosen to enable support for the LDS (Latter Day Saints)
ordinances, the <interface>LDS</interface> tab is visible, and can
be selected. This tab allows you to enter specific information used
by the Church of Jesus Christ of Latter Day Saints.
</para>
<figure id="ep-lds-fig">
<title>LDS Tab</title>
<screenshot>
<screeninfo>LDS Tab</screeninfo>
<graphic fileref="figures/ep-lds" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
</sect2>
</sect1>
<sect1 id="familyview">
<title>Family View</title>
<para>
The Family View window displays the spouses, parents, and children
of the active person. At any time, you can return to this view
either by pressing the <guibutton>Family</guibutton> button at the
top of the screen, or by choosing the
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Family View</guimenuitem>
</menuchoice>
entry from the menus.
</para>
<figure id="familyview-fig">
<title>Family View</title>
<screenshot>
<screeninfo>Family View</screeninfo>
<graphic fileref="figures/familyview" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
In the Family View, the family information related to the active
person is displayed. This information falls into two categories:
families in which the person is a child, and families in which the
person is a spouse or parent.
</para>
<sect2 id="ap-parents">
<title>Relationships to Parents</title>
<para>
On the right hand side of the window displays the parents of the
active person. By default, a birth relationship is
assumed. <application>GRAMPS</application> supports multiple
family relationships for each person. For example, a person may
have natural birth parents and adopted parents. In this case, an
option menu will appear below the parents names, allowing you to
choose which set of parents you wish to view.
</para>
<para>
Pressing the <guibutton>Add/Edit Parents</guibutton>
allows you to choose the active person's parents and specify the
person's relationship to the parents.
</para>
<para>
Pressing the <guibutton>Delete Parents</guibutton> does not
remove the parents from the database, but instead deletes the
relationship between the active person and the currently displayed
parents.
</para>
<para>
To right of the names of the parents are two "arrow"
buttons. Selecting the button next to the father changes the
father to the active person, and displays the fathers
information in the Family View window. Similarly, selecting the
button next to the mother changes the mother to the active
person.
</para>
<para>
To the left of the parents' names are buttons indicating the
relationship to the active person. These are typically labeled
"Father" and "Mother", but in some cases may simply be labeled
"Parent". Pressing one of these buttons will display the
<interface>Edit Person</interface> for the corresponding person.
</para>
</sect2>
<sect2 id="sp-relationships">
<title>Marriage/Relationship Information</title>
<para>
On the left side of the window, below the active person's name,
is the information related to the person's marriages and
relationships. If the person has one or no relationships, the
spouse will appear within a non-editable text box. If more than
one relationship exists, the text box will be replaced with an
option menu that allows you to select the relationship to view.
</para>
<para>
Between the active person and the relationship information is a
button with two arrows. Pressing this button will exchange the
active person and spouse on the display. The currently displayed
spouse will become the active person, and the family information
on the right hand side of the screen will change to reflect
this.
</para>
<para>
Pressing the <guibutton>Spouse</guibutton> next to the spouse's
name will display the currently displayed spouse's information
in an <interface>Edit Person</interface> dialog, allowing you
change the information
</para>
<para>
Pressing the <guibutton>Add</guibutton> located below the entry
for the spouse's name allows a new relationship to be
added. This gives you the opportunity to select and existing
person or to add a new person as the new spouse. The type of
relationship can also be specified. All relationship types,
except "Partners" require that the spouses be of opposite
sex. The "Partners" relationship type requires that the spouses
be of the same sex.
</para>
<para>
Pressing the <guibutton>Edit</guibutton> button allows you to
edit the information related to the marriage. The information
includes events, attributes, and images.
</para>
<para>
The <guibutton>Remove</guibutton> button removes the current
spouse from the relationship. If no children exist in the
relationship, the entire relationship is removed. If children
exist in the relationship, the current spouse is removed,
and the children remain in a family with the active person as the
only parent.
</para>
</sect2>
<sect2 id="sp-children">
<title>Children of a Relationship</title>
<para>
The bottom of the window contains the list of children related
to the active person and the currently selected spouse. Clicking
on an entry in the list makes that child the active child.
</para>
<para>
Clicking the <guibutton>Add New Child</guibutton> creates a new
child and adds him or her as a child of the current
relationship. Clicking the <guibutton>Add Existing
Child</guibutton> allows you to select an existing person and
assign the person as a child of the current
relationship. Clicking the <guibutton>Remove Child</guibutton>
removes the active child from the current relationship, but does
not delete the person from the database.
</para>
<para>
Double clicking on an entry in the list brings up the
<interface>Edit Person</interface> dialog for the child.
</para>
<para>
You are able to make the selected child the active person by
clicking the arrow button next to the child list. The
highlighted child in the child list becomes the active person.
</para>
</sect2>
</sect1>
<sect1 id="pedigreeview">
<title>Pedigree View</title>
<para>
The Pedigree 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 this
view either by pressing the Pedigree button at the top of the
screen, or by choosing the
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Pedigree</guimenuitem>
</menuchoice>
entry from the menus.
</para>
<figure id="pedigreeview-fig">
<title>Pedigree View</title>
<screenshot>
<screeninfo>Pedigree View</screeninfo>
<graphic fileref="figures/pedegreeview" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
Moving the mouse over a displayed name will display additional
information about a person, including their date of birth and date
of death. Double-clicking the box will display the <interface>Edit
Person</interface> dialog box for the person. Holding down the
Shift key while double clicking will will make that person the
active person.
</para>
<para>
Navigation around the tree can be accomplished several
ways. Clicking on the arrow next to the active person will display
a menu listing the children of the active person. Selecting a
person from this list will change the active person to the
selected child, effectively shifting the pedigree view to the
left, or down one generation. Clicking one of the arrow buttons on
the left side of the screen will make the select either the active
person's father (top button) or mother (bottom button),
effectively shifting the pedigree view to the right, or up one
generation. If the active person does not have any children, then
the button on the left-hand side of the screen will not
appear. Similarly, if the active person does have a father or
mother, the corresponding button on the right-hand side of the
screen will not appear.
</para>
<figure id="navfigure-fig">
<title>Navigation</title>
<screenshot>
<screeninfo>Navigation</screeninfo>
<graphic fileref="figures/pedegreesel" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
As a quick short cut, double clicking on a line between two people
will make the person on the right-hand side of the line the active
person. <xref linkend="navfigure-fig"> shows navigation using this
method. When the mouse is over one of the lines connecting
individuals, the line widens and becomes highlighted. In this
case, double clicking on the line would make Hjalmar Smith the
active person.
</para>
</sect1>
<sect1 id="sourcelist">
<title>Source View</title>
<para>
The Source View window displays the different sources that have
been entered into the database. At any time, you can return to
this view either by pressing the <guibutton>Sources</guibutton>
button at the top of the screen, or by choosing the
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Sources</guimenuitem>
</menuchoice>
entry from the menus.
</para>
<figure id="sourceview-fig">
<title>Source list</title>
<screenshot>
<screeninfo>Source View</screeninfo>
<graphic fileref="figures/sourcelist" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
From this screen you are able to Add and Edit sources. Currently,
deleting of sources is not available. This will be implemented in
a future version.
</para>
</sect1>
<sect1 id="placelist">
<title>Place View</title>
<para>
The Place View window displays the different sources that have
been entered into the database. At any time, you can return to
this view either by pressing the <guibutton>Places</guibutton>
button at the top of the screen, or by choosing the
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Places</guimenuitem>
</menuchoice>
entry from the menus.
</para>
<figure id="placeview-fig">
<title>Place View</title>
<screenshot>
<screeninfo>Place View</screeninfo>
<graphic fileref="figures/placelist" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
From this screen you are able to Add, Edit, and Delete places.
</para>
</sect1>
<sect1 id="mediaview">
<title>Media View</title>
<para>
The Media View window displays the files associated with the
database. Typically, these files are images, but
<application>GRAMPS</application> allows you to attach any type of
file to the database. <application>GRAMPS</application> refers to
attached files as media objects. You can access the Media View at
any time by either pressing the <guibutton>Media</guibutton>
button at the top of the screen, or by choosing the
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Media</guimenuitem>
</menuchoice>
entry from the menus.
</para>
<figure id="mediaview-fig">
<title>Media View</title>
<screenshot>
<screeninfo>Media View</screeninfo>
<graphic fileref="figures/mediaview" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<sect2>
<title>Media Objects</title>
<para>
Media objects can be either local or external to a
<application>GRAMPS</application> database. If
<application>GRAMPS</application> is told to import an object as
a local object, it will make its own copy of the file in the
database directory. If the object is not imported as a local
object, the original file is used.
</para>
<para>
There are advantages and disadvantages to both methods. If the
object is local, then if the original file is moved or deleted,
then <application>GRAMPS</application> will still have its own
copy. However, this is at the price of having two copies of the
file. If the file is not imported as a local object, then a copy
is not made, saving disk space. However, altering or deleting
the original copy will affect the
<application>GRAMPS</application> database.
</para>
</sect2>
<sect2>
<title>Adding a Media Object</title>
<para>
Media objects can be imported in several ways. Adding an object
to any gallery adds the object to the Media View. The gallery is
will actually contain a reference to the object in the Media
View.
</para>
<para>
Objects may also be added using the <guibutton>Add Media
Object</guibutton> button. This will add the object to the Media
View, but not to any gallery. When you select the file to be
added, a preview will be displayed in the preview window. If the
file is an image, the image will be displayed. Otherwise, an
icon representing the file type will be displayed. In the dialog
box, you may choose to either import the object as a local
object, or leave it as an external object.
<figure id="addmedia">
<title>Add Media Object Dialog Box</title>
<screenshot>
<screeninfo>Add Media Object Dialog Box</screeninfo>
<graphic fileref="figures/addmedia" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
</para>
<para>
Finally, you may drag-and-drop an object from either a file
manager or a web browser. If the object is dropped into a
gallery, then a reference is made in the gallery, and the object
appears in the Media View. If the object is dropped directly
into the Media View, then it appears in the Media View, but will
not appear in a gallery. Currently, all objects imported via
drag-and-drop are imported as external (not local) objects.
</para>
</sect2>
<sect2>
<title>Making a Reference to a Media Object</title>
<para>
Once an object is in the Media View, it is possible to make a
reference to it in any gallery. You may place the object in as
many galleries as you like, and only one copy of the file will
exist.
</para>
<para>
To make a reference to a media object in a gallery, you may
simply drag-and-drop the object from the Media View directly to
a gallery. The object will then appear in the
gallery. Similarly, you may drag-and-drop from one gallery to
another gallery, and a new object reference is created in the
target gallery.
</para>
</sect2>
<sect2>
<title>Changing a Media Object's Properties</title>
<para>
Media objects have global and local properties. The title of the
object is a global property. It may only be changed from the
Media View, and it will affect all references. An object also
has a global note and a set of user defined global attributes.
A reference in a gallery may a have a local note and local
attributes as well. All references share the global properties,
but each gallery has its own set of notes a attributes.
</para>
<para>
The global note can be used to provide a general
description. For example, in a family reunion image, you may
wish to use the global note to indicate the place, date, and
occasion of the photograph. In a local note in Aunt Martha's
gallery, you may wish to add a local note indicating that
"Aunt Martha is the third person from the right in the
second row".
</para>
<para>
The global properties may be changed by selecting the
<guibutton>Edit Media Object</guibutton> button.
<figure id="globalmedia">
<title>Edit a Media Object's Global Properties</title>
<screenshot>
<screeninfo>Edit a Media Object's Global Properties</screeninfo>
<graphic fileref="figures/globalmedia" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
</para>
</sect2>
</sect1>
<sect1 id="bookmarks">
<title>Bookmarking People</title>
<para>
<application>GRAMPS</application> supports two mechanisms to
quickly find people - the home person and bookmarks.
</para>
<sect2 id="homeperson">
<title>Home Person</title>
<para>
The home person is the default person of the database. Upon
loading the database, <application>GRAMPS</application> will set
the active person to the default person. At any time, clicking
the <guibutton>Home</guibutton> button will return the active
person to the home person.
</para>
<para>
The home person can be set by choosing
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Set Default Person</guimenuitem>
</menuchoice>.
</para>
</sect2>
<sect2 id="bkmarks">
<title>Bookmarks</title>
<para>
Bookmarks work similar to bookmarks in HTML browsers. They
allow you to quickly jump to a person, making that person the
active person. This allows you to avoid searching for them
every time you want to add/change something in their information.
</para>
<figure id="gotobookmark">
<title>Using Bookmarks</title>
<screenshot>
<screeninfo>Using Bookmarks</screeninfo>
<graphic fileref="figures/gotobookmark" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
Choosing
<menuchoice>
<guimenu>Bookmarks</guimenu>
<guimenuitem>Add Bookmark</guimenuitem>
</menuchoice>
adds the current active person to the bookmark list. The person
will then appear in the bookmark list, allowing you to quickly
select the person.
</para>
<para>
Choosing
<menuchoice>
<guimenu>Bookmarks</guimenu>
<guimenuitem>Go to Bookmark</guimenuitem>
</menuchoice>
displays a sub-menu which allows you to choose a person who was
previously bookmarked. Selecting a person from this menu will
make that person the active person.
</para>
<para>
Choosing
<menuchoice>
<guimenu>Bookmarks</guimenu>
<guimenuitem>Edit Bookmarks</guimenuitem>
</menuchoice>
displays a dialog box that allows you to reorder or delete
bookmarks in the list.
</para>
<figure id="editbookmark">
<title>Editing Bookmarks</title>
<screenshot>
<screeninfo>Editing Bookmarks</screeninfo>
<graphic fileref="figures/editbookmarks" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
</sect2>
</sect1>
<sect1 id="revisoncontrol">
<title>Using Revision Control</title>
<para>
Revision control allows you to keep a history of the changes that
you have made to your database. Instead of needing to keep
multiple sets of back up files, a single revision control database
is maintained. At any point, you can revert back to a previously
saved version.
</para>
<para>
<application>GRAMPS</application> uses the standard
<application>RCS</application> system to handle revisions.
</para>
<para>
Revision control is enabled in the Revision Control tab of the
preferences dialog. Once enabled, every save is logged into the
revision control database. If you have enabled prompting for a
comment, then a dialog box will be displayed on every save asking
you to provide a comment about the changes you have made.
<figure id="revcomment">
<title>Providing a revision control comment</title>
<screenshot>
<screeninfo>Providing a revision control comment</screeninfo>
<graphic fileref="figures/savecomment" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
</para>
<sect2>
<title>Reverting to a previous version</title>
<para>
If revision control has been enabled, you have the option of
reverting to a previous version of the database. Selecting the
check box will allow you to select a previous version.
<figure id="opendb">
<title>Opening a database</title>
<screenshot>
<screeninfo>Opening a database</screeninfo>
<graphic fileref="figures/opendb" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
</para>
<para>
If the check box has be selected, <application>GRAMPS</application>
will display a dialog box that will allow you to choose which version
you would like to view. The dialog box displays the version number, the
date the version was saved, who saved the database, and any comment supplied
when the database was saved.
<figure id="revcontrol">
<title>Choosing a revision</title>
<screenshot>
<screeninfo>Choosing a revision</screeninfo>
<graphic fileref="figures/revcontrol" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
</para>
<para>
Choosing a previous revision does not replace your current
database. If you do not save the retrieved database, it will not
replace the current version. If for some reason you accidentally
save the retrieved database when you did not want to replace the
current version, you can always use the revision control
mechanism to get back the version you replaced.
</para>
<para>
Revision control is applied only to the database itself, not to
any media objects have been associated with the database.
</para>
</sect2>
</sect1>
<!-- ============= Customization ============================= -->
<sect1 id="prefs">
<title>Customization</title>
<para>
To change the application settings, select
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Preferences...</guimenuitem>
</menuchoice>. This opens the
<interface>Preferences</interface> dialog, shown in <xref
linkend="prefs-main">.
</para>
<sect2 id="prefs-main">
<title>Preferences Dialog</title>
<figure id="prefs-main-fig">
<title>Preferences Dialog</title>
<screenshot>
<screeninfo>Preferences Dialog</screeninfo>
<graphic fileref="figures/prefs-main" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
<application>GRAMPS</application> groups is options into
categories visible in the left hand side of the
dialog. Selecting one of these entries will display the
corresponding settings in the right hand side of the dialog.
</para>
</sect2>
<sect2 id="prefs-gen">
<title>General Database options</title>
<figure id="prefs-gen-fig">
<title>General Database options</title>
<screenshot>
<screeninfo>General Database Options</screeninfo>
<graphic fileref="figures/prefs-gen" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
The General Database page contains basic information to
control the operation of <application>GRAMPS</application>.
</para>
<variablelist>
<title>General Database options</title>
<varlistentry>
<term>Automatically load last database</term>
<listitem>
<para>
With this selected it will automatically load your last
database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Do not compress XML data file</term>
<listitem>
<para>
<application>GRAMPS</application> normally compresses its
data file to conserve disk space. If you do not wish to
have the file compressed, selecting this option will cause
<application>GRAMPS</application> to leave the file
uncompressed. This may be desirable if other applications
need to process the generated XML file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Autosave interval (minutes)</term>
<listitem>
<para>
If this value is set to a non-zero value, <application>GRAMPS</application>
will save an autosave file every few minutes, depending on the
value set. If for some reason the execution of <application>GRAMPS</application>
is interrupted, you can recover to the last autosave point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Default database directory</term>
<listitem>
<para>
This value indicates the default directory for loading and saving
databases.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 id="prefs-tab1">
<title>Dates and Calendars</title>
<figure id="prefs-dates">
<title>Dates and Calendars</title>
<screenshot>
<screeninfo>Dates and Calendars</screeninfo>
<graphic fileref="figures/prefs-dates" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
The <interface>Dates and Calendars</interface> page allows you to change the
display and entry formats of dates.
</para>
<para>
</para>
<variablelist>
<title>Dates and Calendars options</title>
<varlistentry>
<term>Display Formats</term>
<listitem>
<para>
Allows you to choose your preferences for displaying dates
and names. Options exist for several different date
formats. Names can be displayed with either the given name
or the surname first. This option typically does not
affect lists that are sorted by last name, in which case
the surname is displayed first.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Entry Formats</term>
<listitem>
<para>
Numerical date formats can be ambiguous. Some people enter
the day, month, and year (European style), while others
prefer month, day, year (American style). Selecting the
option here informs <application>GRAMPS</application> how
it should interpret numerical dates.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Calendars</term>
<listitem>
<para>
<application>GRAMPS</application> can support calendars
other than the typical Gregorian calendar. If enabled,
<application>GRAMPS</application> will display a menu
allowing you to specify the calendar that a date
represents. Calendars currently supported are Gregorian,
Hebrew, Julian, and French Republican.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 id="prefs-tab2">
<title>Media Options</title>
<figure id="prefs-media">
<title>Media Options</title>
<screenshot>
<screeninfo>Media Options</screeninfo>
<graphic fileref="figures/prefs-media" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
</sect2>
<sect2 id="prefs-tab-ids">
<title>GRAMPS ID Options</title>
<figure id="prefs-ids">
<title>GRAMPS ID Options</title>
<screenshot>
<screeninfo>GRAMPS ID Options</screeninfo>
<graphic fileref="figures/prefs-ids" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
</sect2>
<sect2 id="prefs-tab-rev">
<title>Revision Control Options</title>
<figure id="prefs-rev">
<title>Revision Control Options</title>
<screenshot>
<screeninfo>Revision Control Options</screeninfo>
<graphic fileref="figures/prefs-revision" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
</sect2>
<sect2 id="prefs-tab-disp">
<title>General Display Options</title>
<figure id="prefs-disp">
<title>General Display Options</title>
<screenshot>
<screeninfo>General Display Options</screeninfo>
<graphic fileref="figures/prefs-disp" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
</sect2>
<sect2 id="prefs-tab-bars">
<title>Tool and Status Bar Options</title>
<figure id="prefs-bars">
<title>Tool and Status Bar Options</title>
<screenshot>
<screeninfo>Tools and Status Bar Options</screeninfo>
<graphic fileref="figures/prefs-bars" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
</sect2>
<sect2 id="prefs-tab-colors">
<title>List Color Options</title>
<figure id="prefs-color">
<title>List Color Options</title>
<screenshot>
<screeninfo>List Color Options</screeninfo>
<graphic fileref="figures/prefs-colors" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
</sect2>
<sect2 id="prefs-tab-find">
<title>Find Options</title>
<figure id="prefs-find">
<title>Find Options</title>
<screenshot>
<screeninfo>Find Options</screeninfo>
<graphic fileref="figures/prefs-find" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
</sect2>
<sect2 id="prefs-tab4">
<title>Report Options</title>
<figure id="prefs-report">
<title>Report Options</title>
<screenshot>
<screeninfo>Report Options</screeninfo>
<graphic fileref="figures/prefs-report" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
Many of the reports that <application>GRAMPS</application>
produces can be generated in different file formats and
different paper sizes. Selecting a <guilabel>Preferred Output
Format</guilabel> and a <guilabel>Preferred Output
Format</guilabel> tells the report generator your
preferences. It should be noted that a report generator might
not support all possible formats.
</para>
</sect2>
<sect2 id="prefs-tab3">
<title>Researcher Information</title>
<figure id="prefs-research">
<title>Researcher Information</title>
<screenshot>
<screeninfo>Researcher Information</screeninfo>
<graphic fileref="figures/prefs-research" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
This is where you are able to change the information you entered
when you started GRAMPS for the first time and was asked to
enter in some information. (This information shows up in your
GEDCOM files as being the researcher/author of the file)
</para>
</sect2>
<sect2 id="prefs-tab5">
<title>Data Guessing Options</title>
<figure id="prefs-tab-guess">
<title>Data Guessing Options</title>
<screenshot>
<screeninfo>Data Guessing Options</screeninfo>
<graphic fileref="figures/prefs-guess" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
</para>
</sect2>
</sect1>
<!-- ============= Generating Reports ============================= -->
<sect1 id="genreports">
<title>Generating Reports</title>
<para>
<application>GRAMPS</application> can produce a wide variety of
reports. A new report generator 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.
</para>
<figure id="report-fig">
<title>Report Generation Dialog</title>
<screenshot>
<screeninfo>Report Generation Dialog</screeninfo>
<graphic fileref="figures/reportsel" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<para>
Unlike many genealogy programs, <application>GRAMPS</application>
does not directly print reports. Instead,
<application>GRAMPS</application> 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 at a later time, or e-mailed to another person.
</para>
<para>
After selecting the report you would like generated there are
options you must select. In the Save As option specify your file
name (use /full path/filename to specify a different directory
than in your Default Report Directory preference in the
preferences). The next step is to select the Report Format.
After choosing the Format you can select the style you would like
to use for your report (this does not apply to the HTML format).
You can Add/Edit/Delete a style for that particular report by
clicking the <guibutton>Style Editor</guibutton> button.
Selecting one of those options you can then change the font (font
face, size, color, and options) for each Paragraph Style along
with the Paragraph Options (Alignment, background color, margins,
and borders). Once you are satisfied with the style you are ready
to proceed with the generation of your report. The next step is
to choose the options (if any for that specific report) and then
Choose the Template (for HTML format only) and click OK. Your
report will now be in default report directory (unless otherwise
specified).
</para>
<sect2 id="htmltemplates">
<title>Using HTML templates</title>
<para>
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.
</para>
<para>
To solve this problem, <application>GRAMPS</application> 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 appearance of the generated files at any time.
Nearly any existing HTML file can be used as an HTML template
for <application>GRAMPS</application>.
</para>
<para>
When a file has been established as the HTML template file,
<application>GRAMPS</application> uses the template for each
file that it generates. <application>GRAMPS</application> starts
each file by copying data from the template until it reaches the
HTML comment, which it uses as a marker. At that point,
<application>GRAMPS</application> inserts its data into the
output file. <application>GRAMPS</application> the continues
reading the until it reaches a second comment that tells it to
resume copying from the template.
</para>
<para>
<application>GRAMPS</application> uses the string
<function><!-- START --></function> to indicate where it
should start inserting its information, and the string
<function><!-- STOP --></function> to indicate where it
should resume copying data from the template. The effect is
that <application>GRAMPS</application> will create a new
document, replacing everything between the <function><!--
START --></function> and <function><!-- STOP
--></function> comments with the report information.
</para>
<para>
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.
</para>
<para>
If no HTML template is specified, or if the specified template
cannot be read, <application>GRAMPS</application> will use a
default, predefined template.
</para>
<figure id="templateexample">
<title>Sample HTML Template Example</title>
<programlisting>
<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>
</programlisting>
</figure>
</sect2>
</sect1>
<!-- ============= Running Tools ============================= -->
<sect1 id="runtools">
<title>Running Tools</title>
<para>
<application>GRAMPS</application> supports standard and user
written tools. These tools can operate on the database to perform
a specified task.
</para>
<figure id="tools-fig">
<title>Tool Selection Dialog</title>
<screenshot>
<screeninfo>Tool Selection Dialog</screeninfo>
<graphic fileref="figures/toolsel" format="png" srccredit="Don Allingham">
</graphic>
</screenshot>
</figure>
<variablelist>
<title>Analysis and Exploration</title>
<varlistentry>
<term>Compare individual events</term>
<listitem>
<para>
Aids in the analysis of data by allowing the development of
custom filters that can be applied to the database to find
similar events.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Interactive descendant browser</term>
<listitem>
<para>
Provides a browsable hierarchy based on the active person.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<title>Data Processing</title>
<varlistentry>
<term>Check and repair database</term>
<listitem>
<para>
Checks the database for integrity problems, fixing the
problems that it can.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Extract information from names</term>
<listitem>
<para>
Searches the entire database and attempts to extract titles
and nicknames that may be embedded in a person's given name
field.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Merge people</term>
<listitem>
<para>
Searches the entire database, looking for individual entries
that may represent the same person.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Rename personal event types</term>
<listitem>
<para>
Allows all the events of a certain name to be renamed to a
new name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Reorder GRAMPS ID's</term>
<listitem>
<para>
Reorders the GRAMPS ID's according to GRAMPS' default rules.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<title>Utilities</title>
<varlistentry>
<term>Generate SoundEx codes</term>
<listitem>
<para>
Generates SoundEx codes for names.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Relationship calculator</term>
<listitem>
<para>
Calculates the relationship between two people.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- ============= Bugs ==================================
<sect1 id="bugs">
<title>Known Bugs and Limitations</title>
<para>
This application has no known bugs.
</para>
</sect1>
-->
<!-- ============= Authors ================================ -->
<sect1 id="authors">
<title>Authors</title>
<para>
<application>GRAMPS</application> was written by Don Allingham
(<email>dallingham@users.sourceforge.net</email>). To find more
information about <application>GRAMPS</application>, please visit
the <ulink url="http://gramps.sourceforge.net" type="http">GRAMPS
Web page</ulink>.
</para>
<para>
This manual was written by Don Allingham
(<email>dallingham@users.sourceforge.net</email>), Larry Allingham
(<email>llkla@erinet.com</email>), and Shawn Ann Griffith
(<email>shawnann1@home.com</email>).
</para>
<!-- For translations: uncomment this:
<para>
Latin translation was done by ME
(<email>MYNAME@MYADDRESS</email>). Please send all comments and
suggestions regarding this translation to SOMEWHERE.
</para>
-->
</sect1>
<!-- ============= Application License ============================= -->
<sect1 id="license">
<title>License</title>
<para>
This program is free software; you can redistribute it and/or
modify it under the terms of the <ulink type="help"
url="gnome-help:gpl"> <citetitle>GNU General Public
License</citetitle></ulink> as published by the Free Software
Foundation; either version 2 of the License, or (at your option)
any later version.
</para>
<para>
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
<citetitle>GNU General Public License</citetitle> for more
details.
</para>
<para>
A copy of the <citetitle>GNU General Public License</citetitle> is
included as an appendix to the <citetitle>GNOME Users
Guide</citetitle>. You may also obtain a copy of the
<citetitle>GNU General Public License</citetitle> from the Free
Software Foundation by visiting <ulink type="http"
url="http://www.fsf.org">their Web site</ulink> or by writing to
<address>
Free Software Foundation, Inc.
<street>59 Temple Place</street> - Suite 330
<city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
<country>USA</country>
</address>
</para>
</sect1>
</article>