diff --git a/ChangeLog b/ChangeLog index 6d7d9b47f..76f5f9b7e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2003-09-27 Alex Roitman + * 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 * src/docgen/RTFDoc.py: Fixed double printing of lines diff --git a/doc/gramps-manual/C/cmdline.xml b/doc/gramps-manual/C/cmdline.xml index cff8cb358..3e581b93e 100644 --- a/doc/gramps-manual/C/cmdline.xml +++ b/doc/gramps-manual/C/cmdline.xml @@ -2,7 +2,7 @@ Command line reference - This appendix provide the reference to the command line + This appendix provides the reference to the command line capabilities available when launching &app; from the terminal. 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! @@ -33,37 +33,38 @@ The format of any file destined for import or export can be specified with the -f format - option. The format can be one of the following: + option. The format can be one of the + following: gramps &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. gedcom 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 gramps-pkg &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 wft 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 iso CD image. This format is available - for export only. Never guessed, always specify explicitly. + for export only. It must always be specified explicitly. @@ -115,7 +116,7 @@ When more than one output file is given, each has to be - preceded by -i flag. The files are written one + preceded by -o flag. The files are written one by one, in the specified order. @@ -148,10 +149,10 @@ Operation - The order of -i, -o, - or -a options does not matter. The actual order - always is: all imports (if any) -> all exports (if any) -> all actions - (if any). + The order of -i, -o, + or -a 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). If no -i 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 ~/.gramps/import directory. - The error encountered during import, export, or action, will + 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. @@ -203,8 +204,18 @@ -o ~/new-package -f gramps-pkg - + To save any error messages of the above example into files + outfile and + errfile, run: + gramps -i file1.ged + -i file2.tgz + -o ~/new-package + -f gramps-pkg + >outfile + 2>errfile + + To import three databases and start interactive gramps session with the result: gramps -i file1.ged diff --git a/doc/gramps-manual/C/figures/pedigree.png b/doc/gramps-manual/C/figures/pedigree.png index 9e02c0996..bcb79abca 100644 Binary files a/doc/gramps-manual/C/figures/pedigree.png and b/doc/gramps-manual/C/figures/pedigree.png differ diff --git a/doc/gramps-manual/C/filtref.xml b/doc/gramps-manual/C/filtref.xml index da2c94ebf..cf2f19014 100644 --- a/doc/gramps-manual/C/filtref.xml +++ b/doc/gramps-manual/C/filtref.xml @@ -2,10 +2,9 @@ Filter rules reference - 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. + 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. @@ -24,8 +23,7 @@ Has a name 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. @@ -74,9 +72,10 @@ Has the birth 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. The rule returns a match if and only if @@ -89,7 +88,8 @@ 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. @@ -103,7 +103,8 @@ 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. @@ -119,9 +120,10 @@ 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. The family events should be selected from a pull-down menu. @@ -157,21 +159,21 @@ Is spouse of filter match 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. Is a child of filter match - This rule matches people whose either parent - is in turn matched by the specified filter. + This rule matches people for whom either parent + is matched by the specified filter. The specified filter name should be selected from the menu. Is a parent of filter match 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. @@ -183,7 +185,7 @@ Ancestral filters This category includes the following rules that match people - based on their being ancestors of other people: + based on their ancestral relations to other people: Is an ancestor of @@ -205,20 +207,20 @@ 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. Is an ancestor of person not more than N generations away 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. @@ -230,14 +232,14 @@ Has a common ancestor with filter match 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. Is an ancestor of filter match 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. @@ -249,7 +251,7 @@ Descendant filters This category includes the following rules that match people - based on their being descendants of other people: + based on their descendant relations to other people: Is a descendant of @@ -271,33 +273,34 @@ 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. Is a descendant of person not more than N generations away 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. Is a descendant of filter match 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. Is a descendant family member of - This rule matches people who are descendants - or the spouse of a descendant of the specified person. + This rule not only matches people who are + descendants of the specified person, but also those descendants' + spouses. @@ -307,15 +310,15 @@ Miscellaneous filters - This category includes the following rules which did not + This category includes the following rules which do not naturally fit into any of the above categories: Has the personal attribute 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. diff --git a/doc/gramps-manual/C/mainwin.xml b/doc/gramps-manual/C/mainwin.xml index 50a499311..9f9e15549 100644 --- a/doc/gramps-manual/C/mainwin.xml +++ b/doc/gramps-manual/C/mainwin.xml @@ -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. + 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. 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 - button removes the selected child from the family. Note that removing - a child from the family does not remove the person from the database. + 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. + + 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 + Display section of the + Preferences dialog. The top-to-bottom view + has the same functionality as the left-to-right view. + + +
+ Alternative Family View + + + Shows Alternative Family View. +
+ +