diff --git a/gramps2/ChangeLog b/gramps2/ChangeLog index 9a4133984..a4c4e0d5f 100644 --- a/gramps2/ChangeLog +++ b/gramps2/ChangeLog @@ -1,3 +1,15 @@ +2005-05-04 Alex Roitman + * doc/gramps-manual/C/figures/scratch-pad.png: Add new figure. + * doc/gramps-manual/C/authors.xml: Update. + * doc/gramps-manual/C/keybind.xml: Update. + * doc/gramps-manual/C/usage.xml: Update. + * doc/gramps-manual/C/figures/cfe-ar.png: Update. + * doc/gramps-manual/C/figures/cfe-df.png: Update. + * src/plugins/FilterEditor.py: Correct manual section. + * src/plugins/ScratchPad.py: Correct manual section. + * src/plugins/SoundGen.py: Correct manual section. + * src/plugins/Verify.py: Correct manual section. + 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/authors.xml b/gramps2/doc/gramps-manual/C/authors.xml index 11e029015..61359dbc1 100644 --- a/gramps2/doc/gramps-manual/C/authors.xml +++ b/gramps2/doc/gramps-manual/C/authors.xml @@ -68,6 +68,7 @@ Radek Malcic Radu Bogdan Mare Richard Bos +Richard Taylor Samuel Tardieu Sebastian Voecking Steve Hall diff --git a/gramps2/doc/gramps-manual/C/figures/cfe-ar.png b/gramps2/doc/gramps-manual/C/figures/cfe-ar.png index dac17db40..aaae11db4 100644 Binary files a/gramps2/doc/gramps-manual/C/figures/cfe-ar.png and b/gramps2/doc/gramps-manual/C/figures/cfe-ar.png differ diff --git a/gramps2/doc/gramps-manual/C/figures/cfe-df.png b/gramps2/doc/gramps-manual/C/figures/cfe-df.png index e921df094..3dd45d74d 100644 Binary files a/gramps2/doc/gramps-manual/C/figures/cfe-df.png and b/gramps2/doc/gramps-manual/C/figures/cfe-df.png differ diff --git a/gramps2/doc/gramps-manual/C/figures/scratch-pad.png b/gramps2/doc/gramps-manual/C/figures/scratch-pad.png new file mode 100644 index 000000000..f0a156e86 Binary files /dev/null and b/gramps2/doc/gramps-manual/C/figures/scratch-pad.png differ diff --git a/gramps2/doc/gramps-manual/C/keybind.xml b/gramps2/doc/gramps-manual/C/keybind.xml index ec7b4071e..e0e1bda8b 100644 --- a/gramps2/doc/gramps-manual/C/keybind.xml +++ b/gramps2/doc/gramps-manual/C/keybind.xml @@ -140,8 +140,8 @@ Ctrl+Up or Ctrl+Left Swap the selected spouse and the Active Person. - Use Ctrl+Down in standard Family View and - Ctrl+Right in alternative Family + Use Ctrl+Up in standard Family View and + Ctrl+Left in alternative Family View. @@ -262,4 +262,4 @@ - \ No newline at end of file + diff --git a/gramps2/doc/gramps-manual/C/usage.xml b/gramps2/doc/gramps-manual/C/usage.xml index 0b07bce41..7e6e2e121 100644 --- a/gramps2/doc/gramps-manual/C/usage.xml +++ b/gramps2/doc/gramps-manual/C/usage.xml @@ -380,8 +380,8 @@ &app; package export Exporting to &app; package will create a gzip-compressed tar - archive (also known as tarball) which contains gramps database, all - local media objects, and copies of all external media objects. This is a + archive (also known as tarball) which contains gramps database + and copies of all media objects files. This is a useful format for moving your database to another machine or for sharing it with somebody, while retaining all the features provided by &app;. @@ -389,8 +389,8 @@ Export to CD - Exporting to CD will prepare you database directory with all its - contents to be recorded to the CD. This is done through the + Exporting to CD will prepare your database and copies of all media + objects files to be recorded to the CD. This is done through the burn:/// location in Nautilus. After exporting to CD, go to the burn:/// location by selecting Go @@ -2862,6 +2862,130 @@ all changes are immediate. + + + Books + Currently, the only available report under this category + is the Book Report. + + The Book Report creates a single document (i.e. a Book) + containing a collection of graphical and textual reports. + Consequently, this allows for a very rich set of documents + that &app; can produce. + + + When Book Report is selected, the following book configuration + dialog appears: + + +
+ Book Report dialog + + + Shows Book Report dialog. +
+ + + The Book name text entry field is used to + save the book (a set of configured selections) for future use. + The top pane lists the items available for inclusion in the + book. The bottom pane lists the currently selected items in + the order they will appear in the book. + + The horizontal set of buttons by the Book + name field operates on the whole book. Click + the Clear button to clear all items from + the current book. Click the Save button to + save the current book (under the name typed in + the Book name text entry field) for future + use. + + + Saving the book also saves the configuration for each item. + + + Click the Open button to load + the book from the list of previously saved books. Finally, click the + Edit books button to evoke the editable list of + available books. + + The vertical set of buttons to the right of the bottom pane + operates on the + selected book item. Click the Add button to + add selected item from the available list to the current book. Click + the Remove button to remove an item from the + current book. Use Up and + Down to change the items order in the current + book. Click the Setup button to configure the + options of the selected item of the current book. + + + The configuration dialogs evoked by Setup + are item-specific. If you choose not to configure the item, sane + defaults will be used for all needed options. The common option for + almost all book items is the center person: the person on whom the + item is centered. Thanks to this option, you can create a book with + items centered on different people (e.g. your mom's and dad's + ancestors as separate chapters). By default, the center person is + set to the active person. + + Almost all items available for inclusion in the book are textual + or graphical reports, and are therefore available in the form of standalone + reports. The exception is the following items which are only available as + book items: + + + + Title Page + This item produces a customized Title page. You can + configure the text of title, subtitle, and the footer of the page. + An image can be optionally placed between the subtitle and the footer. + Because of its configurability, this item can be used to create + title pages for the whole book, its chapter, or even a single item. + + + + + Custom Text + This item produces a page with three paragraphs, each + containing custom text. The appearance of the text can be adjusted by + using custom styles. This item was meant to be used for epigraphs, + dedications, explanations, notes, and so forth. + + + + + + + + + + Code Generators + This category contains reports that produce code intended + to be run through the computer, rather than the usual formatted + output for human reading. The only code generator currently + available in &app; is the Relationship Graph producing the + GraphViz description of the graph. + + The Relationship Graph creates a complex relationship graph in + GraphViz format. The GraphViz dot tool can + transform the graph into postscript, jpeg, png, vrml, svg, and + other formats. GraphViz tools are freely available from the + GraphViz + site. Specific options for this report + include filter and number of generations considered, as well as + several GraphViz-specific options related to pagination, color, + and details of the graph. + + If you are not interested in GraphViz code itself + and just want to generate graphical output, &app; can do it for you + under the hood. Look for Relationship Graph + in the Graphical Reports category, + + + + Graphical Reports @@ -2898,18 +3022,38 @@ all changes are immediate. the format of the displayed entries. + Fan Chart + This report produces a chart resembling a fan, with + Active person in the center, parents the the semicircle next to it, + grandparents in the next semicircle, and so on, for a total of five + generations. + + Relationship Graph This report creates a complex relationship graph in - GraphViz format. The GraphViz dot tool can - transform the graph into postscript, jpeg, png, vrml, svg, and many - other formats. GraphViz tools are freely available from the - GraphViz - site. Specific options for this report - include filter and number of generations considered, as well as + GraphViz format and then converts into graphical output + running it through the the GraphViz dot tool + behind the scene. Specific options for this report + include filter, options for dates and places for the events, and + whether to include URLs and IDs for individuals and families. + There are also several GraphViz-specific options related to pagination, color, and details of the graph. + Statistics Chart + This report can collect and display a wealth of + statistical data about your database. + Specific options include filter, sorting methods, and additional + birth- and gender-based limit for inclusion into statistics. + You can also set the minimum number of items to qualify for the + bar chart, so that the charts with fewer items will generate + a pice chart instead. + The Chart Selection tab + allows you to check which charts you want to include in your report. + + + Timeline Graph This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. @@ -2922,12 +3066,11 @@ all changes are immediate. Common options for graphical reports are the filename of the output, the format of the output, selected style, page size and orientation. Optionally, the reports can be immediately opened - with the default application (set in the main GNOME - Desktop Preferenes - Advanced - Preferred - Applications dialog). - + with the default application. + + The options used in reports are persistent: each report + remembers its options used last time. + @@ -2959,15 +3102,6 @@ all changes are immediate. - Comprehensive Ancestors Report - This report produces a comprehensive description - of ancestors of the active person. The highlights of this report - include elaborate layout, images of children, present and former - spouses, and source citations. Specific options: number - of backward generations to consider, whether to cite sources, - and whether to break pages between generations. - - Complete Individual Report This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report @@ -2978,6 +3112,15 @@ all changes are immediate. source information when listing events. + Comprehensive Ancestors Report + This report produces a comprehensive description + of ancestors of the active person. The highlights of this report + include elaborate layout, images of children, present and former + spouses, and source citations. Specific options: number + of backward generations to consider, whether to cite sources, + and whether to break pages between generations. + + Descendant Report This report produces a brief description of descendants of the active person. Specific options: number @@ -3035,107 +3178,15 @@ all changes are immediate. orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in &app; or a custom template defined by you. - Optionally, the reports can be immediately opened - with the default application (set in the main GNOME - Desktop Preferenes - Advanced - Preferred - Applications dialog). - + Optionally, the reports can be immediately opened + with the default application. + + The options used in reports are persistent: each report + remembers its options used last time. + - - - Books - Currently, the only available report under this category - is the Book Report. - - The Book Report creates a single document (i.e. a Book) - containing a collection of graphical and textual reports. - Consequently, this allows for a very rich set of documents - that &app; can produce. - - - When Book Report is selected, the following book configuration - dialog appears: - - -
- Book Report dialog - - - Shows Book Report dialog. -
- - - The Book name text entry field is used to - save the book (a set of configured selections) for future use. - The top pane lists the items available for inclusion in the - book. The bottom pane lists the currently selected items in - the order they will appear in the book. - - The horizontal set of buttons by the Book - name field operates on the whole book. Click - the Clear button to clear all items from - the current book. Click the Save button to - save the current book (under the name typed in - the Book name text entry field) for future use. - Note that saving the book also saves the configuration for each item. - Click the Open button to load - the book from the list of previously saved books. Finally, click the - Edit books button to evoke the editable list of - available books. - - The vertical set of buttons to the right of the bottom pane - operates on the - selected book item. Click the Add button to - add selected item from the available list to the current book. Click - the Remove button to remove an item from the - current book. Use Up and - Down to change the items order in the current - book. Click the Setup button to configure the - options of the selected item of the current book. - - - The configuration dialogs evoked by Setup - are item-specific. If you choose not to configure the item, sane - defaults will be used for all needed options. The common option for - almost all book items is the center person: the person on whom the - item is centered. Thanks to this option, you can create a book with - items centered on different people (e.g. your mom's and dad's - ancestors as separate chapters). By default, the center person is - set to the active person. - - Almost all items available for inclusion in the book are textual - or graphical reports, and are therefore available in the form of standalone - reports. The exception is the following items which are only available as - book items: - - - - Title Page - This item produces a customized Title page. You can - configure the text of title, subtitle, and the footer of the page. - An image can be optionally placed between the subtitle and the footer. - Because of its configurability, this item can be used to create - title pages for the whole book, its chapter, or even a single item. - - - - - Custom Text - This item produces a page with three paragraphs, each - containing custom text. The appearance of the text can be adjusted by - using custom styles. This item was meant to be used for epigraphs, - dedications, explanations, notes, and so forth. - - - - - - @@ -3163,7 +3214,14 @@ all changes are immediate. Web Page + + This category includes reports producing web sites + based on your data. + + + Generate Web Site + This report generates web pages, either for a selected individual (active person) or a set of individuals. The options for this report are broken down into contents, privacy, and advanced @@ -3177,6 +3235,17 @@ all changes are immediate. information. Finally, the advanced options allow you to include the optional &app; ID, create a GENDEX index, and specify the extension of the resulting files. + + + + Narrative Web Site + This report is an alternative web site generator, + producing the narrative set of web pages. It is still in development, + with the goal of producing a more complete, better looking, and easily + adjustable web site. + + + @@ -3216,15 +3285,23 @@ all changes are immediate. This tool compares events across the selected group of people. The people for this comparison are chosen with the use of custom filters. The custom filters can be created in the Custom Filter - Editor (see ). The resulting table produced - by this tool can be saved as a spreadsheet. + Editor (see ) that can be evoked by clicking + the Custom Filter Editor button. The resulting + table produced by this tool can be saved as a spreadsheet. + Interactive descendant browser This tool builds a tree with the active person being the root. Children branch from their parents in the usual manner. Use this tool for a quick glance of a person's descendants. - + + + Double-clicking on tree node will bring up the Edit + Person dialog allowing to view or modify the personal data. + + + @@ -3234,11 +3311,15 @@ all changes are immediate. Database Processing This section contains tools which may modify your database. - The modifications will only be performed upon your explicit consent. The tools from this section are used mostly for finding and correcting errors in the data. The following database processing tools are currently available in &app;: + + The modifications will only be performed upon your explicit consent, + except for the automatic fixes performed by Check and repair + database tool. + Check and repair database @@ -3273,7 +3354,9 @@ all changes are immediate. Extract information from names This tool searches the entire database and attempts to extract titles and nicknames that may be embedded in a person's - Given name field. + Given name field. If any information could be + extracted, the candidates for fixing will be presented in the table. + You may then decide which to repair as suggested and which not to. @@ -3283,6 +3366,16 @@ all changes are immediate. + Fix capitalization of family names + This tool searches the entire database and attempts + to fix the capitalization of family names. The aim is to have + conventional capitalization: capital first letter and lower case + for the rest of the family name. If deviations from this rule + are detected, the candidates for fixing will be presented in the table. + You may then decide which to repair as suggested and which not to. + + + Rename personal event types This tool allows all the events of a certain name to be renamed to a new name. @@ -3299,6 +3392,42 @@ all changes are immediate. + + + Debug + This section contains debugging tools that are not of general + interest for many of the users of &app;. If you're not interested in + debugging or developing &app; you may safely skip this section. + + + + Python evaluation window + Enter expression into the Evaluation + Window, get the output in Output Window. + Any errors should end up in the Error Window. + + + + Reload plugins + Makes an attempt to reload all plugins. + + + This tool is itself a plugin, but it will not reload itself! + + + + + + Show uncollected objects + Provides the window listing all uncollected objects. + Depending on the system settings, recently abandoned GUI objects + may still be uncollected. + + + + + + Utilities @@ -3309,10 +3438,9 @@ all changes are immediate. database, but they will not modify your existing data. The following utilities are currently available in &app;: - - - Custom Filter Editor - The Custom Filter Editor builds custom filters + + Custom Filter Editor + The Custom Filter Editor builds custom filters that can be used to select people included in reports, exports, and other tools and utilities. This is in fact a very powerful tool in genealogical analysis. @@ -3327,6 +3455,10 @@ all changes are immediate. automatically saved along with your database and will be available with subsequent sessions of &app;. + The changes made to the filters only take effect when you + click the Apply and close button. + + Clicking the Add... button invokes the following Define filter dialog: @@ -3345,15 +3477,19 @@ all changes are immediate. identify this filter in the future into the Comment field. Add as many rules to the Rule list as you would like to your filter using Add... button. - Check Return values that do not match the filter rules - (invert) to negate the filter rule (e.g. inverting "has a - common ancestor with I1" rule will match everyone who does not have a - common ancestor with that person). If the filter has more than one rule, + If the filter has more than one rule, select one of the Rule operations. This allows you to choose whether all rules must apply, only one (either) rule must apply, or exactly one (either) rule must apply, in order for the filter to generate a match. If your filter has only one rule, this selection has no effect. + + + Check Return values that do not match the filter + rules to invert the filter rule. For example, inverting + "has a common ancestor with I1" rule will match everyone who does not + have a common ancestor with that person). + Clicking the Add... button invokes the following Add Rule dialog: @@ -3379,13 +3515,69 @@ all changes are immediate. of the currently edited filter. Clicking Cancel will abort adding the rule to the filter. - Note that a filter you've already designed may be used as a rule + A filter you have already designed may be used as a rule for another filter. This gives you nearly infinite flexibility in custom-tailoring your selection criteria that can be later used in - most of the exports, reports and some of the tools (such as comparing - individual events). - + most of the exports, reports, and some of the tools (such as comparing + individual events). + + Scratch Pad + + This tool provides a temporary note pad to store + database records for easy reuse. In short, this is a sort of the + copy-and-paste functionality extended from textual objects to + other types of records used in &app;. + + + Scratch Pad makes extensive use of drag-and-drop technique. + + + To invoke Scratch Pad, either choose Tools + UtilitiesScratch + Pad or click the Paste + button on the toolbar. The following window will appear: + + +
+ Scratch Pad tool + + + Shows Add Scratch Pad tool. +
+ + + + Scratch pad supports addresses, attributes (both personal and + family), events (both personal and family), names, media objects + references, source references, URLs, and of course textual information + of notes and comments. To store any type of these records, simply drag + the existing record onto the Scratch pad from the corresponding + editor dialog. To reuse the record, drag it from the Scratch Pad + onlto the corresponding place in the editor, e.g. Address tab, + Attribute tab, etc. + + + Some objects are showing the link icon on the left. This + indicates that dragging such selection will produce a reference + to an existing object, not copy the object itself. + + For example, the media object file will not be duplicated. + Instead, the reference will be made to an existing media object, + which will result in the local gallery entry. + + + Scratch Pad storage is persistent within a single &app; + session. Closing the window will not lose the stored records. However, + exiting &app; will. + + + + + Other tools + + Generate SoundEx codes This utility generates SoundEx codes for the names of people in the database. Please visit the Relationship calculator - This utility calculates the relationship between - two people from the database. + This utility calculates and displays the relationship + of any person to the active person. Verify the database This utility allows you to verify the database based - on the set of criteria specified by you. This tool is different from - the previously described Check tool in the following. The Check tool + on the set of criteria specified by you. + + Difference between Verify tool and previously described + Check tool + The Check tool detects inconsistencies in the database structure. The Verify tool, however, is detecting the records that do not satisfy your particular - criteria. + criteria. For example, you may want to make sure that nobody in your database had children at the age of 98. Based on common sense, such a record would indicate an error. However, it is not a consistency error in the database. Besides, someone might have a child at the of - 98 (albeit this rarely happens). The Verify tool will display + 98 (although this rarely happens). The Verify tool will display everything that violates your criteria so that you can check whether the record is erroneous or not. The ultimate decision is yours. @@ -3421,6 +3616,7 @@ all changes are immediate. + diff --git a/gramps2/src/plugins/FilterEditor.py b/gramps2/src/plugins/FilterEditor.py index 9cca8b25e..ea52ebbac 100644 --- a/gramps2/src/plugins/FilterEditor.py +++ b/gramps2/src/plugins/FilterEditor.py @@ -337,7 +337,7 @@ class FilterEditor: def on_help_clicked(self,obj): """Display the relevant portion of GRAMPS manual""" - help_display('gramps-manual','tools-util') + help_display('gramps-manual','tools-util-cfe') def on_delete_event(self,obj,b): self.filterdb.save() @@ -490,7 +490,7 @@ class EditFilter: def on_help_clicked(self,obj): """Display the relevant portion of GRAMPS manual""" - help_display('gramps-manual','tools-util') + help_display('gramps-manual','tools-util-cfe') def on_delete_event(self,obj,b): self.close_child_windows() diff --git a/gramps2/src/plugins/ScratchPad.py b/gramps2/src/plugins/ScratchPad.py index 2408958b1..d82d4fdb7 100644 --- a/gramps2/src/plugins/ScratchPad.py +++ b/gramps2/src/plugins/ScratchPad.py @@ -845,7 +845,7 @@ class ScratchPadWindow: def on_help_clicked(self,obj): """Display the relevant portion of GRAMPS manual""" - help_display('gramps-manual','tools-util') + help_display('gramps-manual','tools-util-scratch-pad') def on_close_scratchpad(self,obj): self.remove_itself_from_menu() diff --git a/gramps2/src/plugins/SoundGen.py b/gramps2/src/plugins/SoundGen.py index f5c657189..a7b96197e 100644 --- a/gramps2/src/plugins/SoundGen.py +++ b/gramps2/src/plugins/SoundGen.py @@ -117,7 +117,7 @@ class SoundGen: def on_help_clicked(self,obj): """Display the relevant portion of GRAMPS manual""" - help_display('gramps-manual','tools-util') + help_display('gramps-manual','tools-util-other') def on_delete_event(self,obj,b): self.remove_itself_from_menu() diff --git a/gramps2/src/plugins/Verify.py b/gramps2/src/plugins/Verify.py index 4eda94504..d61c149c3 100644 --- a/gramps2/src/plugins/Verify.py +++ b/gramps2/src/plugins/Verify.py @@ -109,7 +109,7 @@ class Verify: def on_help_clicked(self,obj): """Display the relevant portion of GRAMPS manual""" - help_display('gramps-manual','tools-util') + help_display('gramps-manual','tools-util-other') def get_year(self,event_handle): """