Copy C sources

svn: r2540
This commit is contained in:
Alex Roitman 2003-12-17 21:57:31 +00:00
parent 856998f0bc
commit 46ad98b045
13 changed files with 5940 additions and 0 deletions

View File

@ -0,0 +1,15 @@
figdir = figures
docname = gramps-manual
lang = C
omffile = gramps-manual-C.omf
entities = legal.xml\
getstart.xml\
mainwin.xml\
usage.xml\
custom.xml\
faq.xml\
keybind.xml\
filtref.xml\
cmdline.xml
include $(top_srcdir)/doc/xmldocs.make
dist-hook: app-dist-hook

View File

@ -0,0 +1,401 @@
# Makefile.in generated by automake 1.6.3 from Makefile.am.
# @configure_input@
# Copyright 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002
# Free Software Foundation, Inc.
# This Makefile.in is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY, to the extent permitted by law; without
# even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE.
@SET_MAKE@
#
# No modifications of this Makefile should be necessary.
#
# To use this template:
# 1) Define: figdir, docname, lang, omffile, and entities in
# your Makefile.am file for each document directory,
# although figdir, omffile, and entities may be empty
# 2) Make sure the Makefile in (1) also includes
# "include $(top_srcdir)/doc/xmldocs.make" and
# "dist-hook: app-dist-hook".
# 3) Optionally define 'entities' to hold xml entities which
# you would also like installed
# 4) Figures must go under $(figdir)/ and be in PNG format
# 5) You should only have one document per directory
# 6) Note that the figure directory, $(figdir)/, should not have its
# own Makefile since this Makefile installs those figures.
#
# example Makefile.am:
# figdir = figures
# docname = scrollkeeper-manual
# lang = C
# omffile=scrollkeeper-manual-C.omf
# entities = fdl.xml
# include $(top_srcdir)/help/xmldocs.make
# dist-hook: app-dist-hook
#
# About this file:
# This file was taken from scrollkeeper_example2, a package illustrating
# how to install documentation and OMF files for use with ScrollKeeper
# 0.3.x and 0.4.x. For more information, see:
# http://scrollkeeper.sourceforge.net/
# Version: 0.1.2 (last updated: March 20, 2002)
#
#
# No modifications of this Makefile should be necessary.
#
# This file contains the build instructions for installing OMF files. It is
# generally called from the makefiles for particular formats of documentation.
#
# Note that you must configure your package with --localstatedir=/var/lib
# so that the scrollkeeper-update command below will update the database
# in the standard scrollkeeper directory.
#
# If it is impossible to configure with --localstatedir=/var/lib, then
# modify the definition of scrollkeeper_localstate_dir so that
# it points to the correct location. Note that you must still use
# $(localstatedir) in this or when people build RPMs it will update
# the real database on their system instead of the one under RPM_BUILD_ROOT.
#
# Note: This make file is not incorporated into xmldocs.make because, in
# general, there will be other documents install besides XML documents
# and the makefiles for these formats should also include this file.
#
# About this file:
# This file was taken from scrollkeeper_example2, a package illustrating
# how to install documentation and OMF files for use with ScrollKeeper
# 0.3.x and 0.4.x. For more information, see:
# http://scrollkeeper.sourceforge.net/
# Version: 0.1.2 (last updated: March 20, 2002)
#
SHELL = @SHELL@
srcdir = @srcdir@
top_srcdir = @top_srcdir@
VPATH = @srcdir@
prefix = @prefix@
exec_prefix = @exec_prefix@
bindir = @bindir@
sbindir = @sbindir@
libexecdir = @libexecdir@
datadir = @datadir@
sysconfdir = @sysconfdir@
sharedstatedir = @sharedstatedir@
localstatedir = @localstatedir@
libdir = @libdir@
infodir = @infodir@
mandir = @mandir@
includedir = @includedir@
oldincludedir = /usr/include
pkgdatadir = $(datadir)/@PACKAGE@
pkglibdir = $(libdir)/@PACKAGE@
pkgincludedir = $(includedir)/@PACKAGE@
top_builddir = ../../..
ACLOCAL = @ACLOCAL@
AUTOCONF = @AUTOCONF@
AUTOMAKE = @AUTOMAKE@
AUTOHEADER = @AUTOHEADER@
am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd
INSTALL = @INSTALL@
INSTALL_PROGRAM = @INSTALL_PROGRAM@
INSTALL_DATA = @INSTALL_DATA@
install_sh_DATA = $(install_sh) -c -m 644
install_sh_PROGRAM = $(install_sh) -c
install_sh_SCRIPT = $(install_sh) -c
INSTALL_SCRIPT = @INSTALL_SCRIPT@
INSTALL_HEADER = $(INSTALL_DATA)
transform = @program_transform_name@
NORMAL_INSTALL = :
PRE_INSTALL = :
POST_INSTALL = :
NORMAL_UNINSTALL = :
PRE_UNINSTALL = :
POST_UNINSTALL = :
EXEEXT = @EXEEXT@
OBJEXT = @OBJEXT@
PATH_SEPARATOR = @PATH_SEPARATOR@
AMTAR = @AMTAR@
AWK = @AWK@
BINSH = @BINSH@
CC = @CC@
DEPDIR = @DEPDIR@
GNOMEHELP = @GNOMEHELP@
GNOMEINC = @GNOMEINC@
GNOMELIB = @GNOMELIB@
GPREFIX = @GPREFIX@
HAVE_PKG_CONFIG = @HAVE_PKG_CONFIG@
ICONV = @ICONV@
INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@
LANGUAGES = @LANGUAGES@
MOFILES = @MOFILES@
MSGCONV = @MSGCONV@
MSGFMT = @MSGFMT@
PACKAGE = @PACKAGE@
POFILES = @POFILES@
PYTHON = @PYTHON@
PYTHON_CPPFLAGS = @PYTHON_CPPFLAGS@
PYTHON_EXEC_PREFIX = @PYTHON_EXEC_PREFIX@
PYTHON_PLATFORM = @PYTHON_PLATFORM@
PYTHON_PREFIX = @PYTHON_PREFIX@
PYTHON_VERSION = @PYTHON_VERSION@
RELEASE = @RELEASE@
SCROLLKEEPER_BUILD_REQUIRED = @SCROLLKEEPER_BUILD_REQUIRED@
SK_CONFIG = @SK_CONFIG@
STRIP = @STRIP@
SWIG = @SWIG@
VERSION = @VERSION@
VERSIONSTRING = @VERSIONSTRING@
ZIP = @ZIP@
am__include = @am__include@
am__quote = @am__quote@
install_sh = @install_sh@
pkgpyexecdir = @pkgpyexecdir@
pkgpythondir = @pkgpythondir@
pyexecdir = @pyexecdir@
pythondir = @pythondir@
figdir = figures
docname = gramps-manual
lang = C
omffile = gramps-manual-C.omf
entities = legal.xml\
getstart.xml\
mainwin.xml\
usage.xml\
custom.xml\
faq.xml\
keybind.xml\
filtref.xml\
cmdline.xml
# ************* Begin of section some packagers may need to modify **************
# This variable (docdir) specifies where the documents should be installed.
# This default value should work for most packages.
docdir = $(datadir)/@PACKAGE@/gnome/help/@PACKAGE@/$(lang)
# ************** You should not have to edit below this line *******************
xml_files = $(entities) $(docname).xml
omf_dir = $(top_srcdir)/omf-install
EXTRA_DIST = $(xml_files) $(omffile)
CLEANFILES = omf_timestamp *.out
omf_dest_dir = $(datadir)/omf/@PACKAGE@
scrollkeeper_localstate_dir = $(localstatedir)/scrollkeeper
subdir = doc/gramps-manual/C
mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs
CONFIG_CLEAN_FILES =
DIST_SOURCES =
DIST_COMMON = Makefile.am Makefile.in
all: all-am
.SUFFIXES:
$(srcdir)/Makefile.in: Makefile.am $(top_srcdir)/doc/xmldocs.make $(top_srcdir)/doc/omf.make $(top_srcdir)/configure.in $(ACLOCAL_M4)
cd $(top_srcdir) && \
$(AUTOMAKE) --gnu doc/gramps-manual/C/Makefile
Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status
cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)
uninstall-info-am:
tags: TAGS
TAGS:
DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
top_distdir = ../../..
distdir = $(top_distdir)/$(PACKAGE)-$(VERSION)
distdir: $(DISTFILES)
@list='$(DISTFILES)'; for file in $$list; do \
if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \
dir=`echo "$$file" | sed -e 's,/[^/]*$$,,'`; \
if test "$$dir" != "$$file" && test "$$dir" != "."; then \
dir="/$$dir"; \
$(mkinstalldirs) "$(distdir)$$dir"; \
else \
dir=''; \
fi; \
if test -d $$d/$$file; then \
if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \
cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \
fi; \
cp -pR $$d/$$file $(distdir)$$dir || exit 1; \
else \
test -f $(distdir)/$$file \
|| cp -p $$d/$$file $(distdir)/$$file \
|| exit 1; \
fi; \
done
$(MAKE) $(AM_MAKEFLAGS) \
top_distdir="${top_distdir}" distdir="$(distdir)" \
dist-hook
check-am: all-am
check: check-am
all-am: Makefile
installdirs:
install: install-am
install-exec: install-exec-am
install-data: install-data-am
uninstall: uninstall-am
install-am: all-am
@$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am
installcheck: installcheck-am
install-strip:
$(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \
INSTALL_STRIP_FLAG=-s \
`test -z '$(STRIP)' || \
echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install
mostlyclean-generic:
clean-generic:
-test -z "$(CLEANFILES)" || rm -f $(CLEANFILES)
distclean-generic:
-rm -f Makefile $(CONFIG_CLEAN_FILES)
maintainer-clean-generic:
@echo "This command is intended for maintainers to use"
@echo "it deletes files that may require special tools to rebuild."
clean: clean-am
clean-am: clean-generic mostlyclean-am
distclean: distclean-am
distclean-am: clean-am distclean-generic
dvi: dvi-am
dvi-am:
info: info-am
info-am:
install-data-am: install-data-local
@$(NORMAL_INSTALL)
$(MAKE) $(AM_MAKEFLAGS) install-data-hook
install-exec-am:
install-info: install-info-am
install-man:
installcheck-am:
maintainer-clean: maintainer-clean-am
maintainer-clean-am: distclean-am maintainer-clean-generic
mostlyclean: mostlyclean-am
mostlyclean-am: mostlyclean-generic
uninstall-am: uninstall-info-am uninstall-local
.PHONY: all all-am check check-am clean clean-generic distclean \
distclean-generic distdir dvi dvi-am info info-am install \
install-am install-data install-data-am install-data-local \
install-exec install-exec-am install-info install-info-am \
install-man install-strip installcheck installcheck-am \
installdirs maintainer-clean maintainer-clean-generic \
mostlyclean mostlyclean-generic uninstall uninstall-am \
uninstall-info-am uninstall-local
omf: omf_timestamp
omf_timestamp: $(omffile)
-for file in $(omffile); do \
scrollkeeper-preinstall $(docdir)/$(docname).xml $(srcdir)/$$file $$file.out; \
done
touch omf_timestamp
install-data-hook-omf:
$(mkinstalldirs) $(DESTDIR)$(omf_dest_dir)
for file in $(omffile); do \
$(INSTALL_DATA) $$file.out $(DESTDIR)$(omf_dest_dir)/$$file; \
done
-scrollkeeper-update -p $(scrollkeeper_localstate_dir) -o $(DESTDIR)$(omf_dest_dir)
uninstall-local-omf:
-for file in $(srcdir)/*.omf; do \
basefile=`basename $$file`; \
rm -f $(omf_dest_dir)/$$basefile; \
done
-rmdir $(omf_dest_dir)
-scrollkeeper-update -p $(scrollkeeper_localstate_dir)
all: omf
$(docname).xml: $(entities)
-ourdir=`pwd`; \
cd $(srcdir); \
cp $(entities) $$ourdir
.PHONY: distclean-hook
distclean: distclean-hook
distclean-hook:
if [ $(top_srcdir) != $(top_builddir) ]; \
then \
rm -f $(entities); \
fi
app-dist-hook:
if test "$(figdir)"; then \
$(mkinstalldirs) $(distdir)/$(figdir); \
for file in $(srcdir)/$(figdir)/*.png; do \
basefile=`echo $$file | sed -e 's,^.*/,,'`; \
$(INSTALL_DATA) $$file $(distdir)/$(figdir)/$$basefile; \
done \
fi
install-data-local: omf
$(mkinstalldirs) $(DESTDIR)$(docdir)
for file in $(xml_files); do \
cp $(srcdir)/$$file $(DESTDIR)$(docdir); \
done
if test "$(figdir)"; then \
$(mkinstalldirs) $(DESTDIR)$(docdir)/$(figdir); \
for file in $(srcdir)/$(figdir)/*.png; do \
basefile=`echo $$file | sed -e 's,^.*/,,'`; \
$(INSTALL_DATA) $$file $(DESTDIR)$(docdir)/$(figdir)/$$basefile; \
done \
fi
install-data-hook: install-data-hook-omf
uninstall-local: uninstall-local-doc uninstall-local-omf
uninstall-local-doc:
-if test "$(figdir)"; then \
for file in $(srcdir)/$(figdir)/*.png; do \
basefile=`echo $$file | sed -e 's,^.*/,,'`; \
rm -f $(DESTDIR)/$(docdir)/$(figdir)/$$basefile; \
done; \
rmdir $(DESTDIR)$(docdir)/$(figdir); \
fi
-for file in $(xml_files); do \
rm -f $(DESTDIR)$(docdir)/$$file; \
done
-rmdir $(DESTDIR)$(docdir)
dist-hook: app-dist-hook
# Tell versions [3.59,3.63) of GNU make to not export all variables.
# Otherwise a system limit (for SysV at least) may be exceeded.
.NOEXPORT:

View File

@ -0,0 +1,247 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
User Manual for Gramps - a GTK+/GNOME based genealogy program
Copyright (C) 2003 Alexander Roitman
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
License (GFDL), Version 1.1 or any later version published
by the Free Software Foundation with no Invariant Sections,
no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the file COPYING-DOCS
distributed with this manual.
-->
<!-- $Id$ -->
<!-- =============== Appendices Subsection ================ -->
<sect2 id="append-cmdline">
<title>Command line reference</title>
<para>This appendix provides the reference to the command line
capabilities available when launching &app; from the terminal. </para>
<para>Let us note here that &app; was designed to be an interactive
program. Therefore it uses graphical display and cannot run from the
true non-graphical console. It would take an enormous amount of effort
to enable it to run in a text-only terminal. This is why the set of
command line options does not aim to completely get rid of dependency
on the graphical display. Rather, it merely makes certain (typical) tasks
more convenient. It also allows one to execute these tasks from the scripts.
However, the graphical display must be accessible at all times!
</para>
<para>To summarize, the use of the command line options provides
non-interactive behavior, but does not get rid of graphical display
dependency. Take it or leave it!
</para>
<sect3 id="cmdline-options">
<title>Available options</title>
<para>Here is the list of the command line options in &app;:
</para>
<variablelist>
<varlistentry><term>Format options</term>
<listitem><para> The format of any file destined for import or export
can be specified with the
<command>-f</command> <replaceable>format</replaceable>
option. The <replaceable>format</replaceable> can be one of the
following:
<variablelist>
<varlistentry><term>gramps</term>
<listitem><para> &app; database. This format is available
for both import and export. When not specified, it can be
guessed if the filename represents a directory.
</para></listitem></varlistentry>
<varlistentry><term>gedcom</term>
<listitem><para> GEDCOM file. This format is available
for both import and export. When not specified, it can be
guessed if the filename ends with .ged
</para></listitem></varlistentry>
<varlistentry><term>gramps-pkg</term>
<listitem><para> &app; package. This format is available
for both import and export. When not specified, it can be
guessed if the filename ends with .tgz
</para></listitem></varlistentry>
<varlistentry><term>wft</term>
<listitem><para> Web Family Tree. This format is available
for export only. When not specified, it can be guessed
if the filename ends with .wft
</para></listitem></varlistentry>
<varlistentry><term>iso</term>
<listitem><para> CD image. This format is available
for export only. It must always be specified explicitly.
</para></listitem></varlistentry>
</variablelist>
</para></listitem>
</varlistentry>
<varlistentry><term>Import options</term>
<listitem><para> The files destined for import can be specified with
the
<command>-i</command> <replaceable>filename</replaceable>
option. The format can be specified with the <command>-f</command>
option immediately following the <replaceable>filename</replaceable>.
If not specified, the guess will be attempted based on
the <replaceable>filename</replaceable>. For <term>gramps</term>
format, the <replaceable>filename</replaceable> is actually the
name of directory under which the gramps database resides. For
<term>gedcom</term> and <term>gramps-pkg</term>, the
<replaceable>filename</replaceable> is the name of the
corresponding file.
</para>
<para>When more than one input file is given, each has to be preceded
by <command>-i</command> flag. The files are imported in the
specified order, i.e.
<command>-i</command> <replaceable>file1</replaceable>
<command>-i</command> <replaceable>file2</replaceable>
and
<command>-i</command> <replaceable>file2</replaceable>
<command>-i</command> <replaceable>file1</replaceable>
might produce different gramps IDs in the resulting database.
</para></listitem>
</varlistentry>
<varlistentry><term>Export options</term>
<listitem><para> The files destined for export can be specified with
the
<command>-o</command> <replaceable>filename</replaceable>
option. The format can be specified with the <command>-f</command>
option immediately following the <replaceable>filename</replaceable>.
If not specified, the guess will be attempted based on
the <replaceable>filename</replaceable>. For <term>gramps</term>
and <term>iso</term> formats, the <replaceable>filename</replaceable>
is actually the name of directory the gramps database will be written
into. For <term>gedcom</term>, <term>wft</term>,
and <term>gramps-pkg</term>, the <replaceable>filename</replaceable>
is the name of the resulting file.
</para>
<para> When more than one output file is given, each has to be
preceded by <command>-o</command> flag. The files are written one
by one, in the specified order.
</para></listitem>
</varlistentry>
<varlistentry><term>Action options</term>
<listitem><para> The action to perform on the imported data can be
specified with the
<command>-a</command> <replaceable>action</replaceable>
option. This is done after all imports are successfully completed.
Currently available actions are <term>summary</term> (same as
<menuchoice><guimenu>Reports</guimenu><guisubmenu>View</guisubmenu>
<guimenuitem>Summary</guimenuitem></menuchoice>)
and <term>check</term> (same as
<menuchoice><guimenu>Tools</guimenu>
<guisubmenu>Database Processing</guisubmenu>
<guimenuitem>Check and Repair</guimenuitem></menuchoice>).
</para>
<para>When more than one output action is given, each has to be
preceded by <command>-a</command> flag. The actions are performed
one by one, in the specified order.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="cmdline-operation">
<title>Operation</title>
<para>The order of <command>-i</command>, <command>-o</command>,
or <command>-a</command> options with respect to each does not matter.
The actual execution order always is: all imports (if any) -> all
exports (if any) -> all actions (if any).</para>
<para>If no <command>-i</command> option is given, gramps will launch
its main window and start the usual interactive session with the empty
database (since there is no data to process, anyway).</para>
<para>If no <command>-o</command> or <command>-a</command> options
are given, gramps will launch its main window and start the usual
interactive session with the database resulted from all imports.
This database resides under
<replaceable>~/.gramps/import</replaceable> directory.</para>
<para>Any errors encountered during import, export, or action, will
be either dumped to stdout (if these are exceptions handled by gramps)
or or to stderr (if these are not handled). Use usual shell redirections
of stdout and stderr to save messages and errors in files.</para>
</sect3>
<sect3 id="cmdline-examples">
<title>Examples</title>
<para>To import four databases (whose formats can be determined from
their names) and then check the resulting database for errors, one may
type:</para>
<para><command>gramps -i</command> <replaceable>file1.ged</replaceable>
<command>-i</command> <replaceable>file2.tgz</replaceable>
<command>-i</command> <replaceable>~/db3</replaceable>
<command>-i</command> <replaceable>file4.wft</replaceable>
<command>-a</command> <replaceable>check</replaceable>
</para>
<para>To explicitly specify the formats in the above example, append
filenames with appropriate <command>-f</command> options:</para>
<para><command>gramps -i</command> <replaceable>file1.ged</replaceable>
<command>-f</command> <replaceable>gedcom</replaceable>
<command>-i</command> <replaceable>file2.tgz</replaceable>
<command>-f</command> <replaceable>gramps-pkg</replaceable>
<command>-i</command> <replaceable>~/db3</replaceable>
<command>-f</command> <replaceable>gramps</replaceable>
<command>-i</command> <replaceable>file4.wft</replaceable>
<command>-f</command> <replaceable>wft</replaceable>
<command>-a</command> <replaceable>check</replaceable>
</para>
<para>To record the database resulting from all imports, supply
<command>-o</command> flag (use <command>-f</command>
if the filename does not allow gramps to guess the format):</para>
<para><command>gramps -i</command> <replaceable>file1.ged</replaceable>
<command>-i</command> <replaceable>file2.tgz</replaceable>
<command>-o</command> <replaceable>~/new-package</replaceable>
<command>-f</command> <replaceable>gramps-pkg</replaceable>
</para>
<para>To save any error messages of the above example into files
<replaceable>outfile</replaceable> and
<replaceable>errfile</replaceable>, run:</para>
<para><command>gramps -i</command> <replaceable>file1.ged</replaceable>
<command>-i</command> <replaceable>file2.tgz</replaceable>
<command>-o</command> <replaceable>~/new-package</replaceable>
<command>-f</command> <replaceable>gramps-pkg</replaceable>
&gt;<replaceable>outfile</replaceable>
2&gt;<replaceable>errfile</replaceable>
</para>
<para>To import three databases and start interactive gramps
session with the result:</para>
<para><command>gramps -i</command> <replaceable>file1.ged</replaceable>
<command>-i</command> <replaceable>file2.tgz</replaceable>
<command>-i</command> <replaceable>~/db3</replaceable>
</para>
<para>Finally, to start normal interactive session type:</para>
<para> <command>gramps </command></para>
</sect3>
</sect2>

View File

@ -0,0 +1,398 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
User Manual for Gramps - a GTK+/GNOME based genealogy program
Copyright (C) 2003 Alexander Roitman
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
License (GFDL), Version 1.1 or any later version published
by the Free Software Foundation with no Invariant Sections,
no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the file COPYING-DOCS
distributed with this manual.
-->
<!-- $Id$ -->
<!-- ================ Customization ================================ -->
<sect1 id="gramps-prefs">
<title>Settings</title>
<para>To configure &app;, choose
<menuchoice><guimenu>Edit</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 the
<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 the
<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 &app; requests information about you,
this information is used only so that &app; can create valid GEDCOM
output files. A valid GEDCOM file requires information about the file's
creator. If you choose, you may leave the information empty, however
none of your exported GEDCOM files will be valid.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
<!-- =============== Customization Sub-subsection ================ -->
<sect3 id="prefs-usage-guess">
<title>Data Guessing</title>
<variablelist>
<varlistentry><term><guilabel>Family name guessing</guilabel></term>
<listitem><para> This option affects the initial family name of a
child when he/she is added to the database. NOTE: this option only
affects the initial family name guessed by &app; when the
<guilabel>Edit Person</guilabel> dialog is launched. You can modify
that name the way you see fit. Set this option to the value that you
will most frequently use, as it will save you a lot of typing.</para>
<para>If <guilabel>None</guilabel> is selected, no guessing will be
attempted. Selecting <guilabel>Father's surname</guilabel> will use
the family name of the father. Selecting <guilabel>Combination of
mother's and father's surname</guilabel> will use the father's name
followed by the mother's name. Finally, <guilabel>Icelandic
style</guilabel> will use the father's given name followed by the
&quot;sson&quot; suffix (e.g. the son of Edwin will be guessed as
Edwinsson).
</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>Default view</guilabel></term>
<listitem><para> This determines which view will appear when you
start &app;. Choose between Person and Family views.
</para></listitem>
</varlistentry>
<varlistentry><term><guilabel>Family view style</guilabel></term>
<listitem><para> This selects between the two available styles of the Family
view layout. The <guilabel>Left to right</guilabel> style is similar to the
Family Tree Maker (tm), while the <guilabel>Top to bottom</guilabel> is
similar to the Reunion.
</para></listitem>
</varlistentry>
<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 the calendar format selection
menu when you are entering dates in the <guilabel>Event
Editor</guilabel> dialog. This will allow you to select different
calendars when editing the dates.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
<!-- =============== Customization Sub-subsection ================ -->
<sect3 id="prefs-display-bars">
<title>Toolbar and Statusbar</title>
<variablelist>
<varlistentry><term><guilabel>Toolbar</guilabel></term>
<listitem><para> Select the desired appearance of the toolbar icons
from the menu. Selecting <guilabel>GNOME Settings</guilabel> will use
the overall settings selected for your GNOME desktop.
</para></listitem>
</varlistentry>
<varlistentry><term><guilabel>Statusbar</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. While it
creates an overhead in performance (some processor cycles must be spent
to decompress the file before use), this overhead is extremely small.
Now that the compression-related bugs have long been fixed, there is
virtually no reason to disable data file compression.
</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. Setting the interval to zero (0)
disables autosaving. </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 the <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>
<para>Before describing preferences for media objects, let us
review the background on local and non-local objects. A local object
is the object whose file is stored inside the same directory in which
the &app; database file resides. A non-local object is stored
elsewhere, so that the database has only the reference to the file's
location and some records of the object's properties. </para>
<para>You may choose to store your media objects either locally
or externally. Making your objects local will increase the amount
of disk space consumed by the &app; database directory. However,
if the external file is deleted or removed, &app; will still be able
to use the local copy. In contrast, leaving your objects non-local
will decrease the disk space requirements. However, losing the
original file will render your media object unusable.
</para>
<para>Note that exporting your database to any format will compile
all medial objects, no matter whether they are local or not.
Specifically, export to gramps package will include all the media
object files in the package and change the references accordingly.
Export to CD will copy all media object files to the directory under
the <guilabel>burn:///</guilabel> location in Nautilus and change the
references accordingly. Finally, export to GEDCOM will place all
media object files next to the GEDCOM file with the appropriate
changes in the path names.
</para>
<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 needs to make best choice.</para>
<para>Check the <guilabel>Display global properties editor when
object is dropped</guilabel> box to invoke the 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 the <guilabel>Display local properties editor
when object is dropped</guilabel> box to invoke the 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 the 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 ================== -->

View File

@ -0,0 +1,371 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
User Manual for Gramps - a GTK+/GNOME based genealogy program
Copyright (C) 2003 Alexander Roitman
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
License (GFDL), Version 1.1 or any later version published
by the Free Software Foundation with no Invariant Sections,
no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the file COPYING-DOCS
distributed with this manual.
-->
<!-- $Id$ -->
<!-- =============== Appendices Subsection ================ -->
<sect2 id="faq">
<title>Frequently Asked Questions</title>
<para>This appendix contains the list of questions that frequently come
up in mailing list discussions and forums. This list is by no means
complete. If you would like to add questions/answers to this list,
please email your suggestions to <ulink url="mailto:gramps-devel@lists.sf.net"
type="mailto">gramps-devel@lists.sf.net</ulink>
</para>
<variablelist>
<varlistentry><term>What is &app;?</term>
<listitem><para> &app; is the Genealogical Research and Analysis
Management Program System. In other words, it is a personal genealogy
program letting you store, edit, and research genealogical data using
the powers of your computer.
</para></listitem>
</varlistentry>
<varlistentry><term>Where do I get it and how much does it cost?</term>
<listitem><para>
&app; can be downloaded from <ulink url="http://sf.net/projects/gramps"
type="http">http://sf.net/projects/gramps</ulink> at no charge.
&app; is an Open Source project covered by the GNU General Public License.
You have full access to the source code and are allowed to distribute the
program and source code freely.
</para></listitem>
</varlistentry>
<varlistentry><term>Does it work with Windows (tm)?</term>
<listitem><para>
No. &app; uses the GTK and GNOME libraries. While the GTK libraries
have been ported to Windows, the GNOME libraries have not.
This, however, may change in the future.
</para></listitem>
</varlistentry>
<varlistentry><term>Does it work with the Mac?</term>
<listitem><para>
The Fink project (<ulink url="http://fink.sf.net"
type="http">http://fink.sf.net</ulink>) has ported an old version of
&app; (0.8.0) to OSX. The Mac OSX port is not directly supported by
the &app; project, primarily because none of the &app; developers
have access to Mac OSX.</para>
<para>The GNOME 2 version of &app; (0.9.x) does not appear to have been
ported by the Fink project. Please contact the Fink project for more
information.
</para></listitem>
</varlistentry>
<varlistentry><term>Does it work with KDE?</term>
<listitem><para>
Yes, as long as the required GNOME libraries are installed.
</para></listitem>
</varlistentry>
<varlistentry><term>Do I really have to have GNOME installed?</term>
<listitem><para> Yes, but you do not have to be running the GNOME desktop.
</para></listitem>
</varlistentry>
<varlistentry><term>What version of GNOME do I need?</term>
<listitem><para>
The latest versions of gramps (0.9.0 and higher) require GNOME 2.0 or higher.
Previous versions required GNOME 1.X.
</para></listitem>
</varlistentry>
<varlistentry><term>Is &app; compatible with
other genealogical software (GenApps)?</term>
<listitem><para>
&app; makes every effort to maintain compatibility with GEDCOM, the general
standard of recording genealogical information. We have import and export
filters that enable &app; to read and write GEDCOM files. </para>
<para>
It is important to understand that the GEDCOM standard is poorly implemented --
virtually every genealogical software has its own "flavor" of GEDCOM. As we
learn about new flavor, the import/export filters can be created very quickly.
However, finding out about the unknown flavors requires user feedback.
Please feel free to inform us about any GEDCOM flavor not supported by &app;,
and we will do our best to support it!
</para></listitem>
</varlistentry>
<varlistentry><term>Can &app; read files created by GenApp X?</term>
<listitem><para> See above.
</para></listitem>
</varlistentry>
<varlistentry><term>Can &app; write files readable by GenApp X?</term>
<listitem><para> See above.
</para></listitem>
</varlistentry>
<varlistentry><term>Can &app; print a genealogical tree for my family?</term>
<listitem><para>
Yes. Different people have different ideas of what a genealogical tree is.
Some think of it as a chart going from the distant ancestor and listing
all his/her descendants and their families. Others think it should be a
chart going from the person back in time, listing the ancestors and their
families. Yet other people think of a table, text report, etc. </para>
<para>
&app; can produce any of the above, and many more different charts and
reports. Moreover, the plugin architechture enables users (you) to create
their own plugins which could be new reports, charts, or research tools.
</para></listitem>
</varlistentry>
<varlistentry><term>In what formats can &app; output its reports?</term>
<listitem><para>
Text reports are available in HTML, PDF, AbiWord, KWord, LaTeX, RTF, and
OpenOffice formats. Graphical reports (charts and diagrams) are available in
PostScript, PDF, SVG, OpenOffice and GraphViz formats.
</para></listitem>
</varlistentry>
<varlistentry><term>Is &app; compatible with the Internet?</term>
<listitem><para>
&app; can store web addresses and direct your browser to them. It can import
data that you download from the Internet. It can export data that you could
send over the Internet. &app; is familiar with the standard file formats
widely used on the Internet (e.g. JPEG, PNG, and GIF images, MP3, OGG, and
WAV sound files, QuickTime, MPEG, and AVI movie files, etc). Other than that,
there is little that a genealogical program can do with the Internet :-)
</para></listitem>
</varlistentry>
<varlistentry><term>Can I create custom reports/filters/whatever?</term>
<listitem><para>
Yes. There are many levels of customization. One is creating or modifying
the templates used for the reports. This gives you some control over
the fonts, colors, and some layout of the reports. You can also use &app;
controls in the report dialogs to tell what contents should be used for a
particular report. In addition to this, you have an ability to create your
own filters -- this is useful in selecting people based on criteria set
by you. You can combine these filters to create new, more complex filters.
Finally, you have an option to create your own plugins. These may be new
reports, research tools, import/export filters, etc. This assumes some
knowledge of programming in Python.
</para></listitem>
</varlistentry>
<varlistentry><term>What standards does &app; support?</term>
<listitem><para>
The nice thing about the standards is that there never is a shortage of
them :-). &app; is tested to support the following flavors of GEDCOM:
GEDCOM5.5, Brother's Keeper, Family Origins, Familty Tree Maker, Ftree,
GeneWeb, Legacy, Personal Ancestral File, Pro-Gen, Reunion, and
Visual Genealogie.
</para></listitem>
</varlistentry>
<varlistentry><term>What is the maximum database
size (bytes) &app; can handle?</term>
<listitem><para>
&app; has no hard limits on the size of a database that it can handle.
In reality, however, there are practical limits. Currently &app; loads all
data into memory, so the limiting factor tends to be the available memory
on the system.
</para></listitem>
</varlistentry>
<varlistentry><term>How many people can &app; database handle?</term>
<listitem><para>
We have found that on a typical system, &app; tends to bog down after the
database has around 15,000 people. Again, this is dependant on how much
memory you have.
</para></listitem>
</varlistentry>
<varlistentry><term>Why is &app; running so slowly?</term>
<listitem><para>
If &app; seems too slow to you, it is most likely that you have a large
database. Currently, &app; loads all the database into memory, therefore
large databases tend to be less than responsive. Specifically, the system
can be virtually brought to its knees if swapping is needed for &app;' data.
</para> <para>
This will be addressed in the next stable release following version 1.0.
Temporarily, adding more memory could make a huge difference, but we realize
that this is a poor way of treating the problem. If you would like to help
with the implementation of the real database backend, please don't hesitate
to email us at <ulink url="mailto:gramps-devel@lists.sf.net"
type="mailto">gramps-devel@lists.sf.net</ulink>
</para></listitem>
</varlistentry>
<varlistentry><term>My database is really big.
Is there a way around loading all the data into memory?</term>
<listitem><para>
Currently, there is no way around it. However, this is our biggest priority
after releasing version 1.0. The real database backend will be incorporated
in the next stable release (1.2) which will dramatically improve performance
in both speed and memory usage.
</para></listitem>
</varlistentry>
<varlistentry><term>Why are non-latin characters displayed
as garbage in PDF/PS reports?</term>
<listitem><para>
This is a known problem -- PS (and PDF) have builtin fonts which pretty much
reflect the latin-1 charset. Any font in principle could be used with PS/PDF
but then it would have to be embedded in the file. This is problematic since
every system has different idea about fonts and their setup.</para>
<para>
This should be resolved as we move to gnome-print. In the meantime, a useable
workaround is to generate reports in OpenOffice.org format and then export
to PDF from the OpenOffice.org application.
</para></listitem>
</varlistentry>
<varlistentry><term>Why can I not add/remove/edit columns to the lists
in People View and Family View?</term>
<listitem><para>
This will be addressed after the TreeModelSort bug is fixed in pygtk,
see <ulink url="http://bugzilla.gnome.org/show_bug.cgi?id=125172"
type="http">http://bugzilla.gnome.org/show_bug.cgi?id=125172</ulink>
for the details.
Once the patch is committed and incorporated into pygtk, we will add the
ability to add/remove/edit sortable columns.
</para></listitem>
</varlistentry>
<varlistentry><term>I would like to contribute to &app; by writing
my favorite report. How do I do that?</term>
<listitem><para>
The easiest way to contribute to reports, filters, tools, etc. is to copy
an existing &app; report, filter, or tool. If you can create what you want
by modifying existing code -- great! If your idea does not fit into the logic
of any existing &app; tool, the <ulink
url="http://gramps.sourceforge.net/phpwiki/index.php/GrampsDevelopersPage"
type="http">following page</ulink> may provide some help in writing your
own plugin from scratch.
If you need more help or would like to discuss your idea with us,
please do not hesitate to contact us at <ulink
url="mailto:gramps-devel@lists.sf.net"
type="mailto">gramps-devel@lists.sf.net</ulink>
</para>
<para>
To test your work in progress, you may save your plugin under
<replaceable>$HOME/.gramps/plugins</replaceable> directory and it should
be found and imported on startup.
The correctly written plugin will register itself with &app;, create menu
item, and so on.</para>
<para>
If you are happy with your plugin and would like to contribute your code
back to the &app; project, you are very welcome to do so by contacting us
at <ulink url="mailto:gramps-devel@lists.sf.net"
type="mailto">gramps-devel@lists.sf.net</ulink>
</para></listitem>
</varlistentry>
<varlistentry><term>I found a bug and I want it fixed right now!
What do I do?</term>
<listitem><para>
The best thing you can do is to fix the bug and send the patch to
<ulink url="mailto:gramps-devel@lists.sf.net"
type="mailto">gramps-devel@lists.sf.net</ulink> :-)</para>
<para>
The next best thing would be to submit a good bug report. This can be done in
one of the two ways: (1) send your report to
<ulink url="mailto:gramps-bugs@lists.sf.net"
type="mailto">gramps-bugs@lists.sf.net</ulink>
or (2) file your report with the bug tracker system at
<ulink url="http://sf.net/tracker/?group_id=25770" type="http">
http://sf.net/tracker/?group_id=25770&amp;atid=385137</ulink>
(this function is also available by selecting
<menuchoice><guisubmenu>Help</guisubmenu><guimenuitem>Report a
bug</guimenuitem></menuchoice> from gramps main menu). </para>
<para>A good bug report would include: </para>
<itemizedlist>
<listitem><para>
Version of gramps you were using when you encountered the bug
(available through <menuchoice><guisubmenu>Help</guisubmenu>
<guimenuitem>About</guimenuitem></menuchoice> menu item).
</para></listitem>
<listitem><para>
Language under which gramps was run
(available by executing </para>
<para><command>echo $LANG</command></para>
<para>in your terminal).
</para></listitem>
<listitem><para>
Symptoms indicating that this is indeed a bug.
</para></listitem>
<listitem><para>
Any Traceback messages, error messages, warnings, etc,
that showed up in your terminal or a in separate traceback window.
</para></listitem>
</itemizedlist>
<para>Most problems can be fixed quickly provided there is enough information.
To ensure this, please follow up on your bug reports. In particular, if you
file a bug report with sf.net bug tracker, PLEASE log in to sf.net before
filing
(register your free account if you don't have one). Then we will have a way
of contacting you should we need more information. If you choose to file your
report anonymously, at least check every so often whether your report page
has something new posted, as it probably would.</para>
<para>If the above explanations seem vague, please follow
<ulink url="http://www.chiark.greenend.org.uk/~sgtatham/bugs.html"
type="http">this link.</ulink>
</para></listitem>
</varlistentry>
<varlistentry><term>It is obvious that &app; absolutely needs to
become a (client-server/web-based/PHP/weblog/Javascript/C++/distributed/KDE/Motif/Tcl/Win32/C#/You-name-it)
application. When is this going to happen?</term>
<listitem><para>
The surest way to see it happen is to get it done by yourself. Since
&app; is free/open source, nobody prevents you from taking all of the
code and continuing its development in whatever direction you see fit.
In doing so, you may consider giving your new project another name to
avoid confusion with the continuing &app; development. If you would
like the &app; project to provide advice, expertise, filters, etc.,
we will gladly cooperate with your new project, to ensure compatability
or import/export options to your new format of a project.</para>
<para>
If, however, you would like the &app; project to to adopt your strategy,
you would need to convince &app; developers that your strategy is good
for &app; and superior to the present development strategy.</para>
<para>
HINT: if &app; developers are still not convinced after about three
messages sent to gramps-devel, maybe you are better off on your own
rather than with a company of retards who can't fully realize the
potential of your great idea :-)
</para></listitem>
</varlistentry>
</variablelist>
</sect2>

View File

@ -0,0 +1,386 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
User Manual for Gramps - a GTK+/GNOME based genealogy program
Copyright (C) 2003 Alexander Roitman
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
License (GFDL), Version 1.1 or any later version published
by the Free Software Foundation with no Invariant Sections,
no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the file COPYING-DOCS
distributed with this manual.
-->
<!-- $Id$ -->
<!-- =============== Appendices Subsection ================ -->
<sect2 id="append-filtref">
<title>Filter rules reference</title>
<para>This appendix lists of all the filter rules currently defined
in &app;. Each of these rules is available for use when creating custom
filters. The rules are listed by their categories.
</para>
<!-- =============== Appendices Sub-subsection ================ -->
<sect3 id="filtref-general">
<title>General filters</title>
<para>This category includes the following most general rules:</para>
<variablelist>
<varlistentry><term>Everyone</term>
<listitem><para> This rule matches any person in the database.
As such it is not very useful on its own except for testing purposes.
However, it may be useful in combinations with other rules.
</para></listitem>
</varlistentry>
<varlistentry><term>Has a name</term>
<listitem><para> This rule matches any person whose name
matches the specified value in full or in part. For example,
Marta Ericsdotter will be matched by the rule using the
value "eric" for the family name.
</para>
<para> Separate values can be used for Given name, Family name,
Suffix, and the Title. The rule returns a match if and only if
all non-empty values are (partially) matched by a person's
name. To use just one value, leave the other values empty.
</para></listitem>
</varlistentry>
<varlistentry><term>Has the Id</term>
<listitem><para> This rule matches any person with a specified
&app; ID. The rule returns a match only if the ID is matched
exactly.
</para>
<para> You can either enter the ID into a text entry field, or
select a person from the list by clicking
<guibutton>Select...</guibutton> button. In the latter case, the
ID will appear in the text field after the selection was made.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a female</term>
<listitem><para> This rule matches any female person.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a male</term>
<listitem><para> This rule matches any male person.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
<!-- =============== Appendices Sub-subsection ================ -->
<sect3 id="filtref-event">
<title>Event filters</title>
<para>This category includes the following rules that match people
based on their recorded events:</para>
<variablelist>
<varlistentry><term>Has the birth</term>
<listitem><para> This rule matches people whose birth event
matches specified values for Date, Place, and Description.
The rule returns a match even if the person's birth event matches
the value partially. The matching rules are case-insensitive.
For example, anyone born in Sweden will be matched by the rule
using the value "sw" for the Place.
</para>
<para> The rule returns a match if and only if
all non-empty values are (partially) matched by a person's
birth. To use just one value, leave the other values empty.
</para></listitem>
</varlistentry>
<varlistentry><term>Has the death</term>
<listitem><para> This rule matches people whose death event
matches specified values for Date, Place, and Description.
The rule returns a match even if the person's death event
matches the value partially. The matching rules are case-insensitive.
For example, anyone who died in Sweden
will be matched by the rule using the value "sw" for the Place.
</para>
<para> The rule returns a match if and only if
all non-empty values are (partially) matched by a person's
death. To use just one value, leave the other values empty.
</para></listitem>
</varlistentry>
<varlistentry><term>Has the personal event</term>
<listitem><para> This rule matches people that have a personal
event matching specified values for the Event type, Date, Place,
and Description. The rule returns a match even if the person's
event matches the value partially. The matching rules are
case-insensitive. For example, anyone who graduated
in Sweden will be matched by the rule using the Graduation event
and the value "sw" for the Place.
</para>
<para> The personal events should be selected from a pull-down menu.
The rule returns a match if and only if all non-empty values
are (partially) matched by the personal event.
To use just one value, leave the other values empty.
</para></listitem>
</varlistentry>
<varlistentry><term>Has the family event</term>
<listitem><para> This rule matches people that have a family
event matching specified values for the Event type, Date, Place,
and Description. The rule returns a match even if the person's
event matches the value partially. The matching rules are
case-insensitive. For example, anyone who was married in Sweden
will be matched by the rule using the Marriage event and the
value "sw" for the Place.
</para>
<para> The family events should be selected from a pull-down menu.
The rule returns a match if and only if all non-empty values
are (partially) matched by the personal event.
To use just one value, leave the other values empty.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
<!-- =============== Appendices Sub-subsection ================ -->
<sect3 id="filtref-family">
<title>Family filters</title>
<para>This category includes the following rules that match people
based on their family relationships:</para>
<variablelist>
<varlistentry><term>Has the relationships</term>
<listitem><para> This rule matches people with a particular
relationship. The relationship must match the type selected from
the menu. Optionally, the number of relationships and the number
of children can be specified.
</para>
<para> The rule returns a match if and only if
all non-empty values are (partially) matched by a person's
birth. To use just one value, leave the other values empty.
</para></listitem>
</varlistentry>
<varlistentry><term>Is spouse of filter match</term>
<listitem><para> This rule matches people married to someone
who is matched by the specified filter.
The specified filter name should be selected from the menu.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a child of filter match</term>
<listitem><para> This rule matches people for whom either parent
is matched by the specified filter.
The specified filter name should be selected from the menu.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a parent of filter match</term>
<listitem><para> This rule matches people whose child
is matched by the specified filter.
The specified filter name should be selected from the menu.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
<!-- =============== Appendices Sub-subsection ================ -->
<sect3 id="filtref-ancestral">
<title>Ancestral filters</title>
<para>This category includes the following rules that match people
based on their ancestral relations to other people:</para>
<variablelist>
<varlistentry><term>Is an ancestor of</term>
<listitem><para> This rule matches people who are ancestors of the
specified person. The Inclusive option determines whether the
specified person should be considered his/her own ancestor (useful
for building reports).
</para>
<para> You can either enter the ID into a text entry field, or
select a person from the list by clicking
<guibutton>Select...</guibutton> button. In the latter case, the
ID will appear in the text field after the selection was made.
</para></listitem>
</varlistentry>
<varlistentry><term>Is an ancestor of person at
least N generations away</term>
<listitem><para> This rule matches people who are ancestors of the
specified person and are at least N generations away from that person
in their lineage. For example, using this rule with the value of 2
for the number of generations will match grandparents,
great-grandparents, etc., but not the parents of the specified
person.
</para></listitem>
</varlistentry>
<varlistentry><term>Is an ancestor of person not more
than N generations away</term>
<listitem><para> This rule matches people who are ancestors of the
specified person and are no more than N generations away from that
person in their lineage. For example, using this rule with the value
of 2 for the number of generations will match parents and
grandparents, but not great-grandparents, etc., of the specified
person.
</para></listitem>
</varlistentry>
<varlistentry><term>Has a common ancestor with</term>
<listitem><para> This rule matches people who have common ancestors
with the specified person.
</para></listitem>
</varlistentry>
<varlistentry><term>Has a common ancestor with filter match</term>
<listitem><para> This rule matches people who have common ancestors
with someone who is matched by the specified filter.
The specified filter name should be selected from the menu.
</para></listitem>
</varlistentry>
<varlistentry><term>Is an ancestor of filter match</term>
<listitem><para> This rule matches people who are ancestors
of someone who is matched by the specified filter.
The specified filter name should be selected from the menu.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
<!-- =============== Appendices Sub-subsection ================ -->
<sect3 id="filtref-descendant">
<title>Descendant filters</title>
<para>This category includes the following rules that match people
based on their descendant relations to other people:</para>
<variablelist>
<varlistentry><term>Is a descendant of</term>
<listitem><para> This rule matches people who are descendants of the
specified person. The Inclusive option determines whether the
specified person should be considered his/her own descendant (useful
for building reports).
</para>
<para> You can either enter the ID into a text entry field, or
select a person from the list by clicking
<guibutton>Select...</guibutton> button. In the latter case, the
ID will appear in the text field after the selection was made.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a descendant of person at
least N generations away</term>
<listitem><para> This rule matches people who are descendants of the
specified person and are at least N generations away from that person
in their lineage. For example, using this rule with the value of 2
for the number of generations will match grandchildren,
great-grandchildren, etc., but not the children of the specified
person.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a descendant of person not more
than N generations away</term>
<listitem><para> This rule matches people who are descendants of the
specified person and are no more than N generations away from that
person in their lineage. For example, using this rule with the value
of 2 for the number of generations will match children and
grandchildren, but not great-grandchildren, etc., of the specified
person.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a descendant of filter match</term>
<listitem><para> This rule matches people who are descendants
of someone who is matched by the specified filter.
The specified filter name should be selected from the menu.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a descendant family member of</term>
<listitem><para> This rule not only matches people who are
descendants of the specified person, but also those descendants'
spouses.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
<!-- =============== Appendices Sub-subsection ================ -->
<sect3 id="filtref-relat">
<title>Relationship filters</title>
<para>This category includes the following rules that match people
based on their mutual relationship:</para>
<variablelist>
<varlistentry><term>Relationship path between two people</term>
<listitem><para> This rule matches all ancestors of both people
back to their common ancestors (if exist). This produces the
&quot;relationship path&quot; between these two people, through
their common ancestors.
</para>
<para> You can either enter the ID of each person into the
appropriate text entry fields, or select people from the list by
clicking their <guibutton>Select...</guibutton> buttons. In the
latter case, the ID will appear in the text field after the
selection was made.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<!-- =============== Appendices Sub-subsection ================ -->
<sect3 id="filtref-misc">
<title>Miscellaneous filters</title>
<para>This category includes the following rules which do not
naturally fit into any of the above categories:</para>
<variablelist>
<varlistentry><term>Has the personal attribute</term>
<listitem><para> This rule matches people who have the personal
attribute of the specified value. The specified personal attribute
name should be selected from the menu. The specified value should
be typed into the text entry field.
</para></listitem>
</varlistentry>
<varlistentry><term>Has the family attribute</term>
<listitem><para> This rule matches people who have the family
attribute of the specified value. The specified family attribute
should be selected from the menu. The specified value should be
typed into the text entry field.
</para></listitem>
</varlistentry>
<varlistentry><term>Matches the filter named</term>
<listitem><para> This rule matches people who are matched
by the specified filter.
The specified filter name should be selected from the menu.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>

View File

@ -0,0 +1,210 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
User Manual for Gramps - a GTK+/GNOME based genealogy program
Copyright (C) 2003 Alexander Roitman
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
License (GFDL), Version 1.1 or any later version published
by the Free Software Foundation with no Invariant Sections,
no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the file COPYING-DOCS
distributed with this manual.
-->
<!-- $Id$ -->
<!-- =========== 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 &app; 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 &app; from a command line, type
<command>gramps</command>, then press <keycap>Return</keycap>.</para>
<para>If you would like &app; 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 -i</command> <replaceable>filename.ged</replaceable>
</para>
<para>where <replaceable>filename.ged</replaceable> is the name
of the file you want to open/import. The detailed reference to the
command line options is found in the <xref linkend="append-cmdline"/>.
</para></listitem>
</varlistentry>
</variablelist>
</sect2>
<!-- ================ Getting Started Subsection ==== -->
<sect2 id="run-1st-time">
<title>Running &app; for the first time</title>
<para>
The first time you run the program, GRAMPS will display its
Getting Started dialogs. Follow the directions guiding you through
<guilabel>Researcher information</guilabel>, <guilabel>Numerical date
formats</guilabel>, <guilabel>Alternate calendar support</guilabel>,
and <guilabel>LDS extensions</guilabel> sections. Most of the dialogs
are self-explanatory and will not be covered here.
</para>
<!-- ==== Figure: Getting Started Druid Window ==== -->
<figure id="druid-fig">
<title>&app; Getting Started Window: Researcher Information</title>
<screenshot><mediaobject><imageobject><imagedata
fileref="figures/researcher.png" format="PNG"/></imageobject>
<textobject>
<phrase>Shows Researcher Information Window. </phrase>
</textobject></mediaobject></screenshot></figure>
<!-- ==== End of Figure ==== -->
<para>Enter your personal information in the corresponding
text entry fields. Although &app; requests information about you,
this information is used only so that &app; can create valid GEDCOM
output files. A valid GEDCOM file requires information about the file's
creator. If you choose, you may leave the information empty, however
all the GEDCOM files you export will not be valid.
</para>
<para>This information can be entered at any time in the
<guilabel>Preferences</guilabel> dialog, under the
<guilabel>Usage</guilabel> category.
</para>
</sect2>
<!-- ================ Getting Started Subsection -->
<sect2 id="choose-db-start">
<title>Choosing a database on startup</title>
<para>If &app; 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 the <guibutton>OK</guibutton> button. 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>
<para>NOTE: when starting new database, you should
select an empty <replaceable>DIRECTORY</replaceable>
and <replaceable>NOT a FILE</replaceable>. Create empty directory if
needed. The directory you specify will be used by &app; to store
database file <replaceable>data.gramps</replaceable> as well as any
possible copies of media objects. This directory will be updated by &app;
each time the database is saved. </para>
<para>NOTE: when opening an existing database, you should
open a <replaceable>DIRECTORY</replaceable> and
<replaceable>NOT a FILE</replaceable>. The directory you need to open
should contain the database file <replaceable>data.gramps</replaceable>
as well as any possible copies of media objects. Such a directory is
created by &app; when you start a new database and is updated each time
the database is saved. </para>
</sect2>
<!-- ================ Getting Started Sub-subsection
<sect3 id="zodb-support">
<title>Optional ZODB support</title>
<para>If either StandaloneZODB or Zope is installed on your system,
&app; 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
a few thousand people). </para>
<para>Its is hard to tell which format is better, since this is a typical
trade-off 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 off with ZODB. </para>
</sect3>
-->
<!-- ================ Getting Started Subsection ==== -->
<sect2 id="get-help">
<title>Obtaining Help</title>
<para> At any time, the following items are available for immediate aid
from the <menuchoice><guimenu>Help</guimenu></menuchoice> menu: </para>
<variablelist>
<varlistentry><term>User manual</term>
<listitem><para> Choose this item to read the text of this manual
in the help browser. </para></listitem>
</varlistentry>
<varlistentry><term>FAQ</term>
<listitem><para> Use this item to read Frequently Asked Questions
about &app; in the browser. </para></listitem>
</varlistentry>
<varlistentry><term>GRAMPS home page</term>
<listitem><para> Select this item to open home page of &app; in your
default web browser. </para></listitem>
</varlistentry>
<varlistentry><term>GRAMPS mailing lists</term>
<listitem><para> Choose this item to direct your web browser
to the &app; mailing list archives. </para></listitem>
</varlistentry>
<varlistentry><term>Report a bug</term>
<listitem><para> Use this item to file a bug report against &app;
with the bug tracking system. </para></listitem>
</varlistentry>
<varlistentry><term>Show plugin status</term>
<listitem><para> Use this item to display the status of loaded
plugins. </para></listitem>
</varlistentry>
<varlistentry><term>Open example database</term>
<listitem><para> Select this item to load the example database shipped
with &app;. This database is composed of fictitious people and serves as
a useful example for learning how to work with &app;. </para></listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1> <!-- ================ End Getting Started ======================== -->

View File

@ -0,0 +1,18 @@
<?xml version="1.0" encoding="UTF-8"?>
<omf>
<resource>
<creator>Alex Roitman shura@alex.neuro.umn.edu</creator>
<title>GRAMPS Manual</title>
<date>2003-12-01</date>
<version identifier="2.4" date="2003-12-01" description="GNOME2 Compliant GRAMPS Manual"/>
<subject category="GNOME|Applications"/>
<description>User Manual for GRAMPS.</description>
<type>User Manual</type>
<format mime="text/xml" dtd="-//OASIS//DTD DocBook XML V4.1.2//EN"/>
<identifier url=""/>
<language code="C"/>
<relation seriesid="aa15a444-5ed9-11d7-8329-d7319c90009c"/>
<rights type="GNU FDL" license.version="1.1" license="http://www.gnu.org/licenses/fdl.html" holder="Alex Roitman"/>
</resource>
</omf>

View File

@ -0,0 +1,307 @@
<?xml version="1.0"?>
<!--
User Manual for Gramps - a GTK+/GNOME based genealogy program
Copyright (C) 2003 Alexander Roitman
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
License (GFDL), Version 1.1 or any later version published
by the Free Software Foundation with no Invariant Sections,
no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the file COPYING-DOCS
distributed with this manual.
-->
<!-- $Id$ -->
<!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 getstart SYSTEM "getstart.xml">
<!ENTITY mainwin SYSTEM "mainwin.xml">
<!ENTITY usage SYSTEM "usage.xml">
<!ENTITY custom SYSTEM "custom.xml">
<!ENTITY faq SYSTEM "faq.xml">
<!ENTITY keybind SYSTEM "keybind.xml">
<!ENTITY filtref SYSTEM "filtref.xml">
<!ENTITY cmdline SYSTEM "cmdline.xml">
<!ENTITY appversion "0.98.0">
<!ENTITY manrevision "2.4">
<!ENTITY date "December 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 time frame 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 Manual V2.3</revnumber>
<date>September 2003</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 Manual V2.2</revnumber>
<date>July 2003</date>
<revdescription>
<para role="author">Alex Roitman
<email>shura@alex.neuro.umn.edu</email></para>
<para role="author">Donald A. Peterson
<email>dpeterson@sigmaxi.org</email></para>
<para role="publisher">GRAMPS Project</para>
</revdescription>
</revision>
<revision>
<revnumber>GRAMPS Manual V2.1</revnumber>
<date>May 2003</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 Manual V2.0</revnumber>
<date>April 2003</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> &app; 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, &app; offers some unique features. </para>
<sect2 id="why-gramps">
<title>Why &app;?</title>
<para> &app; 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> &app;, 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 &app; 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, it
is 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 ================================ -->
&getstart; <!-- Getting Started -->
&mainwin; <!-- Main window -->
&usage; <!-- Usage -->
&custom; <!-- 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, use the help menu in &app;, or 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> <!-- ============= End About ============================= -->
<!-- ============= Appendices ================================== -->
<sect1 id="appendices">
<title>Appendices</title>
&faq; <!-- FAQ -->
&keybind; <!-- Keybindings reference -->
&filtref; <!-- Filter rule reference -->
&cmdline; <!-- Command line reference -->
</sect1>
</article>

View File

@ -0,0 +1,264 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
User Manual for Gramps - a GTK+/GNOME based genealogy program
Copyright (C) 2003 Alexander Roitman
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
License (GFDL), Version 1.1 or any later version published
by the Free Software Foundation with no Invariant Sections,
no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the file COPYING-DOCS
distributed with this manual.
-->
<!-- $Id$ -->
<!-- =============== Appendices Subsection ================ -->
<sect2 id="append-keybind">
<title>Keybindings reference</title>
<para>This appendix contains the list of keybindings that are not
displayed in menus of &app;.
</para>
<!-- =============== Appendices Sub-subsection ================ -->
<sect3 id="keybind-people">
<title>People View</title>
<para>The following bindings are available in the People View:</para>
<informaltable frame="topbot">
<tgroup cols="2">
<colspec colname="col1"/>
<colspec colname="col2"/>
<thead>
<row valign="top">
<entry colname="col1" colsep="0" valign="top"><para>Key</para></entry>
<entry colname="col2" valign="top"><para>Function</para></entry>
</row>
</thead>
<tbody>
<row valign="top">
<entry><para><keycap>Enter</keycap></para></entry>
<entry><para>Invoke <guilabel>Edit Person</guilabel> dialog
with the selected person.</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect3>
<!-- =============== Appendices Sub-subsection ================ -->
<sect3 id="keybind-family">
<title>Family View</title>
<para>The bindings available in the Family View depend on where the
focus is. The following tables list the bindings for all focus
targets.</para>
<variablelist>
<varlistentry><term>Focus on the Active Person</term>
<listitem>
<informaltable frame="topbot">
<tgroup cols="2">
<colspec colname="col1"/>
<colspec colname="col2"/>
<thead>
<row valign="top">
<entry colname="col1" colsep="0" valign="top"><para>Key</para></entry>
<entry colname="col2" valign="top"><para>Function</para></entry>
</row>
</thead>
<tbody>
<row valign="top">
<entry><para><keycap>Enter</keycap></para></entry>
<entry><para>Invoke <guilabel>Edit Person</guilabel> dialog with
the active person.</para></entry>
</row>
<row valign="top">
<entry><para><keycap>Ctrl</keycap>+<keycap>Down</keycap>
or <keycap>Ctrl</keycap>+<keycap>Right</keycap></para></entry>
<entry><para>Swap the Active Person and the selected spouse.
Use <keycap>Ctrl</keycap>+<keycap>Down</keycap> in standard Family View and
<keycap>Ctrl</keycap>+<keycap>Right</keycap> in alternative Family
View.</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry><term>Focus on the Spouse box</term>
<listitem>
<informaltable frame="topbot">
<tgroup cols="2">
<colspec colname="col1"/>
<colspec colname="col2"/>
<thead>
<row valign="top">
<entry colname="col1" colsep="0" valign="top"><para>Key</para></entry>
<entry colname="col2" valign="top"><para>Function</para></entry>
</row>
</thead>
<tbody>
<row valign="top">
<entry><para><keycap>Enter</keycap></para></entry>
<entry><para>Edit relationship between the Active Person and
the selected spouse.</para></entry>
</row>
<row valign="top">
<entry><para><keycap>Shift</keycap>+<keycap>Enter</keycap></para></entry>
<entry><para>Edit the personal information for the selected
spouse.</para></entry>
</row>
<row valign="top">
<entry><para><keycap>Insert</keycap></para></entry>
<entry><para>Add a person from the database to the spouse
list.</para></entry>
</row>
<row valign="top">
<entry><para><keycap>Shift</keycap>+<keycap>Insert</keycap></para></entry>
<entry><para>Add a new person to the database and to the spouse
list.</para></entry>
</row>
<row valign="top">
<entry><para><keycap>Delete</keycap></para></entry>
<entry><para>Delete the selected spouse from the spouse
list. The spouse is not deleted from the database.</para></entry>
</row>
<row valign="top">
<entry><para><keycap>Ctrl</keycap>+<keycap>Up</keycap>
or <keycap>Ctrl</keycap>+<keycap>Left</keycap></para></entry>
<entry><para>Swap the selected spouse and the Active Person.
Use <keycap>Ctrl</keycap>+<keycap>Down</keycap> in standard Family View and
<keycap>Ctrl</keycap>+<keycap>Right</keycap> in alternative Family
View.</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry><term>Focus on the Parents box</term>
<listitem>
<informaltable frame="topbot">
<tgroup cols="2">
<colspec colname="col1"/>
<colspec colname="col2"/>
<thead>
<row valign="top">
<entry colname="col1" colsep="0" valign="top"><para>Key</para></entry>
<entry colname="col2" valign="top"><para>Function</para></entry>
</row>
</thead>
<tbody>
<row valign="top">
<entry><para><keycap>Enter</keycap></para></entry>
<entry><para>Edit relationship between the parents and their
child (either the Active Person or the selected spouse, depending
which parents box the focus is in).</para></entry>
</row>
<row valign="top">
<entry><para><keycap>Insert</keycap></para></entry>
<entry><para>Add a new set of parents from the database to the
list.</para></entry>
</row>
<row valign="top">
<entry><para><keycap>Shift</keycap>+<keycap>Insert</keycap></para></entry>
<entry><para>Add a new set of parents to the database and to the
list.</para></entry>
</row>
<row valign="top">
<entry><para><keycap>Delete</keycap></para></entry>
<entry><para>Delete the selected parents from the list.
The parents are not deleted from the database.</para></entry>
</row>
<row valign="top">
<entry><para><keycap>Ctrl</keycap>+<keycap>Right</keycap>
or <keycap>Ctrl</keycap>+<keycap>Down</keycap></para></entry>
<entry><para>Make the selected parents the active family.
Use <keycap>Ctrl</keycap>+<keycap>Right</keycap> in standard Family View and
<keycap>Ctrl</keycap>+<keycap>Down</keycap> in alternative Family
View.</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry><term>Focus on the Children box</term>
<listitem>
<informaltable frame="topbot">
<tgroup cols="2">
<colspec colname="col1"/>
<colspec colname="col2"/>
<thead>
<row valign="top">
<entry colname="col1" colsep="0" valign="top"><para>Key</para></entry>
<entry colname="col2" valign="top"><para>Function</para></entry>
</row>
</thead>
<tbody>
<row valign="top">
<entry><para><keycap>Enter</keycap></para></entry>
<entry><para>Edit relationship between the child and his/her
parents (the Active Person and the selected
spouse).</para></entry>
</row>
<row valign="top">
<entry><para><keycap>Shift</keycap>+<keycap>Enter</keycap></para></entry>
<entry><para>Edit the personal information for the selected
child.</para></entry>
</row>
<row valign="top">
<entry><para><keycap>Insert</keycap></para></entry>
<entry><para>Add a new person from the database to the children
list.</para></entry>
</row>
<row valign="top">
<entry><para><keycap>Shift</keycap>+<keycap>Insert</keycap></para></entry>
<entry><para>Add a new person to the database and to the children
list.</para></entry>
</row>
<row valign="top">
<entry><para><keycap>Delete</keycap></para></entry>
<entry><para>Delete the selected child from the list.
The child is not deleted from the database.</para></entry>
</row>
<row valign="top">
<entry><para><keycap>Ctrl</keycap>+<keycap>Left</keycap>
or <keycap>Ctrl</keycap>+<keycap>Up</keycap></para></entry>
<entry><para>Make the selected child the Active Person.
Use <keycap>Ctrl</keycap>+<keycap>Left</keycap> in standard Family View and
<keycap>Ctrl</keycap>+<keycap>Up</keycap> in alternative Family
View.</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>

View File

@ -0,0 +1,76 @@
<legalnotice id="legalnotice">
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
License (GFDL), Version 1.1 or any later version published
by the Free Software Foundation with no Invariant Sections,
no Front-Cover Texts, and no Back-Cover Texts. You can find
a copy of the GFDL at this <ulink type="help"
url="ghelp:fdl">link</ulink> or in the file COPYING-DOCS
distributed with this manual.
</para>
<para> This manual is part of a collection of GNOME manuals
distributed under the GFDL. If you want to distribute this
manual separately from the collection, you can do so by
adding a copy of the license to the manual, as described in
section 6 of the license.
</para>
<para>
Many of the names used by companies to distinguish their
products and services are claimed as trademarks. Where those
names appear in any GNOME documentation, and the members of
the GNOME Documentation Project are made aware of those
trademarks, then the names are in capital letters or initial
capital letters.
</para>
<para>
DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED
UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE
WITH THE FURTHER UNDERSTANDING THAT:
<orderedlist>
<listitem>
<para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS,
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES
THAT THE DOCUMENT OR MODIFIED VERSION OF THE
DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR
A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE
RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE
OF THE DOCUMENT OR MODIFIED VERSION OF THE
DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR
MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT,
YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY
CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY
SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER
OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED
VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER
EXCEPT UNDER THIS DISCLAIMER; AND
</para>
</listitem>
<listitem>
<para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL
THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE),
CONTRACT, OR OTHERWISE, SHALL THE AUTHOR,
INITIAL WRITER, ANY CONTRIBUTOR, OR ANY
DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION
OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH
PARTIES, BE LIABLE TO ANY PERSON FOR ANY
DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES OF ANY CHARACTER
INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS
OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR
MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR
LOSSES ARISING OUT OF OR RELATING TO USE OF THE
DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT,
EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF
THE POSSIBILITY OF SUCH DAMAGES.
</para>
</listitem>
</orderedlist>
</para>
</legalnotice>

View File

@ -0,0 +1,473 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
User Manual for Gramps - a GTK+/GNOME based genealogy program
Copyright (C) 2003 Alexander Roitman
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
License (GFDL), Version 1.1 or any later version published
by the Free Software Foundation with no Invariant Sections,
no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the file COPYING-DOCS
distributed with this manual.
-->
<!-- $Id$ -->
<!-- ================ 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, progressbar, 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 is located at the very top of the window
(right below the window title) and provides access to all features of
&app; through its menus.</para></listitem>
</varlistentry>
<varlistentry><term>Toolbar</term>
<listitem><para> The toolbar is located immediately below the menubar.
The toolbar provides access to the most frequently used functions
of &app;. The appearance of the toolbar
can be adjusted in the <guilabel>Preferences</guilabel>
dialog. </para></listitem>
</varlistentry>
<varlistentry><term>Progressbar</term>
<listitem><para>The progressbar 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
progressbar, on the very bottom of the &app; window.
It displays information about current &app;
activity and contextual information about the menu items.
The behavior of the statusbar 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 &app;:
<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 its 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 &app; menu.</para>
</sect3>
<!-- ================ Main Window Sub-subsection -->
<sect3 id="people-view">
<title>People View</title>
<para>When &app; first opens a database,
the View is set to the People View (<xref linkend="side-nofilt-fig"/>
and <xref linkend="noside-nofilt-fig"/>). The People View lists
individuals whose data is stored in the database.</para>
<para> The individuals are arranged in a tree-like structure,
according to their family names. Every family name is a node of the
tree. Clicking the arrow on the left of the node will toggle its
expansion state. When expanded, the node's contents is listed in the
window. When collapsed, the contents is rolled up and not visible.
However, all the data is still intact, it is just not being displayed.
</para>
<para>The 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,
&app; 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 &app; 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 the pop-up <guilabel>Filter</guilabel> menu above the
people's list. Once the filter is chosen, click the
<guibutton>Apply</guibutton> button in the upper right corner of the
window. The filtering will take effect upon clicking the
<guibutton>Apply</guibutton> button. 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 the
<guibutton>Apply</guibutton> button. To cancel any filtering, set
the filter to <guilabel>All people</guilabel>
and then click the <guibutton>Apply</guibutton> button. </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>&app; offers another way of
managing long lists of people -- alphabetical tabs. Upon loading a
database, &app; 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 you to exchange the currently selected spouse (Current spouse)
with the Active person. Double-clicking on the Active person allows the
editing of Active person's data. Double-clicking on the Current spouse
allows you to edit their relationship information. Shift-clicking on
the Current spouse allows the editing of the Current spouse's data.</para>
<para> To add a new relationship use one of the two upper buttons to the
right of the spouse box. Click the top one to add a new person to a
database and to the new relationship. Click the middle one to add a
person already existing in the database to the new relationship.
To remove Current spouse, click the lowest button
(<guibutton>-</guibutton>) to the
right of the spouse box. Note that removing a spouse from the
relationship does not remove the person from the database. Most of these
functions are also available by right-clicking into the spouse box and
selecting an appropriate items from the context menu. </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 you to add and remove parents of the Active person and the
Current spouse, respectively. Clicking the right arrow button
makes the family in the corresponding list box an active family.
That is, it makes the selected Father the Active person, and the
selected Mother the Current spouse. Most of these
functions are also available by right-clicking into the parent box and
selecting an appropriate items from the context menu. </para>
<para>The bottom list box displays children of the Active person and
the Current Spouse. The Children's list can be ordered by the Birth date
in the 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 a
<guilabel>Status</guilabel> column. The pair of status words reflect the
relationship between the child and his Father/Mother (such as Birth, Adoption,
etc.) Four buttons are available on the right side of the
children list box. The top (left arrow) button makes
the selected child the Active person. The next two buttons add a new
child to the family: the upper one adds a new person to the database
and to the family, the lower one just adds a person existing in the
database to the family. Finally, the lowest <guibutton>-</guibutton>
button removes the selected child from the family. Note that removing
a child from the family does not remove the person from the
database. Most of these functions are also available by right-clicking
into the children box and selecting an appropriate items from the
context menu.</para>
<para>The layout of the Family View can be switched from the
left-to-right arrangement (shown above) to the top-to-bottom
arrangement (shown below). This can be done in the
<guilabel>Display</guilabel> section of the
<guilabel>Preferences</guilabel> dialog. The top-to-bottom view
has the same functionality as the left-to-right view. </para>
<!-- ==== Figure: Family View ==== -->
<figure id="family-alt-fig">
<title>Alternative Family View</title>
<screenshot><mediaobject><imageobject><imagedata
fileref="figures/family-alt.png" format="PNG"/></imageobject>
<textobject>
<phrase>Shows Alternative Family View. </phrase>
</textobject></mediaobject></screenshot></figure>
<!-- ==== End of Figure ==== -->
</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>The Pedigree View helps to visualize the place of the Active
person in the tree of his/her ancestors. The Pedigree View shows four
generations, going back in time from the Active person
<guilabel>1</guilabel> to his/her parents <guilabel>2</guilabel>,
to grandparents <guilabel>3</guilabel>, to great-grandparents
<guilabel>4</guilabel>.
Each person is denoted by a 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 become highlighted 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 the newly selected Active
person. </para>
<!-- ==== Figure: Pedigree View ==== -->
<figure id="pedigree-child-cut-fig">
<title>Children Menu</title>
<screenshot><mediaobject><imageobject><imagedata
fileref="figures/pedigree-child-cut.png" format="PNG"/></imageobject>
<textobject>
<phrase>Shows Children Menu in Pedigree View. </phrase>
</textobject></mediaobject></screenshot></figure>
<!-- ==== End of Figure ==== -->
<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. The appearance of the children's names
in the menu serves to differentiate the "dead ends" of the tree from
the continuing branches as follows. The children who have children
appear in the menu in the boldface and italic typeset, while the
children without children ("dead ends") appear in a regular
font. If the Active person has a single child, no menu will be
displayed (since there is no choice) and the child will become
the Active person upon clicking the arrow button. </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 the 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 the 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>The 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 a 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. Any column 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>The Places View lists the geographical places in which the events
of the database took place. These could be places of birth, death,
and marriages of people, as well as their home, employment, education
addresses, or any other conceivable reference to the geographical
location. The Places View lists the 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 columns 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>The 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
a preview (if available) and information about the Media
Object. </para>
</sect3>
</sect2>
</sect1> <!-- ================ End Main Window ===================== -->

File diff suppressed because it is too large Load Diff