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

* doc/gramps-manual/C/filtref.xml: Manual corrections.

Browse Source 
* doc/gramps-manual/C/cmdline.xml: Likewise.
* doc/gramps-manual/C/mainwin.xml: Likewise.
* doc/gramps-manual/C/figures/pedigree.png: Update figure.


svn: r2177
This commit is contained in:
Alex Roitman 2003-09-27 23:01:41 +00:00
parent f4aab8924b
commit 8501a8c85d
5 changed files with 108 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
ChangeLog
View File

@ -1,3 +1,9 @@
2003-09-27 Alex Roitman <shura@alex.neuro.umn.edu>
* doc/gramps-manual/C/filtref.xml: Manual corrections.
* doc/gramps-manual/C/cmdline.xml: Likewise.
* doc/gramps-manual/C/mainwin.xml: Likewise.
* doc/gramps-manual/C/figures/pedigree.png: Update figure.
2003-09-27 Don Allingham <dallingham@users.sourceforge.net>
* src/docgen/RTFDoc.py: Fixed double printing of lines

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

@ -2,7 +2,7 @@
<!-- =============== Appendices Subsection ================ -->
<sect2 id="append-cmdline">
<title>Command line reference</title>
<para>This appendix provide the reference to the command line
<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
@ -10,8 +10,8 @@
true non-graphical console. It would take an enormous amount of effort
to enable it to run in a text-only terminal. This is why the set of
command line options does not aim to completely get rid of dependency
on graphical display It merely makes certain (typical) tasks more
convenient. It also allows one to execute these tasks from the scripts.
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>
@ -33,37 +33,38 @@
<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 format can be one of the following:
option. The <replaceable>format</replaceable> can be one of the
following:
<variablelist>
<varlistentry><term>gramps</term>
<listitem><para> &app; database. This format is available
for both import and export. When not specified, can be guessed
if the filename represents a directory.
for both import and export. When not specified, it can be
guessed if the filename represents a directory.
</para></listitem></varlistentry>
<varlistentry><term>gedcom</term>
<listitem><para> GEDCOM file. This format is available
for both import and export. When not specified, can be guessed
if the filename ends with .ged
for both import and export. When not specified, it can be
guessed if the filename ends with .ged
</para></listitem></varlistentry>
<varlistentry><term>gramps-pkg</term>
<listitem><para> &app; package. This format is available
for both import and export. When not specified, can be guessed
if the filename ends with .tgz
for both import and export. When not specified, it can be
guessed if the filename ends with .tgz
</para></listitem></varlistentry>
<varlistentry><term>wft</term>
<listitem><para> Web Family Tree. This format is available
for export only. When not specified, can be guessed
for export only. When not specified, it can be guessed
if the filename ends with .wft
</para></listitem></varlistentry>
<varlistentry><term>iso</term>
<listitem><para> CD image. This format is available
for export only. Never guessed, always specify explicitly.
for export only. It must always be specified explicitly.
</para></listitem></varlistentry>
</variablelist>
@ -115,7 +116,7 @@
</para>
<para> When more than one output file is given, each has to be
preceded by <command>-i</command> flag. The files are written one
preceded by <command>-o</command> flag. The files are written one
by one, in the specified order.
</para></listitem>
</varlistentry>
@ -148,10 +149,10 @@
<sect3 id="cmdline-operation">
<title>Operation</title>
<para>The order of <command>-i</command>, <command>-o</command>,
or <command>-a</command> options does not matter. The actual order
always is: all imports (if any) -> all exports (if any) -> all actions
(if any).</para>
<para>The order of <command>-i</command>, <command>-o</command>,
or <command>-a</command> options with respect to each does not matter.
The actual execution order always is: all imports (if any) -> all
exports (if any) -> all actions (if any).</para>
<para>If no <command>-i</command> option is given, gramps will launch
its main window and start the usual interactive session with the empty
@ -163,7 +164,7 @@
This database resides under
<replaceable>~/.gramps/import</replaceable> directory.</para>
<para>The error encountered during import, export, or action, will
<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>
@ -203,8 +204,18 @@
<command>-o</command> <replaceable>~/new-package</replaceable>
<command>-f</command> <replaceable>gramps-pkg</replaceable>
</para>
<para>To save any error messages of the above example into files
<replaceable>outfile</replaceable> and
<replaceable>errfile</replaceable>, run:</para>
<para><command>gramps -i</command> <replaceable>file1.ged</replaceable>
<command>-i</command> <replaceable>file2.tgz</replaceable>
<command>-o</command> <replaceable>~/new-package</replaceable>
<command>-f</command> <replaceable>gramps-pkg</replaceable>
&gt;<replaceable>outfile</replaceable>
2&gt;<replaceable>errfile</replaceable>
</para>
<para>To import three databases and start interactive gramps
session with the result:</para>
<para><command>gramps -i</command> <replaceable>file1.ged</replaceable>

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

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 22 KiB

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

@ -2,10 +2,9 @@
<!-- =============== Appendices Subsection ================ -->
<sect2 id="append-filtref">
<title>Filter rules reference</title>
<para>This appendix provides the list of all the filter rules
which are currently defined in &app;. All these rules are available
for use when creating custom filters. The rules are listed by their
categories.
<para>This appendix lists of all the filter rules currently defined
in &app;. Each of these rules is available for use when creating custom
filters. The rules are listed by their categories.
</para>
<!-- =============== Appendices Sub-subsection ================ -->
@ -24,8 +23,7 @@
<varlistentry><term>Has a name</term>
<listitem><para> This rule matches any person whose name
matches the specified value. The rule returns a match even if
the person's name matches the value partially. For example,
matches the specified value in full or in part. For example,
Marta Ericsdotter will be matched by the rule using the
value "eric" for the family name.
</para>
@ -74,9 +72,10 @@
<varlistentry><term>Has the birth</term>
<listitem><para> This rule matches people whose birth event
matches specified values for Date, Place, and Description.
The rule returns a match even if the person's birth event
matches the value partially. For example, anyone born in Sweden
will be matched by the rule using the value "sw" for the Place.
The rule returns a match even if the person's birth event matches
the value partially. The matching rules are case-insensitive.
For example, anyone born in Sweden will be matched by the rule
using the value "sw" for the Place.
</para>
<para> The rule returns a match if and only if
@ -89,7 +88,8 @@
<listitem><para> This rule matches people whose death event
matches specified values for Date, Place, and Description.
The rule returns a match even if the person's death event
matches the value partially. For example, anyone who died in Sweden
matches the value partially. The matching rules are case-insensitive.
For example, anyone who died in Sweden
will be matched by the rule using the value "sw" for the Place.
</para>
@ -103,7 +103,8 @@
<listitem><para> This rule matches people that have a personal
event matching specified values for the Event type, Date, Place,
and Description. The rule returns a match even if the person's
event matches the value partially. For example, anyone who graduated
event matches the value partially. The matching rules are
case-insensitive. For example, anyone who graduated
in Sweden will be matched by the rule using the Graduation event
and the value "sw" for the Place.
</para>
@ -119,9 +120,10 @@
<listitem><para> This rule matches people that have a family
event matching specified values for the Event type, Date, Place,
and Description. The rule returns a match even if the person's
event matches the value partially. For example, anyone who was
married in Sweden will be matched by the rule using the Marriage
event and the value "sw" for the Place.
event matches the value partially. The matching rules are
case-insensitive. For example, anyone who was married in Sweden
will be matched by the rule using the Marriage event and the
value "sw" for the Place.
</para>
<para> The family events should be selected from a pull-down menu.
@ -157,21 +159,21 @@
<varlistentry><term>Is spouse of filter match</term>
<listitem><para> This rule matches people married to someone
who is in turn matched by the specified filter.
who is matched by the specified filter.
The specified filter name should be selected from the menu.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a child of filter match</term>
<listitem><para> This rule matches people whose either parent
is in turn matched by the specified filter.
<listitem><para> This rule matches people for whom either parent
is matched by the specified filter.
The specified filter name should be selected from the menu.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a parent of filter match</term>
<listitem><para> This rule matches people whose child
is in turn matched by the specified filter.
is matched by the specified filter.
The specified filter name should be selected from the menu.
</para></listitem>
</varlistentry>
@ -183,7 +185,7 @@
<sect3 id="filtref-ancestral">
<title>Ancestral filters</title>
<para>This category includes the following rules that match people
based on their being ancestors of other people:</para>
based on their ancestral relations to other people:</para>
<variablelist>
<varlistentry><term>Is an ancestor of</term>
@ -205,20 +207,20 @@
<listitem><para> This rule matches people who are ancestors of the
specified person and are at least N generations away from that person
in their lineage. For example, using this rule with the value of 2
for the number of generations will match grandparents, great
grandparents, etc., of the specified person, but not the parents of
that person.
for the number of generations will match grandparents,
great-grandparents, etc., but not the parents of the specified
person.
</para></listitem>
</varlistentry>
<varlistentry><term>Is an ancestor of person not more
than N generations away</term>
<listitem><para> This rule matches people who are ancestors of the
specified person and are no more N generations away from that person
in their lineage. For example, using this rule with the value of 2
for the number of generations will match parents of the specified
person, but not grandparents, great grandparents, etc.,
of that person.
specified person and are no more than N generations away from that
person in their lineage. For example, using this rule with the value
of 2 for the number of generations will match parents and
grandparents, but not great-grandparents, etc., of the specified
person.
</para></listitem>
</varlistentry>
@ -230,14 +232,14 @@
<varlistentry><term>Has a common ancestor with filter match</term>
<listitem><para> This rule matches people who have common ancestors
with someone who is in turn matched by the specified filter.
with someone who is matched by the specified filter.
The specified filter name should be selected from the menu.
</para></listitem>
</varlistentry>
<varlistentry><term>Is an ancestor of filter match</term>
<listitem><para> This rule matches people who are ancestors
of someone who is in turn matched by the specified filter.
of someone who is matched by the specified filter.
The specified filter name should be selected from the menu.
</para></listitem>
</varlistentry>
@ -249,7 +251,7 @@
<sect3 id="filtref-descendant">
<title>Descendant filters</title>
<para>This category includes the following rules that match people
based on their being descendants of other people:</para>
based on their descendant relations to other people:</para>
<variablelist>
<varlistentry><term>Is a descendant of</term>
@ -271,33 +273,34 @@
<listitem><para> This rule matches people who are descendants of the
specified person and are at least N generations away from that person
in their lineage. For example, using this rule with the value of 2
for the number of generations will match grandchildren, great
grandchildren, etc., of the specified person, but not the children of
that person.
for the number of generations will match grandchildren,
great-grandchildren, etc., but not the children of the specified
person.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a descendant of person not more
than N generations away</term>
<listitem><para> This rule matches people who are descendants of the
specified person and are no more N generations away from that person
in their lineage. For example, using this rule with the value of 2
for the number of generations will match children of the specified
person, but not grandchildren, great grandchildren, etc.,
of that person.
specified person and are no more than N generations away from that
person in their lineage. For example, using this rule with the value
of 2 for the number of generations will match children and
grandchildren, but not great-grandchildren, etc., of the specified
person.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a descendant of filter match</term>
<listitem><para> This rule matches people who are descendants
of someone who is in turn matched by the specified filter.
of someone who is matched by the specified filter.
The specified filter name should be selected from the menu.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a descendant family member of</term>
<listitem><para> This rule matches people who are descendants
or the spouse of a descendant of the specified person.
<listitem><para> This rule not only matches people who are
descendants of the specified person, but also those descendants'
spouses.
</para></listitem>
</varlistentry>
@ -307,15 +310,15 @@
<!-- =============== Appendices Sub-subsection ================ -->
<sect3 id="filtref-misc">
<title>Miscellaneous filters</title>
<para>This category includes the following rules which did not
<para>This category includes the following rules which do not
naturally fit into any of the above categories:</para>
<variablelist>
<varlistentry><term>Has the personal attribute</term>
<listitem><para> This rule matches people who have the personal
attribute of the specified value. The specified personal attribute
should be selected from the menu. The specified value should be
typed into the text entry field.
name should be selected from the menu. The specified value should
be typed into the text entry field.
</para></listitem>
</varlistentry>

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

@ -262,7 +262,9 @@
Current spouse, respectively. Clicking the right arrow button
makes the family in the corresponding list box an active family.
That is, it makes the selected Father the Active person, and the
selected Mother the Current spouse. </para>
selected Mother the Current spouse. Most of these
functions are also available by right-clicking into the parent box and
selecting an appropriate items from the context menu. </para>
<para>The bottom list box displays children of the Active person and
the Current Spouse. The Children's list can be ordered by the Birth date
@ -279,7 +281,28 @@
and to the family, the lower one just adds a person existing in the
database to the family. Finally, the lowest <guibutton>-</guibutton>
button removes the selected child from the family. Note that removing
a child from the family does not remove the person from the database.</para>
a child from the family does not remove the person from the
database. Most of these functions are also available by right-clicking
into the children box and selecting an appropriate items from the
context menu.</para>
<para>The layout of the Family View can be switched from the
left-to-right arrangement (shown above) to the top-to-bottom
arrangement (shown below). This can be done in the
<guilabel>Display</guilabel> section of the
<guilabel>Preferences</guilabel> dialog. The top-to-bottom view
has the same functionality as the left-to-right view. </para>
<!-- ==== Figure: Family View ==== -->
<figure id="family-alt-fig">
<title>Alternative Family View</title>
<screenshot><mediaobject><imageobject><imagedata
fileref="figures/family-alt.png" format="PNG"/></imageobject>
<textobject>
<phrase>Shows Alternative Family View. </phrase>
</textobject></mediaobject></screenshot></figure>
<!-- ==== End of Figure ==== -->
</sect3>
<!-- ================ Main Window Sub-subsection -->