Cyclone-Team/gramps
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge changes made in gramps20 into HEAD

Browse Source 
svn: r4549
This commit is contained in:
Alex Roitman
2005-05-11 14:04:47 +00:00
parent 90a4d68cef
commit 2a77676b36
111 changed files with 42212 additions and 31765 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
doc/gramps-manual/C/authors.xml
View File

@@ -29,52 +29,56 @@
<para>
The somewhat incomplete list of contributors includes (in alphabetical order):
<itemizedlist>
<listitem><para>Alexandre Duret-Lutz</para></listitem>
<listitem><para>Alexander Bogdashevsky</para></listitem>
<listitem><para>Alexander Roitman</para></listitem>
<listitem><para>Arkadiusz Lipiec</para></listitem>
<listitem><para>Bernd Felsche</para></listitem>
<listitem><para>David R. Hampton</para></listitem>
<listitem><para>Bernd Schandl</para></listitem>
<listitem><para>Billy C. Earney</para></listitem>
<listitem><para>Bruce J. DeGrasse</para></listitem>
<listitem><para>Donald A. Peterson</para></listitem>
<listitem><para>Douglas S. Blank</para></listitem>
<listitem><para>Eero Tamminen</para></listitem>
<listitem><para>Egyeki Gergely</para></listitem>
<listitem><para>Frederick Noronha</para></listitem>
<listitem><para>Frode Jemtland</para></listitem>
<listitem><para>Gary Shao</para></listitem>
<listitem><para>Greg Kuperberg</para></listitem>
<listitem><para>Guillaume Pratte</para></listitem>
<listitem><para>James Treacy</para></listitem>
<listitem><para>Jason Salaz</para></listitem>
<listitem><para>Jeffrey C. Ollie</para></listitem>
<listitem><para>Larry Allingham</para></listitem>
<listitem><para>Jens Arvidsson</para></listitem>
<listitem><para>Jesper Zedlitz</para></listitem>
<listitem><para>Jim Smart</para></listitem>
<listitem><para>Julio Sanchez</para></listitem>
<listitem><para>Lars Kr. Lundin</para></listitem>
<listitem><para>Laurent Protois</para></listitem>
<listitem><para>Leonid Mamtchenkov</para></listitem>
<listitem><para>Lorenzo Cappelletti</para></listitem>
<listitem><para>Marcos Bedinelli</para></listitem>
<listitem><para>Martin Hawlisch</para></listitem>
<listitem><para>Martin Senftleben</para></listitem>
<listitem><para>Matthieu Pupat</para></listitem>
<listitem><para>Michel Guitel</para></listitem>
<listitem><para>Nathan Bullock</para></listitem>
<listitem><para>Pier Luigi Cinquantini</para></listitem>
<listitem><para>Radek Malcic</para></listitem>
<listitem><para>Douglas S. Blank</para></listitem>
<listitem><para>Radu Bogdan Mare</para></listitem>
<listitem><para>Alexander Bogdashevsky</para></listitem>
<listitem><para>Richard Bos</para></listitem>
<listitem><para>Samuel Tardieu</para></listitem>
<listitem><para>Sebastian Voecking</para></listitem>
<listitem><para>Nathan Bullock</para></listitem>
<listitem><para>Lorenzo Cappelletti</para></listitem>
<listitem><para>Pier Luigi Cinquantini</para></listitem>
<listitem><para>Bruce J. DeGrasse</para></listitem>
<listitem><para>Alexandre Duret-Lutz</para></listitem>
<listitem><para>Billy C. Earney</para></listitem>
<listitem><para>Baruch Even</para></listitem>
<listitem><para>Bernd Felsche</para></listitem>
<listitem><para>Egyeki Gergely</para></listitem>
<listitem><para>Michel Guitel</para></listitem>
<listitem><para>Steve Hall</para></listitem>
<listitem><para>Steve Swales</para></listitem>
<listitem><para>Tim Waugh</para></listitem>
<listitem><para>David R. Hampton</para></listitem>
<listitem><para>Martin Hawlisch</para></listitem>
<listitem><para>Frode Jemtland</para></listitem>
<listitem><para>Greg Kuperberg</para></listitem>
<listitem><para>Arkadiusz Lipiec</para></listitem>
<listitem><para>Lars Kr. Lundin</para></listitem>
<listitem><para>Radek Malcic</para></listitem>
<listitem><para>Leonid Mamtchenkov</para></listitem>
<listitem><para>Tino Meinen</para></listitem>
<listitem><para>Frederick Noronha</para></listitem>
<listitem><para>Jeffrey C. Ollie</para></listitem>
<listitem><para>Donald A. Peterson</para></listitem>
<listitem><para>Guillaume Pratte</para></listitem>
<listitem><para>Laurent Protois</para></listitem>
<listitem><para>Matthieu Pupat</para></listitem>
<listitem><para>Alexander Roitman</para></listitem>
<listitem><para>Jason Salaz</para></listitem>
<listitem><para>Julio Sanchez</para></listitem>
<listitem><para>Bernd Schandl</para></listitem>
<listitem><para>Martin Senftleben</para></listitem>
<listitem><para>Gary Shao</para></listitem>
<listitem><para>Jim Smart</para></listitem>
<listitem><para>Steve Swales</para></listitem>
<listitem><para>Eero Tamminen</para></listitem>
<listitem><para>Samuel Tardieu</para></listitem>
<listitem><para>Richard Taylor</para></listitem>
<listitem><para>James Treacy</para></listitem>
<listitem><para>Sebastian Voecking</para></listitem>
<listitem><para>Xing Wang</para></listitem>
<listitem><para>Tim Waugh</para></listitem>
<listitem><para>Jesper Zedlitz</para></listitem>
</itemizedlist>
If you know of somebody else who should be listed here, please let us know.
</para>

14
doc/gramps-manual/C/bugs.xml
View File

@@ -24,4 +24,18 @@
<title>Known Bugs and Limitations</title>
<para>The bugs are tracked through the
<ulink url="http://sourceforge.net/tracker/?group_id=25770&amp;atid=385137" type="http">
sourceforge.net tracking system</ulink>.
</para>
<para>The known limitations include the BSDDB performance issues related
to caching and the memory size. As long as the BSDDB cache fits completely
into the available memory on the system, the performance should be
adequate. When the cache size exceeds that of the free memory and
portions of database cache start to be swapped onto the disk, the performance
degrades appreciably. This can be solved by adjusting the BSDDB cache
size for the large databases.
</para>
</appendix >

492
doc/gramps-manual/C/cmdline.xml
View File

@@ -27,7 +27,7 @@
<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
<note><para>&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
@@ -35,49 +35,62 @@
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></note>
<para>To summarize, the use of the command line options provides
<tip><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>
</para></tip>
<sect1 id="cmdline-options">
<title>Available options</title>
<para>Here is the list of the command line options in &app;:
<para>This section provides the reference list of all command line
options available in &app;. If you want to know more than just
a list of options, see next sections: <xref linkend="cmdline-operation"/>
and <xref linkend="cmdline-examples"/>.
</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:
<sect2 id="cmdline-opt-format"><title>Format options</title>
<para> The format of any file destined for opening, importing,
or exporting can be specified with the
<command>-f <replaceable>format</replaceable></command>
option. The acceptable <replaceable>format</replaceable> values
are listed below.</para>
<variablelist>
<varlistentry><term>gramps</term>
<varlistentry><term>grdb</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.
for opening, import, and export. When not specified, it can be
guessed if the filename ends with .grdb
</para></listitem></varlistentry>
<varlistentry><term>gramps-xml</term>
<listitem><para> &app; XML database. This format is available
for opening, 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
for opening, 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
for import and export. When not specified, it can be
guessed if the filename ends with .tgz
</para></listitem></varlistentry>
<varlistentry><term>geneweb</term>
<listitem><para> GeneWen file This format is available
for import and export. When not specified, it can be
guessed if the filename ends with gw
</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
@@ -91,79 +104,228 @@
</variablelist>
</para></listitem>
</varlistentry>
</sect2>
<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>.
<sect2 id="cmdline-opt-open"><title>Opening options</title>
<para>There are two ways to give &app; the name of the file to
be opened: </para>
<itemizedlist>
<listitem><para>supply bare file name</para></listitem>
<listitem><para>use the
<command>-O <filename>filename</filename></command> or
<command>-open=<filename>filename</filename></command> option
</para></listitem>
</itemizedlist>
<para>If the filename is given without any option flag, the attempt
to open the file will be made, and then the interactive &app; session
will be launched.
</para>
<tip><para>If no option is given, just the file name, &app; will
ignore the rest of the command line arguments. Use the -O flag
to open the file and do something with the data.
</para></tip>
<para>The format can be specified with the
<command>-f <replaceable>format</replaceable></command> or
<command>--format=<replaceable>format</replaceable></command>
option, immediately following the <filename>filename</filename>.
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
the <filename>filename</filename>. For gramps-xml
format, the <filename>filename</filename> 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
grdb and gedcom,
the <filename>filename</filename> is the name of the
corresponding file.
</para>
<tip><para>Only grdb, gramps-xml,
and gedcom formats can be opened directly.
For other formats, you will need to use the import option
which will set up the empty database and then import data into it.
</para></tip>
<tip><para>Only a single file can be opened. If you need to combine
data from several sources, you will need to use
the import option.</para></tip>
</sect2>
<sect2 id="cmdline-opt-import"><title>Import options</title>
<para> The files destined for import can be specified with the
<command>-i <filename>filename</filename></command>
or <command>--import=<filename>filename</filename></command>
option. The format can be specified with the
<command>-f <replaceable>format</replaceable></command> or
<command>--format=<replaceable>format</replaceable></command>
option, immediately following the <filename>filename</filename>.
If not specified, the guess will be attempted based on
the <filename>filename</filename>. For gramps-xml
format, the <filename>filename</filename> is actually the
name of directory under which the gramps database resides. For
grdb, gedcom, gramps-pkg, and geneweb,
the <filename>filename</filename> is the name of the
corresponding file.
</para>
<tip><para>More than one file can be imported in one command.
If this is the case, &app; will incorporate the data from
the next file into the database available at the moment.
</para></tip>
<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>
specified order, i.e. <command>
-i <filename>file1</filename>
-i <filename>file2</filename>
</command> and <command>
-i <filename>file2</filename>
-i <filename>file1</filename>
</command>
might produce different gramps IDs in the resulting database.
</para></listitem>
</varlistentry>
</para></sect2>
<varlistentry><term>Export options</term>
<listitem><para> The files destined for export can be specified with
the
<command>-o</command> <replaceable>filename</replaceable>
<sect2 id="cmdline-opt-export"><title>Export options</title>
<para> The files destined for export can be specified with the
<command>-o <filename>filename</filename></command> or
<command>--output=<filename>filename</filename></command>
option. The format can be specified with the <command>-f</command>
option immediately following the <replaceable>filename</replaceable>.
option immediately following the <filename>filename</filename>.
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>
the <filename>filename</filename>. For gramps-xml
and iso formats, the <filename>filename</filename>
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>
into. For grdb, gedcom, wft, geneweb,
and gramps-pkg, the <filename>filename</filename>
is the name of the resulting file.
</para>
<tip><para>More than one file can be exported in one command.
If this is the case, &app; will attempt to write several files
using the data from the database available at the moment.
</para></tip>
<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>
</para></sect2>
<varlistentry><term>Action options</term>
<listitem><para> The action to perform on the imported data can be
<sect2 id="cmdline-opt-action"><title>Action options</title>
<para> The action to perform on the imported data can be
specified with the
<command>-a</command> <replaceable>action</replaceable>
<command>-a <replaceable>action</replaceable></command> or
<command>--action=<replaceable>action</replaceable></command>
option. This is done after all imports are successfully completed.
Currently available actions are <term>summary</term> (same as
</para>
<para>Currently available actions are:</para>
<variablelist>
<varlistentry><term>summary</term>
<listitem><para>This action is the same as
<menuchoice><guimenu>Reports</guimenu><guisubmenu>View</guisubmenu>
<guimenuitem>Summary</guimenuitem></menuchoice>)
and <term>check</term> (same as
<guimenuitem>Summary</guimenuitem></menuchoice>
</para></listitem></varlistentry>
<varlistentry><term>check</term>
<listitem><para>This action is the same as
<menuchoice><guimenu>Tools</guimenu>
<guisubmenu>Database Processing</guisubmenu>
<guimenuitem>Check and Repair</guimenuitem></menuchoice>).
<guimenuitem>Check and Repair</guimenuitem></menuchoice>.
</para> </listitem> </varlistentry>
<varlistentry><term>report</term>
<listitem><para>This action allows producing reports
from the command line. As reports generally have many options
of their own, this action should be followed by the report option
string. The string is given using the
<command>-p <replaceable>option_string</replaceable></command> or
<command>--options=<replaceable>option_string</replaceable></command>
option.
</para>
<tip><para>
The report option string should satisfy the following conditions:
</para>
<itemizedlist>
<listitem><para>It must not contain any spaces. If some arguments
need to include spaces, the string should be enclosed with
quotation marks.
</para></listitem>
<listitem><para>Option string must list pairs of option names
and values.
</para></listitem>
<listitem><para>Withing a pair, option name and value must be
separated by the equal sign.
</para></listitem>
<listitem><para>Different pairs must be separated by commas.
</para></listitem>
</itemizedlist>
</tip>
<para>Most of the report options are specific for every report.
However, there some common options.
</para>
<variablelist>
<varlistentry><term>name=report_name</term>
<listitem> <para>
This mandatory option determines which report will be
generated. If the supplied report_name does not correspond
to any available report, the error message will be printed
followed by the list of available reports.
</para>
</listitem> </varlistentry>
<varlistentry><term>show=all</term>
<listitem> <para>
This will produce the list of names for all options available for
a given report.
</para>
</listitem> </varlistentry>
<varlistentry><term>show=option_name</term>
<listitem> <para>
This will print the description of the functionality supplied
by the option_name, as well as what are the acceptable types
and values for this option.
</para>
</listitem> </varlistentry>
</variablelist>
<para>
Use the above options to find out everything about a given report.
</para>
<tip><para>
If an option is not supplied, the last used value will be used.
If this report has never been generated before, then the
value from last generated report will be used when applicable.
Otherwise, the default value will be used.
</para></tip>
</listitem> </varlistentry>
</variablelist>
<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>
</para></sect2>
</sect1>
@@ -171,83 +333,181 @@
<sect1 id="cmdline-operation">
<title>Operation</title>
<itemizedlist>
<listitem>
<para>If the first argument on the command line does not start
with dash (i.e. no flag), &app; will attempt to open the file
with the name given by the first argument and start interactive
session, ignoring the rest of the command line arguments.
</para></listitem>
<listitem>
<para>If the <command>-O</command> flag is given, then &app; will
try opening the
supplied file name and then work with that data, as instructed by
the further command line parameters.
</para>
<note><para>Only one file can be opened in a single invokation
of &app;. If you need to get data from multiple sources, use
the importing options by using <command>-i</command> flag.
</para></note>
</listitem>
<listitem>
<para>With or without the <command>-O</command> flag, there could
be multiple imports, exports, and actions specified further on
the command line by using <command>-i</command>,
<command>-o</command>, and <command>-a</command> flags.
</para></listitem>
<listitem>
<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
<note><para>But opening must always be first!</para></note>
</listitem>
<listitem>
<para>If no <command>-O</command> or <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>
database, since there is no data to process, anyway.
</para></listitem>
<listitem>
<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>
interactive session with the database resulted from opening
and all imports (if any). This database resides in the
<filename>import_db.grdb</filename> file under the
<filename>~/.gramps/import/</filename> directory.
</para></listitem>
<listitem>
<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>
of stdout and stderr to save messages and errors in files.
</para></listitem>
</itemizedlist>
</sect1>
<sect1 id="cmdline-examples">
<title>Examples</title>
<para>To import four databases (whose formats can be determined from
<variablelist>
<varlistentry>
<term>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>
type:</term>
<listitem>
<para><command>gramps
-i<filename>file1.ged</filename>
-i <filename>file2.tgz</filename>
-i <filename>~/db3</filename>
-i <filename>file4.wft</filename>
-a <filename>check</filename></command>
</para> </listitem></varlistentry>
<varlistentry>
<term>To explicitly specify the formats in the above example, append
filenames with appropriate <command>-f</command> options:</term>
<listitem>
<para><command>gramps
-i <filename>file1.ged</filename>
-f <replaceable>gedcom</replaceable>
-i <filename>file2.tgz</filename>
-f <replaceable>gramps-pkg</replaceable>
-i <filename>~/db3</filename>
-f <replaceable>gramps</replaceable>
-i <filename>file4.wft</filename>
-f <replaceable>wft</replaceable>
-a <replaceable>check</replaceable></command>
</para></listitem>
</varlistentry>
<varlistentry>
<term>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):</term>
<listitem>
<para><command>gramps
-i <filename>file1.ged</filename>
-i <filename>file2.tgz</filename>
-o <filename>~/new-package</filename>
-f <replaceable>gramps-pkg</replaceable></command>
</para></listitem>
</varlistentry>
<varlistentry>
<term>To save any error messages of the above example into files
<filename>outfile</filename> and
<filename>errfile</filename>, run:</term>
<listitem>
<para><command>gramps
-i <filename>file1.ged</filename>
-i <filename>file2.tgz</filename>
-o <filename>~/new-package</filename>
-f <replaceable>gramps-pkg</replaceable>
&gt;<filename>outfile</filename>
2&gt;<filename>errfile</filename> </command>
</para></listitem>
</varlistentry>
<varlistentry>
<term>To import three databases and start interactive gramps
session with the result:</term>
<listitem>
<para><command>gramps
-i <filename>file1.ged</filename>
-i <filename>file2.tgz</filename>
-i <filename>~/db3</filename>
</command>
</para> </listitem>
</varlistentry>
<varlistentry>
<term>To open a database and, based on that data, generate timeline
report in PDF format putting the output into the
<filename>my_timeline.pdf</filename> file:</term>
<listitem>
<para><command>gramps
-O <filename>file.grdb</filename>
-a <replaceable>report</replaceable>
-p <replaceable>name=timeline,off=pdf,of=my_timeline.pdf</replaceable>
</command>
</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>
<tip><para>Use the <replaceable>name=timeline,show=all</replaceable>
to find out about all available options for the timeline report. To
find out details of a particular option, use
<replaceable>show=option_name</replaceable>,
e.g. <replaceable>name=timeline,show=off</replaceable>
string.</para>
<para>To learn about available report names, use
<replaceable>name=show</replaceable> string.
</para>
</tip>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term>Finally, to start normal interactive session type:</term>
<listitem><para> <command>gramps </command></para></listitem>
</varlistentry>
</variablelist>
<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>
</sect1>
</appendix>

548
doc/gramps-manual/C/custom.xml
View File

@@ -1,4 +1,4 @@
<chapter id="gramps-prefs">
<chapter id="gramps-settings">
<!--
User Manual for Gramps - a GTK+/GNOME based genealogy program
@@ -23,379 +23,269 @@
<!-- $Id$ -->
<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>
<sect1 id="gramps-prefs">
<title>Preferences</title>
<para>Most of the settings in &app;, are configured in the
<guilabel>Preferences</guilabel> dialog. To invoke it, choose
<menuchoice><guimenu>Edit</guimenu>
<guimenuitem>Preferences...</guimenuitem></menuchoice>. </para>
<!-- ==== Figure: Type-ahead find ==== -->
<figure id="prefs-fig">
<title>Preferences dialog</title>
<screenshot><mediaobject><imageobject><imagedata
fileref="figures/prefs.png" format="PNG"/></imageobject>
<textobject>
<phrase>Shows Preferences dialog. </phrase>
</textobject></mediaobject></screenshot></figure>
<!-- ==== End of Figure ==== -->
<para>The pane on the left displays the tree of available option
categories. Selecting a tree node will display the corresponding
options in the right side of the dialog. </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 ================ -->
<sect1 id="gramps-prefs-usage">
<title>Usage</title>
<sect2 id="gramps-prefs-db">
<title>Database</title>
<para> This category contains preferences relevant to the
general usage of &app;. It has the following subcategories:</para>
<!-- =============== Customization Sub-subsection ================ -->
<sect2 id="prefs-usage-find">
<title>Find</title>
database itself. It has the following subcategories: </para>
<variablelist>
<varlistentry><term><guilabel>General</guilabel></term>
<listitem>
<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>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><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. </para>
<tip><para>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></tip>
<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>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<!-- =============== Customization Sub-subsection ================ -->
<sect2 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><term><guilabel>GRAMPS IDs</guilabel></term>
<listitem><para> Enter ID prefixes for various kinds of database
entries into the corresponding text entry fields.
</para>
<tip><para>The ID prefixes use formatting conventions common for
C, Python, and other programming languages. For example, the %04d
expands to an integer, prepended with zeros to have the total
width of founr digits. If you would like IDs to be 1, 2, 3, etc,
simply set the formatting parameter to %d.
</para></tip>
</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>
</sect2>
<!-- =============== Customization Sub-subsection ================ -->
<sect2 id="prefs-usage-res">
<title>Researcher Information</title>
<variablelist>
<varlistentry><term><guilabel>Researcher information</guilabel></term>
<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>
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect2>
<!-- =============== Customization Sub-subsection ================ -->
<sect2 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>
</sect2>
</sect1>
<!-- =============== Customization Subsection ================ -->
<sect1 id="gramps-prefs-display">
<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 ================ -->
<sect2 id="prefs-display-gen">
<title>General</title>
<variablelist>
<varlistentry><term><guilabel>General</guilabel></term>
<listitem>
<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>Display Tip of the
Day</guilabel></term>
<listitem><para> Check this box to have the <guilabel>Tip
of the Day</guilabel> dialog appear on every startup.
The tips are displayed randomly from the large collection
of information bits on &app;.
</para>
<tip><para>The <guilabel>Tip of the Day</guilabel> is likely
to be useful for new user of &app;.
</para></tip>
</listitem></varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry><term><guilabel>Dates</guilabel></term>
<listitem>
<para> Select the display format for the dates
from the available formats listed in this menu.
</para>
<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>
<tip><para>Available date display formats are language-specific.
Depending on whether or not there is a &app; date displayer
available for your language, you may or may not have a lot of
choices.
</para></tip>
</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>Toolbar and Statusbar</guilabel></term>
<listitem>
<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>
<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>Show index numbers in child list</guilabel></term>
<listitem><para>
This option is not currently implemented.
</para></listitem>
<varlistentry><term><guilabel>Statusbar</guilabel></term>
<listitem><para> Select the desired contents displayed in the
statusbar using the radio buttons.
</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<!-- =============== Customization Sub-subsection ================ -->
<sect2 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>
</sect2>
<!-- =============== Customization Sub-subsection ================ -->
<sect2 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>
</sect2>
</sect2>
</sect1>
<!-- =============== Customization Subsection ================ -->
<sect1 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 ================ -->
<sect2 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>
</sect2>
<!-- =============== Customization Sub-subsection ================ -->
<sect2 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.
<sect1 id="gramps-prefs-other">
<title>Other settings</title>
<para>Besides <guilabel>Preferences</guilabel> dialog, there are
other settings available in &app;. For various reasons they have been
made more readily accessible, as listed below.</para>
<variablelist>
<varlistentry>
<term>Column Editor</term>
<listitem>
<para>The columns of the list views may be added, removed, or reordered
in a <guilabel>Column Editor Dialog</guilabel>,
see <xref linkend="column-editor-fig"/>. Only checked columns will
be shown in the view. To change their order, drag any column to its desired place inside
the editor. Clicking <guibutton>OK</guibutton> will reflect the changes
in the appropriate view. To invoke <guilabel>Column Editor Dialog</guilabel>,
choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Column
Editor...</guimenuitem></menuchoice>.
</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>
<tip>
<para>The <guilabel>Column Editor</guilabel> is available
and works in the same way for all list views.
Specifically, it is available for People View, Family View (children list).
Sources View, Places View, and Media View.</para> </tip>
</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><term>Setting Home person</term>
<listitem><para>The Home person is the person who becomes active
when database opened, when <guibutton>Home</guibutton> button is clicked
or the <guimenuitem>Home</guimenuitem> menu item is selected from
either <guimenu>Go</guimenu> menu or the right-click context menu
anywhere.</para>
<para>To set Home person, make the desired person active and
then choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Set Home
person...</guimenuitem></menuchoice>.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<!-- =============== Customization Sub-subsection ================ -->
<sect2 id="prefs-db-id">
<title>GRAMPS 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><term>Adjusting viewing controls</term>
<listitem>Whether the toolbar, the sidebar, or the filter (People View
only) are displayed in the main window is adjusted through
the <guimenu>View</guimenu> menu.
</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>
</sect2>
<!-- =============== Customization Sub-subsection ================ -->
<sect2 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>
</sect2>
</variablelist>
</sect1>
<sect1 id="gramps-prefs-adv">
<title>Advanced manipulation of settings</title>
<warning><para>The contents of this section is outside the scope
of interest of a general user of &app;. If you proceed with tweaking
the options on the low level you may damage your &app; installation.
Be careful. YOU HAVE BEEN WARNED!
</para></warning>
<para>By default, &app; stores its settings using gconf2 system.
All the settings used in this version of &app; are stored in
subdirectories under <filename>/apps/gramps/</filename> in the
gconf2 namespace. Accessing the keys can be done either using
<command>gconftool-2</command> command line tool, or the
<command>gconf-editor</command> GUI tool.
</para>
<para>All keys are documented, and the notification mechanisms
are used as appropriate. Therefore, updating keys from outside
of &app; should lead to updating &app; in real time, without
necessarily restarting it.</para>
</sect1>
</chapter>

93
doc/gramps-manual/C/faq.xml
View File

@@ -61,13 +61,15 @@ This, however, may change in the future.
<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
<ulink url="http://fink.sourceforge.net"
type="http">The Fink project</ulink> has ported
<ulink url="http://fink.sourceforge.net/pdb/package.php/gramps"
type="http">some older versions</ulink> of
&app; to OSX (tm). 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>
have access to Mac OSX and because OSX is not Free Software.</para>
<para>The GNOME 2 version of &app; (0.9.x) does not appear to have been
<para>This version of &app; (&appversion;) does not appear to have been
ported by the Fink project. Please contact the Fink project for more
information.
</para></listitem>
@@ -86,8 +88,8 @@ Yes, as long as the required GNOME libraries are installed.
<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.
This version of gramps requires GNOME 2.8.0 or higher.
Previous versions in 1.0.x series required GNOME 2.0.
</para></listitem>
</varlistentry>
@@ -137,7 +139,7 @@ their own plugins which could be new reports, charts, or research tools.
<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.
PostScript, PDF, SVG, OpenOffice, and GraphViz formats.
</para></listitem>
</varlistentry>
@@ -148,7 +150,7 @@ 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 :-)
there is little that a genealogical program can do with the Internet.
</para></listitem>
</varlistentry>
@@ -170,7 +172,7 @@ knowledge of programming in Python.
<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:
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.
@@ -181,43 +183,34 @@ Visual Genealogie.
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.
Starting with this release, &app; no longer loads all data into memory,
which allows it to work with much larger database than before.
In reality, however, there are practical limits. The main limiting factors
are the available memory on the system and the cache size used for BSDDB
database access. With common memory sizes these days, &app; should have
no problem using databases with tens of thousands of people.
</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
database has around 150,000 people. Again, this is dependent 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>
<listitem><para> It does not anymore! Just try out the current
version, &appversion;.
</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.
Starting with this release, &app; no longer loads all data into memory,
which allows it to work with much larger database than before.
</para></listitem>
</varlistentry>
@@ -229,34 +222,30 @@ in both speed and memory usage.
the flag needs to be reset. This can be done with the following
command: </para>
<para><command>gconftool-2 -u /apps/gramps/startup</command>
<para><command>gconftool-2 -u /apps/gramps/behavior/startup</command>
</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>
<listitem><para> This is a limitation of the builtin fonts of PS
and PDF formats. To print non-latin text, use the Print...
in the format selection menu of the report dialog. This will use
the gnome-print backend, which supports PS and PDF creation,
as well as direct printing.</para>
<para>If you only have latin text, the PDF option will produce
a smalled PDF compared to that created by gnome-print, simply because
no font information will be embedded.
</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.
<listitem><para> Now you can! Just try out the current
version, &appversion;.
</para></listitem>
</varlistentry>
@@ -374,13 +363,13 @@ 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
<tip><para>
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>
</para></tip></listitem>
</varlistentry>
</variablelist>

BIN
doc/gramps-manual/C/figures/cfe-ar.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 14 KiB

BIN
doc/gramps-manual/C/figures/cfe-df.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 16 KiB

BIN
doc/gramps-manual/C/figures/comp-people.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

BIN
doc/gramps-manual/C/figures/date-selection.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

BIN
doc/gramps-manual/C/figures/edit-ad.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 13 KiB

BIN
doc/gramps-manual/C/figures/edit-an.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 17 KiB

BIN
doc/gramps-manual/C/figures/edit-at.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 7.5 KiB

BIN
doc/gramps-manual/C/figures/edit-ev.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 11 KiB

BIN
doc/gramps-manual/C/figures/edit-media.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 14 KiB

BIN
doc/gramps-manual/C/figures/edit-person-addresses.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 12 KiB

BIN
doc/gramps-manual/C/figures/edit-person-attributes.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 8.9 KiB

BIN
doc/gramps-manual/C/figures/edit-person-events.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 12 KiB

BIN
doc/gramps-manual/C/figures/edit-person-gallery.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 22 KiB

BIN
doc/gramps-manual/C/figures/edit-person-internet.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 9.6 KiB

BIN
doc/gramps-manual/C/figures/edit-person-lds.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 14 KiB

BIN
doc/gramps-manual/C/figures/edit-person-names.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 9.9 KiB

BIN
doc/gramps-manual/C/figures/edit-person-notes.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 8.3 KiB

BIN
doc/gramps-manual/C/figures/edit-person-sources.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 6.5 KiB

BIN
doc/gramps-manual/C/figures/edit-person.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 24 KiB

BIN
doc/gramps-manual/C/figures/edit-plc.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 14 KiB

BIN
doc/gramps-manual/C/figures/edit-rel.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 13 KiB

BIN
doc/gramps-manual/C/figures/edit-si.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 17 KiB

BIN
doc/gramps-manual/C/figures/edit-src.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 12 KiB

BIN
doc/gramps-manual/C/figures/edit-wi.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 8.1 KiB

BIN
doc/gramps-manual/C/figures/find-people.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 26 KiB

BIN
doc/gramps-manual/C/figures/merge-people.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.0 KiB

BIN
doc/gramps-manual/C/figures/merge-plc.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 10 KiB

BIN
doc/gramps-manual/C/figures/merge-src.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

BIN
doc/gramps-manual/C/figures/prefs.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 10 KiB

BIN
doc/gramps-manual/C/figures/scratch-pad.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

115
doc/gramps-manual/C/filtref.xml
View File

@@ -25,7 +25,8 @@
<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.
filters, see <xref linkend="tools-util-cfe"/>. The rules are
listed by their categories.
</para>
<!-- =============== Appendices Sub-subsection ================ -->
@@ -43,6 +44,26 @@
</para></listitem>
</varlistentry>
<varlistentry><term>People with incomplete names</term>
<listitem><para> This rule matches all people with either
given name or family name missing.
</para></listitem>
</varlistentry>
<varlistentry><term>Is bookmarked person</term>
<listitem><para> This rule matches all people who are on the
bookmark list.
</para></listitem>
</varlistentry>
<varlistentry><term>Has text matching substring of</term>
<listitem><para> This rule matches all people whose records contain
specified substring. All textual records are searched. Optionally,
the search can be made case sensitive, or a regular expression
match.
</para></listitem>
</varlistentry>
<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.
@@ -50,6 +71,13 @@
</para></listitem>
</varlistentry>
<varlistentry><term>People probably alive</term>
<listitem><para> This rule matches all people whose records do
not indicate their death and who are not unreasonably old,
judging by their available birth data and today's date.
</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,
@@ -58,7 +86,7 @@
</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
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>
@@ -77,11 +105,33 @@
</para></listitem>
</varlistentry>
<varlistentry><term>Is default person</term>
<listitem><para> This rule matches the default (home) person.
</para></listitem>
</varlistentry>
<varlistentry><term>People marked private</term>
<listitem><para> This rule matches people whose records are marked
as private.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a female</term>
<listitem><para> This rule matches any female person.
</para></listitem>
</varlistentry>
<varlistentry><term>People who have images</term>
<listitem><para> This rule matches people with images in their
galleries.
</para></listitem>
</varlistentry>
<varlistentry><term>People without a birth date</term>
<listitem><para> This rule matches people missing birth date.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a male</term>
<listitem><para> This rule matches any male person.
</para></listitem>
@@ -107,7 +157,7 @@
using the value "sw" for the Place.
</para>
<para> The rule returns a match if and only if
<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>
@@ -122,12 +172,18 @@
will be matched by the rule using the value "sw" for the Place.
</para>
<para> The rule returns a match if and only if
<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 source of</term>
<listitem><para> This rule matches people whose records refer
to the specified source.
</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,
@@ -139,7 +195,7 @@
</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
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>
@@ -156,12 +212,30 @@
</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
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>Witness</term>
<listitem><para> This rule matches people who are present as
a witness in the event. If the personal or family event type is
specified, only the events of this type will be searched.
</para></listitem>
</varlistentry>
<varlistentry><term>People with incomplete events</term>
<listitem><para> This rule matches people missing date or place in
any personal event.
</para></listitem>
</varlistentry>
<varlistentry><term>Families with incomplete events</term>
<listitem><para> This rule matches people missing date or place in
any family event of any of their families.
</para></listitem>
</varlistentry>
</variablelist>
</sect1>
@@ -173,6 +247,26 @@
based on their family relationships:</para>
<variablelist>
<varlistentry><term>People with children</term>
<listitem><para> This rule matches people with children.
</para></listitem>
</varlistentry>
<varlistentry><term>People with multiple marriage records</term>
<listitem><para> This rule matches people with more than one spouse.
</para></listitem>
</varlistentry>
<varlistentry><term>People with no marriage records</term>
<listitem><para> This rule matches people with no spouses.
</para></listitem>
</varlistentry>
<varlistentry><term>People who were adopted</term>
<listitem><para> This rule matches adopted people.
</para></listitem>
</varlistentry>
<varlistentry><term>Has the relationships</term>
<listitem><para> This rule matches people with a particular
relationship. The relationship must match the type selected from
@@ -180,7 +274,7 @@
of children can be specified.
</para>
<para> The rule returns a match if and only if
<para> The rule returns a match if, and only if,
all non-empty values are (partially) matched by a person's
relationship. To use just one value, leave the other values empty.
</para></listitem>
@@ -207,6 +301,13 @@
</para></listitem>
</varlistentry>
<varlistentry><term>Is a sibling of filter match</term>
<listitem><para> This rule matches people whose sibling
is matched by the specified filter.
The specified filter name should be selected from the menu.
</para></listitem>
</varlistentry>
</variablelist>
</sect1>

11
doc/gramps-manual/C/getstart.xml
View File

@@ -25,8 +25,9 @@
<title>Getting Started</title>
<para>This chapter provides the most basic information on starting &app; and
obtaining help. Please procede to the following chapters for more information.</para>
<para>This chapter provides the most basic information on starting &app;
and obtaining help. Please procede to the following chapters for more
information.</para>
<!-- ================ Getting Started Subsection ====== -->
<sect1 id="gramps-start">
@@ -35,13 +36,15 @@
<variablelist>
<varlistentry>
<term><guimenu>Applications</guimenu> menu</term>
<listitem><para>Choose <menuchoice><guisubmenu>Other</guisubmenu>
<listitem><para>The method of starting &app; from the menus may vary from
distribution to distribution. On default GNOME desktop,
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>
<command>gramps</command>, then press <keycap>Enter</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

29
doc/gramps-manual/C/gramps-manual.xml
View File

@@ -34,9 +34,9 @@
<!ENTITY legal SYSTEM "legal.xml">
<!ENTITY appversion "1.2.0">
<!ENTITY appversion "2.0.0">
<!ENTITY manrevision "2.6">
<!ENTITY date "February 2005">
<!ENTITY date "May 2005">
<!ENTITY app "GRAMPS">
<!-- The rest of the entities is simply the chapters of the manual.. -->
@@ -93,7 +93,7 @@
<surname>Roitman</surname>
<affiliation>
<orgname>GRAMPS Project</orgname>
<address> <email>shura@alex.neuro.umn.edu</email> </address>
<address> <email>shura@gramps-project.org</email> </address>
</affiliation>
</author>
<author>
@@ -101,7 +101,7 @@
<surname>Allingham</surname>
<affiliation>
<orgname>GRAMPS Project</orgname>
<address> <email>dallingham@users.sourceforge.net</email> </address>
<address> <email>don@gramps-project.org</email> </address>
</affiliation>
</author>
@@ -139,7 +139,7 @@
<date>&date;</date>
<revdescription>
<para role="author">Alex Roitman
<email>shura@alex.neuro.umn.edu</email></para>
<email>shura@gramps-project.org</email></para>
<para role="publisher">GRAMPS Project</para>
</revdescription>
</revision>
@@ -148,7 +148,7 @@
<date>February 2004</date>
<revdescription>
<para role="author">Alex Roitman
<email>shura@alex.neuro.umn.edu</email></para>
<email>shura@gramps-project.org</email></para>
<para role="publisher">GRAMPS Project</para>
</revdescription>
</revision>
@@ -157,7 +157,7 @@
<date>December 2003</date>
<revdescription>
<para role="author">Alex Roitman
<email>shura@alex.neuro.umn.edu</email></para>
<email>shura@gramps-project.org</email></para>
<para role="publisher">GRAMPS Project</para>
</revdescription>
</revision>
@@ -166,7 +166,7 @@
<date>September 2003</date>
<revdescription>
<para role="author">Alex Roitman
<email>shura@alex.neuro.umn.edu</email></para>
<email>shura@gramps-project.org</email></para>
<para role="publisher">GRAMPS Project</para>
</revdescription>
</revision>
@@ -175,7 +175,7 @@
<date>July 2003</date>
<revdescription>
<para role="author">Alex Roitman
<email>shura@alex.neuro.umn.edu</email></para>
<email>shura@gramps-project.org</email></para>
<para role="author">Donald A. Peterson
<email>dpeterson@sigmaxi.org</email></para>
<para role="publisher">GRAMPS Project</para>
@@ -186,7 +186,7 @@
<date>May 2003</date>
<revdescription>
<para role="author">Alex Roitman
<email>shura@alex.neuro.umn.edu</email>
<email>shura@gramps-project.org</email>
</para>
<para role="publisher">GRAMPS Project</para>
</revdescription>
@@ -196,7 +196,7 @@
<date>April 2003</date>
<revdescription>
<para role="author">Alex Roitman
<email>shura@alex.neuro.umn.edu</email>
<email>shura@gramps-project.org</email>
</para>
<para role="publisher">GRAMPS Project</para>
</revdescription>
@@ -206,7 +206,7 @@
<date>2001</date>
<revdescription>
<para role="author">Donald N. Allingham
<email>dallingham@users.sourceforge.net</email>
<email>don@gramps-project.org</email>
</para>
<para role="publisher">GRAMPS Project</para>
</revdescription>
@@ -216,7 +216,7 @@
<date>2001</date>
<revdescription>
<para role="author">Donald N. Allingham
<email>dallingham@users.sourceforge.net</email>
<email>don@gramps-project.org</email>
</para>
<para role="publisher">GRAMPS Project</para>
</revdescription>
@@ -231,7 +231,8 @@
<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
on <ulink url="http://gramps.sourceforce.net/contact.html" type="http">this site.</ulink>
found on <ulink url="http://gramps-project.org/index.php?module=pagemaster&amp;PAGE_user_op=view_page&amp;PAGE_id=3"
type="http">this site</ulink>.
</para>
<!-- Translators may also add here feedback address for translations -->

18
doc/gramps-manual/C/keybind.xml
View File

@@ -23,13 +23,19 @@
<!-- $Id$ -->
<title>Keybindings reference</title>
<para>Most of the standard menu items define equivalent keybindings.
These are apparent because they are displayed on the right of
the menu item. However, some keybindings are not associated with
any items in the menu. </para>
<para>This appendix contains the list of keybindings that are not
displayed in menus of &app;.
</para>
<sect1 id="keybind-people">
<title>People View</title>
<para>The following bindings are available in the People View:</para>
<sect1 id="keybind-lists">
<title>List Views</title>
<para>The following bindings are available in all list views:
People View, Sources View, Places View, and Media View.</para>
<informaltable frame="topbot">
<tgroup cols="2">
@@ -140,8 +146,8 @@
<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
Use <keycap>Ctrl</keycap>+<keycap>Up</keycap> in standard Family View and
<keycap>Ctrl</keycap>+<keycap>Left</keycap> in alternative Family
View.</para></entry>
</row>
</tbody>
@@ -262,4 +268,4 @@
</sect1>
</appendix>
</appendix>

28
doc/gramps-manual/C/mainwin.xml
View File

@@ -123,7 +123,7 @@
<!-- ==== End of Figure ==== -->
</listitem></varlistentry>
<varlistentry><term>To switch the View while in a Notebook mode,
<varlistentry><term>To switch the View while in a Tabbed mode,
click on the desired notebook tab.</term>
<listitem>
<!-- ==== Figure: Tabbed Notebook Mode ==== -->
@@ -138,7 +138,7 @@
</listitem></varlistentry>
</variablelist>
<para>To switch between sidebar and notebook viewing modes,
<para>To switch between sidebar and tabbed viewing modes,
choose <menuchoice> <guimenu>View</guimenu>
<guimenuitem>Sidebar</guimenuitem>
</menuchoice> from the &app; menu.</para>
@@ -156,7 +156,7 @@
<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
expansion state. When expanded, the node's content 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>
@@ -179,7 +179,7 @@
see <xref linkend="column-editor-fig"/>. Only checked columns will be shown
in the view. To change their order, drag any column to its desired place inside
the editor. Clicking <guibutton>OK</guibutton> will reflect the changes
in the People View. To incoke <guilabel>Column Editor Dialog</guilabel>,
in the People View. To invoke <guilabel>Column Editor Dialog</guilabel>,
choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Column
Editor</guimenuitem></menuchoice>.
</para>
@@ -286,7 +286,7 @@
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
<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.
@@ -295,7 +295,7 @@
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>
selecting an appropriate item 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
@@ -308,7 +308,7 @@
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>
selecting an appropriate item 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
@@ -329,7 +329,7 @@
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
into the children box and selecting an appropriate item from the
context menu.</para>
<para>The layout of the Family View can be switched from the
@@ -378,7 +378,7 @@
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
placed over the family line, the line becomes 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
@@ -428,7 +428,7 @@
context menu. Among other useful items, the context menu has submenus
listing <guilabel>Spouses</guilabel>, <guilabel>Siblings</guilabel>,
<guilabel>Children</guilabel>, and <guilabel>Parents</guilabel>
of that person. Insensitive (greyed out) submenus indicate the absense
of that person. Insensitive (greyed out) submenus indicate the absence
of the data in the appropriate category. Similarly to the children menu above,
children's and parents' menus distinguish continuing lines from dead ends.
</para>
@@ -465,7 +465,7 @@
of the display area.
The set anchor person will stay in effect until either the anchor is
removed (by selecting the <guilabel>Remove anchor</guilabel> item from the
context menu) or until the active person chosen is unrelated to the anchor
context menu), or until the active person chosen is unrelated to the anchor
person. The latter move can be made using extensive navigation tools
available in &app;, see <xref linkend="gramps-nav"/> for the detailed
reference.
@@ -546,8 +546,10 @@
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. <guilabel>Column Editor Dialog</guilabel>
files, etc. The list box on the bottom lists the <guilabel>Name</guilabel>,
<guilabel>ID</guilabel>, <guilabel>Type</guilabel>, and
<guilabel>Path</guilabel> of the Media Object.
<guilabel>Column Editor Dialog</guilabel>
may be used to rearrange the displayed columns, which obey usual
sorting rules. The top part of the GRAMPS window shows
a preview (if available) and information about the Media

54
doc/gramps-manual/C/preface.xml
View File

@@ -67,10 +67,11 @@
<variablelist>
<varlistentry><term>Berkely database backend</term>
<listitem><para>The default format for &app; is now the BSDDB database. This change
allowed us to overcome performance issues and memory requirements of the 1.0.X branch.
With the database backend, the database sizes of several hunder thousand people do not
<varlistentry><term>Berkeley database backend</term>
<listitem><para>The default format for &app; is now the BSDDB database.
This change allowed us to overcome performance issues and memory
requirements of the 1.0.X branch. With the database backend, the database
sizes of up to a hundred thousand people do not
present a major obstacle any longer.</para>
<para>
@@ -161,14 +162,15 @@
<varlistentry><term>Internationalization</term>
<listitem><para>
The approach for entering and displaying dates has been completely re-worked. In
particular, the new framework allows for a deeper localization of displayed dates than
was ever possible using the translatable strings.</para>
The approach for entering and displaying dates has been completely
re-worked. In particular, the new framework allows for a deeper
localization of displayed dates than was ever possible using the
translatable strings.</para>
<para>The internationalization of names have also been improved. Names can be
grouped under a non-default string. Patronymic names are supported, and it is easy
to program new ways on displaying names, as may be required by other cultures
and languages.
<para>The internationalization of names have also been improved.
Names can be grouped under a non-default string. Patronymic names are
supported, and it is easy to program new ways on displaying names, as
may be required by various cultures and languages.
</para></listitem>
</varlistentry>
@@ -191,27 +193,27 @@
<title>Typographical conventions</title>
<para>
In this book, we some words are marked with special typography:
<simplelist>
<member><application>Applications</application></member>
<member><command>Commands</command> you type at the command
line</member>
<member><filename>Filenames</filename></member>
<member><replaceable>Replaceable text</replaceable></member>
<member><guilabel>Labels</guilabel> for buttons and other
portions of the graphical interface</member>
<itemizedlist>
<listitem><application>Applications</application></listitem>
<listitem><command>Commands</command> you type at the command
line</listitem>
<listitem><filename>Filenames</filename></listitem>
<listitem><replaceable>Replaceable text</replaceable></listitem>
<listitem><guilabel>Labels</guilabel> for buttons and other
portions of the graphical interface</listitem>
<member> Menu selections look like this:
<listitem> Menu selections look like this:
<menuchoice>
<guimenu>Menu</guimenu>
<guisubmenu>Submenu</guisubmenu>
<guimenuitem>Menu Item</guimenuitem>
</menuchoice>
</member>
<member><guibutton>Buttons</guibutton> you can
click</member>
<member><userinput>Anything you type
in</userinput></member>
</simplelist>
</listitem>
<listitem><guibutton>Buttons</guibutton> you can
click</listitem>
<listitem><userinput>Anything you type
in</userinput></listitem>
</itemizedlist>
</para>
<para>

1561
doc/gramps-manual/C/usage.xml
View File

File diff suppressed because it is too large Load Diff

2
doc/gramps-manual/Makefile.am
View File

@@ -1,3 +1,3 @@
# Process this file with automake to produce Makefile.in
SUBDIRS = C fr ru
SUBDIRS = C

144
doc/gramps.1.in
View File

@@ -1,4 +1,4 @@
.TH gramps 1 "@VERSION@" "June 2004" "@VERSION@"
.TH gramps 1 "@VERSION@" "May 2005" "@VERSION@"
.SH NAME
gramps \- Genealogical Research and Analysis Management Programming System.
@@ -7,6 +7,10 @@ gramps \- Genealogical Research and Analysis Management Programming System.
.RB [ \-?|\-\^\-help ]
.RB [ \-\^\-usage ]
.RB [ \-\^\-version ]
.RB [ \-O|\-\^\-open=
.IR FILE
.RB [ \-f|\-\^\-format=
.IR FORMAT ]]
.RB [ \-i|\-\^\-import=
.IR FILE
.RB [ \-f|\-\^\-format=
@@ -19,18 +23,19 @@ gramps \- Genealogical Research and Analysis Management Programming System.
.IR FORMAT ]]
.RB [ \-a|\-\^\-action=
.IR ACTION ]
.RB [ \-p|\-\^\-options=
.IR OPTIONSTRING ]]
.RB [
.IR FILE
.RB ]
.SH DESCRIPTION
.PP
\fIGramps\fP is an open source genealogy program. It is written in Python,
using the GTK/GNOME interface.
.br
\fIGramps\fP is a Free/OpenSource genealogy program. It is written in Python,
using the GTK+/GNOME interface.
Gramps should seem familiar to anyone who has used other geneology programs
before such as \fIFamily Tree Maker for Windows(TM)\fR or the GNU Geneweb.
.br
before such as \fIFamily Tree Maker (TM)\fR, \fIPersonal Ancestral
Files (TM)\fR, or the GNU Geneweb.
It supports importing of the ever popular GEDCOM format which is used world
wide by almost all other genealogy software.
@@ -41,32 +46,56 @@ When \fIFILE\fR is given (without any flags) then it is
opened and an interactive session is started. The rest of the options
is ignored. This way of launching is suitable for using gramps
as a handler for genealogical data in e.g. web browsers. This invokation
can accept any data format known to gramps, see below.
can accept any data format native to gramps, see below.
.br
.TP
.BI \-f,\-\^\-format= " FORMAT"
Explicitly specify format of \fIFILE\fR given by preceding \fB\-i\fR or
Explicitly specify format of \fIFILE\fR given by preceding \fB\-O\fR,
\fB\-i\fR, or
\fB\-o\fR option. If the \fB\-f\fR option is not given for any \fIFILE\fR,
the format of that file is guessed according to its extension.
.br
Formats
available for import are \fBgramps\-xml\fR (guessed if \fIFILE\fR is a
directory), \fBgedcom\fR (guessed if \fIFILE\fR ends with \fB.ged\fR), and
\fBgramps\-pkg\fR (guessed if \fIFILE\fR ends with \fB.gpkg\fR).
available for opening are \fBgrdb\fR (guessed if \fIFILE\fR ends with
\fB.grdb\fR), \fBgramps\-xml\fR (guessed if \fIFILE\fR is a
directory), and \fBgedcom\fR (guessed if \fIFILE\fR ends with \fB.ged\fR).
.br
Formats available for export are \fBgramps\-xml\fR, \fBgedcom\fR, \fBgramps\-pkg\fR,
\fBwft\fR (guessed if \fIFILE\fR ends with \fB.wft\fR), and \fBiso\fR
(never guessed, always specify with \fB\-f\fR option).
Formats
available for import are \fBgrdb\fR, \fBgramps\-xml\fR, \fBgedcom\fR,
\fBgramps\-pkg\fR (guessed if \fIFILE\fR ends with \fB.gpkg\fR), and
\fBgeneweb\fR (guessed if \fIFILE\fR ends with \fB.gw\fR).
.br
Formats available for export are \fBgrdb\fR, \fBgramps\-xml\fR, \fBgedcom\fR,
\fBgramps\-pkg\fR, \fBwft\fR (guessed if \fIFILE\fR ends with \fB.wft\fR),
\fBgeneweb\fR, and \fBiso\fR (never guessed, always specify with
\fB\-f\fR option).
.TP
.BI \-O,\-\^\-open= " FILE"
Open \fIFILE\fR.
Only \fBgrdb\fR, \fBgramps\-xml\fR, and \fBgedcom\fR formats can be
opened directly. For other formats, you will need to use the import option
which will set up the empty database and then import data into it.
For \fBgramps\-xml\fR format, the \fIFILE\fR
is actually the name of directory under which the gramps database resides.
For \fBgrdb\fR and \fBgedcom\fR, the \fIFILE\fR is the name of
the corresponding file.
.br
Only a single file can be opened. If you need to combine data from several
sources, you will need to use the import option.
.TP
.BI \-i,\-\^\-import= " FILE"
Import data from \fIFILE\fR. For \fBgramps\-xml\fR format, the \fIFILE\fR
is actually the name of directory under which the gramps database resides.
For \fBgedcom\fR and \fBgramps\-pkg\fR, the \fIFILE\fR is the name of
the corresponding file.
For \fBgrdb\fR, \fBgedcom\fR, \fBgramps\-pkg\fR, and \fBgeneweb\fR,
the \fIFILE\fR is
the name of the corresponding file.
.br
When more than one input file is given, each has to be preceded by \fB\-i\fR
@@ -79,8 +108,8 @@ gramps IDs in the resulting database.
.BI \-o,\-\^\-output= " FILE"
Export data into \fIFILE\fR. For \fBgramps\-xml\fR and \fBiso\fR formats, the
\fIFILE\fR is actually the name of directory the gramps database will be
written into. For \fBgedcom\fR, \fBwft\fR, and \fBgramps\-pkg\fR,
the \fIFILE\fR is the name of the resulting file.
written into. For \fBgrdb\fR, \fBgedcom\fR, \fBwft\fR, \fBgramps\-pkg\fR,
and \fBgeneweb\fR, the \fIFILE\fR is the name of the resulting file.
.br
When more than one output file is given, each has to be preceded
@@ -90,27 +119,82 @@ by \fB\-o\fR flag. The files are written one by one, in the specified order.
.BI \-a,\-\^\-action= " ACTION"
Perform \fIACTION\fR on the imported data. This is done after all imports
are succesfully completed. Currently available actions are \fBsummary\fR
(same as Reports->View->Summary) and \fBcheck\fR (same as Tools->Database
Processing->Check and Repair).
(same as Reports->View->Summary), \fBcheck\fR (same as Tools->Database
Processing->Check and Repair), and \fBreport\fR (generates report, needs
the \fIOPTIONSTRING\fR supplied by the \fB\-p\fR flag).
.br
The report option string should satisfy the following conditions:
.br
It must not contain any spaces.
If some arguments need to include spaces, the string should
be enclosed with quotation marks.
Option string must list pairs of option names and values.
Withing a pair, option name and value must be separated by the equality sign.
Different pairs must be separated by commas.
.br
Most of the report options are specific for every report. However, there some
common options.
.BI "name=reportname"
.br
This mandatory option determines which report
will be generated. If the supplied report_name does not correspond to any
available report, the error message will be printed followed by the list of
available reports.
.BI "show=all"
.br
This will produce the list of names for all options
available for a given report.
.BI "show=optionname"
.br
This will print the description of
the functionality supplied by the optionname, as well as what are the
acceptable types and values for this option.
.br
Use the above options to find out
everything about a given report.
.LP
When more than one output action is given, each has to be preceded
by \fB\-a\fR flag. The actions are performed one by one, in the specified order.
.BI "Operation"
.br
If the first argument on the command line does not start with dash (i.e. no
flag), gramps will attempt to open the file with the name given by the first
argument and start interactive session, ignoring the rest of the command line
arguments.
.LP
If the \fB\-O\fR flag is given, then gramps will try opening
the supplied file name and then work with that data, as instructed by the
further command line parameters.
.LP
With or without the \fB\-O\fR flag, there could be multiple imports,
exports, and actions specified further on the command line by using \fB\-i\fR,
\fB\-o\fR, and \fB\-a\fR flags.
.LP
The order of \fB\-i\fR, \fB\-o\fR, or \fB\-a\fR options does not matter. The
actual order always is: all imports (if any) -> all exports (if any) ->
all actions (if any).
all actions (if any). But opening must always be first!
.LP
If no \fB\-i\fR 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).
If no \fB\-O\fR or \fB\-i\fR 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.
.LP
If no \fB\-o\fR or \fB\-a\fR 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 \fB~/.gramps/import\fR directory.
from all imports. This database resides in the \fBimport_db.grdb\fR
under \fB~/.gramps/import\fR directory.
.LP
The error encountered during import, export, or action, will be either
@@ -141,7 +225,7 @@ report generators, tools, and display filters to be added without modification
of the main program.
.LP
In addition to generating direct printer output, report generators also
target other systems, such as \fIOpenOffice.org\fR, \fIAbiWord\fR, HTML
target other systems, such as \fIOpenOffice.org\fR, \fIAbiWord\fR, HTML,
or LaTeX to allow the users to modify the format to suit their needs.
.SH KNOWN BUGS AND LIMITATIONS
@@ -155,7 +239,7 @@ or LaTeX to allow the users to modify the format to suit their needs.
\fI${HOME}/.gramps\fP
.SH AUTHORS
Donald Allingham \fI<dallingham@users.sourceforge.net>\fR
Donald Allingham \fI<don@gramps-project.org>\fR
.br
\fIhttp://gramps.sourceforge.net\fR
.LP
@@ -167,7 +251,7 @@ for inclusion in the Debian GNU/Linux system.
.LP
This manpage is currently maintained by:
.br
Alex Roitman \fI<shura@alex.neuro.umn.edu>\fR
Alex Roitman \fI<shura@gramps-project.org>\fR
.br
.SH DOCUMENTATION
@@ -176,5 +260,5 @@ in the form of Gramps Manual. The manual is also available in XML format
as \fBgramps-manual.xml\fR under \fIdoc/gramps-manual/$LANG\fR in the official
source distribution.
.LP
The developer documentation can be found in the \fBDocs\fR section
of \fIhttp://sourceforge.net/project/gramps\fR site.
The developer documentation can be found on the
\fIhttp://developers.gramps-project.org\fR site.