* src/SourceView.py (__init__): Connect to the key-press-event.

* doc/gramps-manual/C/keybind.xml: Update.
* doc/gramps-manual/C/cmdline.xml: Update.
* doc/gramps-manual/C/custom.xml: Update.
* doc/gramps-manual/C/filtref.xml: Update.


svn: r4485
This commit is contained in:
Alex Roitman
2005-05-05 04:55:08 +00:00
parent fdb8acce47
commit 9e3b938b2a
6 changed files with 422 additions and 62 deletions

View File

@@ -10,6 +10,12 @@
* src/plugins/SoundGen.py: Correct manual section.
* src/plugins/Verify.py: Correct manual section.
* src/SourceView.py (__init__): Connect to the key-press-event.
* doc/gramps-manual/C/keybind.xml: Update.
* doc/gramps-manual/C/cmdline.xml: Update.
* doc/gramps-manual/C/custom.xml: Update.
* doc/gramps-manual/C/filtref.xml: Update.
2005-05-03 Don Allingham <don@gramps-project.org>
* src/gramps_main.py: remove beta warning, handle OSError
on config open

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
<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</command> <replaceable>format</replaceable>
option. The <replaceable>format</replaceable> can be one of the
following:
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,24 +104,79 @@
</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 <replaceable>filename</replaceable></command> or
<command>-open=<replaceable>filename</replaceable></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 <replaceable>filename</replaceable>.
If not specified, the guess will be attempted based on
the <replaceable>filename</replaceable>. For <term>gramps</term>
the <replaceable>filename</replaceable>. For <term>gramps-xml</term>
format, the <replaceable>filename</replaceable> is actually the
name of directory under which the gramps database resides. For
<term>gedcom</term> and <term>gramps-pkg</term>, the
<replaceable>filename</replaceable> is the name of the
<term>grdb</term> and <term>gedcom</term>,
the <replaceable>filename</replaceable> is the name of the
corresponding file.
</para>
<tip><para>Only <term>grdb</term>, <term>gramps-xml</term>,
and <term>gedcom</term> 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 <replaceable>filename</replaceable></command>
or <command>--import=<replaceable>filename</replaceable></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 <replaceable>filename</replaceable>.
If not specified, the guess will be attempted based on
the <replaceable>filename</replaceable>. For <term>gramps-xml</term>
format, the <replaceable>filename</replaceable> is actually the
name of directory under which the gramps database resides. For
<term>grdb</term>, <term>gedcom</term>, <term>gramps-pkg</term>,
and <term>geneweb</term>,
the <replaceable>filename</replaceable> 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.
@@ -118,52 +186,147 @@
<command>-i</command> <replaceable>file2</replaceable>
<command>-i</command> <replaceable>file1</replaceable>
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 <replaceable>filename</replaceable></command> or
<command>--output=<replaceable>filename</replaceable></command>
option. The format can be specified with the <command>-f</command>
option immediately following the <replaceable>filename</replaceable>.
If not specified, the guess will be attempted based on
the <replaceable>filename</replaceable>. For <term>gramps</term>
the <replaceable>filename</replaceable>. For <term>gramps-xml</term>
and <term>iso</term> formats, the <replaceable>filename</replaceable>
is actually the name of directory the gramps database will be written
into. For <term>gedcom</term>, <term>wft</term>,
into. For <term>grdb</term>, <term>gedcom</term>,
<term>wft</term>, <term>geneweb</term>,
and <term>gramps-pkg</term>, the <replaceable>filename</replaceable>
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>

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,10 +23,14 @@
<!-- $Id$ -->
<title>Settings</title>
<para>To configure &app;, choose
<menuchoice><guimenu>Edit</guimenu>
<guimenuitem>Preferences...</guimenuitem></menuchoice>. This will
bring up the following <guilabel>Preferences</guilabel> dialog.</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">
@@ -42,7 +46,7 @@
categories. Selecting a tree node will display the corresponding
options in the right side of the dialog. </para>
<sect1 id="gramps-prefs-db">
<sect2 id="gramps-prefs-db">
<title>Database</title>
<para> This category contains preferences relevant to the
database itself. It has the following subcategories: </para>
@@ -108,9 +112,9 @@
</varlistentry>
</variablelist>
</sect1>
</sect2>
<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;.
@@ -202,7 +206,86 @@
</varlistentry>
</variablelist>
</sect2>
</sect1>
<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>
<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>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>
<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>
</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>

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,
@@ -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>
@@ -128,6 +178,12 @@
</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,
@@ -162,6 +218,24 @@
</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
@@ -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>

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">

View File

@@ -71,6 +71,7 @@ class SourceView:
self.list = glade.get_widget("source_list")
#self.list.set_property('fixed-height-mode',True)
self.list.connect('button-press-event',self.button_press)
self.list.connect('key-press-event',self.key_press)
self.selection = self.list.get_selection()
self.selection.set_mode(gtk.SELECTION_MULTIPLE)