3138 lines
135 KiB
XML
3138 lines
135 KiB
XML
<?xml version="1.0"?>
|
|
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
|
<!ENTITY legal SYSTEM "legal.xml">
|
|
<!ENTITY appversion "0.9.1">
|
|
<!ENTITY manrevision "2.0">
|
|
<!ENTITY date "March 2003">
|
|
<!ENTITY app "<application>GRAMPS</application>">
|
|
<!-- Information about the entities
|
|
The legal.xml file contains legal information, there is no need to edit the file.
|
|
Use the appversion entity to specify the version of the application.
|
|
Use the manrevision entity to specify the revision number of this manual.
|
|
Use the date entity to specify the release date of this manual.
|
|
Use the app entity to specify the name of the application. -->
|
|
]>
|
|
<!--
|
|
(Do not remove this comment block.)
|
|
Maintained by the GNOME Documentation Project
|
|
http://developer.gnome.org/projects/gdp
|
|
Template version: 2.0 beta
|
|
Template last modified Apr 11, 2002
|
|
-->
|
|
<!-- =============Document Header ============================= -->
|
|
<article id="index" lang="en">
|
|
<!-- please do not change the id; for translations, change lang to -->
|
|
<!-- appropriate code -->
|
|
<articleinfo>
|
|
<title>&app; Manual V&manrevision;</title>
|
|
|
|
<copyright> <year>2003</year> <holder>Alex Roitman</holder> </copyright>
|
|
<copyright> <year>2001</year> <holder>Donald N. Allingham</holder> </copyright>
|
|
|
|
<!-- translators: uncomment this:
|
|
|
|
<copyright>
|
|
<year>2002</year>
|
|
<holder>ME-THE-TRANSLATOR (Latin translation)</holder>
|
|
</copyright>
|
|
|
|
-->
|
|
<!-- An address can be added to the publisher information. If a role is
|
|
not specified, the publisher/author is the same for all versions of the
|
|
document. -->
|
|
<publisher> <publishername> GRAMPS Project </publishername> </publisher>
|
|
|
|
&legal;
|
|
<!-- This file contains link to license for the documentation (GNU FDL), and
|
|
other legal stuff such as "NO WARRANTY" statement. Please do not change
|
|
any of this. -->
|
|
|
|
<authorgroup>
|
|
<author>
|
|
<firstname>Alex</firstname>
|
|
<surname>Roitman</surname>
|
|
<affiliation>
|
|
<orgname>GRAMPS Project</orgname>
|
|
<address> <email>shura@alex.neuro.umn.edu</email> </address>
|
|
</affiliation>
|
|
</author>
|
|
<author>
|
|
<firstname>Donald N.</firstname>
|
|
<surname>Allingham</surname>
|
|
<affiliation>
|
|
<orgname>GRAMPS Project</orgname>
|
|
<address> <email>dallingham@users.sourceforge.net</email> </address>
|
|
</affiliation>
|
|
</author>
|
|
|
|
<!-- This is appropriate place for other contributors: translators,
|
|
maintainers, etc. Commented out by default.
|
|
|
|
<othercredit role="translator">
|
|
<firstname>Latin</firstname>
|
|
<surname>Translator 1</surname>
|
|
<affiliation>
|
|
<orgname>Latin Translation Team</orgname>
|
|
<address> <email>translator@gnome.org</email> </address>
|
|
</affiliation>
|
|
<contrib>Latin translation</contrib>
|
|
</othercredit>
|
|
-->
|
|
</authorgroup>
|
|
|
|
<!-- According to GNU FDL, revision history is mandatory if you are -->
|
|
<!-- modifying/reusing someone else's document. If not, you can omit it. -->
|
|
<!-- Remember to remove the &manrevision; entity from the revision entries other
|
|
-->
|
|
<!-- than the current revision. -->
|
|
<!-- The revision numbering system for GNOME manuals is as follows: -->
|
|
<!-- * the revision number consists of two components -->
|
|
<!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
|
|
<!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
|
|
<!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
|
|
<!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
|
|
<!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
|
|
<!-- to V3.0, and so on. -->
|
|
<revhistory>
|
|
<revision>
|
|
<revnumber>GRAMPS Manual V&manrevision;</revnumber>
|
|
<date>&date;</date>
|
|
<revdescription>
|
|
<para role="author">Alex Roitman
|
|
<email>shura@alex.neuro.umn.edu</email>
|
|
</para>
|
|
<para role="publisher">GRAMPS Project</para>
|
|
</revdescription>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>GRAMPS User Manual V1.1</revnumber>
|
|
<date>2001</date>
|
|
<revdescription>
|
|
<para role="author">Donald N. Allingham
|
|
<email>dallingham@users.sourceforge.net</email>
|
|
</para>
|
|
<para role="publisher">GRAMPS Project</para>
|
|
</revdescription>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>gramps User Manual V1.0</revnumber>
|
|
<date>2001</date>
|
|
<revdescription>
|
|
<para role="author">Donald N. Allingham
|
|
<email>dallingham@users.sourceforge.net</email>
|
|
</para>
|
|
<para role="publisher">GRAMPS Project</para>
|
|
</revdescription>
|
|
</revision>
|
|
</revhistory>
|
|
|
|
<releaseinfo>This manual describes version &appversion; of GRAMPS.
|
|
</releaseinfo>
|
|
<legalnotice>
|
|
<title>Feedback</title>
|
|
<para>To report a bug or make a suggestion regarding the &app; application or
|
|
this manual, follow the directions in the <ulink url="ghelp:gnome-feedback"
|
|
type="help">GNOME Feedback Page</ulink>.
|
|
</para>
|
|
<!-- Translators may also add here feedback address for translations -->
|
|
</legalnotice>
|
|
</articleinfo>
|
|
|
|
<indexterm zone="index"> <primary>GRAMPS</primary> </indexterm>
|
|
<indexterm zone="index"> <primary>gramps</primary> </indexterm>
|
|
|
|
<!-- ============= Document Body ============================= -->
|
|
<!-- ============= Introduction ============================== -->
|
|
<sect1 id="gramps-intro">
|
|
<title>Introduction</title>
|
|
<para> The <application>&app;</application> is a genealogical
|
|
application. &app; is an acronym for the
|
|
Genealogical Research and Analysis Management Programming System. To put
|
|
it shortly, it allows you to store, edit, and research genealogical data
|
|
using your computer. Its functionality is somewhat common to other
|
|
genealogical programs. However, <application>&app;</application> offers
|
|
some unique features. </para>
|
|
|
|
<sect2 id="why-gramps">
|
|
<title>Why &app;?</title>
|
|
<para> <application>&app;</application> 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
|
|
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 the data contained in the various reports. </para>
|
|
|
|
<para> <application>&app;</application>, on the other hand, attempts to
|
|
provide all of the common capabilities of these programs, but, more
|
|
importantly, to provide an additional capability of integration not common
|
|
to these programs. This is the ability to input any bits and pieces of
|
|
information directly into <application>&app;</application> 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>
|
|
</sect2>
|
|
</sect1> <!-- ================ End Intro ================================ -->
|
|
|
|
<!-- =========== Getting Started ============================== -->
|
|
|
|
<sect1 id="gramps-getting-started">
|
|
<title>Getting Started</title>
|
|
|
|
<!-- ================ Getting Started Subsection ====== -->
|
|
<sect2 id="gramps-start">
|
|
<title>To Start &app;</title>
|
|
<para>You can start <application>&app;</application> in the
|
|
following ways:</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><guimenu>Applications</guimenu> menu</term>
|
|
<listitem><para>Choose <menuchoice><guisubmenu>Other</guisubmenu>
|
|
<guimenuitem>Gramps</guimenuitem></menuchoice>. </para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>Command line</term>
|
|
<listitem><para>To start <application>&app;</application>
|
|
from a command line, type <command>gramps</command>, then
|
|
press <keycap>Return</keycap>.</para>
|
|
|
|
<para>If you would like <application>&app;</application> to open
|
|
a specific database or to import a specific file on startup, you can
|
|
supply the filename as a command line argument:</para>
|
|
|
|
<para>
|
|
<command>gramps</command> <replaceable>filename.ged</replaceable>
|
|
</para>
|
|
|
|
<para>where <replaceable>filename.ged</replaceable> is the name
|
|
of the file you want to open/import. </para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</sect2>
|
|
|
|
<!-- ================ Getting Started Subsection ==== -->
|
|
<sect2 id="run-1st-time">
|
|
<title>Running &app; for the first time</title>
|
|
<para>
|
|
[ FIXME: NEED TO RUN Getting Started DRUID to document this section ]
|
|
|
|
The first time you run the program, GRAMPS will display its
|
|
Getting Started screens. </para>
|
|
|
|
<!-- ==== Figure: Getting Started Druid Window ==== -->
|
|
<figure id="druid-fig">
|
|
<title>&app; Getting Started Window</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/druid.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Getting Started Window. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
|
|
<!-- ================ Getting Started Sub-subsection -->
|
|
<sect3 id="choose-db-start">
|
|
<title>Choosing a database on startup</title>
|
|
<para>If <application>&app;</application> is started without any
|
|
database to open, the following window will appear prompting you to
|
|
choose what database to open. </para>
|
|
|
|
<!-- ==== Figure: Open existing/new database window ==== -->
|
|
<figure id="first-open">
|
|
<title>Open Database Window</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/first-open.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Open Database Window. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para>If you would like to open an existing database, check the top radio
|
|
button and click <guibutton>OK</guibutton>. You will then be asked to
|
|
specify the name of your existing database. If you would like to start
|
|
creating your brand new database from scratch right away, choose new XML
|
|
database. </para>
|
|
</sect3>
|
|
|
|
<!-- ================ Getting Started Sub-subsection -->
|
|
<sect3 id="zodb-support">
|
|
<title>Optional ZODB support</title>
|
|
|
|
<para>If either StandaloneZODB or Zope is installed on your system,
|
|
<application>&app;</application> will give you the third option of
|
|
creating a new ZODB database. You can choose to start your new database
|
|
in either XML or ZODB format. Both formats have their strong and weak
|
|
points.</para>
|
|
|
|
<para>XML stands for eXtensible Markup Language, and is a human readable
|
|
structured description of data. It could be easily parsed by other
|
|
programs should the need occur. It stores only the data itself. Its weak
|
|
point is the relatively low speed of processing large data files. </para>
|
|
|
|
<para>ZODB stands for Zope Object Database and provides the full-fledged
|
|
database support. ZODB files are not human readable. They contain a
|
|
certain overhead to assist working with large data structures. However,
|
|
ZODB provides a significant speed-up when the database size is large (over
|
|
few thousand people). </para>
|
|
|
|
<para>Its is hard to tell which format is better, since this is a typical
|
|
tradeoff situation. If you are starting your research then you are likely
|
|
to be fine with the regular XML database. If you have tons of data to
|
|
import describing thousands upon thousands of people, then you are
|
|
probably better of with ZODB. </para>
|
|
|
|
</sect3>
|
|
</sect2>
|
|
</sect1> <!-- ================ End Getting Started ======================== -->
|
|
|
|
<!-- ================ Main Window ================================ -->
|
|
<sect1 id="gramps-mainwin">
|
|
<title>Main Window</title>
|
|
<para>When you open a database (either existing or brand new),
|
|
the following window is displayed.</para>
|
|
|
|
<!-- ==== Figure: Main Window ==== -->
|
|
<figure id="mainwin-fig">
|
|
<title>&app; Main Window</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/mainwin.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows &app; main window. Contains titlebar, menubar,
|
|
toolbar, sidebar, display area, statusbar, progress bar, and
|
|
scrollbars. Menubar contains File, Edit, View, Bookmarks,
|
|
Reports, Tools, Settings, and Help menus. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para>The &app; window contains the following elements: </para>
|
|
<variablelist>
|
|
<varlistentry><term>Menubar</term>
|
|
<listitem><para>The menubar provides access to all features of
|
|
<application>&app;</application> through its menus.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>Toolbar</term>
|
|
<listitem><para> The toolbar provides access to the most frequently
|
|
used functions of <application>&app;</application>. The appearance of
|
|
the toolbar can be adjusted in <guilabel>Preferences</guilabel>
|
|
dialog. </para></listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>Progress bar</term>
|
|
<listitem><para>The progress bar is located in the lower left corner
|
|
of the &app; window. It displays the
|
|
progress of time consuming operations, such as opening and saving
|
|
large data bases, importing and exporting to other formats, generating
|
|
web sites, etc. </para></listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>Statusbar</term>
|
|
<listitem><para>The statusbar is located to the right of the progress
|
|
bar, on the very bottom of the &app; window.
|
|
It displays information about current <application>&app;</application>
|
|
activity and contextual information about the menu items.
|
|
The behavior of the Status line can be adjusted in
|
|
<guilabel>Preferences</guilabel> dialog. </para></listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>Display area</term>
|
|
<listitem><para>The largest area in the center of the
|
|
&app; window is the display area.
|
|
It shows certain aspects of genealogical information, depending on the
|
|
currently selected View. The following six Views are available
|
|
in <application>&app;</application>:
|
|
<itemizedlist>
|
|
<listitem><para>People View</para></listitem>
|
|
<listitem><para>Family View</para></listitem>
|
|
<listitem><para>Pedigree View</para></listitem>
|
|
<listitem><para>Sources View</para></listitem>
|
|
<listitem><para>Places View</para></listitem>
|
|
<listitem><para>Media View</para></listitem>
|
|
|
|
</itemizedlist>
|
|
</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
<!-- ================ Main Window Subsection -->
|
|
<sect2 id="gramps-views">
|
|
<title>Views</title>
|
|
<para>Views are the various ways to display different aspects of
|
|
genealogical information, as described below. Since the relevant
|
|
information is very broad and non-uniform in both context and modality,
|
|
it is best to split it's display into smaller categories, uniform in
|
|
context and modality. Each View represents such a split and displays a
|
|
certain portion of overall available information. Before the detailed
|
|
description of available Views, let us guide you through the ways of
|
|
switching between the Views.</para>
|
|
|
|
<!-- ================ Main Window Sub-subsection -->
|
|
<sect3 id="view-modes">
|
|
<title>Switching Views and Viewing Modes</title>
|
|
<para>Depending on the state of the <menuchoice>
|
|
<guimenu>View</guimenu><guimenuitem>Sidebar</guimenuitem>
|
|
</menuchoice> menu item, the View could be switched either in the
|
|
sidebar or in the notebook tabs in the top part of the window.
|
|
</para>
|
|
|
|
<variablelist>
|
|
<varlistentry><term>To switch the View while in a Sidebar mode,
|
|
click on the desired sidebar icon.</term>
|
|
<listitem>
|
|
<!-- ==== Figure: Sidebar Mode ==== -->
|
|
<figure id="side-nofilt-fig">
|
|
<title>Sidebar Viewing Mode</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/mainwin.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows sidebar viewing mode. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
</listitem></varlistentry>
|
|
|
|
<varlistentry><term>To switch the View while in a Notebook mode,
|
|
click on the desired notebook tab.</term>
|
|
<listitem>
|
|
<!-- ==== Figure: Tabbed Notebook Mode ==== -->
|
|
<figure id="noside-nofilt-fig">
|
|
<title>Tabbed Viewing Mode</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/noside-nofilt.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows tabbed viewing mode. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<para>To switch between sidebar and notebook viewing modes,
|
|
choose <menuchoice> <guimenu>View</guimenu>
|
|
<guimenuitem>Sidebar</guimenuitem>
|
|
</menuchoice> from the <application>&app;</application> menu.</para>
|
|
|
|
</sect3>
|
|
|
|
<!-- ================ Main Window Sub-subsection -->
|
|
<sect3 id="people-view">
|
|
<title>People View</title>
|
|
<para>When <application>&app;</application> opens a database,
|
|
the View is set to the People View (<xref linkend="side-nofilt-fig"/>
|
|
and <xref linkend="noside-nofilt-fig"/>). People View lists individuals
|
|
whose data is stored in the database. People View displays people's
|
|
<guilabel>Names</guilabel>, &app; <guilabel>ID</guilabel> numbers,
|
|
<guilabel>Gender</guilabel>, and
|
|
their <guilabel>Birth</guilabel> and <guilabel>Death dates</guilabel>.
|
|
The list can be ordered by any field.</para>
|
|
|
|
<para>Example: to order list by the Birth date, click on the
|
|
<guilabel>Birth date</guilabel> column heading. To order list in
|
|
reverse (descending) order, click one more time on the desired column
|
|
heading. </para>
|
|
|
|
<!-- ================ Main Window Sub-sub-subsection -->
|
|
<sect4 id="filters">
|
|
<title>Filters</title>
|
|
<para>Genealogical databases may contain huge numbers of people.
|
|
Since the long lists are hard for humans to handle,
|
|
<application>&app;</application> provides a convenient way to limit
|
|
the scope of browsing by using the Filter. To save screen space,
|
|
Filter controls may be hidden, depending on the state of
|
|
<menuchoice> <guimenu>View</guimenu>
|
|
<guimenuitem>Filter</guimenuitem> </menuchoice> menu item.</para>
|
|
|
|
<!-- ==== Figure: Enabled Filter ==== -->
|
|
<figure id="side-filt-fig">
|
|
<title>Filter Controls Displayed</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/side-filt.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows filter controls. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para>When <application>&app;</application> opens a database, the
|
|
Filter is set to the trivial filter called <guilabel>All
|
|
people</guilabel>, i.e. no filtering is in effect. To choose a
|
|
filter, use a pop-up <guilabel>Filter</guilabel> menu above the
|
|
people's list. Once the Filter is chosen, click
|
|
<guibutton>Apply</guibutton> in the upper right corner of the
|
|
window. The filtering will take effect upon clicking
|
|
<guibutton>Apply</guibutton>. To invert the filtering rule, check
|
|
the <guilabel>Invert</guilabel> box on the left
|
|
of <guibutton>Apply</guibutton> button. </para>
|
|
|
|
<para>Example: To show people without children, choose
|
|
<guilabel>People with children</guilabel> filter, then check
|
|
<guilabel>Invert</guilabel> box, and then click
|
|
<guibutton>Apply</guibutton>. To cancel any filtering, set
|
|
the filter to <guilabel>All people</guilabel>
|
|
and then click <guibutton>Apply</guibutton>. </para>
|
|
|
|
<para>Note: even if the Filter controls are not displayed
|
|
(<menuchoice> <guimenu>View</guimenu>
|
|
<guimenuitem>Filter</guimenuitem> </menuchoice> menu item is
|
|
unchecked), the filtering might still be in place. In other words,
|
|
the visibility of the Filter controls is not related to the actual
|
|
filtering imposed on the list. This may be a cause of confusion, when
|
|
you enable the filtering and then remove the controls from the
|
|
display. If in doubt, enable the display of Filter controls by
|
|
checking <menuchoice> <guimenu>View</guimenu>
|
|
<guimenuitem>Filter</guimenuitem> </menuchoice> menu item and check
|
|
what kind of filtering is currently set.</para>
|
|
</sect4>
|
|
|
|
<!-- ================ Main Window Sub-sub-subsection -->
|
|
<sect4 id="alpha-tabs">
|
|
<title>Alphabetical Tabs</title>
|
|
<para><application>&app;</application> offers another way of
|
|
managing long lists of people -- alphabetical tabs. Upon loading a
|
|
database, <application>&app;</application> checks for the stored
|
|
Family names and breaks the people list into sublists based on the
|
|
first letter of their name. The alphabetical tabs are displayed in
|
|
the bottom part of the &app; window.
|
|
The last tab, <guilabel>Other</guilabel>, stands for unidentified
|
|
characters -- all the entries not assigned to any other tab end up
|
|
in <guilabel>Other</guilabel>. In particular, people with no family
|
|
name will appear under this category.</para>
|
|
</sect4>
|
|
|
|
</sect3>
|
|
|
|
<!-- ================ Main Window Sub-subsection -->
|
|
<sect3 id="family-view">
|
|
<title>Family View</title>
|
|
<para>Family View displays the Family information of a currently
|
|
selected (or Active) person. Specifically, this view shows the
|
|
relationships (e.g marriages, partnerships, etc.) of the active
|
|
person, his/her parents (or step parents, or guardians, etc), and
|
|
his/her children (could be step children, adopted children, etc.).
|
|
</para>
|
|
|
|
<!-- ==== Figure: Family View ==== -->
|
|
<figure id="family-fig">
|
|
<title>Family View</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/family.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Family View. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para>The Active person's data is in the list-box in the upper left
|
|
corner of the window. Directly below it, another box lists the Spouse's
|
|
data, for each relationship of Active person (can be more than one).
|
|
The double-arrow button to the right of the Active person list-box
|
|
allows to exchange the currently selected spouse (Current spouse)
|
|
with the Active person. Double-clicking on the Active person allows
|
|
to edit Active person's data. Double-clicking on the Current spouse
|
|
allows to edit their relationship information. To add a spouse,
|
|
click <guibutton>+</guibutton> to the right of the spouse box.
|
|
To remove Current spouse, click <guibutton>-</guibutton> to the
|
|
right of the spouse box. </para>
|
|
|
|
<para>The parents of both the Active person and the Current spouse
|
|
are listed in the corresponding list-boxes in the right-hand part of
|
|
the window (Active person's parents on top, Current spouse parents
|
|
on the bottom). Both list-boxes have a set of three buttons on their
|
|
right side. The <guibutton>+</guibutton> and <guibutton>-</guibutton>
|
|
buttons allow to add and remove parents of the Active person and the
|
|
Current spouse, respectively. Clicking <guibutton>-></guibutton>
|
|
makes the family in the corresponding list-box and active family.
|
|
That is, it makes the selected Father the Active person, and the
|
|
selected Mother the Current spouse. </para>
|
|
|
|
<para>The bottom list-box displays children of the Active person and
|
|
the Current Spouse. Children's list can be order by the Birth date,
|
|
by usual way of clicking on the <guilabel>Birth date</guilabel> column
|
|
header. In addition to the <guilabel>Name</guilabel>,
|
|
<guilabel>ID</guilabel>, <guilabel>Gender</guilabel>, and
|
|
<guilabel>Birth date</guilabel> columns, the list includes
|
|
<guilabel>Status</guilabel> column. The pair of status words reflect the
|
|
relationship between the child and his Father/Mother (such as Birth, Adoption,
|
|
etc.) The three buttons are available on the right side of the
|
|
children list-box. The <guibutton>+</guibutton>
|
|
and <guibutton>+</guibutton> buttons allow to add and remove
|
|
children, respectively. Clicking left arrow button makes
|
|
the selected child the Active person.</para>
|
|
</sect3>
|
|
|
|
<!-- ================ Main Window Sub-subsection -->
|
|
<sect3 id="pedigree-view">
|
|
<title>Pedigree View</title>
|
|
|
|
<!-- ==== Figure: Pedigree View ==== -->
|
|
<figure id="pedigree-fig">
|
|
<title>Pedigree View</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/pedigree.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Pedigree View. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para>Pedigree View helps to visualize the place of the Active
|
|
person in the tree of its ancestors. Pedigree View shows four
|
|
generations, going back in time from the Active person
|
|
<guilabel>1</guilabel> to his/her parents <guilabel>1</guilabel>,
|
|
to grandparents <guilabel>1</guilabel>, to great-grandparents
|
|
<guilabel>1</guilabel>.
|
|
Each person is denoted by a white box bearing the person's name.
|
|
The two lines that converge on the box represent ties with the
|
|
person's Father (top line) and mother (bottom line). Solid lines
|
|
represent birth relations, while dashed lines represent non-birth
|
|
relations (such as adoption, step-parenthood, guardianship, etc.).
|
|
When the mouse moves over the white box, it expands to display the
|
|
corresponding person's dates of birth and death. When the mouse is
|
|
placed over the family line, the line changes color to indicate an
|
|
active link: double-clicking on the line makes the corresponding
|
|
ancestor the Active person. The display in that case is re-adjusted
|
|
to show four generations, starting from a newly selected Active
|
|
person. </para>
|
|
|
|
<para>The left-hand side of the window shows the left arrow button.
|
|
Upon clicking, the button expands to the menu listing the children
|
|
of the Active person. Selecting the menu item makes the corresponding
|
|
child the Active person. </para>
|
|
|
|
<para>The right-hand side of the window shows two right arrow buttons.
|
|
When the top button is clicked, the Father of the Active person
|
|
becomes Active person. Clicking the bottom button makes the Mother of
|
|
the Active person the Active person. Again, the display is re-adjusted
|
|
to show four generations, starting from a newly selected Active
|
|
person.</para>
|
|
</sect3>
|
|
|
|
<!-- ================ Main Window Sub-subsection -->
|
|
<sect3 id="sources-view">
|
|
<title>Sources View</title>
|
|
|
|
<!-- ==== Figure: Sources View ==== -->
|
|
<figure id="sources-fig">
|
|
<title>Sources View</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/sources.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Sources View. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para>Sources View lists the sources of information stored in the
|
|
database. This can include various documents (birth, death, and
|
|
marriage certificates, etc.), books, films, journals, private diaries,
|
|
i.e. virtually anything that can be classified as a source of
|
|
information. The sources can be used as the reference for any event
|
|
stored in the database. The Source View lists the
|
|
<guilabel>Title</guilabel>, <guilabel>ID</guilabel>, and the
|
|
<guilabel>Author</guilabel> of the source. All the columns can be
|
|
used for sorting the list. The usual rules apply: one click for
|
|
ascending order, another click for descending order.</para>
|
|
</sect3>
|
|
|
|
<!-- ================ Main Window Sub-subsection -->
|
|
<sect3 id="places-view">
|
|
<title>Places View</title>
|
|
|
|
<!-- ==== Figure: Places View ==== -->
|
|
<figure id="places-fig">
|
|
<title>Places View</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/places.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Places View. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para>Places View lists the geographical places in which the events
|
|
of the database took place. These could be places of birth, death,
|
|
marriages of people, as well as their home, employment, education
|
|
addresses, or any other conceivable reference to the geographical
|
|
location. The Places View lists places' <guilabel>Name</guilabel>,
|
|
<guilabel>ID</guilabel>, <guilabel>Church Parish</guilabel>,
|
|
<guilabel>City</guilabel>, <guilabel>County</guilabel>,
|
|
<guilabel>State</guilabel>, and <guilabel>Country</guilabel>. All of
|
|
these can be used for sorting by the usual sorting rules. </para>
|
|
</sect3>
|
|
|
|
<!-- ================ Main Window Sub-subsection -->
|
|
<sect3 id="media-view">
|
|
<title>Media View</title>
|
|
|
|
<!-- ==== Figure: Media View ==== -->
|
|
<figure id="media-fig">
|
|
<title>Media View</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/media.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Media View. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para>Media View is a list of Media Objects used in the database.
|
|
Media Objects are any files that relate somehow to the stored
|
|
genealogical data. Technically, any file can be stored as a Media
|
|
Object. Most frequently, these are images, audio files, animation
|
|
files, etc. The list-box on the bottom lists the Name, ID, Type, and
|
|
Path to the Media Object. The top part of the GRAMPS window shows
|
|
the preview (if available) and the information about the Media
|
|
Object. </para>
|
|
</sect3>
|
|
|
|
</sect2>
|
|
</sect1> <!-- ================ End Main Window ===================== -->
|
|
|
|
|
|
<!-- ================ Usage ================================ -->
|
|
<sect1 id="gramps-usage">
|
|
<title>Usage</title>
|
|
<para>As commonly encountered in everyday life, in
|
|
<application>&app;</application> there is usually more than one way to
|
|
accomplish something. The alternatives to some actions will therefore
|
|
be listed as appropriate.</para>
|
|
|
|
<!-- ================ Usage Subsection ================================ -->
|
|
<sect2 id="open-db">
|
|
<title>Opening Database</title>
|
|
<para>To open a database, either choose <menuchoice>
|
|
<guimenu>File</guimenu><guimenuitem>Open</guimenuitem></menuchoice>
|
|
or click <guibutton>Open</guibutton> button on the Toolbar.
|
|
The <guilabel>Open Database</guilabel> dialog will appear.
|
|
Either type the full path into the <guilabel>Database</guilabel> text
|
|
entry field, or click <guibutton>Browse...</guibutton> to get the
|
|
<guilabel>Open File</guilabel> dialog in which you can select the file
|
|
that you want to open. After you have selected the file, click
|
|
<guibutton>OK</guibutton> to open it. </para>
|
|
|
|
<para>If you have previously opened files with
|
|
<application>&app;</application> you can retrieve your past selections
|
|
from the drop-down menu by clicking the down arrow button. Finally, if
|
|
the Revision Control System (RCS) is enabled in the
|
|
<guilabel>Preferences</guilabel> dialog, the check-box
|
|
<guilabel>Revert to an older version from RCS</guilabel>
|
|
will be available. Check it to revert your database to an older RCS
|
|
version. </para>
|
|
|
|
<para>Note: the name you type or select should be the directory
|
|
(folder) which has your data (data.gramps or data.zodb files) as well as
|
|
any possible copies of Media Objects. </para>
|
|
</sect2>
|
|
|
|
<!-- ================ Usage Subsection ================================ -->
|
|
<sect2 id="new-db">
|
|
<title>Starting New Database</title>
|
|
<para>To start a new database, choose <menuchoice><guimenu>File</guimenu>
|
|
<guimenuitem>New</guimenuitem></menuchoice>. You will then be
|
|
prompted with the <guilabel>Save Database</guilabel> dialog asking
|
|
to specify the name under which the new database will be stored.
|
|
Choose an empty directory for your new database (create one if
|
|
necessary). </para>
|
|
</sect2>
|
|
|
|
<!-- ================ Usage Subsection ================================ -->
|
|
<sect2 id="save-db">
|
|
<title>Saving Database</title>
|
|
<para>To save changes made to your database, choose <menuchoice>
|
|
<guimenu>File</guimenu>
|
|
<guimenuitem>Save</guimenuitem></menuchoice> or click
|
|
<guibutton>Save</guibutton> on the Toolbar. The Status line will then
|
|
display <guilabel>Saving <replaceable>filename</replaceable>...</guilabel>
|
|
message, and the progress bar will advance as the saving progresses.</para>
|
|
</sect2>
|
|
|
|
<!-- ================ Usage Subsection ================================ -->
|
|
<sect2 id="import-gedcom">
|
|
<title>Importing GEDCOM Data</title>
|
|
<para>Importing GEDCOM data allows you to incorporate the data created in
|
|
other genealogical programs into your currently open &app; database.
|
|
<application>&app;</application> can import GEDCOM data files from a
|
|
number of software packages, as long as they comply with GEDCOM
|
|
standards. To import GEDCOM file, choose <menuchoice><guimenu>File</guimenu>
|
|
<guisubmenu>Import</guisubmenu><guimenuitem>Import from
|
|
GEDCOM</guimenuitem></menuchoice>. You will then be prompted with the
|
|
<guilabel>Open File</guilabel> dialog asking to specify the GEDCOM file
|
|
name. </para>
|
|
|
|
<para>Upon starting the import, <application>&app;</application> will
|
|
display the following GEDCOM import dialog with the summary of the
|
|
information about the data. The information is updated as the import
|
|
progresses. </para>
|
|
|
|
<!-- ==== Figure: GEDCOM Import ==== -->
|
|
<figure id="gedcom-import-fig">
|
|
<title>GEDCOM Import</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/gedcom-import.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows GEDCOM Import Window. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
</sect2>
|
|
<!-- ================ Usage Subsection ================================ -->
|
|
<sect2 id="export-gedcom">
|
|
<title>Exporting GEDCOM Data</title>
|
|
<para>Exporting GEDCOM data allows you to share any portion of your
|
|
&app; database with other researchers
|
|
by way of standard GEDCOM files. To export into GEDCOM file,
|
|
choose <menuchoice> <guimenu>File</guimenu>
|
|
<guisubmenu>Export</guisubmenu>
|
|
<guimenuitem>Export to GEDCOM</guimenuitem></menuchoice>. The following
|
|
<guilabel>Export GEDCOM file</guilabel> dialog will appear.</para>
|
|
|
|
<!-- ==== Figure: GEDCOM Export ==== -->
|
|
<figure id="gedcom-export-fig">
|
|
<title>Export GEDCOM File dialog</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/gedcom-export.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Export GEDCOM File dialog</phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Export ==== -->
|
|
|
|
<para>Type the desired GEDCOM filename into the text entry box or
|
|
click <guibutton>Browse...</guibutton> to evoke
|
|
<guilabel>Save File</guilabel> dialog. Use <guilabel>Filter</guilabel>
|
|
pop-up menu to limit the scope of export according to the stated rule.
|
|
Choose the desired <guilabel>Encoding</guilabel> of the exported file.
|
|
Use <guilabel>Target</guilabel> to select the desired GEDCOM
|
|
dialect. Select you copyright statement from the
|
|
<guilabel>Copyright</guilabel> menu. Check <guilabel>Do not include
|
|
records marked private</guilabel> to disable the output of private
|
|
records. Check <guilabel>Restrict data on living people</guilabel>
|
|
to limit living people's data to family ties. With this option,
|
|
information concerning birth, death, addresses, various events,
|
|
etc. will be omitted in the exported GEDCOM file.
|
|
</para>
|
|
|
|
<para>Upon starting the export, <application>&app;</application> will
|
|
display the following GEDCOM export progress window with the progress
|
|
bars reflecting the current state of exporting. </para>
|
|
|
|
<!-- ==== Figure: GEDCOM Export ==== -->
|
|
<figure id="gedcom-export-progress-fig">
|
|
<title>Export GEDCOM progress dialog</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/gedcom-export-progress.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Export GEDCOM progress dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Export ==== -->
|
|
</sect2>
|
|
|
|
<!-- ================ Usage Subsection ================================ -->
|
|
<sect2 id="gramps-package-impex">
|
|
<title>Importing and Exporting &app; Packages</title>
|
|
<para> <application>&app;</application> provides a way to make your
|
|
&app; database completely portable. This might
|
|
prove useful, for instance, when you need to move your database to
|
|
another machine or to share it with somebody, while retaining all the
|
|
features provided by <application>&app;</application>. To accomplish
|
|
this, choose <menuchoice><guimenu>File</guimenu>
|
|
<guisubmenu>Export</guisubmenu>
|
|
<guimenuitem>Export to GRAMPS Package</guimenuitem></menuchoice>. The
|
|
<guilabel>GRAMPS Package Export</guilabel> window will appear. Type
|
|
the desired package name into the text entry area or click
|
|
<guibutton>Browse...</guibutton> to select the file using the
|
|
<guilabel>Save File</guilabel> dialog. The resulting package is
|
|
gzip-compressed tar archive (also known as tarball) which contains
|
|
gramps database, all local media objects, and copies of all external
|
|
media objects. </para>
|
|
|
|
<para>To import data from such a package into your &app; database, choose
|
|
<menuchoice><guimenu>File</guimenu><guisubmenu>Import</guisubmenu>
|
|
<guimenuitem>Import from GRAMPS</guimenuitem></menuchoice>, then select
|
|
a package to be imported from the <guilabel>Import from GRAMPS</guilabel>
|
|
dialog. </para>
|
|
</sect2>
|
|
|
|
<!-- ================ Usage Subsection ================================ -->
|
|
<sect2 id="gramps-edit-quick">
|
|
<title>Editing Data: Quick Start</title>
|
|
<para> Editing any portion of data allows you to amend and/or
|
|
modify information stored in the database. The available editing
|
|
options include editing personal data, relationship data, data about
|
|
children and parents, information about sources, places, and media
|
|
objects used in the database. In short, any data stored in the
|
|
database can be edited! Adding new pieces of information is in fact
|
|
creating an appropriate empty data structure and subsequent
|
|
editing of that empty structure. </para>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="gramps-add-pers">
|
|
<title>To Add a Person</title>
|
|
<para> To add a person to the database, switch to the People View
|
|
(<xref linkend="side-nofilt-fig"/>) and then click
|
|
<guibutton>Add</guibutton> on the toolbar.
|
|
Enter any data you know about this person into the <guilabel>Edit
|
|
Person</guilabel> Dialog (see <xref linkend="edit-pers-fig"/>
|
|
for details). To edit information about a person already present
|
|
in the database, select an entry you would like to view/modify,
|
|
and then click <guibutton>Edit</guibutton> on the toolbar. </para>
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="gramps-spec-rel">
|
|
<title>To Specify a Relationship</title>
|
|
<para>To specify a relationship, first switch to the Family View
|
|
(<xref linkend="family-fig"/>). Then click <guibutton>+</guibutton>
|
|
button on the right of the spouse box. Select a spouse/partner from the
|
|
list and specify their relationship using the menu at the bottom. If
|
|
necessary, you can add a person to the list by clicking
|
|
<guibutton>Add...</guibutton> button. To edit information about
|
|
relationship already present in the database, move the mouse over
|
|
<guilabel>Spouse</guilabel> box and double-click.
|
|
</para>
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="gramps-spec-par">
|
|
<title>To Specify Parents</title>
|
|
<para>To specify parents of an active person, first switch to the
|
|
Family View (<xref linkend="family-fig"/>). Then click
|
|
<guibutton>+</guibutton> button on the right of the active person's
|
|
parents list-box. Select the parents from two lists and specify the
|
|
parents' relationships to the active person using menus at the bottom.
|
|
You can also specify parents' relationship to each other.
|
|
If necessary, you can add a person to the list by clicking
|
|
<guibutton>Add...</guibutton> button. </para>
|
|
|
|
<para> The top and bottom lists contain males and females,
|
|
respectively. By default, <application>&app;</application> will
|
|
limit both lists to people who could possibly be the parents (judged
|
|
by the date of birth) of the active person. To override this, check
|
|
the <guilabel>Show all</guilabel> box for each list.
|
|
</para>
|
|
|
|
<para>To specify parents of the active person's spouse, switch to the
|
|
Family View and then click <guibutton>+</guibutton> button on the
|
|
right of the spouse's parents list-box. To edit information about
|
|
parents already present in the database, move the mouse over
|
|
the corresponding parents' box and double-click.</para>
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="gramps-spec-ch">
|
|
<title>To Specify Children</title>
|
|
<para>To specify children of an active person, switch to the
|
|
Family View (<xref linkend="family-fig"/>) and then
|
|
click <guibutton>+</guibutton> button on the
|
|
right of the children list-box. Select a child from the list and
|
|
specify child's relationship with father and mother using menus
|
|
at the bottom. If necessary, you can add a person to the list by
|
|
clicking <guibutton>Add...</guibutton> button.</para>
|
|
|
|
<para> By default, <application>&app;</application> will
|
|
limit the list lists to people who could possibly be the child (judged
|
|
by the date of birth) of the active person. To override this, check
|
|
the <guilabel>Show all</guilabel> box.
|
|
</para>
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="gramps-add-img">
|
|
<title>To Add Images</title>
|
|
<para>You can add images (as well as other media objects) to
|
|
individual people, events, sources, places, as well as images
|
|
generally related to the database (e.g. group family photos). </para>
|
|
|
|
<para> To add images related to a single person, switch to the
|
|
People View (<xref linkend="side-nofilt-fig"/>), select a person, and
|
|
then click <guibutton>Edit</guibutton> on the toolbar to invoke
|
|
the <guilabel>Edit Person</guilabel> Dialog
|
|
(<xref linkend="edit-pers-fig"/>). Then, select the
|
|
<guilabel>Gallery</guilabel> tab, and click
|
|
<guibutton>Add...</guibutton> to invoke <guilabel>Select a media
|
|
object</guilabel> dialog. Type filename or select a file with the
|
|
image, then provide a title for that image. To prevent the file from
|
|
being copied into your database directory, check the <guilabel>Do not
|
|
make a local copy</guilabel> box. Keep adding images until you are
|
|
done. </para>
|
|
|
|
<para> To add images related to a relationship (e.g. marriage),
|
|
switch to the Family View (<xref linkend="family-fig"/>) and then
|
|
double click on the Spouse box invoke <guilabel>Marriage/Relationship
|
|
editor</guilabel> dialog. Select the <guilabel>Gallery</guilabel>
|
|
tab and click <guibutton>Add...</guibutton> to add an image. </para>
|
|
|
|
<para> To add images related to a source or a place, first switch to
|
|
the Sources View (<xref linkend="sources-fig"/>) or Places
|
|
View (<xref linkend="places-fig"/>), respectively. Then select the
|
|
appropriate source or place and then either double click on it
|
|
or click <guibutton>Edit</guibutton> on the toolbar to invoke
|
|
<guilabel>Source Editor</guilabel> (or <guilabel>Place
|
|
Editor</guilabel>) dialog. Select the <guilabel>Gallery</guilabel>
|
|
tab and click <guibutton>Add...</guibutton> to add an image. </para>
|
|
|
|
<para> Finally, to add images that are generally related to the
|
|
database but not limited to any person, relationship, source, or place
|
|
in particular, switch to the Media View (<xref linkend="media-fig"/>).
|
|
Then click <guibutton>Add</guibutton> on the toolbar to add an image.
|
|
If you have already added any images to any individual galleries,
|
|
you will also find the listed in the Media View. </para>
|
|
|
|
<para> In any gallery, you can also use <guibutton>Edit...</guibutton>
|
|
and <guibutton>Remove</guibutton> buttons to edit image information
|
|
and to remove the image reference from that gallery. Note that in all
|
|
galleries removing the reference to the image does not remove the image
|
|
from the database. To completely remove the image from the database,
|
|
delete it from Media View by first selecting it and then
|
|
clicking <guibutton>Remove</guibutton> on the toolbar. </para>
|
|
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="gramps-edit-src-plc">
|
|
<title>To Edit Sources and Places</title>
|
|
|
|
<para> To add a source or a place to the database, switch to
|
|
the appropriate Sources View (<xref linkend="sources-fig"/>) or
|
|
Places View (<xref linkend="places-fig"/>).
|
|
Then click <guibutton>Add</guibutton> on the toolbar to add a
|
|
source/place. Enter the information into the <guilabel>Source
|
|
Editor</guilabel> (or <guilabel>Place Editor</guilabel>) dialog.
|
|
</para>
|
|
|
|
<para> To edit information about sources and places already present
|
|
in the database, switch to the appropriate view, select an entry
|
|
you would like to view/modify, and then click
|
|
<guibutton>Edit</guibutton> on the toolbar.
|
|
</para>
|
|
|
|
</sect3>
|
|
</sect2>
|
|
|
|
<!-- ================ Usage Subsection ================================ -->
|
|
<sect2 id="gramps-edit-complete">
|
|
<title>Editing Data: Complete Description</title>
|
|
<para> This section provides a complete description of all editing
|
|
options for all pieces of data in the &app; database. </para>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="adv-pers">
|
|
<title>Edit Personal Information</title>
|
|
<para> Editing of personal data can be performed in the
|
|
following ways. </para>
|
|
<variablelist>
|
|
<varlistentry><term>From People View:</term><listitem><para>
|
|
Double-click the name of the person whose data you would like
|
|
to edit, or select the name by single click and then click
|
|
<guibutton>Edit</guibutton> on the toolbar.
|
|
</para></listitem></varlistentry>
|
|
<varlistentry><term>From Family View:</term><listitem><para>
|
|
Move the mouse into the <guilabel>Active person</guilabel> box,
|
|
then double-click.
|
|
</para></listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<para> With either method, the following <guilabel>Edit
|
|
Person</guilabel> dialog will appear: </para>
|
|
|
|
<!-- ==== Figure: Edit Person dialog ==== -->
|
|
<figure id="edit-pers-fig">
|
|
<title>Edit Person dialog</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-person.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Edit Person dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> The top of the window shows the name of the person whose
|
|
data is being edited. The main part of the window displays nine
|
|
notebook tabs containing different categories of available
|
|
information. You can bring any tab to the top for viewing
|
|
or editing by clicking on the appropriate tab heading.
|
|
The bottom part has <guibutton>OK</guibutton> and
|
|
<guibutton>Cancel</guibutton> buttons. Clicking <guibutton>OK</guibutton>
|
|
at any time will apply all the changes made in all tabs and close the
|
|
dialog window. Clicking <guibutton>Cancel</guibutton> at any time will
|
|
close the window without applying any changes. If any of the data
|
|
in any tab was modified, the alert window will appear with the
|
|
choices of closing the dialog without saving changes, canceling the
|
|
initial cancel request, or saving the changes.
|
|
</para>
|
|
|
|
<para>
|
|
The tabs provide the following information categories of
|
|
personal data:
|
|
</para>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>General</guilabel></term>
|
|
<listitem><para>
|
|
<guilabel>General</guilabel> tab allows editing of
|
|
the most general information about the person. This includes text
|
|
entry fields of <guilabel>Given name</guilabel>,
|
|
<guilabel>Family name</guilabel>, <guilabel>Family prefix</guilabel>
|
|
(such as de or van), <guilabel>Suffix</guilabel> (e.g. Jr. or III),
|
|
<guilabel>Title</guilabel> (e.g. Dr. or Rev.),
|
|
<guilabel>Nickname</guilabel> (Bob for Robert),
|
|
<guilabel>Type</guilabel> of the name (birth name, married name, etc.)
|
|
and <guilabel>Date</guilabel> and <guilabel>Place</guilabel> of birth
|
|
and death. Some of these (<guilabel>Family name</guilabel>,
|
|
<guilabel>Type</guilabel>, and both <guilabel>Place</guilabel> fields),
|
|
in addition to typing the data in, allow to choose the corresponding
|
|
contents from the drop-down menus by clicking on a down-arrow button
|
|
located immediately to the right of the text entry field. The
|
|
available menu choices are formed from the information already stored
|
|
in the database. Also, when you start to type within these fields,
|
|
<application>&app;</application> will try to guess the remainder of
|
|
the text by using the same choices that are available from the
|
|
corresponding menu. To accept the highlighted guess and move to
|
|
the next field, press <keycap>Tab</keycap>. </para>
|
|
|
|
<para>
|
|
The <guilabel>Gender</guilabel> radio buttons offers
|
|
the choice of person's gender between <guilabel>male</guilabel>,
|
|
<guilabel>female</guilabel>, and <guilabel>unknown</guilabel>.
|
|
The buttons <guibutton>Source...</guibutton> and
|
|
<guibutton>Note...</guibutton> allow to add or modify the data about
|
|
the sources of the name information and any notes relevant to it.
|
|
Similarly, clicking <guibutton>Edit...</guibutton> buttons located by the
|
|
birth and death <guilabel>Date</guilabel> fields allows to edit the
|
|
corresponding events of birth and death.
|
|
The field <guilabel>ID</guilabel> displays internal
|
|
&app; ID number which identifies user in the
|
|
database. Finally, the <guilabel>Image</guilabel> area shows the first
|
|
image available in the <guilabel>Gallery</guilabel> of this person.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Names</guilabel></term>
|
|
<listitem>
|
|
|
|
<!-- ==== Figure: Edit Person dialog - Names ==== -->
|
|
<figure id="edit-pers-names-fig">
|
|
<title>Edit Person dialog - Names</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-person-names.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Names Tab of Edit Person dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> <guilabel>Names</guilabel> tab displays information concerning
|
|
alternate names of the person and the controls allowing its
|
|
modification. The bottom part displays the list of all alternate names
|
|
of the person stored in the database. The top part shows the details
|
|
of the currently selected name in the list (if any). The buttons
|
|
<guibutton>Add...</guibutton>, <guibutton>Edit...</guibutton>,
|
|
and <guibutton>Delete</guibutton> allow to correspondingly add,
|
|
modify, and remove an alternate name record from the database.
|
|
Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Delete</guibutton> buttons become available only when
|
|
an alternate name is selected from the list.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Events</guilabel></term>
|
|
<listitem>
|
|
|
|
<!-- ==== Figure: Edit Person dialog - Events ==== -->
|
|
<figure id="edit-pers-events-fig">
|
|
<title>Edit Person dialog - Events</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-person-events.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Events Tab of Edit Person dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> <guilabel>Events</guilabel> tab displays information about
|
|
the events relevant to the person and the controls allowing its
|
|
modification. The bottom part displays the list of all such events
|
|
stored in the database. The top part shows the details
|
|
of the currently selected event in the list (if any). The buttons
|
|
<guibutton>Add...</guibutton>, <guibutton>Edit...</guibutton>,
|
|
and <guibutton>Delete</guibutton> allow to correspondingly add,
|
|
modify, and remove an event record from the database.
|
|
Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Delete</guibutton> buttons become available only when
|
|
an event is selected from the list.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Attributes</guilabel></term>
|
|
<listitem>
|
|
|
|
<!-- ==== Figure: Edit Person dialog - Attributes ==== -->
|
|
<figure id="edit-pers-attributes-fig">
|
|
<title>Edit Person dialog - Attributes</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-person-attributes.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Attributes Tab of Edit Person dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> <guilabel>Attributes</guilabel> tab displays information about
|
|
the attributes of the person and the controls allowing its
|
|
modification. These could be any personal attributes of a person whose
|
|
description naturally fits into Parameter-Value pairs (e.g. enormous
|
|
generosity can be stored as the parameter "Generosity" with the
|
|
value "Enormous", etc.). The bottom part displays the list of all
|
|
attributes stored in the database. The top part shows the details
|
|
of the currently selected attribute in the list (if any). The buttons
|
|
<guibutton>Add...</guibutton>, <guibutton>Edit...</guibutton>,
|
|
and <guibutton>Delete</guibutton> allow to correspondingly add,
|
|
modify, and remove an attribute record from the database.
|
|
Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Delete</guibutton> buttons become available only when
|
|
an attribute is selected from the list.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Addresses</guilabel></term>
|
|
<listitem>
|
|
|
|
<!-- ==== Figure: Edit Person dialog - Addresses ==== -->
|
|
<figure id="edit-pers-addresses-fig">
|
|
<title>Edit Person dialog - Addresses</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-person-addresses.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Addresses Tab of Edit Person dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> <guilabel>Addresses</guilabel> tab displays information about
|
|
the addresses of the person and the controls allowing its
|
|
modification. The bottom part displays the list of all
|
|
addresses stored in the database. The top part shows the details
|
|
of the currently selected address in the list (if any). The buttons
|
|
<guibutton>Add...</guibutton>, <guibutton>Edit...</guibutton>,
|
|
and <guibutton>Delete</guibutton> allow to correspondingly add,
|
|
modify, and remove an address record from the database.
|
|
Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Delete</guibutton> buttons become available only when
|
|
an address is selected from the list.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Notes</guilabel></term>
|
|
<listitem>
|
|
|
|
<!-- ==== Figure: Edit Person dialog - Notes ==== -->
|
|
<figure id="edit-pers-notes-fig">
|
|
<title>Edit Person dialog - Notes</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-person-notes.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Notes Tab of Edit Person dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> <guilabel>Notes</guilabel> tab displays information about
|
|
the notes concerning the person. These could be any notes which do not
|
|
naturally fit into the Parameter-Value pairs available to Attributes.
|
|
To add a note or modify existing notes simply edit the text in the
|
|
text entry field.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Gallery</guilabel></term>
|
|
<listitem>
|
|
|
|
<!-- ==== Figure: Edit Person dialog - Gallery ==== -->
|
|
<figure id="edit-pers-gallery-fig">
|
|
<title>Edit Person dialog - Gallery</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-person-gallery.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Gallery Tab of Edit Person dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> <guilabel>Gallery</guilabel> tab displays information about
|
|
media objects associated with the person and the controls allowing its
|
|
modification. The central part shows the list of all such media objects.
|
|
For media object which are valid image files previews of images are
|
|
displayed. For other objects such as audio files, movie files, etc.
|
|
generic &app; icon is displayed instead. Note that the first available
|
|
image in the gallery will be also displayed in the
|
|
<guilabel>Image</guilabel> area in the <guilabel>General</guilabel>
|
|
tab. The buttons <guibutton>Add...</guibutton>,
|
|
<guibutton>Edit...</guibutton>, and <guibutton>Remove</guibutton> allow
|
|
to correspondingly add, modify, and remove a media object reference
|
|
to this person. Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Remove</guibutton> buttons become available only when
|
|
a media object is selected from the list.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Internet</guilabel></term>
|
|
<listitem>
|
|
|
|
<!-- ==== Figure: Edit Person dialog - Internet ==== -->
|
|
<figure id="edit-pers-internet-fig">
|
|
<title>Edit Person dialog - Internet</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-person-internet.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Internet Tab of Edit Person dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> <guilabel>Internet</guilabel> tab displays information about
|
|
Internet addresses relevant to the person and the controls
|
|
allowing its modification. The bottom part displays the list of all
|
|
such Internet addresses stored in the database. The top part shows the
|
|
details of the currently selected addresses in the list (if any).
|
|
The buttons <guibutton>Add...</guibutton>,
|
|
<guibutton>Edit...</guibutton>, and <guibutton>Delete</guibutton>
|
|
allow to correspondingly add, modify, and remove an Internet address
|
|
record from the database. The button <guibutton>Go</guibutton> allows
|
|
to open a web-page with the corresponding address with your default
|
|
browser. Note that <guibutton>Edit...</guibutton>,
|
|
<guibutton>Delete</guibutton>, and <guibutton>Go</guibutton> buttons
|
|
become available only when an address is selected from the list.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>LDS</guilabel></term>
|
|
<listitem>
|
|
|
|
<!-- ==== Figure: Edit Person dialog - LDS ==== -->
|
|
<figure id="edit-pers-lds-fig">
|
|
<title>Edit Person dialog - LDS</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-person-lds.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows LDS Tab of Edit Person dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> <guilabel>LDS</guilabel> tab displays information
|
|
about LDS ordinances of the person and the controls allowing its
|
|
modification. These are <guilabel>LDS baptism</guilabel>,
|
|
<guilabel>Endowment</guilabel>, and <guilabel>Sealed to
|
|
parents</guilabel> ordinances, as labeled inside the tab.
|
|
Each ordinance is described by its date, LDS temple, and Place where
|
|
it happened. An additional pop-up menu <guilabel>Parents</guilabel> is
|
|
available for the <guilabel>Sealed to parents</guilabel> ordinance.
|
|
Each ordinance can further be described by its status through the
|
|
selections available in the <guilabel>Status</guilabel> pop-up
|
|
menu and can also be referenced by sources and notes via corresponding
|
|
<guibutton>Sources...</guibutton> and <guibutton>Note</guibutton>
|
|
buttons.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="adv-rel">
|
|
<title>Edit Relationship Data</title>
|
|
<para> Editing of relationship data is performed in the following
|
|
<guilabel>Marriage/Relationship Editor</guilabel> dialog which appears
|
|
after double-clicking on the spouse box in the Family View.</para>
|
|
|
|
<!-- ==== Figure: Edit Relationship dialog ==== -->
|
|
<figure id="edit-rel-fig">
|
|
<title>Marriage/Relationship Editor dialog</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-rel.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Marriage/Relationship Editor dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> The top of the window shows the names of the people whose
|
|
relationship is being edited. The main part of the window displays
|
|
six notebook tabs containing different categories of available
|
|
information. You can bring any tab to the top for viewing
|
|
or editing by clicking on the appropriate tab heading.
|
|
The bottom part has <guibutton>OK</guibutton> and
|
|
<guibutton>Cancel</guibutton> buttons. Clicking <guibutton>OK</guibutton>
|
|
at any time will apply all the changes made in all tabs and close the
|
|
dialog window. Clicking <guibutton>Cancel</guibutton> at any time will
|
|
close the window without applying any changes. If any of the data
|
|
in any tab was modified, the alert window will appear with the
|
|
choices of closing the dialog without saving changes, canceling the
|
|
initial cancel request, or saving the changes. </para>
|
|
|
|
<para>
|
|
The tabs provide the following information categories of
|
|
relationship data:
|
|
</para>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>General</guilabel></term>
|
|
<listitem><para>
|
|
<guilabel>General</guilabel> tab allows editing of the most general
|
|
information about the relationship: the relationship type.
|
|
The available types (such as married, partners, etc.) can be chosen
|
|
from the drop-down <guilabel>Relationship type</guilabel> menu.
|
|
The non-editable field <guilabel>ID</guilabel> displays internal &app;
|
|
ID number which identifies this relationship in the database.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Events</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>Events</guilabel> tab displays information about
|
|
the events relevant to the relationship and the controls allowing
|
|
its modification. The bottom part displays the list of all such events
|
|
stored in the database. The top part shows the details
|
|
of the currently selected event in the list (if any). The buttons
|
|
<guibutton>Add...</guibutton>, <guibutton>Edit...</guibutton>,
|
|
and <guibutton>Delete</guibutton> allow to correspondingly add,
|
|
modify, and remove an event record from the database.
|
|
Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Delete</guibutton> buttons become available only when
|
|
an event is selected from the list.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Attributes</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>Attributes</guilabel> tab displays information about
|
|
the attributes of the relationship and the controls allowing its
|
|
modification. The bottom part displays the list of all such
|
|
attributes stored in the database. The top part shows the details
|
|
of the currently selected attribute in the list (if any). The buttons
|
|
<guibutton>Add...</guibutton>, <guibutton>Edit...</guibutton>,
|
|
and <guibutton>Delete</guibutton> allow to correspondingly add,
|
|
modify, and remove an attribute record from the database.
|
|
Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Delete</guibutton> buttons become available only when
|
|
an attribute is selected from the list.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Notes</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>Notes</guilabel> tab displays information about the
|
|
notes concerning the relationship. These could be any notes which do
|
|
not naturally fit into the Parameter-Value pairs available to
|
|
Attributes. To add a note or modify existing notes simply edit the
|
|
text in the text entry field.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Gallery</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>Gallery</guilabel> tab displays information about
|
|
media objects associated with the person and the controls allowing its
|
|
modification. The central part shows the list of all such media objects.
|
|
For media object which are valid image files previews of images are
|
|
displayed. For other objects such as audio files, movie files, etc.
|
|
generic &app; icon is displayed instead. The buttons
|
|
<guibutton>Add...</guibutton>, <guibutton>Edit...</guibutton>,
|
|
and <guibutton>Remove</guibutton> allow to correspondingly add, modify,
|
|
and remove a media object reference to this relationship.
|
|
Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Remove</guibutton> buttons become available only when
|
|
a media object is selected from the list.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>LDS</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>LDS</guilabel> tab displays information
|
|
about LDS <guilabel>Sealed to spouse</guilabel> ordinance
|
|
of the person and the controls allowing its
|
|
modification. The data can include date, LDS temple, and Place where
|
|
it happened. The ordinance can further be described by its status
|
|
through the selections available in the <guilabel>Status</guilabel>
|
|
pop-up menu and can also be referenced by sources and notes via
|
|
corresponding <guibutton>Sources...</guibutton> and
|
|
<guibutton>Note</guibutton> buttons. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="adv-src">
|
|
<title>Edit Source Data</title>
|
|
<para> To edit source data, switch to the Sources View and select the
|
|
desired entry in the list of sources. Double-click on that entry or
|
|
click <guibutton>Edit</guibutton> on the toolbar to invoke the
|
|
following <guilabel>Source Editor</guilabel> dialog: </para>
|
|
|
|
<!-- ==== Figure: Source Editor dialog ==== -->
|
|
<figure id="edit-src-fig">
|
|
<title>Source Editor dialog</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-src.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Source Editor dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> The top of the window shows the <guilabel>Source Editor</guilabel>
|
|
title of the dialog. The main part of the window displays four notebook
|
|
tabs containing different categories of available information. You can
|
|
bring any tab to the top for viewing or editing by clicking on the
|
|
appropriate tab heading. The bottom part has <guibutton>OK</guibutton>
|
|
and <guibutton>Cancel</guibutton> buttons. Clicking
|
|
<guibutton>OK</guibutton> at any time will apply all the changes made
|
|
in all tabs and close the dialog window. Clicking
|
|
<guibutton>Cancel</guibutton> at any time will close the window without
|
|
applying any changes. If any of the data in any tab was modified,
|
|
the alert window will appear with the choices of closing the dialog
|
|
without saving changes, canceling the initial cancel request, or saving
|
|
the changes. </para>
|
|
|
|
<para>
|
|
The tabs provide the following information categories of
|
|
source data:
|
|
</para>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>General</guilabel></term>
|
|
<listitem><para>
|
|
<guilabel>General</guilabel> tab allows editing of the most general
|
|
information about the source: its title, author, and publication
|
|
information. This information can be typed in the appropriate
|
|
text entry fields.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Note</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>Note</guilabel> tab displays any notes concerning
|
|
the source. To add a note or modify existing notes simply edit the
|
|
text in the text entry field.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Gallery</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>Gallery</guilabel> tab displays information about
|
|
media objects associated with the given source and the controls
|
|
allowing its modification. The central part shows the list of all
|
|
such media objects. For media object which are valid image files
|
|
previews of images are displayed. For other objects such as audio
|
|
files, movie files, etc., generic &app; icon is displayed instead.
|
|
The buttons <guibutton>Add...</guibutton>,
|
|
<guibutton>Edit...</guibutton>, and <guibutton>Remove</guibutton> allow
|
|
to correspondingly add, modify, and remove a media object reference
|
|
to this source. Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Remove</guibutton> buttons become available only when
|
|
a media object is selected from the list.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>References</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>References</guilabel> tab displays information about
|
|
database records that refer to this source. If the source is not
|
|
referenced from any database record, the tab shows empty list.
|
|
If the source is referenced from many records, the tab will list
|
|
all of them. The list can be ordered by any of its column headers:
|
|
<guilabel>Source type</guilabel>, <guilabel>Object</guilabel>, or
|
|
<guilabel>Value</guilabel>. This information cannot be modified from
|
|
the <guilabel>Source Editor</guilabel> dialog. Instead, the
|
|
corresponding database record (e.g. birth event) has to be brought
|
|
up and its source reference edited. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="adv-plc">
|
|
<title>Edit Place Data</title>
|
|
<para> To edit place data, switch to the Places View and select the
|
|
desired entry in the list of places. Double-click on that entry or
|
|
click <guibutton>Edit</guibutton> on the toolbar to invoke the
|
|
following <guilabel>Place Editor</guilabel> dialog: </para>
|
|
|
|
<!-- ==== Figure: Place Editor dialog ==== -->
|
|
<figure id="edit-plc-fig">
|
|
<title>Place Editor dialog</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-plc.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Place Editor dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> The top of the window shows the <guilabel>Place Editor</guilabel>
|
|
title of the dialog. The main part of the window displays seven
|
|
notebook tabs containing different categories of available information.
|
|
You can bring any tab to the top for viewing or editing by clicking on
|
|
the appropriate tab heading. The bottom part has
|
|
<guibutton>OK</guibutton> and <guibutton>Cancel</guibutton> buttons.
|
|
Clicking <guibutton>OK</guibutton> at any time will apply all the
|
|
changes made in all tabs and close the dialog window. Clicking
|
|
<guibutton>Cancel</guibutton> at any time will close the window without
|
|
applying any changes. If any of the data in any tab was modified,
|
|
the alert window will appear with the choices of closing the dialog
|
|
without saving changes, canceling the initial cancel request, or saving
|
|
the changes. </para>
|
|
|
|
<para>
|
|
The tabs provide the following information categories of
|
|
place data:
|
|
</para>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>General</guilabel></term>
|
|
<listitem><para>
|
|
<guilabel>General</guilabel> tab allows editing of the most general
|
|
information about the place: title which labels it in the database,
|
|
city, church parish, county, state, country, longitude, and latitude.
|
|
This information can be typed in the appropriate text entry fields.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Other names</guilabel></term>
|
|
<listitem><para>
|
|
<guilabel>Other names</guilabel> tab displays information concerning
|
|
other names by which the place might be known and the controls
|
|
allowing its modification. The bottom part displays the list of all
|
|
other names of the place stored in the database. The top part shows
|
|
the details of the currently selected name in the list (if any).
|
|
The buttons <guibutton>Add...</guibutton>,
|
|
<guibutton>Edit...</guibutton>, and <guibutton>Delete</guibutton> allow
|
|
to correspondingly add, modify, and remove a name record
|
|
from the database. Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Delete</guibutton> buttons become available only when
|
|
a name is selected from the list. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Note</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>Note</guilabel> tab displays any notes concerning
|
|
the place. To add a note or modify existing notes simply edit the
|
|
text in the text entry field.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Sources</guilabel></term>
|
|
<listitem><para>
|
|
<guilabel>Sources</guilabel> tab displays information about sources
|
|
relevant to this place and the controls allowing its modification.
|
|
The central part displays the list of all such sources references
|
|
stored in the database. The buttons <guibutton>Add...</guibutton>,
|
|
<guibutton>Edit...</guibutton>, and <guibutton>Delete</guibutton> allow
|
|
to correspondingly add, modify, and remove a source reference
|
|
to this place. Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Delete</guibutton> buttons become available only when
|
|
a source reference is selected from the list. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Gallery</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>Gallery</guilabel> tab displays information about
|
|
media objects associated with the given place and the controls
|
|
allowing its modification. The central part shows the list of all
|
|
such media objects. For media object which are valid image files
|
|
previews of images are displayed. For other objects such as audio
|
|
files, movie files, etc., generic &app; icon is displayed instead.
|
|
The buttons <guibutton>Add...</guibutton>,
|
|
<guibutton>Edit...</guibutton>, and <guibutton>Remove</guibutton> allow
|
|
to correspondingly add, modify, and remove a media object reference
|
|
to this source. Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Remove</guibutton> buttons become available only when
|
|
a media object is selected from the list.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Internet</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>Internet</guilabel> tab displays information about
|
|
Internet addresses relevant to the place and the controls
|
|
allowing its modification. The bottom part displays the list of all
|
|
such Internet addresses stored in the database. The top part shows the
|
|
details of the currently selected addresses in the list (if any).
|
|
The buttons <guibutton>Add...</guibutton>,
|
|
<guibutton>Edit...</guibutton>, and <guibutton>Delete</guibutton>
|
|
allow to correspondingly add, modify, and remove an Internet address
|
|
record from the database. The button <guibutton>Go</guibutton> allows
|
|
to open a web-page with the corresponding address with your default
|
|
browser. Note that <guibutton>Edit...</guibutton>,
|
|
<guibutton>Delete</guibutton>, and <guibutton>Go</guibutton> buttons
|
|
become available only when an address is selected from the list.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>References</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>References</guilabel> tab displays information about
|
|
database records that refer to this place. If the place is not
|
|
referenced from any database record, the tab shows empty list.
|
|
If the place is referenced from many records, the tab will list
|
|
all of them. This information cannot be modified from
|
|
the <guilabel>Place Editor</guilabel> dialog. Instead, the
|
|
corresponding database record (e.g. birth event) has to be brought
|
|
up and its place reference edited. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="adv-media">
|
|
<title>Edit Media Data</title>
|
|
<para> To edit media data, switch to the Media View and select the
|
|
desired entry in the list of sources. Double-click on that entry or
|
|
click <guibutton>Edit</guibutton> on the toolbar to invoke the
|
|
following <guilabel>Edit Media Properties</guilabel> dialog: </para>
|
|
|
|
<!-- ==== Figure: Edit Media Properties dialog ==== -->
|
|
<figure id="edit-media-fig">
|
|
<title>Edit Media Properties dialog</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-media.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Edit Media Properties dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> The top of the window shows the dialog title. Below the title
|
|
is the preview of an object and the summary of its properties (ID,
|
|
path, and object type). The central part of the window displays four
|
|
notebook tabs containing different categories of available information.
|
|
You can bring any tab to the top for viewing or editing by clicking on
|
|
the appropriate tab heading. The bottom part has
|
|
<guibutton>OK</guibutton> and <guibutton>Cancel</guibutton> buttons.
|
|
Clicking <guibutton>OK</guibutton> at any time will apply all the
|
|
changes made in all tabs and close the dialog window. Clicking
|
|
<guibutton>Cancel</guibutton> at any time will close the window without
|
|
applying any changes. If any of the data in any tab was modified,
|
|
the alert window will appear with the choices of closing the dialog
|
|
without saving changes, canceling the initial cancel request, or saving
|
|
the changes. </para>
|
|
|
|
<para>
|
|
The tabs provide the following information categories of
|
|
media object data:
|
|
</para>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>General</guilabel></term>
|
|
<listitem><para>
|
|
<guilabel>General</guilabel> tab allows to edit the title which labels
|
|
this object in the database. The title can be typed in the appropriate
|
|
text entry field. If the object is not local (i.e. the corresponding
|
|
file does not reside under &app; database directory), the
|
|
<guibutton>Make a local copy</guibutton> button is available.
|
|
Click it to copy the media into &app; database directory. This will
|
|
increase the amount of disk space consumed by &app; database. However,
|
|
if the external file is deleted or removed, &app; will still be able
|
|
to use the local copy. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Attributes</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>Attributes</guilabel> tab displays information about
|
|
the attributes of the media object and the controls allowing its
|
|
modification. The bottom part displays the list of all such
|
|
attributes stored in the database. The top part shows the details
|
|
of the currently selected attribute in the list (if any). The buttons
|
|
<guibutton>Add...</guibutton>, <guibutton>Edit...</guibutton>,
|
|
and <guibutton>Delete</guibutton> allow to correspondingly add,
|
|
modify, and remove an attribute record from the database.
|
|
Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Delete</guibutton> buttons become available only when
|
|
an attribute is selected from the list. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Notes</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>Notes</guilabel> tab displays information about the
|
|
notes concerning the media object. These could be any notes which do
|
|
not naturally fit into the Parameter-Value pairs available to
|
|
Attributes. To add a note or modify existing notes simply edit the
|
|
text in the text entry field. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>References</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>References</guilabel> tab displays information about
|
|
database records that refer to this media object. If the object is not
|
|
referenced from any database record, the tab shows empty list.
|
|
If the object is referenced from many records, the tab will list
|
|
all of them. The list can be ordered by any of its column headers:
|
|
<guilabel>Type</guilabel>, <guilabel>Object</guilabel>, or
|
|
<guilabel>Value</guilabel>. This information cannot be modified from
|
|
the <guilabel>Media Object Properties Editor</guilabel> dialog.
|
|
Instead, the corresponding database record (e.g. birth event) has to
|
|
be brought up and its media object reference edited in the gallery
|
|
tab. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="adv-ev">
|
|
<title>Edit Events</title>
|
|
<para> Events are edited through the following <guilabel>Event
|
|
Editor</guilabel> dialog: </para>
|
|
|
|
<!-- ==== Figure: Event Editor dialog ==== -->
|
|
<figure id="edit-ev-fig">
|
|
<title>Event Editor dialog</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-ev.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Event Editor dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> The top of the window shows the dialog title including the name
|
|
of the person whose event is being edited. The central part of the
|
|
window displays four notebook tabs containing different categories of
|
|
available information. You can bring any tab to the top for viewing or
|
|
editing by clicking on the appropriate tab heading. The bottom part has
|
|
<guibutton>OK</guibutton> and <guibutton>Cancel</guibutton> buttons.
|
|
Clicking <guibutton>OK</guibutton> at any time will apply all the
|
|
changes made in all tabs and close the dialog window. Clicking
|
|
<guibutton>Cancel</guibutton> at any time will close the window without
|
|
applying any changes. If any of the data in any tab was modified,
|
|
the alert window will appear with the choices of closing the dialog
|
|
without saving changes, canceling the initial cancel request, or saving
|
|
the changes. </para>
|
|
|
|
<para>The tabs provide the following information categories of
|
|
the event data: </para>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>General</guilabel></term>
|
|
<listitem><para>
|
|
<guilabel>General</guilabel> tab allows editing of the most general
|
|
information about the event: its type, date, place, cause, and
|
|
description. The type can be selected from available types listed
|
|
in the <guilabel>Event type </guilabel> drop-down menu. The rest
|
|
of the information can be typed in the appropriate text entry fields.
|
|
Check the <guilabel>Private record</guilabel> box to mark this event
|
|
record as private. This will give you a chance to omit this event from
|
|
being included in the reports, if you choose so among the report
|
|
generation options. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Sources</guilabel></term>
|
|
<listitem><para>
|
|
<guilabel>Sources</guilabel> tab displays information about sources
|
|
relevant to this event and the controls allowing its modification.
|
|
The central part displays the list of all such sources references
|
|
stored in the database. The buttons <guibutton>Add...</guibutton>,
|
|
<guibutton>Edit...</guibutton>, and <guibutton>Delete</guibutton>
|
|
allow to correspondingly add, modify, and remove a source reference
|
|
to this event. Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Delete</guibutton> buttons become available only when
|
|
a source reference is selected from the list. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Note</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>Note</guilabel> tab displays any notes concerning
|
|
the event. To add a note or modify existing notes simply edit the
|
|
text in the text entry field.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Witnesses</guilabel></term>
|
|
<listitem><para>
|
|
<guilabel>Witnesses</guilabel> tab displays information about witnesses
|
|
relevant to this event and the controls allowing its modification.
|
|
The central part displays the list of all such witnesses
|
|
stored in the database. The buttons <guibutton>Add...</guibutton>,
|
|
<guibutton>Edit...</guibutton>, and <guibutton>Delete</guibutton>
|
|
allow to correspondingly add, modify, and remove a witness reference
|
|
to this event. Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Delete</guibutton> buttons become available only when
|
|
a witness reference is selected from the list. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="adv-si">
|
|
<title>Edit Source Information</title>
|
|
<para> When adding source references to events, places, etc.,
|
|
the following dialog appears: </para>
|
|
|
|
<!-- ==== Figure: Source Information dialog ==== -->
|
|
<figure id="edit-si-fig">
|
|
<title>Source Information dialog</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-si.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Source Information dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> The top of the window shows the dialog title. The central part
|
|
displays the source information. The bottom part has
|
|
<guibutton>OK</guibutton> and <guibutton>Cancel</guibutton> buttons.
|
|
Clicking <guibutton>OK</guibutton> at any time will apply all the
|
|
changes made and close the dialog window. Clicking
|
|
<guibutton>Cancel</guibutton> at any time will close the window without
|
|
applying any changes. If any of the data was modified,
|
|
the alert window will appear with the choices of closing the dialog
|
|
without saving changes, canceling the initial cancel request, or saving
|
|
the changes. </para>
|
|
|
|
<para> The source can be selected from available sources listed in the
|
|
<guilabel>Title</guilabel> drop-down menu. If the source you are
|
|
referencing is not present in the database yet, you can enter it into
|
|
the database. To do this, click <guibutton>New...</guibutton> button
|
|
and enter source information into the invoked <guilabel>Source
|
|
Editor</guilabel> dialog. You can also set the details specific for
|
|
this particular reference: confidence, volume/file/page. date, text,
|
|
and comments. Choose the confidence
|
|
level from the <guilabel>Confidence</guilabel> drop-down menu.
|
|
The rest of the details can be typed in the appropriate text entry
|
|
fields. </para>
|
|
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="adv-an">
|
|
<title>Edit Alternate Names</title>
|
|
<para> Alternate names are edited through the following
|
|
<guilabel>Alternate Names Editor</guilabel> dialog: </para>
|
|
|
|
<!-- ==== Figure: Alternate Names Editor dialog ==== -->
|
|
<figure id="edit-an-fig">
|
|
<title>Alternate Names Editor dialog</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-an.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Alternate Names Editor dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> The top of the window shows the dialog title including the name
|
|
of the person whose alternate name is being edited. The central part
|
|
of the window displays three notebook tabs containing different
|
|
categories of available information. You can bring any tab to the
|
|
top for viewing or editing by clicking on the appropriate tab heading.
|
|
The bottom part has <guibutton>OK</guibutton> and
|
|
<guibutton>Cancel</guibutton> buttons. Clicking
|
|
<guibutton>OK</guibutton> at any time will apply all the
|
|
changes made in all tabs and close the dialog window. Clicking
|
|
<guibutton>Cancel</guibutton> at any time will close the window without
|
|
applying any changes. If any of the data in any tab was modified,
|
|
the alert window will appear with the choices of closing the dialog
|
|
without saving changes, canceling the initial cancel request, or saving
|
|
the changes. </para>
|
|
|
|
<para>The tabs provide the following information categories of
|
|
the alternate name data: </para>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>General</guilabel></term>
|
|
<listitem><para>
|
|
<guilabel>General</guilabel> tab allows editing of the most general
|
|
information about the alternate name: given name, family name, family
|
|
prefix, suffix, title, and type of the name. The information can be
|
|
typed in the appropriate text entry fields. The family name and the
|
|
type can be also selected from available choices listed in the
|
|
appropriate drop-down menus.
|
|
Check the <guilabel>Private record</guilabel> box to mark this name
|
|
record as private. This will give you a chance to omit this name from
|
|
being included in the reports, if you choose so among the report
|
|
generation options. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Sources</guilabel></term>
|
|
<listitem><para>
|
|
<guilabel>Sources</guilabel> tab displays information about sources
|
|
relevant to this name and the controls allowing its modification.
|
|
The central part displays the list of all such sources references
|
|
stored in the database. The buttons <guibutton>Add...</guibutton>,
|
|
<guibutton>Edit...</guibutton>, and <guibutton>Delete</guibutton>
|
|
allow to correspondingly add, modify, and remove a source reference
|
|
to this name. Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Delete</guibutton> buttons become available only when
|
|
a source reference is selected from the list. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Note</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>Note</guilabel> tab displays any notes concerning
|
|
the name. To add a note or modify existing notes simply edit the
|
|
text in the text entry field.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="adv-at">
|
|
<title>Edit Attributes</title>
|
|
<para> Attributes are edited through the following
|
|
<guilabel>Attribute Editor</guilabel> dialog: </para>
|
|
|
|
<!-- ==== Figure: Attribute Editor dialog ==== -->
|
|
<figure id="edit-at-fig">
|
|
<title>Attribute Editor dialog</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-at.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Attribute Editor dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> The top of the window shows the dialog title including the name
|
|
of the person whose attribute is being edited. The central part
|
|
of the window displays three notebook tabs containing different
|
|
categories of available information. You can bring any tab to the
|
|
top for viewing or editing by clicking on the appropriate tab heading.
|
|
The bottom part has <guibutton>OK</guibutton> and
|
|
<guibutton>Cancel</guibutton> buttons. Clicking
|
|
<guibutton>OK</guibutton> at any time will apply all the
|
|
changes made in all tabs and close the dialog window. Clicking
|
|
<guibutton>Cancel</guibutton> at any time will close the window without
|
|
applying any changes. If any of the data in any tab was modified,
|
|
the alert window will appear with the choices of closing the dialog
|
|
without saving changes, canceling the initial cancel request, or saving
|
|
the changes. </para>
|
|
|
|
<para>The tabs provide the following information categories of
|
|
the attribute data: </para>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>General</guilabel></term>
|
|
<listitem><para>
|
|
<guilabel>General</guilabel> tab allows editing of the most general
|
|
information about the attribute: name of the attribute and its value.
|
|
The information can be typed in the appropriate text entry fields.
|
|
The attribute name can also be selected from available choices (if any)
|
|
listed in the <guilabel>Attribute </guilabel> drop-down menu.
|
|
Check the <guilabel>Private record</guilabel> box to mark this
|
|
attribute record as private. This will give you a chance to omit
|
|
this attribute from being included in the reports, if you choose
|
|
so among the report generation options. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Sources</guilabel></term>
|
|
<listitem><para>
|
|
<guilabel>Sources</guilabel> tab displays information about sources
|
|
relevant to this attribute and the controls allowing its modification.
|
|
The central part displays the list of all such sources references
|
|
stored in the database. The buttons <guibutton>Add...</guibutton>,
|
|
<guibutton>Edit...</guibutton>, and <guibutton>Delete</guibutton>
|
|
allow to correspondingly add, modify, and remove a source reference
|
|
to this attribute . Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Delete</guibutton> buttons become available only when
|
|
a source reference is selected from the list. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Note</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>Note</guilabel> tab displays any notes concerning
|
|
the attribute . To add a note or modify existing notes simply edit the
|
|
text in the text entry field.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="adv-ad">
|
|
<title>Edit Addresses</title>
|
|
<para> Addresses are edited through the following
|
|
<guilabel>Address Editor</guilabel> dialog: </para>
|
|
|
|
<!-- ==== Figure: Address Editor dialog ==== -->
|
|
<figure id="edit-ad-fig">
|
|
<title>Address Editor dialog</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-ad.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Address Editor dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> The top of the window shows the dialog title including the name
|
|
of the person whose address is being edited. The central part
|
|
of the window displays three notebook tabs containing different
|
|
categories of available information. You can bring any tab to the
|
|
top for viewing or editing by clicking on the appropriate tab heading.
|
|
The bottom part has <guibutton>OK</guibutton> and
|
|
<guibutton>Cancel</guibutton> buttons. Clicking
|
|
<guibutton>OK</guibutton> at any time will apply all the
|
|
changes made in all tabs and close the dialog window. Clicking
|
|
<guibutton>Cancel</guibutton> at any time will close the window without
|
|
applying any changes. If any of the data in any tab was modified,
|
|
the alert window will appear with the choices of closing the dialog
|
|
without saving changes, canceling the initial cancel request, or saving
|
|
the changes. </para>
|
|
|
|
<para>The tabs provide the following information categories of
|
|
the address data: </para>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>General</guilabel></term>
|
|
<listitem><para>
|
|
<guilabel>General</guilabel> tab allows editing of the most general
|
|
information about the address: date, street address, city or county,
|
|
state or province, country, and the postal code. The information can
|
|
be typed in the appropriate text entry fields.
|
|
Check the <guilabel>Private record</guilabel> box to mark this address
|
|
record as private. This will give you a chance to omit this address
|
|
from being included in the reports, if you choose so among the report
|
|
generation options. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Sources</guilabel></term>
|
|
<listitem><para>
|
|
<guilabel>Sources</guilabel> tab displays information about sources
|
|
relevant to this address and the controls allowing its modification.
|
|
The central part displays the list of all such sources references
|
|
stored in the database. The buttons <guibutton>Add...</guibutton>,
|
|
<guibutton>Edit...</guibutton>, and <guibutton>Delete</guibutton>
|
|
allow to correspondingly add, modify, and remove a source reference
|
|
to this address. Note that <guibutton>Edit...</guibutton> and
|
|
<guibutton>Delete</guibutton> buttons become available only when
|
|
a source reference is selected from the list. </para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><guilabel>Note</guilabel></term>
|
|
<listitem>
|
|
<para> <guilabel>Note</guilabel> tab displays any notes concerning
|
|
the address. To add a note or modify existing notes simply edit the
|
|
text in the text entry field.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="adv-wit">
|
|
<title>Edit Witnesses</title>
|
|
<para> Witnesses are edited through the following
|
|
<guilabel>Witness Editor</guilabel> dialog: </para>
|
|
|
|
<!-- ==== Figure: Witness Editor dialog ==== -->
|
|
<figure id="edit-wi-fig">
|
|
<title>Witness Editor dialog</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-wi.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Witness Editor dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> The top of the window shows the dialog title. The central part
|
|
of the window displays information about the witness. The bottom part
|
|
has <guibutton>OK</guibutton> and <guibutton>Cancel</guibutton> buttons.
|
|
Clicking <guibutton>OK</guibutton> at any time will apply all the
|
|
changes made and close the dialog window. Clicking
|
|
<guibutton>Cancel</guibutton> at any time will close the window
|
|
without applying any changes. If any of the data was
|
|
modified, the alert window will appear with the choices of closing
|
|
the dialog without saving changes, canceling the initial cancel
|
|
request, or saving the changes. </para>
|
|
|
|
<para>The witness name can be entered in two ways, depending on
|
|
whether the witness is a person already stored in the database or
|
|
not (unrelated person). </para>
|
|
|
|
<variablelist>
|
|
<varlistentry><term>Person from the database</term>
|
|
<listitem><para>
|
|
If the person's data are stored in a database, click <guilabel>Person
|
|
is in the database</guilabel> box. Then ...
|
|
|
|
[ FIXME: Need Don to decide which way this will eventually be implemented. ]
|
|
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<variablelist>
|
|
<varlistentry><term>Unrelated person</term>
|
|
<listitem><para>
|
|
If the person is not in the database, make sure that
|
|
<guilabel>Person is in the database</guilabel> box is unchecked.
|
|
Then enter the name or any description of a person into the
|
|
<guilabel>Person</guilabel> text entry field. This information
|
|
is stored as entered, and this is the only place it is stored in.
|
|
In other words, there is no reference to that person in the entire
|
|
database except for this witness reference. If the person is in fact
|
|
a member of the database, it is advised to user the former method.
|
|
</para>
|
|
</listitem></varlistentry>
|
|
</variablelist>
|
|
|
|
<para> The <guilabel>Comment</guilabel> text area allows to enter
|
|
any comments concerning the witness. To add a comment or to modify
|
|
existing comments simply edit the text in the text area.
|
|
</para>
|
|
|
|
</sect3>
|
|
|
|
</sect2>
|
|
|
|
<!-- ================ Usage Subsection ================================ -->
|
|
<sect2 id="gramps-nav">
|
|
<title>Navigation</title>
|
|
<para> As long as any database is open,
|
|
<application>&app;</application> is focused on a
|
|
single person usually referred to as an Active person. This
|
|
allows you to view or modify the data concerning this person,
|
|
his or her immediate family, etc. Navigating in the database (i.e.
|
|
moving from person to person) is in fact nothing else but changing
|
|
the Active person. This section describes many alternative ways
|
|
to navigate through the database using complex and convenient
|
|
interface <application>&app;</application> provides. All these ways
|
|
eventually accomplish the same thing, but some are more convenient
|
|
than others, depending what you are doing in
|
|
<application>&app;</application> at the moment. </para>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="gramps-nav-people">
|
|
<title>Using People View</title>
|
|
<para> The most intuitive way to select an active person is
|
|
to use the People View. When in the People View, just select the
|
|
name of the desired person from the list by clicking that list
|
|
entry. The person you have selected becomes active. The statusbar
|
|
updates to reflect the change of the active person. </para>
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="gramps-nav-family">
|
|
<title>Using Family View</title>
|
|
<para> When in the Family View, you can easily navigate between the
|
|
members of the displayed family as follows: </para>
|
|
|
|
<itemizedlist>
|
|
<listitem><para>To make currently selected spouse the active person,
|
|
click double-arrow button to the right of the active person box.
|
|
</para></listitem>
|
|
|
|
<listitem><para>To make currently selected parents the active family
|
|
(thereby making father the active person and mother the selected
|
|
spouse), click right-arrow button to the right of the active person's
|
|
parents box. </para></listitem>
|
|
|
|
<listitem><para>To make currently selected spouse's parents
|
|
the active family (thereby making father the active person and mother
|
|
the selected spouse), click right-arrow button to the right of the
|
|
spouse's parents box.</para></listitem>
|
|
|
|
<listitem><para>To make currently selected child the active person,
|
|
click left-arrow button to the right of the children box.
|
|
</para></listitem>
|
|
|
|
</itemizedlist>
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="gramps-nav-pedigree">
|
|
<title>Using Pedigree View</title>
|
|
<para> Pedigree View also allows you to move along the family tree.
|
|
The benefits of this method is that you can see more than one
|
|
generation of the family tree. Also, you can jump directly from a
|
|
great-grandson to a great-grandfather without going through the
|
|
intermediate generations. </para>
|
|
|
|
<para> Note that after changing the active person in the Pedigree
|
|
View, the display is re-adjusted to show four generations, starting
|
|
from a newly selected Active person. When in the Pedigree View, you
|
|
can easily navigate between the members of the displayed family tree
|
|
as follows: </para>
|
|
|
|
<itemizedlist>
|
|
<listitem><para>To make any displayed person the active person,
|
|
double click the line that connects to the left side of the
|
|
corresponding box. </para></listitem>
|
|
|
|
<listitem><para>To make a child of currently active person (if any)
|
|
the active person, click the left arrow button to the left of the
|
|
corresponding box. If there is more than one child, the button expands
|
|
to the menu listing the children to choose from. </para></listitem>
|
|
|
|
<listitem><para>To move the whole family tree one generation back,
|
|
click on the corresponding right arrow button on the right-hand side
|
|
of the display area. Clicking the upper button will move the tree
|
|
along the paternal line. Clicking the lower button will move the
|
|
tree along the maternal line. </para>
|
|
|
|
<para> Clicking either of these buttons is completely equivalent to
|
|
double-clicking the lines connecting to the left of the corresponding
|
|
boxes for father and mother. </para></listitem>
|
|
</itemizedlist>
|
|
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="gramps-nav-default">
|
|
<title>Setting Default Person</title>
|
|
<para> One and only one person in the database can be selected as the
|
|
default person. Once the default person is selected, moving to that
|
|
person becomes a matter of a single click, regardless of which view
|
|
you are using at the moment. </para>
|
|
|
|
<para> To set the default person, first navigate to that person using
|
|
any method you like. Then choose
|
|
<menuchoice><guimenu>Settings</guimenu>
|
|
<guimenuitem>Default Person</guimenuitem></menuchoice>. Once this is
|
|
done, you can move to the default person from anywhere in the
|
|
database by simply clicking <guibutton>Home</guibutton> on the
|
|
toolbar. </para>
|
|
|
|
</sect3>
|
|
|
|
<!-- ================ Usage Sub-subsection ================ -->
|
|
<sect3 id="gramps-nav-bookmk">
|
|
<title>Bookmarking People</title>
|
|
<para> Similarly to the default person, you can bookmark other people
|
|
from the database to simplify further navigation. To bookmark a person,
|
|
first navigate to that person, then choose
|
|
<menuchoice><guimenu>Bookmarks</guimenu>
|
|
<guimenuitem>Add bookmark</guimenuitem></menuchoice>. To move to that
|
|
person from anywhere in the database, choose
|
|
<menuchoice><guimenu>Bookmarks</guimenu>
|
|
<guisubmenu>Go to bookmark</guisubmenu>
|
|
<guimenuitem><replaceable>Person's name</replaceable></guimenuitem>
|
|
</menuchoice>. </para>
|
|
|
|
<para> You can manage your bookmarks by choosing
|
|
<menuchoice><guimenu>Bookmarks</guimenu>
|
|
<guimenuitem>Edit bookmarks</guimenuitem></menuchoice>. This opens
|
|
the following<guilabel>Edit Bookmarks</guilabel> dialog with the
|
|
list of bookmarks and the controls to modify this list. </para>
|
|
|
|
<!-- ==== Figure: Edit Bookmarks dialog ==== -->
|
|
<figure id="edit-bm-fig">
|
|
<title>Edit Bookmarks dialog</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/edit-bm.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Edit Bookmarks dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
</sect3>
|
|
|
|
</sect2>
|
|
|
|
<!-- ================ Usage Subsection ================================ -->
|
|
<sect2 id="gen-reports">
|
|
<title>Generating Reports</title>
|
|
<para> Reports are the most common form of the output produced by
|
|
genealogical research. Majority of genealogical software puts a lot
|
|
of emphasis on developing nicely looking reports. &app; is no
|
|
exception in this regard: it offers a variety of reports to choose
|
|
from. &app; can generate reports in a multitude of open formats, both
|
|
text based and graphical. &app; can also produce screen based reports
|
|
that are convenient for viewing the summary of your database.
|
|
Finally, &app; can generate a web-site suitable for immediate
|
|
posting on the Internet. All these are almost infinitely flexible:
|
|
you get to design and choose the style for your reports. </para>
|
|
|
|
<para> All reports can be accessed through the menu by choosing
|
|
<menuchoice><guimenu>Reports</guimenu>
|
|
<guisubmenu><replaceable>Report Type</replaceable></guisubmenu>
|
|
<guimenuitem><replaceable>Particular
|
|
Report</replaceable></guimenuitem></menuchoice>. Alternatively,
|
|
you can browse the complete selection of available reports along
|
|
with their brief descriptions in a <guilabel>Report
|
|
Selection</guilabel> dialog evoked by clicking
|
|
<guibutton>Reports</guibutton> on the toolbar.
|
|
</para>
|
|
|
|
<!-- =============== Usage Sub-subsection ================ -->
|
|
<sect3 id="rep-graph">
|
|
<title>Graphical Reports</title>
|
|
<para> Graphical reports represent information in forms of charts
|
|
and graphs. Most of the options are common among graphical reports,
|
|
therefore they will be described only once, at the end of this
|
|
section. Few options specific to the given report will be
|
|
described directly in that report's entry.</para>
|
|
|
|
<para>The following graphical reports are currently
|
|
available in &app;: </para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry><term>Timeline Graph</term>
|
|
<listitem><para>This report outputs the list of people with their
|
|
lifetimes represented by intervals on a common chronological scale.
|
|
Specific options include filter, sorting method, and the title of
|
|
the report. </para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term>Relationship Graph</term>
|
|
<listitem><para>This report creates complex relationship graph in
|
|
GraphViz format. The GraphViz <command>dot</command> tool can
|
|
transform the graph into postscript, jpeg, png, vrml, svg, and many
|
|
other formats. GraphViz tools are freely available from
|
|
<ulink url="http://www.graphviz.org" type="http">GraphViz
|
|
site</ulink>. Specific options include filter for this report
|
|
include filter and number of generations considered, as well as
|
|
several GraphViz specific options related to pagination, color,
|
|
and details of the graph. </para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term>Descendant Graph</term>
|
|
<listitem><para>This report generates the graph of people who are
|
|
descendants of a currently active person. Specific options include
|
|
the format of the displayed entries. </para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term>Ancestor Chart</term>
|
|
<listitem><para>This report generates the chart of people who are
|
|
ancestors of a currently active person. Specific options include
|
|
the number of generations considered and the format of the displayed
|
|
entries. </para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
<para>Common options for graphical reports are the filename of the
|
|
output, the format of the output, selected style, and page size and
|
|
orientation. </para>
|
|
|
|
</sect3>
|
|
|
|
<!-- =============== Usage Sub-subsection ================ -->
|
|
<sect3 id="rep-text">
|
|
<title>Text Reports</title>
|
|
<para> Text reports represent the desired information as formatted
|
|
text. Most of the options are common among text reports,
|
|
therefore they will be described only once, at the end of this
|
|
section. Few options specific to the given report will be
|
|
described directly in that report's entry.</para>
|
|
|
|
<para>The following text reports are currently
|
|
available in &app;:</para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry><term>Individual Summary</term>
|
|
<listitem><para>This report produces a detailed summary on the
|
|
active person. The report includes all the facts known to the
|
|
database about that person. </para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term>Family Group Report</term>
|
|
<listitem><para>This creates a family group report, showing
|
|
information on a set of parents and their children. Specific
|
|
options: the spouse (available only if the active person has more
|
|
than one spouse). </para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term>Detailed Descendant Report</term>
|
|
<listitem><para>This report covers in detail the descendants of the
|
|
active person. It includes vital (birth and death) as well as
|
|
marriages. Specific options: number of forward generations
|
|
to consider. </para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term>Detailed Ancestral Report</term>
|
|
<listitem><para>This report covers in detail the ancestors of the
|
|
active person. It includes vital data (birth and death) as well as
|
|
marriages. Specific options: number of backward generations
|
|
to consider, as well as a variety of options on what exactly
|
|
contents to include. </para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term>Descendant Report</term>
|
|
<listitem><para>This report produces brief description
|
|
of descendants of the active person. Specific options: number
|
|
of forward generations to consider. </para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term>Complete Individual Report</term>
|
|
<listitem><para>This report provides individual summaries similar to
|
|
that of the Individual Summary report. The advantage of this report
|
|
is the specific filter option. Depending on the filter choice (active
|
|
person only, his or her descendants, his or her ancestors, or entire
|
|
database), the report may contain from one to many individual
|
|
summaries. Another option for this report is the inclusion of
|
|
source information when listing events. </para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term>Ahnentafel Report</term>
|
|
<listitem><para>This report lists the active person and his or her
|
|
ancestors along with their vital data. The people are numbered in a
|
|
special way which is an established standard called Ahnentafel.
|
|
The active person is given number 1. His or her father and mother
|
|
have numbers 2 and 3, respectively. This rule holds for every person
|
|
while going back in generations: father's parents are numbered 4 and 5,
|
|
and mother's parents are numbered 6 and 7, fathers always numbered
|
|
with even and mothers with odd numbers. Therefore, for any person
|
|
having number N in this tree, the numbers of father and mother
|
|
are 2N and 2N+1, respectively.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
<para>Common options for text reports are the filename of the
|
|
output, the format of the output, selected style, and page size and
|
|
orientation. For HTML reports, there is no page information.
|
|
Instead, HTML options include the choice of the HTML template,
|
|
either available in &app; or a custom template defined by you. </para>
|
|
|
|
</sect3>
|
|
|
|
<!-- =============== Usage Sub-subsection ================ -->
|
|
<sect3 id="rep-view">
|
|
<title>View</title>
|
|
<para> View reports represent overall summaries of the database
|
|
information available immediately for on-screen viewing.
|
|
The following view reports are currently available in &app;:</para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry><term>Number of ancestors</term>
|
|
<listitem><para>This report displays the number of ancestors of the
|
|
active person. </para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term>Summary of the database</term>
|
|
<listitem><para>This report displays the overall statistics concerning
|
|
number of individuals of each gender, various incomplete entries
|
|
statistics, as well as family and media statistics. </para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</sect3>
|
|
|
|
<!-- =============== Usage Sub-subsection ================ -->
|
|
<sect3 id="rep-web">
|
|
<title>Web Page</title>
|
|
|
|
<para> This report generates web pages, either for a selected
|
|
individual (active person) or a set of individuals. The options
|
|
for this report are broken down into contents, privacy, and advanced
|
|
options. The contents options include the filter (determine the
|
|
scope of the database to consider), number of generations to consider,
|
|
destination directory for the images, and a link to the index page.
|
|
Privacy options allow you to omit private records, restrict
|
|
information on living people, to skip images (either all or those of
|
|
living people), and to omit comments and text in source information.
|
|
Finally, the advanced options allow to include optional &app; ID,
|
|
create a GENDEX index, and specify the extension of the resulting
|
|
files. </para>
|
|
|
|
</sect3>
|
|
|
|
</sect2>
|
|
|
|
<!-- ================ Usage Subsection ================================ -->
|
|
<sect2 id="gramps-tools">
|
|
<title>Running Tools</title>
|
|
<para> &app; tools allow you to perform various types of analyses
|
|
of your genealogical data. Typically, the tools do not produce
|
|
output in form of printouts or files. Instead, they produce screen
|
|
output immediately available for the researcher. However, when
|
|
appropriate, you can save the result of running a tool into a file.
|
|
Tools present one of the major strengths of &app; compared to the most
|
|
genealogical software. </para>
|
|
|
|
<para>The tools can be accessed through the menu by choosing
|
|
<menuchoice><guimenu>Tools</guimenu>
|
|
<guisubmenu><replaceable>Tool Section</replaceable></guisubmenu>
|
|
<guimenuitem><replaceable>Particular
|
|
Tool</replaceable></guimenuitem></menuchoice>. Alternatively,
|
|
you can browse the complete selection of available tools along
|
|
with their brief descriptions in a <guilabel>Tool
|
|
Selection</guilabel> dialog evoked by clicking
|
|
<guibutton>Tools</guibutton> on the toolbar. </para>
|
|
|
|
<!-- =============== Usage Sub-subsection ================ -->
|
|
<sect3 id="tools-ae">
|
|
<title>Analysis and Exploration</title>
|
|
<para> This section contains tools which analyze and explore the
|
|
database, but do not alter it. The following analysis and exploration
|
|
tools are currently available in &app;: </para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry><term>Compare individual events</term>
|
|
<listitem><para>This tool compares events across the selected group of
|
|
people. The people for this comparison are chosen with the use of
|
|
custom filters. The custom filters can be created in the Custom Filter
|
|
Editor (see <xref linkend="tools-util"/>). The resulting table produced
|
|
by this tool can be saved as a spreadsheet. </para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term>Interactive descendant browser</term>
|
|
<listitem><para>This tool builds a tree with the active person being
|
|
the root. Children branch from their parents in a usual manner.
|
|
Use this tool for a quick glance on a person's descendants.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</sect3>
|
|
|
|
<!-- =============== Usage Sub-subsection ================ -->
|
|
<sect3 id="tools-db">
|
|
<title>Database Processing</title>
|
|
<para> This section contains tools which may modify your database.
|
|
The modifications will only be performed upon your explicit consent.
|
|
The tools from this section are used most for finding and correcting
|
|
errors in the data. The following database processing tools are
|
|
currently available in &app;:</para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry><term>Check and repair database</term>
|
|
<listitem><para>This tool checks the database for integrity problems,
|
|
fixing the problems it can.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term>Extract information from names</term>
|
|
<listitem><para>This tool 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>Find possible duplicate people</term>
|
|
<listitem><para>This tool searches the entire database, looking
|
|
for the entries that may represent the same person.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term>Rename personal event types</term>
|
|
<listitem><para>This tool allows all the events of a certain name
|
|
to be renamed to a new name.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term>Reorder &app; IDs</term>
|
|
<listitem><para>This tool reorders the &app; IDs according to the
|
|
defaults of &app;.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
<!-- =============== Usage Sub-subsection ================ -->
|
|
<sect3 id="tools-util">
|
|
<title>Utilities</title>
|
|
<para> </para>
|
|
|
|
<para> This section contains tools allowing to perform a simple
|
|
operation on a portion of data. The results can be saved in your
|
|
database, but they will not modify your existing data.
|
|
The following utilities are currently available in &app;:</para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry><term>Custom Filter Editor</term>
|
|
<listitem><para>The Custom Filter Editor builds custom filters
|
|
that can be used to select people included in reports, exports,
|
|
and other tools and utilities. This is in fact a very powerful tool
|
|
in genealogical analysis.</para>
|
|
|
|
<para>When you launch it, the <guilabel>User defined filters</guilabel>
|
|
dialog appears that lists all the filters (if any) previously defined
|
|
by you. Click <guibutton>Add...</guibutton> to define a new filter.
|
|
Once you have designed your filters, you can edit, test, and delete
|
|
selected filters using <guibutton>Edit...</guibutton>,
|
|
<guibutton>Test...</guibutton>, and <guibutton>Delete...</guibutton>
|
|
buttons, respectively. All the filters displayed in the list will be
|
|
automatically saved along with your database and will be available
|
|
upon the future runs of <application>&app;</application>. </para>
|
|
|
|
<para>Clicking <guibutton>Add...</guibutton> invokes the
|
|
following <guilabel>Define filter</guilabel> dialog: </para>
|
|
|
|
<!-- ==== Figure: Define filter dialog ==== -->
|
|
<figure id="cfe-df-fig">
|
|
<title>Define filter dialog</title>
|
|
<screenshot><mediaobject><imageobject><imagedata
|
|
fileref="figures/cfe-df.png" format="PNG"/></imageobject>
|
|
<textobject>
|
|
<phrase>Shows Define filter dialog. </phrase>
|
|
</textobject></mediaobject></screenshot></figure>
|
|
<!-- ==== End of Figure ==== -->
|
|
|
|
<para> Type the name for your new filter into the
|
|
<guilabel>Name</guilabel> field. Enter any comment that would help you
|
|
identify this filter in the future into the <guilabel>Comment</guilabel>
|
|
field. Add as many rules to the <guilabel>Rule list</guilabel> as you
|
|
would like to your filter using <guibutton>Add...</guibutton> button.
|
|
Check <guilabel>Return values that do not match the filter rules
|
|
(invert)</guilabel> to negate the filter rule (e.g. inverting "has a
|
|
common ancestor with I1" rule will match everyone who does not have a
|
|
common ancestor with that person). If the filter has more than one rule,
|
|
select one of the <guilabel>Rule operations</guilabel>. This allows you
|
|
to choose whether all rules must apply, only one (either) rule must
|
|
apply, or exactly one (either) rule must apply, in order for the filter
|
|
to generate a match. If your filter has only one rule, this selection
|
|
has no effect. </para>
|
|
|
|
<para> Note that the filters you already designed may be used as a rule
|
|
for another filter. This gives you nearly infinite flexibility in
|
|
custom-tailoring your selection criteria that can be later used in
|
|
most of the exports, reports and some of the tools (such as comparing
|
|
individual events). </para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term>Generate SoundEx codes</term>
|
|
<listitem><para>This utility generates SoundEx codes for the names of
|
|
people in the database.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term>Relationship calculator</term>
|
|
<listitem><para>This utility calculates the relationship between
|
|
two people from the database.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term>Verify the database</term>
|
|
<listitem><para>This utility allows you to verify the database based
|
|
on the set of criteria specified by you.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
</sect2>
|
|
|
|
</sect1> <!-- ================ End Usage ============== -->
|
|
|
|
<!-- ================ Customization ================================ -->
|
|
|
|
<sect1 id="gramps-prefs">
|
|
<title>Settings</title>
|
|
<para>To configure <application>&app;</application>, choose
|
|
<menuchoice><guimenu>Settings</guimenu>
|
|
<guimenuitem>Preferences</guimenuitem></menuchoice>.
|
|
The <guilabel>Preferences</guilabel> dialog contains the following
|
|
categories: </para>
|
|
|
|
<itemizedlist>
|
|
<listitem><para><xref linkend="gramps-prefs-usage"/></para></listitem>
|
|
<listitem><para><xref linkend="gramps-prefs-display"/></para></listitem>
|
|
<listitem><para><xref linkend="gramps-prefs-db"/></para></listitem>
|
|
</itemizedlist>
|
|
|
|
<!-- =============== Customization Subsection ================ -->
|
|
<sect2 id="gramps-prefs-usage">
|
|
<title>Usage</title>
|
|
<para> This category contains preferences relevant to the
|
|
general usage of &app;. It has the following subcategories:</para>
|
|
|
|
<!-- =============== Customization Sub-subsection ================ -->
|
|
<sect3 id="prefs-usage-find">
|
|
<title>Find</title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry><term><guilabel>Enable autocompletion</guilabel></term>
|
|
<listitem><para>If this box is checked, &app; will attempt to complete
|
|
the text as you type it into text entry fields such as family name,
|
|
place of birth, etc. Completion is attempted based on the match
|
|
between the beginning of the text being typed and the corresponding
|
|
data already stored in the database.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
<!-- =============== Customization Sub-subsection ================ -->
|
|
<sect3 id="prefs-usage-report">
|
|
<title>Report Preferences</title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry><term><guilabel>Preferred text format</guilabel></term>
|
|
<listitem><para> Select the preferred format for text reports
|
|
from the available formats listed in this menu.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term><guilabel>Preferred graphical format</guilabel></term>
|
|
<listitem><para> Select the preferred format for graphical reports
|
|
from the available formats listed in this menu.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term><guilabel>Preferred paper size</guilabel></term>
|
|
<listitem><para> Select the preferred paper size used for reports
|
|
from the available sizes listed in this menu.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term><guilabel>Default report directory</guilabel></term>
|
|
<listitem><para> Choose the default directory for the reports using
|
|
<guibutton>Browse...</guibutton> button or type it in the text entry
|
|
field. </para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term><guilabel>Default web site directory</guilabel></term>
|
|
<listitem><para> Choose the default directory for the web site using
|
|
<guibutton>Browse...</guibutton> button or type it in the text entry
|
|
field. </para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
<!-- =============== Customization Sub-subsection ================ -->
|
|
<sect3 id="prefs-usage-res">
|
|
<title>Researcher Information</title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry><term><guilabel>Researcher information</guilabel></term>
|
|
<listitem><para> Enter your personal information in the corresponding
|
|
text entry fields. Although GRAMPS requests information about you,
|
|
this information is used only so that it can create valid GEDCOM
|
|
output files. A valid GEDCOM file requires information about the files
|
|
creator. If you choose, you may leave the information empty, however
|
|
all the GEDCOM files you export will not be valid.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
<!-- =============== Customization Sub-subsection ================ -->
|
|
<sect3 id="prefs-usage-guess">
|
|
<title>Data Guessing</title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry><term><guilabel>Surname guessing</guilabel></term>
|
|
<listitem><para> This option is not currently implemented.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
</sect2>
|
|
|
|
<!-- =============== Customization Subsection ================ -->
|
|
<sect2 id="gramps-prefs-display">
|
|
<title>Display</title>
|
|
<para> This category contains preferences relevant to
|
|
displaying database records and controls in &app;.
|
|
It has the following subcategories:</para>
|
|
|
|
<!-- =============== Customization Sub-subsection ================ -->
|
|
<sect3 id="prefs-display-gen">
|
|
<title>General</title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry><term><guilabel>Always display the LDS ordinance tabs</guilabel></term>
|
|
<listitem><para> Check this box to have LDS ordinance tabs displayed.
|
|
If you do not know what LDS is then you probably should not check it.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term><guilabel>Show index numbers in child list</guilabel></term>
|
|
<listitem><para>
|
|
This option is not currently implemented.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</sect3>
|
|
|
|
<!-- =============== Customization Sub-subsection ================ -->
|
|
<sect3 id="prefs-display-date">
|
|
<title>Dates and Calendar</title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry><term><guilabel>Display: Date format</guilabel></term>
|
|
<listitem><para> Select the display format for the dates
|
|
from the available formats listed in this menu.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term><guilabel>Name format</guilabel></term>
|
|
<listitem><para> Select the display format for the names
|
|
from the available formats listed in this menu.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term><guilabel>Entry: Date format</guilabel></term>
|
|
<listitem><para> Select the entry format for the dates
|
|
from the available formats listed in this menu.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term><guilabel>Show calendar format selection menu</guilabel></term>
|
|
<listitem><para> Check this box to enable calendar format selection
|
|
menu when you are entering dates in the <guilabel>Event
|
|
Editor</guilabel> dialog.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</sect3>
|
|
|
|
<!-- =============== Customization Sub-subsection ================ -->
|
|
<sect3 id="prefs-display-bars">
|
|
<title>Tool and Status Bars</title>
|
|
<variablelist>
|
|
|
|
<varlistentry><term><guilabel>Toolbar</guilabel></term>
|
|
<listitem><para> Select the desired appearance of the toolbar icons
|
|
using the radio buttons.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term><guilabel>Status bar</guilabel></term>
|
|
<listitem><para> Select the desired contents displayed in the
|
|
statusbar using the radio buttons.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</sect3>
|
|
|
|
</sect2>
|
|
|
|
<!-- =============== Customization Subsection ================ -->
|
|
<sect2 id="gramps-prefs-db">
|
|
<title>Database</title>
|
|
<para> This category contains preferences relevant to the
|
|
database itself. It has the following subcategories: </para>
|
|
|
|
<!-- =============== Customization Sub-subsection ================ -->
|
|
<sect3 id="prefs-db-gen">
|
|
<title>General</title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry><term><guilabel>Automatically load last database</guilabel></term>
|
|
<listitem><para> Check this box to automatically load the last open
|
|
database on startup. </para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term><guilabel>Do not compress XML data file</guilabel></term>
|
|
<listitem><para> Check this box to disable compression of the XML
|
|
data file. Compression significantly reduces the file size.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term><guilabel>Capitalize surnames</guilabel></term>
|
|
<listitem><para> Check this box to capitalize surnames entered into the
|
|
database. </para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term><guilabel>Autosave interval</guilabel></term>
|
|
<listitem><para> Set the interval (in minutes) after which &app; will
|
|
automatically save your database. Zero interval completely disables
|
|
autosave. </para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term><guilabel>Default database directory</guilabel></term>
|
|
<listitem><para> Choose the default directory in which &app; starts
|
|
looking when saving the database using <guibutton>Browse...</guibutton>
|
|
or type its path into the text entry field. </para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</sect3>
|
|
|
|
<!-- =============== Customization Sub-subsection ================ -->
|
|
<sect3 id="prefs-db-media">
|
|
<title>Media Objects</title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry><term><guilabel>Drag and drop from an external source</guilabel></term>
|
|
<listitem><para> Choose between a reference and a local copy made when
|
|
the object is dropped into the gallery. The reference saves disk
|
|
space as it does not copy the object. The local copy makes your
|
|
database portable as it does not depend on an external file. Consult
|
|
your need to make best choice.</para>
|
|
|
|
<para>Check <guilabel>Display global properties editor when object is
|
|
dropped</guilabel> box to invoke global properties editor after you
|
|
drop an external object into the gallery.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term><guilabel>Drag and drop from an internal source</guilabel></term>
|
|
<listitem><para> Check <guilabel>Display local properties editor when
|
|
object is dropped</guilabel> box to invoke local properties editor
|
|
after you drop an internal object into the gallery.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</sect3>
|
|
|
|
<!-- =============== Customization Sub-subsection ================ -->
|
|
<sect3 id="prefs-db-id">
|
|
<title>&app; internal IDs</title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry><term><guilabel> GRAMPS ID prefixes</guilabel></term>
|
|
<listitem><para> Enter ID prefixes for various kinds of database
|
|
entries into the corresponding text entry fields.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term><guilabel>Allow internal GRAMPS ID numbers to be
|
|
edited</guilabel></term>
|
|
<listitem><para> Check this box to enable editing of the internal &app;
|
|
ID numbers. Unless you know what you are doing, leave it unchecked.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</sect3>
|
|
|
|
<!-- =============== Customization Sub-subsection ================ -->
|
|
<sect3 id="prefs-db-rcs">
|
|
<title>Revision Control</title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry><term><guilabel>Use revision control</guilabel></term>
|
|
<listitem><para> Check this box to enable &app; to use revision control
|
|
system for your database. If you choose this option, select the
|
|
particular revision control system from the menu.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry><term><guilabel>Prompt for comment on save</guilabel></term>
|
|
<listitem><para> Check this box to instruct &app; to prompt you to enter
|
|
the comment when you save the database.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
</sect2>
|
|
|
|
</sect1> <!-- ================ End Customization ================== -->
|
|
|
|
<!-- ============= Bugs ================================== -->
|
|
<!-- This section is optional and is commented out by default.
|
|
You can use it to describe known bugs and limitations of the
|
|
program if there are any - please be frank and list all
|
|
problems you know of.
|
|
|
|
<sect1 id="mayapp-bugs">
|
|
<title>Known Bugs and Limitations</title>
|
|
<para> </para>
|
|
</sect1>
|
|
-->
|
|
<!-- ============= About ================================== -->
|
|
<!-- This section contains info about the program (not docs), such as
|
|
author's name(s), web page, license, feedback address. This
|
|
section is optional: primary place for this info is "About.." box of
|
|
the program. However, if you do wish to include this info in the
|
|
manual, this is the place to put it.
|
|
Alternatively, you can put this information in the title page.-->
|
|
<sect1 id="gramps-about">
|
|
<title>About &app;</title>
|
|
<para> &app; was written by Donald N. Allingham
|
|
(<email>dallingham@users.sourceforge.net</email>).
|
|
To find more information about &app;, please visit the
|
|
<ulink url="http://gramps.sourceforge.net" type="http">GRAMPS Project
|
|
Web page</ulink>. </para>
|
|
<para>
|
|
To report a bug or make a suggestion regarding this application or
|
|
this manual, follow the directions in this
|
|
<ulink url="ghelp:gnome-feedback" type="help">document</ulink>.
|
|
</para>
|
|
|
|
<para> This program is distributed 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. A copy of this license can be found at this
|
|
<ulink url="ghelp:gpl" type="help">link</ulink>, or in the file
|
|
COPYING included with the source code of this program. </para>
|
|
|
|
</sect1>
|
|
</article>
|