gramps/doc/gramps-manual/C/filtref.xml
Alex Roitman 22739fbb7f * src/po/ru.po: Update Russian translation.
* doc/gramps-manual/C/gramps-manual.xml: Update manual.
* doc/gramps-manual/C/filtref.xml: Add file -- split appendix
into a separate file.
* doc/gramps-manual/C/cmdline.xml: Likewise.
* doc/gramps-manual/C/getstart.xml: Likewise.
* doc/gramps-manual/C/mainwin.xml: Likewise.
* doc/gramps-manual/C/usage.xml: Likewise.
* doc/gramps-manual/C/custom.xml: Likewise.
* doc/gramps-manual/C/Makefile.am: Ship new files.
* doc/gramps-manual/C/Makefile.in: Likewise.


svn: r2157
2003-09-23 00:48:01 +00:00

341 lines
15 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- =============== 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>
<!-- =============== Appendices Sub-subsection ================ -->
<sect3 id="filtref-general">
<title>General filters</title>
<para>This category includes the following most general rules:</para>
<variablelist>
<varlistentry><term>Everyone</term>
<listitem><para> This rule matches any person in the database.
As such it is not very useful on its own except for testing purposes.
However, it may be useful in combinations with other rules.
</para></listitem>
</varlistentry>
<varlistentry><term>Has a name</term>
<listitem><para> This rule matches any person whose name
matches the specified value. The rule returns a match even if
the person's name matches the value partially. For example,
Marta Ericsdotter will be matched by the rule using the
value "eric" for the family name.
</para>
<para> Separate values can be used for Given name, Family name,
Suffix, and the Title. The rule returns a match IF AND ONLY IF
all non-empty values are (partially) matched by a person's
name. To use just one value, leave the other values empty.
</para></listitem>
</varlistentry>
<varlistentry><term>Has the Id</term>
<listitem><para> This rule matches any person with a specified
&app; ID. The rule returns a match only if the ID is matched
exactly.
</para>
<para> You can either enter the ID into a text entry field, or
select a person from the list by clicking
<guibutton>Select...</guibutton> button. In the latter case, the
ID will appear in the text field after the selection was made.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a female</term>
<listitem><para> This rule matches any female person.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a male</term>
<listitem><para> This rule matches any male person.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
<!-- =============== Appendices Sub-subsection ================ -->
<sect3 id="filtref-event">
<title>Event filters</title>
<para>This category includes the following rules that match people
based on their recorded events:</para>
<variablelist>
<varlistentry><term>Has the birth</term>
<listitem><para> This rule matches people whose birth event
matches specified values for Date, Place, and Description.
The rule returns a match even if the person's birth event
matches the value partially. For example, anyone born in Sweden
will be matched by the rule using the value "sw" for the Place.
</para>
<para> The rule returns a match if and only if
all non-empty values are (partially) matched by a person's
birth. To use just one value, leave the other values empty.
</para></listitem>
</varlistentry>
<varlistentry><term>Has the death</term>
<listitem><para> This rule matches people whose death event
matches specified values for Date, Place, and Description.
The rule returns a match even if the person's death event
matches the value partially. For example, anyone who died in Sweden
will be matched by the rule using the value "sw" for the Place.
</para>
<para> The rule returns a match if and only if
all non-empty values are (partially) matched by a person's
death. To use just one value, leave the other values empty.
</para></listitem>
</varlistentry>
<varlistentry><term>Has the personal event</term>
<listitem><para> This rule matches people that have a personal
event matching specified values for the Event type, Date, Place,
and Description. The rule returns a match even if the person's
event matches the value partially. For example, anyone who graduated
in Sweden will be matched by the rule using the Graduation event
and the value "sw" for the Place.
</para>
<para> The personal events should be selected from a pull-down menu.
The rule returns a match if and only if all non-empty values
are (partially) matched by the personal event.
To use just one value, leave the other values empty.
</para></listitem>
</varlistentry>
<varlistentry><term>Has the family event</term>
<listitem><para> This rule matches people that have a family
event matching specified values for the Event type, Date, Place,
and Description. The rule returns a match even if the person's
event matches the value partially. For example, anyone who was
married in Sweden will be matched by the rule using the Marriage
event and the value "sw" for the Place.
</para>
<para> The family events should be selected from a pull-down menu.
The rule returns a match if and only if all non-empty values
are (partially) matched by the personal event.
To use just one value, leave the other values empty.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
<!-- =============== Appendices Sub-subsection ================ -->
<sect3 id="filtref-family">
<title>Family filters</title>
<para>This category includes the following rules that match people
based on their family relationships:</para>
<variablelist>
<varlistentry><term>Has the relationships</term>
<listitem><para> This rule matches people with a particular
relationship. The relationship must match the type selected from
the menu. Optionally, the number of relationships and the number
of children can be specified.
</para>
<para> The rule returns a match if and only if
all non-empty values are (partially) matched by a person's
birth. To use just one value, leave the other values empty.
</para></listitem>
</varlistentry>
<varlistentry><term>Is spouse of filter match</term>
<listitem><para> This rule matches people married to someone
who is in turn 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.
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.
The specified filter name should be selected from the menu.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
<!-- =============== Appendices Sub-subsection ================ -->
<sect3 id="filtref-ancestral">
<title>Ancestral filters</title>
<para>This category includes the following rules that match people
based on their being ancestors of other people:</para>
<variablelist>
<varlistentry><term>Is an ancestor of</term>
<listitem><para> This rule matches people who are ancestors of the
specified person. The Inclusive option determines whether the
specified person should be considered his/her own ancestor (useful
for building reports).
</para>
<para> You can either enter the ID into a text entry field, or
select a person from the list by clicking
<guibutton>Select...</guibutton> button. In the latter case, the
ID will appear in the text field after the selection was made.
</para></listitem>
</varlistentry>
<varlistentry><term>Is an ancestor of person at
least N generations away</term>
<listitem><para> This rule matches people who are ancestors of the
specified person and are at least N generations away from that person
in their lineage. For example, using this rule with the value of 2
for the number of generations will match grandparents, great
grandparents, etc., of the specified person, but not the parents of
that 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.
</para></listitem>
</varlistentry>
<varlistentry><term>Has a common ancestor with</term>
<listitem><para> This rule matches people who have common ancestors
with the specified person.
</para></listitem>
</varlistentry>
<varlistentry><term>Has a common ancestor with filter match</term>
<listitem><para> This rule matches people who have common ancestors
with someone who is in turn 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.
The specified filter name should be selected from the menu.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
<!-- =============== Appendices Sub-subsection ================ -->
<sect3 id="filtref-descendant">
<title>Descendant filters</title>
<para>This category includes the following rules that match people
based on their being descendants of other people:</para>
<variablelist>
<varlistentry><term>Is a descendant of</term>
<listitem><para> This rule matches people who are descendants of the
specified person. The Inclusive option determines whether the
specified person should be considered his/her own descendant (useful
for building reports).
</para>
<para> You can either enter the ID into a text entry field, or
select a person from the list by clicking
<guibutton>Select...</guibutton> button. In the latter case, the
ID will appear in the text field after the selection was made.
</para></listitem>
</varlistentry>
<varlistentry><term>Is a descendant of person at
least N generations away</term>
<listitem><para> This rule matches people who are descendants of the
specified person and are at least N generations away from that person
in their lineage. For example, using this rule with the value of 2
for the number of generations will match grandchildren, great
grandchildren, etc., of the specified person, but not the children of
that 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.
</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.
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.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
<!-- =============== Appendices Sub-subsection ================ -->
<sect3 id="filtref-misc">
<title>Miscellaneous filters</title>
<para>This category includes the following rules which did 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.
</para></listitem>
</varlistentry>
<varlistentry><term>Has the family attribute</term>
<listitem><para> This rule matches people who have the family
attribute of the specified value. The specified family attribute
should be selected from the menu. The specified value should be
typed into the text entry field.
</para></listitem>
</varlistentry>
<varlistentry><term>Matches the filter named</term>
<listitem><para> This rule matches people who are matched
by the specified filter.
The specified filter name should be selected from the menu.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>