From f1de6cc347cd54ac78493792da26a0d7ee17c8e2 Mon Sep 17 00:00:00 2001 From: Don Allingham Date: Sat, 17 Dec 2005 04:52:17 +0000 Subject: [PATCH] * src/gramps-manual/C/usuage.xml: updates svn: r5566 --- gramps2/ChangeLog | 1 + gramps2/doc/gramps-manual/C/mainwin.xml | 143 +++++------ gramps2/doc/gramps-manual/C/usage.xml | 301 +++++++++++------------- 3 files changed, 215 insertions(+), 230 deletions(-) diff --git a/gramps2/ChangeLog b/gramps2/ChangeLog index 6744f9948..c70049919 100644 --- a/gramps2/ChangeLog +++ b/gramps2/ChangeLog @@ -1,4 +1,5 @@ 2005-12-16 Don Allingham + * src/gramps-manual/C/usuage.xml: updates * src/gramps-manual/C/mainwin.xml: updates 2005-12-14 Don Allingham diff --git a/gramps2/doc/gramps-manual/C/mainwin.xml b/gramps2/doc/gramps-manual/C/mainwin.xml index e9fd42341..a6d056f8b 100644 --- a/gramps2/doc/gramps-manual/C/mainwin.xml +++ b/gramps2/doc/gramps-manual/C/mainwin.xml @@ -250,7 +250,7 @@ - + Shows column editor dialog. @@ -263,16 +263,18 @@ Filters - - Genealogical databases may contain huge numbers of people. - Since the long lists are hard for humans to manage, &app; - provides a convenient way to limit the scope of browsing by - using the filter. To save screen space, filter controls may - be hidden, depending on the state of - View Filter - menu item. - - + + + + Genealogical databases can contain information on many people, + families, places, and objects. It's therefore possible for a + View to can contain a long list of data that's difficult to + work with. &app; gives you a means for controlling this + condition by allowing you to filter a list to a more + manageable size. + + +
@@ -292,15 +294,37 @@ - When &app; opens a database, the filter is set to the - trivial filter called All people, - i.e. no filtering is in effect. To choose a filter, use the - pop-up Filter menu above the people's - list. Once the filter is chosen, click the - Apply button in the upper right - corner of the window. The filtering will take effect upon - clicking the Apply button. - + + When &app; opens a database, no filtering is in effect. In + People View, for example, all people in the database are + listed by default. To filter the list, go to + View Filter + . This will place a new menu just above the list + of People. Click on the double arrows of this menu to get a + pop-up list of all the criteria by which you can filter the + People listed. Choose a filter (for example, "Males" + or "People with children") and click + Apply. + + + + + Displaying the filter + + + To reduce screen clutter, the filter menu is hidden by + default. To display it, go to the + View Filter + menu. Please understand that even if the + filter menu is not displayed, filtering may still be in + effect. (Thus, we say that filtering is persistent.) If you + are unsure if your list is filtered, bring up the filter + menu (by going to View + Filter ) and check + if any filtering is set. + + + Example filter use @@ -313,27 +337,6 @@ - - Filtering is persistent - - Even if the filter controls are not displayed - ( View - Filter menu - item is unchecked), the filtering might still be in - place. In other words, the visibility of the filter - controls is not related to the actual filtering imposed - on the list. - - - This may be a cause of confusion, when you enable the - filtering and then remove the controls from the - display. If in doubt, enable the display of filter - controls by checking - View - Filter menu - item and check what kind of filtering is currently set. - - @@ -772,42 +775,43 @@ Places View - + - The Places View lists the geographical places in which the - events of the database took place. These could be places of - birth, death, and marriages of people, as well as their - home, employment, education addresses, or any other - conceivable reference to the geographical location. The - Places View lists the places' Name, - ID, Church Parish, - City, County, - State, and - Country. All of these columns can be - used for sorting by the usual sorting rules. The - Column Editor dialog may be used to - add, remove and rearrange the displayed columns. + The Places View lists the geographical places in which the + events of the database took place. These could be places of + birth, death, and marriages of people, as well as their + home, employment, education addresses, or any other + conceivable reference to the geographical location. The + Places View lists the places' Name, + ID, Church Parish, + City, County, + State, and + Country. All of these columns can be + used for sorting by the usual sorting rules. The + Column Editor dialog may be used to + add, remove and rearrange the displayed columns. - + -
- Places View - - - - - - - Shows Places View. - - - -
+
+ Places View + + + + + + + Shows Places View. + + + +
+ @@ -849,6 +853,5 @@ - diff --git a/gramps2/doc/gramps-manual/C/usage.xml b/gramps2/doc/gramps-manual/C/usage.xml index 32d82307e..f89aa36e9 100644 --- a/gramps2/doc/gramps-manual/C/usage.xml +++ b/gramps2/doc/gramps-manual/C/usage.xml @@ -23,9 +23,10 @@ Usage - As commonly encountered in everyday life, there is usually more - than one way to accomplish something in &app;. The alternatives to - some actions will therefore be listed as appropriate. + Now we turn to a detailed exploration of the day-to-day use of + GRAMPS. First, we should point out that GRAMPS often offers more + than one way to do the same task. We'll try to point out some of + these alternatives where appropriate. @@ -42,20 +43,17 @@ New . - You will then be prompted with the Create GRAMPS - database dialog asking to specify the name under - which the new database will be stored. The new database will be - created in the BSDDB format, with .grdb as - the default extension. - + You will then be asked to give the new database a name. + - Selecting file + &app; databases - This version does not require selecting a directory for the - database. Please select filename, as you would in any other - application. + &app; stores your data in Berkeley database, sometimes + known as BSDDB. These files have ".grdb" as + their default extension. The extension is automatically + added to your filename. @@ -75,59 +73,50 @@ or click the Open button on the Toolbar. - The Open database dialog will appear. + The Open database dialog will appear and + you'll see a list of files. If you don't see the file you're + looking for, make sure the All files filter is selected. (This + dialog has a "filetype" filter, meaning it may only be + showing files that have a certain extension.) - The filetype filter in the Open database - dialog allows you to display files of a certain type. If the - All files filter is selected (the default), - all the files will be shown. The type will be determined by the - extension of the selected filename. + To open a recently accessed database, choose + File Open Recent + and select the filename from the list. - - Selecting file - - - Unlike the version 1.0.X of &app;, this version does not - require selecting directory for the database. Please select - filename, as you would in any other application. - - - - If you do not have write permissions for the selected database, + If you do not have "write permissions" for the selected database, it will be opened in a Read Only mode. In this mode, the data may be viewed, but no changes will be made to the database. To indicate this mode, the title of the main window will be appended with (Read Only) text. + + + GRAMPS allows you to open certain databases that have not been + saved in GRAMPS' own file format. These include XML and GEDCOM + databases. But you should be aware that if the XML or GEDCOM + database is relatively large, you may encounter some performance + problems. These can be avoided by creating a new GRAMPS database + and importing your XML/GEDCOM data into it. + + Opening XML and GEDCOM databases - This version allows direct opening and editing of &app; XML - and GEDCOM databases. Please keep in mind that, unlike using - the native grdb format, these formats require holding all data - in memory. This leads to performance and memory consumption - problems which grdb was designed to solve. - - - - - While direct opening of a &app; XML or GEDCOM file is - convenient for a small database, it may prove burdensome for - large databases. If you experience this, please consider - creating a new native (grdb) database and importing your XML - or GEDCOM data into it. This will make accessing your data - much more efficient and quick. + XML and GEDCOM databases require all data to be held in + memory. GRAMPS' native grdb format does not. Thus, a database + with a grdb format can access data quicker and more efficiently. + GEDCOM Editing @@ -140,23 +129,6 @@ - - To open a recently opened database, choose - - - File - Open Recent - - - and select the filename from the list. You can also use - - - Actions - Recent Documents - - - from the GNOME Actions menu. - @@ -165,56 +137,41 @@ Saving a Database - A consequence of the new database backend is that the changes, - once approved by the user, are applied immediately. Once you - click OK in the Person, Family, Source, - Place, Media object, or Event editor, all the changes made to - this object are recorded in the database. No saving is - necessary, or even possible. + GRAMPS saves your changes as soon as you apply them. This + means, for example, that any time you click + OK when using GRAMPS, your changes are + immediately recorded and saved. There is no separate + "save" command (although there is a "save + as" command that we'll discuss below.) + - Choosing - - Edit - Undo - - allows you to undo the changes you made, one step at a time. + You can undo changes you've made by selecting + Edit + Undo . If you select + this command repeatedly, your most recent changes will be undone + one at a time. + + If you have made changes to your data, and would like to return + your database to the way it was when you opened it, select + FileAbandon changes + and quit. This just like quitting + without saving in other programs. - - Reverting the whole session - - - If you would like to revert the whole editing session, choose - FileAbandon - changes and quit. This will be - analogous to quitting without saving any changes in other - applications. - - - If you would like to save your database under a different name, - you can do so by choosing - - File - Save as... - - and specifying the name (and, optionally, format) of your new - database. + you can do so by choosing File + Save as... and + specifying the name (and, optionally, format) of your new + database. Note that "Save as" will allow you to + continuing editing the newly saved database. If this is not what + you want to do, you may wish to use the "Export" + command instead. - - "Save as" continues editing - - If you use the Save as... function, the - editing in the main window is performed on the newly made - copy. If this is not what you want to do, please consider - using Export... instead. - - @@ -223,40 +180,83 @@ Importing Data - Importing allows you to incorporate the data from other - databases into your currently open &app; database. Currently, - &app; can import data from the following formats: &app; database - (grdb), GEDCOM, &app; XML, &app; package, and GeneWeb. All of - these are available by choosing - - - File - Import - - and selecting an appropriate file. - + Importing allows you to bring data from other + genealogy programs into a &app; database Currently, + &app; can import data from the following formats: + + + + + Another &app; database (having the "grdb" file + extension), + + + + GEDCOM + + + &app; XML + + + &app; package + + + GeneWeb + + + + + Importing vs. opening + + Please recognize that importing a database is different from + opening a database. When you import, you are actually bringing + data from one database into a GRAMPS database. When you open a + file, you editing your original file. + + + - &app; database (grdb), &app; XML, and &app; package are all - native &app; formats in that there is no information loss - resulting from reading from and writing into these formats. + To import data, select File + Import . The + Import database dialog will open, asking you + to specify the file you wish to import. - - - &app; database (grdb) - - - The native &app; database format is a specific form of - Berkeley database (BSDDB) with special structure of data - tables. This format is binary and - architecture-dependent. It is very quick and efficient, - but not generally portable across computers with - different binary architecture (e.g. i386 vs alpha). - - - - + + + + Data loss with some formats + + It is important to note that the importing process is not + perfect for GEDCOM and GeneWeb databases. There is a chance + that some of the data in these databases will not be imported + into &app;. + + + + + + The &app; database (grdb), &app; XML, and &app; package are all + native &app; formats. There is no risk of information loss + when import or exporting to these formats. + + + + + &app; database (grdb) + + + The native &app; database format is a specific form of + Berkeley database (BSDDB) with special structure of data + tables. This format is binary and + architecture-dependent. It is very quick and efficient, + but not generally portable across computers with + different binary architecture (e.g. i386 vs alpha). + + + + &app; XML @@ -300,37 +300,18 @@ - - Opening vs importing - - The difference between opening &app; database (in any format) - and importing from &app; or GEDCOM database is that importing - incorporates all the data into your currently open database, - if any. In contrast, opening the database will switch from - editing your current data to editing another file. - - - - After choosing an import format, you will be prompted with the - Import database dialog asking you to - specify the file name from which to import. - - - Selecting file - - This version does not require selecting a directory for the - database. Please select filename, as you would in any other - application. - - + If you import information from another GRAMPS database, you will + see the progress of the operation in the progress bar of GRAMPS' + main window. + + + + If you import a GEDCOM database, you will see the import dialog + shown in . The information in + the dialog is updated as the import progresses. - - Upon starting the GEDCOM import, &app; will display the - following GEDCOM import dialog with the summary of the - information about the data. The information is updated as the - import progresses.