From 1c5ad3f57f34156bb957875ba4aeb583569d6519 Mon Sep 17 00:00:00 2001 From: Don Allingham Date: Sun, 18 Dec 2005 02:44:05 +0000 Subject: [PATCH] * doc/gramps-manual/C/usage.xml: updates * doc/gramps-manual/C/usage.xml: updates * doc/gramps-manual/C/mainwin.xml: updates svn: r5580 --- gramps2/ChangeLog | 7 +- gramps2/doc/gramps-manual/C/usage.xml | 693 +++++++++++++++----------- 2 files changed, 417 insertions(+), 283 deletions(-) diff --git a/gramps2/ChangeLog b/gramps2/ChangeLog index ed006fd28..b2fb811e6 100644 --- a/gramps2/ChangeLog +++ b/gramps2/ChangeLog @@ -1,9 +1,12 @@ +2005-12-17 Don Allingham + * doc/gramps-manual/C/usage.xml: updates + 2005-12-17 Alex Roitman * src/GrampsDbBase.py (transaction_commit): Typo. 2005-12-16 Don Allingham - * src/gramps-manual/C/usuage.xml: updates - * src/gramps-manual/C/mainwin.xml: updates + * doc/gramps-manual/C/usage.xml: updates + * doc/gramps-manual/C/mainwin.xml: updates 2005-12-14 Don Allingham * doc/gramps-manual/C/getstart.xml: updates diff --git a/gramps2/doc/gramps-manual/C/usage.xml b/gramps2/doc/gramps-manual/C/usage.xml index 290897b46..0e8bb37ed 100644 --- a/gramps2/doc/gramps-manual/C/usage.xml +++ b/gramps2/doc/gramps-manual/C/usage.xml @@ -321,14 +321,11 @@ - - Upon starting the &app; database or &app; package import, &app; - will display the progress in the progress bar of its main window. - - If a media file is not found during import, the following dialog - will prompt you for the possible actions: + If a media file is not found during import, you'll be prompted + to take one of the actions indicated in . @@ -353,35 +350,28 @@ - To remove the object corresponding to the missing file as - well as all the references to that object from various - database records, click the Remove - Object button. This will alter your database so - that it will be in a consistent state, but all the - references to the missing file will be gone. Use this option - if the file is irrevocably lost and there is no possibility - of ever replacing it. + If you don't have the missing file and have no possibility of + replacing it, click the Remove Object + button. This will remove the object that corresponds to the + missing file as well as all the references in the database to + that object. - To keep the reference to the object corresponding to the - missing file, click the Keep - Reference button. This will leave things as is, - i.e. in an inconsistent state. You could supply the missing - file later, in which case you will have to copy it into your - database directory. Choose this option if the replacement is - possible, but not available right now. + If you're not sure where the missing file is, but think you + still have it or may be able to find it, click the + Keep Reference button. If and when you + find the file, you can simply copy it into your database + directory and have access to it through &app;. - To supply the missing file during import, click the - Select File button. This will copy - the file you select in place of the missing file. No - references will be altered in the database, and it will be - in the consistent state. Use this option if the replacement - is readily available. + If you can supply the missing file during the import + operation, click the Select File + button. This will copy the file you select in place of the + missing file. No references will be altered in the database. @@ -402,28 +392,30 @@ Exporting Data Exporting allows you to share any portion of your &app; database - with other researchers as well as to make your database - completely portable to another computer. Currently, &app; can + with other researchers as well as to enable you to transfer your data to another computer. Currently, &app; can export data to the following formats: &app; database (grdb), &app; XML, GEDCOM, &app; package, Web Family Tree, and GeneWeb. + Export is saving a copy - Exporting will create another file with the copy of your data. - The database currently opened in your &app; window is NOT the - file saved by your export. Future editing of the currently - opened database will not alter the copy produced by the - export. + WheN you export, you are saving a copy of the currently opened + database. Exporting creates another file with a copy of your + data. Note that the database that remains opened in your GRAMPS + window is NOT the file saved by your export. Additional editing + of the currently opened database will not alter the copy + produced by the export. + To export data, choose File Export . - This will bring up the Export druid. Its + This will bring up the Export assistant. Its pages will guide you through the format selection (see ), file selection, and format specific export options (see
- Export druid: format selection + Export assistant: format selection @@ -445,34 +437,125 @@ width="500" depth="383" scale="75"/> - Shows format selection page of an Export druid + Shows format selection page of an Export assistant
- GEDCOM export + Exporting into the GEDCOM format - GEDCOM export options allow you to fine tune your export (see - ). Choose the desired - Encoding of the exported file. Use the - Filter pop-up menu to limit the scope of - the export according to the stated rule. Use the - Target menu to select the desired GEDCOM - dialect. Select your copyright statement from the - Copyright menu. Check Do not - include records marked private to disable the - output of private records. Check Restrict data on - living people to limit living people's data to - family ties. With this option, information concerning birth, - death, addresses, various events, etc. will be omitted in the - exported GEDCOM file. If this option is selected, you can - further choose whether to use the word "Living" as first name, - exclude notes, and exclude sources for the living - people. Check Reference images from path - to tell &app; to use the specific path for your images when - writing image references in GEDCOM. + + &app; allows you to export a database into the common GEDCM + format. It provides options that allow you to fine tune your + export (see ). + + + + Encoding + + + Since different languages use different characters, it is + important to tell a GEDCOM file what character set is used. + The two formats traditionally accepted are ASCII and ANSEL. + Since all ASCII characters are valid ANSEL characters, + GRAMPS does not provide an option for ASCII. + + + Because ANSEL is not commonly used, some genealogy programs + will accept the ANSI (more commonly know as ISO-8859-1) and + Unicode character sets. Only select ANSI or Unicode if you + know any program that attempts to read the GEDCOM file will + understand these character sets. + + + + + Filter + + + The filter allows you to export a limited amount of data, + based on the criteria you select. + + + + + + Target + + + While GEDCOM is a standard, not every program implements + it in the same way. This can lead to data loss. &app; can + reduce the data loss in some cases. You can tell &app; + what program is the target, and &app; will customize the + exported file for that program. If your program is not + listed, choose the "GEDCOM 5.5 Standard". + + + + + + Copyright + + + Allows you to select a statement to describe your Copyright + claim. + + + + + + No not include records marked private + + + Check this box to prevent private records from being + included in the exported file. + + + + + + Restrict data on living people + + + Check this box to limit the information exported for living + people. This means that all information concerning their + birth, death, addresses, significant events, etc., will be + omitted in the exported GEDCOM file. If you choose this + option, you will be given additional options to limit + further the data on living people. For example, you can + choose to substitute the word "Living" for the + first name; you can exclude notes; and you can exclude + sources for living people. + + + Sometimes, it is not always obvious from the data if someone + is actually alive. &app; uses an advanced algorithm to try + to determine if a person could still be alive. Remember, + &app; is making its best guess, and it may not always be + able to guess correctly all the time. Please double check + your data. + + + + + + Reference images from path + + + Check this box to tell GRAMPS to use the specific path for + your images when writing image references in GEDCOM. + + + This option allows specify where your image files are + located. This is useful when you are transfering your GEDCOM + file from one computer to another. It tells the program + that is importing the data where your images are. + + + +
Export druid: GEDCOM options @@ -490,6 +573,8 @@
+ + Export into &app; formats @@ -497,10 +582,11 @@ &app; database (grdb) export - Exporting to the native format will simply make a copy - of your data under another name. It also may be useful - if you have directly opened XML or GEDCOM file and - would like to save it as the grdb file. + Exporting to the &app; native format will simply make a + copy of your data under another name. Exporting to this + format can also be useful if you have directly opened + an XML or GEDCOM file and would like to save it as the + grdb file. @@ -519,12 +605,11 @@ &app; package export - Exporting to &app; package will create a gzip-compressed - tar 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; . + Exporting to the GRAMPS package format will create a + compressed file that contains the database and copies of + all associated media files. This is useful if you want to + move your database to another computer or to share it with + someone. @@ -556,78 +641,13 @@ - If a media file is not found during export, the following - dialog will prompt you for the possible actions: + If a media file is not found during export, you will see the + same Missing Media dialog you encounter + with GEDCOM export. - - -
- Missing Media dialog - - - - - - - Shows Missing Media dialog. - - - -
- - - - - - - To remove the object corresponding to the missing file - as well as all the references to that object from - various database records, click the Remove - Object button. This will alter your database - so that it will be in the consistent state, but all the - references to the missing file will be gone. Use this - option if the file is irrevocably lost and there is no - possibility of ever replacing it. - - - - - To keep the reference to the object corresponding to the - missing file, click the Keep - Reference button. This will leave things as - is, i.e. in the inconsistent state. You could supply - the missing file later, in which case you will have to - copy it into your database directory. Choose this option - if the replacement is possible, but not available right - now. - - - - - To supply the missing file during export, click the - Select File button. This will - copy the file you select in place of the missing - file. No references will be altered in the database, and - it will be in the consistent state. Use this option if - the replacement is readily available. - - - - - To automatically use the selection made in this dialog - for all missing media files, check the Use - this selection for all missing media files - box. This will remember your choice and use it for all - media files missing during this export, so that no - further dialogs will be presented. Use this option if - you anticipate many missing files and want to deal with - all of them in the same manner. - - - + Export into other formats @@ -635,11 +655,11 @@ Web Family Tree - Exporting to Web Family Tree will create the text file - suitable as an input for the WFT program. Specific - options include filter selection and the ability to - restrict data on living people, that is to limit living - people's data to family ties. + Exporting to Web Family Tree will create atext file + that can be used by the Web Family Tree program. + Export options include filter selection and the ability + to limit data on living people to that of their family + ties. @@ -651,7 +671,7 @@ a popular web genealogy format. To find out more about GeneWeb and its format, visit this site. + type="http">http://cristal.inria.fr/~ddr/GeneWeb/en/. @@ -670,129 +690,219 @@ + Editing Data: Quick Start - - Editing any portion of data allows you to amend and/or modify - information stored in the database. The available editing - options include editing personal data, relationship data, data - about children and parents, and information about sources, - places, and media objects used in the database. In short, any - data stored in the database can be edited! Adding a new piece - of information is the process of creating an appropriate empty - data structure and subsequently editing that empty structure. - + - This section refers mainly to the menu items and buttons as - the main way of interacting with &app;. In addition to this, - &app; provides an extensive set of key bindings. The detailed - reference to the key bindings is found in the - . - + + This section is designed to give you the basic knowledge necessary + to start putting your genealogical information into GRAMPS. It + will explain how to enter people into the database and how to + specify their family relationships. (A more detailed explanation + will follow in the section entitled .) + + + + First, let's identify the types of information you can enter into + your GRAMPS database. These include: + + + + + + + Personal information about an individual (names, addresses, + birth and death dates, etc.) + + + + + Information about an individual's relationships (marriages, + divorces, civil unions, etc.) + + + + + Information about an individual's parents and children + + + + + Sources that document your research + + + + + + Keybindings + + In addition to interacting with GRAMPS through menu items and + buttons, you can use its extensive set of + "keybindings." For more information, see . + + + + + Now let's take a quick look at how you can enter and edit these + various types of information. + + - To Add a Person + To Add or Edit a Person To add a person to the database, switch to the People View () and then click the Add on the toolbar. Enter any data you know about this person into the Edit - Person Dialog (see - for details). To edit information about a person already + Person dialog (see + for details). + + To edit information about a person already present in the database, select an entry you would like to view/modify, and then click the Edit icon on the toolbar. - - You can also use Add... and - Edit... menu items available under the - Edit. Or you can right-click on the - person and select Add... or - Edit... from the invoked context menu. - + + + Alternate ways of adding or editing a person + + You can also use Add... and + Edit... menu items available under the + Edit. Or you can right-click on the + person and select Add... or + Edit... from the context menu that pops + up. + + + + To Specify a Relationship - To specify a relationship, first switch to the Family View - (). Then click one of the two top - buttons on the right of the spouse box. The topmost button - adds a new person to the database and to the relationship, - while the second top button adds a person that is already in a - database to the relationship. - - - If using the second button, select the spouse/partner from the - list and specify the relationship using the menu at the - bottom. If necessary, you can add a person to the list by - clicking the + button. &app; will - filter the displayed list of people based on the apparent - relationship possibility. Specifically, shown are the people who - could possibly be in relationship with the active person, as - judged by the available birth and death information. To - override this and display all people from the database, check - the Show all box. + To specify a relationship, select the person for whom the + relationship applies. Switch to the Family View + () and you'll see this individual + indicated as the "Active person". + + + + Now a question: Does the person who will form the relationship + with the Active person already exist in the database? If yes, + click the middle button to the right of the Spouse box. You'll + then be able to browse through the list of people in the + database to select the one you want. If not, click the topmost + button to the right of the Spouse box. This will allow you to + add a new person to the database and to specify the + relationship this person has to the Active person. + + + + Filtering + + By default, GRAMPS filters the displayed list to show only + those people who could theoretically have a relationship with + the Active Person. That is, GRAMPS only shows those people + whose birthdates and death dates fit within the lifetime of + the Active Person. If you wish, you can add a person to the + list by clicking the + button. To + completely override the filter and display all people from the + database, check the Show all box. + + + - To edit information about a relationship already present in - the database, move the mouse over the - Spouse box and double-click. If the - relationship lists has more than one person, you can specify - the preferred spouse/partner by selecting an appropriate item - from the context menu available upon right-clicking into the - spouse box. Also, most of the above function are available - from the items of this context menu. + To edit an existing relationship, double-click in the Spouse + box. If there is more than one relationship in the list, you can + select the spouse or partner you want from the list before + double-clicking. + + + Alternate ways of editing relationships. + + Most of the functions described above are also available in + the context menu that pops up when you right-click. + + + To Specify Parents - To specify parents of an active person, first switch to the - Family View (). Then click the - + button on the right of the active - person's parents list box. Select the parents from two lists - and specify the parents' relationships to the active person - using menus at the bottom. You can also specify parents' - relationship to each other. If necessary, you can add a - person to the list by clicking the - Add... button. - - - The top and bottom lists contain males and females, - respectively. By default, &app; will limit both lists to - people who could possibly be the parents (judged by the date - of birth) of the active person. To override this, check the - Show all box for each list. + + To specify parents of a person, highlight that individual in + the People View and then switch to the Family View (). Your selected person will be + indicated as the Active person. Click the + + button to the right of the Active + person's parents list box. This will bring up the Choose + Parents dialog. You will see three sections, one for Father, + one for Mother, and one for specifying the relationships + between everyone. + + + + If the Father and Mother of the Active person are already stored + in your database, you can scroll through the lists and make your + selections. If they are not in the database, you can click + + to add them. + + + Filtering + + By default, GRAMPS will limit both lists to people who could + possibly be the parents (judged by the date of birth) of the + Active person. To override this, check the Show all box for + each list. + + + - To specify parents of the active person's spouse, switch to - the Family View and then click the + - button on the right of the spouse's parents list box. To edit - information about parents already present in the database, - move the mouse over the corresponding parents' box and - double-click. All these functions can also be performed by - right-clicking on the parents' box and selecting an - appropriate item from the context menu. + To specify parents of the Active person's spouse, switch to + Family View and then click the + button + to the right of the Spouse's parents list box. + + To edit information about parents who are already present in the + database, move the mouse over the corresponding parents' box and + double-click. + + + Alternate ways of specifying parents + + These functions can also be performed by right-clicking on the + parents' box and using the context menu that pops up. + + + + + To Specify Children - To specify children of an active person, switch to the Family + To specify children of an Active person, switch to the Family View () and then click either the - second or the third button from the top on the right of the + second or the third button from the top righht of the children list box. The second button adds a child to the database and to the family, while the third button adds a - child already present in the database to the family. + child to the family who is already present in the database. If using the third button, select a child from the list and specify the child's relationship with father and mother using - menus at the bottom. If necessary, you can add a person to the + menus at the bottom. If you want, you can add a person to the list by clicking the Add... button. By default, &app; will limit the lists to people who could possibly be the child (judged by the date of birth) of the @@ -800,72 +910,93 @@ all box. - The relationship of the child to the parents can be modified - by selecting an appropriate item from the context menu - available upon right-clicking into the children box. Also, - most of the above function are available from the items of - this context menu. + The relationship of the child to the parents can be modified by + right-clicking in the children's box and using the context menu + that pops up. Again, most of the above functions are available + through this context menu. + - To Add Images + Adding Photos and Other Media Objects - You can add images (as well as other media objects) to - individual people, events, sources, places, as well as images - generally related to the database (e.g. group family photos). - - - To add images related to a single person, switch to the People - View (), select a person, and - then click the Edit icon on the toolbar - to invoke the Edit Person Dialog - (). Then, select the - Gallery tab, and click the - + button to invoke the Select - a media object dialog. Type the filename or select - a file with the image, then provide a title for that - image. Keep adding images until you are done. - - - To add images related to a relationship (e.g. marriage), - switch to the Family View () and - then double-click on the Spouse box invoke the - Marriage/Relationship editor - dialog. Select the Gallery tab and click - the + button to add an image. - - - To add images related to a source or a place, first switch to - the Sources View () or Places - View (), respectively. Then select - the appropriate source or place and then either double-click - on it or click the Edit icon on the - toolbar to invoke the Source Editor (or - Place Editor) dialog. Select the - Gallery tab and click the - + button to add an image. - - - Finally, to add images that are generally related to the - database but not limited to any person, relationship, source, - or place in particular, switch to the Media View (). Then click the - Add icon on the toolbar to add an - image. If you have already added any images to any individual - galleries, you will also find them listed in the Media View. + You can add photos and other media objects to individual people, + events, sources, and places. You can also add images that might + not be limited to a single person or event (for example, group + family photos). + + If you want to add an image to a single person, switch to the + People View (), select a + person, and then click the Edit icon on + the toolbar. This will bring up the Edit + Person dialog (). Next, select the + Gallery tab, and click the + + button to call up the Select + a media object dialog. Type a filename or browse to + find the image file you want and then provide a title for that + image. Keep adding images until you are done. + + To add images related to a relationship (for example, a + marriage), switch to the Family View () and double-click on the Spouse box. This + calls up the Marriage/Relationship editor + dialog. Select the Gallery tab and click + the + button to add an image. + + To add images related to a source or a place, first switch to + the Source View () or Place View + (). Select the source or place you + want and then either double-click on it or click the + Edit icon on the toolbar. Select the + Gallery tab and click the + + button to add an image. + + + + Finally, to add images that you want to include in the database, + but hare are not limited to any particular person, relationship, + source or place, switch to the Media View (). Then click the + Add icon on the toolbar to add an + image. If you have already added any images to any individual + galleries, you will also find them listed in the Media View. + + + Alternate way of adding images to galleries + + + An image can always be added to any gallery by using + drag-and-drop. Items can be dragged from the Media View, any + gallery, the desktop, the file manager or a web browser and + dropped on the target gallery, adding the image to the + gallery. + + + + + In any gallery, you can also use the - Edit and - - buttons to edit image information and to remove the image - reference from that gallery. Note that in all galleries - removing the reference to the image does not remove the image - from the database. To completely remove the image from the - database, delete it from Media View by first selecting it and - then clicking the Remove icon on the - toolbar. + Edit to edit image information and the + - button and to remove the image + reference from that gallery. + + + Removing an image from a gallery + + + In all galleries, removing the reference to the image does + not remove the image from the database, but just from the + gallery. To completely remove the image from the database, + delete it from Media View by first selecting it and then + clicking the Remove icon on the + toolbar. + + @@ -874,8 +1005,8 @@ To Edit Sources and Places To add a source or a place to the database, switch to the - appropriate Sources View () or - Places View (). Then click the + appropriate Source View () or + Place View (). Then click the Add icon on the toolbar to add a source/place. Enter the information into the Source Editor (or Place Editor)