diff --git a/gramps2/ChangeLog b/gramps2/ChangeLog index a4c4e0d5f..4669f9011 100644 --- a/gramps2/ChangeLog +++ b/gramps2/ChangeLog @@ -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 * src/gramps_main.py: remove beta warning, handle OSError on config open diff --git a/gramps2/doc/gramps-manual/C/cmdline.xml b/gramps2/doc/gramps-manual/C/cmdline.xml index 90bfc6269..a9f24f2ab 100644 --- a/gramps2/doc/gramps-manual/C/cmdline.xml +++ b/gramps2/doc/gramps-manual/C/cmdline.xml @@ -27,7 +27,7 @@ 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 + &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! - + - To summarize, the use of the command line options provides + 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! - + Available options - Here is the list of the command line options in &app;: + 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: + and . - - - Format options - The format of any file destined for import or export - can be specified with the + Format options + The format of any file destined for opening, importing, + or exporting can be specified with the -f format - option. The format can be one of the - following: + option. The acceptable format values + are listed below. - gramps + grdb &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 + + + gramps-xml + &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. gedcom 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 gramps-pkg &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 + geneweb + GeneWen file This format is available + for import and export. When not specified, it can be + guessed if the filename ends with gw + + wft Web Family Tree. This format is available for export only. When not specified, it can be guessed @@ -91,24 +104,79 @@ - - + - Import options - The files destined for import can be specified with - the - -i filename - option. The format can be specified with the -f - option immediately following the filename. + Opening options + There are two ways to give &app; the name of the file to + be opened: + + supply bare file name + + use the + -O filename or + -open=filename option + + + + + 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. + + + 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. + + + The format can be specified with the + -f format or + --format=format + option, immediately following the filename. If not specified, the guess will be attempted based on - the filename. For gramps + the filename. For gramps-xml format, the filename is actually the name of directory under which the gramps database resides. For - gedcom and gramps-pkg, the - filename is the name of the + grdb and gedcom, + the filename is the name of the corresponding file. + 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. + + + Only a single file can be opened. If you need to combine + data from several sources, you will need to use + the import option. + + + + Import options + The files destined for import can be specified with the + -i filename + or --import=filename + option. The format can be specified with the + -f format or + --format=format + option, immediately following the filename. + If not specified, the guess will be attempted based on + the filename. For gramps-xml + format, the filename is actually the + name of directory under which the gramps database resides. For + grdb, gedcom, gramps-pkg, + and geneweb, + the filename is the name of the + corresponding file. + + + 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. + + When more than one input file is given, each has to be preceded by -i flag. The files are imported in the specified order, i.e. @@ -118,52 +186,147 @@ -i file2 -i file1 might produce different gramps IDs in the resulting database. - - + - - Export options - The files destined for export can be specified with - the - -o filename + Export options + The files destined for export can be specified with the + -o filename or + --output=filename option. The format can be specified with the -f option immediately following the filename. If not specified, the guess will be attempted based on - the filename. For gramps + the filename. For gramps-xml and iso formats, the filename is actually the name of directory the gramps database will be written - into. For gedcom, wft, + into. For grdb, gedcom, + wft, geneweb, and gramps-pkg, the filename is the name of the resulting file. + 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. + + When more than one output file is given, each has to be preceded by -o flag. The files are written one by one, in the specified order. - - + - Action options - The action to perform on the imported data can be + Action options + The action to perform on the imported data can be specified with the - -a action + -a action or + --action=action option. This is done after all imports are successfully completed. - Currently available actions are summary (same as + + + Currently available actions are: + + + + summary + This action is the same as ReportsView - Summary) - and check (same as + Summary + + + + check + This action is the same as Tools Database Processing - Check and Repair). + Check and Repair. + + + report + 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 + -p option_string or + --options=option_string + option. + + + The report option string should satisfy the following conditions: + + + + + 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 equal sign. + + + Different pairs must be separated by commas. + + + + + + + Most of the report options are specific for every report. + However, there some common options. + + + + + name=report_name + + 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. + + + + show=all + + This will produce the list of names for all options available for + a given report. + + + + show=option_name + + 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. + + + + + + + Use the above options to find out everything about a given report. + + + + 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. + + + + + When more than one output action is given, each has to be preceded by -a flag. The actions are performed one by one, in the specified order. - - - - + diff --git a/gramps2/doc/gramps-manual/C/custom.xml b/gramps2/doc/gramps-manual/C/custom.xml index 54e1ebb23..0e3e06127 100644 --- a/gramps2/doc/gramps-manual/C/custom.xml +++ b/gramps2/doc/gramps-manual/C/custom.xml @@ -1,4 +1,4 @@ - + Settings - To configure &app;, choose - Edit - Preferences.... This will - bring up the following Preferences dialog. + + + Preferences + + Most of the settings in &app;, are configured in the + Preferences dialog. To invoke it, choose + Edit + Preferences....
@@ -42,7 +46,7 @@ categories. Selecting a tree node will display the corresponding options in the right side of the dialog. - + Database This category contains preferences relevant to the database itself. It has the following subcategories: @@ -108,9 +112,9 @@ - + - + Display This category contains preferences relevant to displaying database records and controls in &app;. @@ -202,7 +206,86 @@ + + + + Other settings + + Besides Preferences dialog, there are + other settings available in &app;. For various reasons they have been + made more readily accessible, as listed below. + + + + Column Editor + + The columns of the list views may be added, removed, or reordered + in a Column Editor Dialog, + see . Only checked columns will + be shown in the view. To change their order, drag any column to its desired place inside + the editor. Clicking OK will reflect the changes + in the appropriate view. To invoke Column Editor Dialog, + choose EditColumn + Editor.... + + + + The Column Editor 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. + + + + + Setting Home person + The Home person is the person who becomes active + when database opened, when Home button is clicked + or the Home menu item is selected from + either Go menu or the right-click context menu + anywhere. + + To set Home person, make the desired person active and + then choose EditSet Home + person.... + + + + + Adjusting viewing controls + Whether the toolbar, the sidebar, or the filter (People View + only) are displayed in the main window is adjusted through + the View menu. + + + + + + + + + Advanced manipulation of settings + + 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! + + + By default, &app; stores its settings using gconf2 system. + All the settings used in this version of &app; are stored in + subdirectories under /apps/gramps/ in the + gconf2 namespace. Accessing the keys can be done either using + gconftool-2 command line tool, or the + gconf-editor GUI tool. + + + 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. + diff --git a/gramps2/doc/gramps-manual/C/filtref.xml b/gramps2/doc/gramps-manual/C/filtref.xml index fbbc3eef3..462bdb731 100644 --- a/gramps2/doc/gramps-manual/C/filtref.xml +++ b/gramps2/doc/gramps-manual/C/filtref.xml @@ -25,7 +25,8 @@ Filter rules reference 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 . The rules are + listed by their categories. @@ -43,6 +44,26 @@ + People with incomplete names + This rule matches all people with either + given name or family name missing. + + + + Is bookmarked person + This rule matches all people who are on the + bookmark list. + + + + Has text matching substring of + 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. + + + Everyone 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 @@ + People probably alive + 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. + + + Has a name This rule matches any person whose name matches the specified value in full or in part. For example, @@ -77,11 +105,33 @@ + Is default person + This rule matches the default (home) person. + + + + People marked private + This rule matches people whose records are marked + as private. + + + Is a female This rule matches any female person. + People who have images + This rule matches people with images in their + galleries. + + + + People without a birth date + This rule matches people missing birth date. + + + Is a male This rule matches any male person. @@ -128,6 +178,12 @@ + Has source of + This rule matches people whose records refer + to the specified source. + + + Has the personal event This rule matches people that have a personal event matching specified values for the Event type, Date, Place, @@ -162,6 +218,24 @@ + Witness + 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. + + + + People with incomplete events + This rule matches people missing date or place in + any personal event. + + + + Families with incomplete events + This rule matches people missing date or place in + any family event of any of their families. + + @@ -173,6 +247,26 @@ based on their family relationships: + People with children + This rule matches people with children. + + + + People with multiple marriage records + This rule matches people with more than one spouse. + + + + People with no marriage records + This rule matches people with no spouses. + + + + People who were adopted + This rule matches adopted people. + + + Has the relationships This rule matches people with a particular relationship. The relationship must match the type selected from @@ -207,6 +301,13 @@ + Is a sibling of filter match + This rule matches people whose sibling + is matched by the specified filter. + The specified filter name should be selected from the menu. + + + diff --git a/gramps2/doc/gramps-manual/C/keybind.xml b/gramps2/doc/gramps-manual/C/keybind.xml index e0e1bda8b..f79aab30c 100644 --- a/gramps2/doc/gramps-manual/C/keybind.xml +++ b/gramps2/doc/gramps-manual/C/keybind.xml @@ -23,13 +23,19 @@ Keybindings reference + 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. + This appendix contains the list of keybindings that are not displayed in menus of &app;. - - People View - The following bindings are available in the People View: + + List Views + The following bindings are available in all list views: + People View, Sources View, Places View, and Media View. diff --git a/gramps2/src/SourceView.py b/gramps2/src/SourceView.py index 86cc848c1..7497f2f77 100644 --- a/gramps2/src/SourceView.py +++ b/gramps2/src/SourceView.py @@ -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)