diff --git a/gramps2/ChangeLog b/gramps2/ChangeLog index f46009bf1..5936d640c 100644 --- a/gramps2/ChangeLog +++ b/gramps2/ChangeLog @@ -1,3 +1,10 @@ +2005-09-23 Don Allingham + * doc/gramps-manual/C/faq.xml: more updates + * doc/gramps-manual/C/getstart.xml: more updates + * doc/gramps-manual/C/gramps-manual.xml: more updates + * doc/gramps-manual/C/mainwin.xml: more updates + * doc/gramps-manual/C/usage.xml: more updates + 2005-09-24 Don Allingham * src/WriteGedcom.py: handle patronymics diff --git a/gramps2/doc/gramps-manual/C/faq.xml b/gramps2/doc/gramps-manual/C/faq.xml index 90c79c745..8934f9fc9 100644 --- a/gramps2/doc/gramps-manual/C/faq.xml +++ b/gramps2/doc/gramps-manual/C/faq.xml @@ -1,5 +1,3 @@ - - - Frequently Asked Questions - This appendix contains the list of questions that frequently come - up in mailing list discussions and forums. This list is by no means - complete. If you would like to add questions/answers to this list, - please email your suggestions to gramps-devel@lists.sf.net - - - - - - What is &app;? - &app; is the Genealogical Research and Analysis - Management Program System. In other words, it is a personal genealogy - program letting you store, edit, and research genealogical data using - the powers of your computer. - - - - Where do I get it and how much does it cost? - -&app; can be downloaded from http://sf.net/projects/gramps at no charge. -&app; is an Open Source project covered by the GNU General Public License. -You have full access to the source code and are allowed to distribute the -program and source code freely. - - - - Does it work with Windows (tm)? - -No. &app; uses the GTK and GNOME libraries. While the GTK libraries -have been ported to Windows, the GNOME libraries have not. -This, however, may change in the future. - - - - Does it work with the Mac? - -The Fink project has ported -some older versions of -&app; to OSX (tm). The Mac OSX port is not directly supported by -the &app; project, primarily because none of the &app; developers -have access to Mac OSX and because OSX is not Free Software. - -This version of &app; (&appversion;) does not appear to have been -ported by the Fink project. Please contact the Fink project for more -information. - - - - Does it work with KDE? - -Yes, as long as the required GNOME libraries are installed. - - - - Do I really have to have GNOME installed? - Yes, but you do not have to be running the GNOME desktop. - - - - What version of GNOME do I need? - -This version of gramps requires GNOME 2.8.0 or higher. -Previous versions in 1.0.x series required GNOME 2.0. - - - - Is &app; compatible with - other genealogical software (GenApps)? - -&app; makes every effort to maintain compatibility with GEDCOM, the general -standard of recording genealogical information. We have import and export -filters that enable &app; to read and write GEDCOM files. - - -It is important to understand that the GEDCOM standard is poorly implemented -- -virtually every genealogical software has its own "flavor" of GEDCOM. As we -learn about new flavor, the import/export filters can be created very quickly. -However, finding out about the unknown flavors requires user feedback. -Please feel free to inform us about any GEDCOM flavor not supported by &app;, -and we will do our best to support it! - - - - Can &app; read files created by GenApp X? - See above. - - - - Can &app; write files readable by GenApp X? - See above. - - - - Can &app; print a genealogical tree for my family? - -Yes. Different people have different ideas of what a genealogical tree is. -Some think of it as a chart going from the distant ancestor and listing -all his/her descendants and their families. Others think it should be a -chart going from the person back in time, listing the ancestors and their -families. Yet other people think of a table, text report, etc. - - -&app; can produce any of the above, and many more different charts and -reports. Moreover, the plugin architecture enables users (you) to create -their own plugins which could be new reports, charts, or research tools. - - - - In what formats can &app; output its reports? - -Text reports are available in HTML, PDF, AbiWord, KWord, LaTeX, RTF, and -OpenOffice formats. Graphical reports (charts and diagrams) are available in -PostScript, PDF, SVG, OpenOffice, and GraphViz formats. - - - - Is &app; compatible with the Internet? - -&app; can store web addresses and direct your browser to them. It can import -data that you download from the Internet. It can export data that you could -send over the Internet. &app; is familiar with the standard file formats -widely used on the Internet (e.g. JPEG, PNG, and GIF images, MP3, OGG, and -WAV sound files, QuickTime, MPEG, and AVI movie files, etc). Other than that, -there is little that a genealogical program can do with the Internet. - - - - Can I create custom reports/filters/whatever? - -Yes. There are many levels of customization. One is creating or modifying -the templates used for the reports. This gives you some control over -the fonts, colors, and some layout of the reports. You can also use &app; -controls in the report dialogs to tell what contents should be used for a -particular report. In addition to this, you have an ability to create your -own filters -- this is useful in selecting people based on criteria set -by you. You can combine these filters to create new, more complex filters. -Finally, you have an option to create your own plugins. These may be new -reports, research tools, import/export filters, etc. This assumes some -knowledge of programming in Python. - - - - What standards does &app; support? - -The nice thing about standards is that there never is a shortage of -them. &app; is tested to support the following flavors of GEDCOM: -GEDCOM5.5, Brother's Keeper, Family Origins, Family Tree Maker, Ftree, -GeneWeb, Legacy, Personal Ancestral File, Pro-Gen, Reunion, and -Visual Genealogie. - - - - What is the maximum database - size (bytes) &app; can handle? - -&app; has no hard limits on the size of a database that it can handle. -Starting with this release, &app; no longer loads all data into memory, -which allows it to work with a much larger database than before. -In reality, however, there are practical limits. The main limiting factors -are the available memory on the system and the cache size used for BSDDB -database access. With common memory sizes these days, &app; should have -no problem using databases with tens of thousands of people. - - - - How many people can &app; database handle? - -We have found that on a typical system, &app; tends to bog down after the -database has around 150,000 people. Again, this is dependent on how much -memory you have. - - - - Why is &app; running so slowly? - It does not anymore! Just try out the current - version, &appversion;. - - - - My database is really big. - Is there a way around loading all the data into memory? - -Starting with this release, &app; no longer loads all data into memory, -which allows it to work with a much larger database than before. - - - - I want to rerun the Startup dialog (druid). - How do I do this? - - &app; keeps a flag in the GNOME configuration database to indicate - that the startup dialog has been run. To cause &app; to rerun this, - the flag needs to be reset. This can be done with the following - command: - - gconftool-2 -u /apps/gramps/behavior/startup - - - - Why are non-latin characters displayed - as garbage in PDF/PS reports? - This is a limitation of the builtin fonts of PS - and PDF formats. To print non-latin text, use the Print... - in the format selection menu of the report dialog. This will use - the gnome-print backend, which supports PS and PDF creation, - as well as direct printing. - - If you only have latin text, the PDF option will produce - a smalled PDF compared to that created by gnome-print, simply because - no font information will be embedded. - + + Frequently Asked Questions + + + This appendix contains the list of questions that frequently come + up in mailing list discussions and forums. This list is by no + means complete. If you would like to add questions/answers to this + list, please email your suggestions to gramps-devel@lists.sf.net + + + + + What is &app;? + + + &app; is the Genealogical Research and Analysis Management + Program System. In other words, it is a personal genealogy + program letting you store, edit, and research genealogical + data using the powers of your computer. + - + - Why can I not add/remove/edit columns to the lists - in People View and Family View? - Now you can! Just try out the current - version, &appversion;. - - + + Where do I get it and how much does it cost? + + + &app; can be downloaded from http://sf.net/projects/gramps at no + charge. &app; is an Open Source project covered by the GNU + General Public License. You have full access to the source + code and are allowed to distribute the program and source + code freely. + + + - I would like to contribute to &app; by writing - my favorite report. How do I do that? - -The easiest way to contribute to reports, filters, tools, etc. is to copy -an existing &app; report, filter, or tool. If you can create what you want -by modifying existing code -- great! If your idea does not fit into the logic -of any existing &app; tool, the following page may provide some help in writing your -own plugin from scratch. + + Does it work with Windows (tm)? + + + No. &app; uses the GTK and GNOME libraries. While the GTK + libraries have been ported to Windows, the GNOME libraries + have not. This, however, may change in the future. + + + -If you need more help or would like to discuss your idea with us, -please do not hesitate to contact us at gramps-devel@lists.sf.net - + + Does it work with the Mac? + + + + The Fink project has ported + some older versions of + &app; to OSX (tm). The Mac OSX port is not directly supported by + the &app; project, primarily because none of the &app; developers + have access to Mac OSX and because OSX is not Free Software. + + This version of &app; (&appversion;) does not appear to have been + ported by the Fink project. Please contact the Fink project for + more information. + + Some people have had success using the DarwinPorts instead of the + Fink project. + + + - -To test your work in progress, you may save your plugin under -$HOME/.gramps/plugins directory and it should -be found and imported on startup. -The correctly written plugin will register itself with &app;, create menu -item, and so on. + + Does it work with KDE? + + + Yes, as long as the required GNOME libraries are installed. + + + - -If you are happy with your plugin and would like to contribute your code -back to the &app; project, you are very welcome to do so by contacting us -at gramps-devel@lists.sf.net - - + + Do I really have to have GNOME installed? + + + Yes, but you do not have to be running the GNOME desktop. + + + + + What version of GNOME do I need? + + + This version of gramps requires GNOME 2.8.0 or higher. + Previous versions in 1.0.x series required GNOME 2.0. + + + - I found a bug and I want it fixed right now! - What do I do? - -The best thing you can do is to fix the bug and send the patch to -gramps-devel@lists.sf.net :-) + + Is &app; compatible with other genealogical software? + + + &app; makes every effort to maintain compatibility with + GEDCOM, the general standard of recording genealogical + information. We have import and export filters that enable + &app; to read and write GEDCOM files. + + It is important to understand that the GEDCOM standard is + poorly implemented -- virtually every genealogical software + has its own "flavor" of GEDCOM. As we learn about new + flavor, the import/export filters can be created very + quickly. However, finding out about the unknown flavors + requires user feedback. Please feel free to inform us about + any GEDCOM flavor not supported by &app;, and we will do our + best to support it! + + + -A good bug report would include: + + Can &app; read files created by other genealogy programs? + + See above. + + - + + Can &app; write files readable by other genealogy programs? + + See above. + + - -Version of gramps you were using when you encountered the bug -(available through Help -About menu item). - + + Can &app; print a genealogical tree for my family? + + + Yes. Different people have different ideas of what a + genealogical tree is. Some think of it as a chart going + from the distant ancestor and listing all his/her + descendants and their families. Others think it should be a + chart going from the person back in time, listing the + ancestors and their families. Yet other people think of a + table, text report, etc. + + &app; can produce any of the above, and many more different + charts and reports. Moreover, the plugin architecture + enables users (you) to create their own plugins which could + be new reports, charts, or research tools. + + + - -Language under which gramps was run -(available by executing - echo $LANG -in your terminal). - + + In what formats can &app; output its reports? + + + Text reports are available in HTML, PDF, AbiWord, KWord, + LaTeX, RTF, and OpenOffice formats. Graphical reports + (charts and diagrams) are available in PostScript, PDF, SVG, + OpenOffice, and GraphViz formats. + + + - -Symptoms indicating that this is indeed a bug. - + + Is &app; compatible with the Internet? + + + &app; can store web addresses and direct your browser to + them. It can import data that you download from the + Internet. It can export data that you could send over the + Internet. &app; is familiar with the standard file formats + widely used on the Internet (e.g. JPEG, PNG, and GIF images, + MP3, OGG, and WAV sound files, QuickTime, MPEG, and AVI + movie files, etc). Other than that, there is little that a + genealogical program can do with the Internet. + + + - -Any Traceback messages, error messages, warnings, etc, -that showed up in your terminal or a in separate traceback window. - + + Can I create custom reports/filters/whatever? + + + Yes. There are many levels of customization. One is creating + or modifying the templates used for the reports. This gives + you some control over the fonts, colors, and some layout of + the reports. You can also use &app; controls in the report + dialogs to tell what contents should be used for a + particular report. In addition to this, you have an ability + to create your own filters -- this is useful in selecting + people based on criteria set by you. You can combine these + filters to create new, more complex filters. Finally, you + have an option to create your own plugins. These may be new + reports, research tools, import/export filters, etc. This + assumes some knowledge of programming in Python. + + + - + + What standards does &app; support? + + + The nice thing about standards is that there never is a + shortage of them. &app; is tested to support the following + flavors of GEDCOM: GEDCOM5.5, Brother's Keeper, Family + Origins, Family Tree Maker, Ftree, GeneWeb, Legacy, Personal + Ancestral File, Pro-Gen, Reunion, and Visual Genealogie. + + + -Most problems can be fixed quickly provided there is enough information. -To ensure this, please follow up on your bug reports. In particular, if you -file a bug report with sf.net bug tracker, PLEASE log in to sf.net before -filing -(register your free account if you don't have one). Then we will have a way -of contacting you should we need more information. If you choose to file your -report anonymously, at least check every so often whether your report page -has something new posted, as it probably would. + + What is the maximum database size (bytes) &app; can handle? + + + &app; has no hard limits on the size of a database that it + can handle. Starting with this release, &app; no longer + loads all data into memory, which allows it to work with a + much larger database than before. In reality, however, + there are practical limits. The main limiting factors are + the available memory on the system and the cache size used + for BSDDB database access. With common memory sizes these + days, &app; should have no problem using databases with tens + of thousands of people. + + + -If the above explanations seem vague, please follow -this link. + + How many people can &app; database handle? + + + We have found that on a typical system, &app; tends to bog + down after the database has around 150,000 people. Again, + this is dependent on how much memory you have. + + + - - + + Why is &app; running so slowly? + + + It does not anymore! Just try out the current + version, &appversion;. + + + - It is obvious that &app; absolutely needs to - become a (client-server/web-based/PHP/weblog/Javascript/C++/distributed/KDE/Motif/Tcl/Win32/C#/You-name-it) - application. When is this going to happen? - -The surest way to see it happen is to get it done by yourself. Since -&app; is free/open source, nobody prevents you from taking all of the -code and continuing its development in whatever direction you see fit. -In doing so, you may consider giving your new project another name to -avoid confusion with the continuing &app; development. If you would -like the &app; project to provide advice, expertise, filters, etc., -we will gladly cooperate with your new project, to ensure compatibility -or import/export options to your new format of a project. + + + My database is really big. Is there a way around loading + all the data into memory? + + + + Starting with this release, &app; no longer loads all data + into memory, which allows it to work with a much larger + database than before. + + + - -If, however, you would like the &app; project to to adopt your strategy, -you would need to convince &app; developers that your strategy is good -for &app; and superior to the present development strategy. + + I want to rerun the Startup dialog. How do I do this? + + + &app; keeps a flag in the GNOME configuration database to + indicate that the startup dialog has been run. To cause + &app; to rerun this, the flag needs to be reset. This can be + done with the following command: + + + gconftool-2 -u /apps/gramps/behavior/startup + + + - - + + + Why are non-latin characters displayed as garbage in PDF/PS + reports? + + + + This is a limitation of the builtin fonts of PS and PDF + formats. To print non-latin text, use the Print... in the + format selection menu of the report dialog. This will use + the gnome-print backend, which supports PS and PDF creation, + as well as direct printing. + + + If you only have latin text, the PDF option will produce a + smalled PDF compared to that created by gnome-print, simply + because no font information will be embedded. + + + - + + + Why can I not add/remove/edit columns to the lists in People + View and Family View? + + + + Now you can! Just try out the current version, &appversion;. + + + + + + I would like to contribute to &app; by writing my favorite + report. How do I do that? + + + + The easiest way to contribute to reports, filters, tools, + etc. is to copy an existing &app; report, filter, or + tool. If you can create what you want by modifying existing + code -- great! If your idea does not fit into the logic of + any existing &app; tool, the following page may provide some help in + writing your own plugin from scratch. + + + If you need more help or would like to discuss your idea + with us, please do not hesitate to contact us at gramps-devel@lists.sf.net + + + To test your work in progress, you may save your plugin + under $HOME/.gramps/plugins + directory and it should be found and imported on startup. + The correctly written plugin will register itself with + &app;, create menu item, and so on. + + + If you are happy with your plugin and would like to + contribute your code back to the &app; project, you are very + welcome to do so by contacting us at gramps-devel@lists.sf.net + + + + + + + I found a bug and I want it fixed right now! What do I do? + + + + The best thing you can do is to fix the bug and send the + patch to gramps-devel@lists.sf.net :-) + + A good bug report would include: + + + + Version of gramps you were using when you encountered + the bug (available through + Help + About menu + item). + + + + + Language under which gramps was run (available by executing + + echo $LANG + in your terminal). + + + Symptoms indicating that this is indeed a bug. + + + + Any Traceback messages, error messages, warnings, etc, + that showed up in your terminal or a in separate + traceback window. + + + + + Most problems can be fixed quickly provided there is enough + information. To ensure this, please follow up on your bug + reports. In particular, if you file a bug report with sf.net + bug tracker, PLEASE log in to sf.net before filing (register + your free account if you don't have one). Then we will have + a way of contacting you should we need more information. If + you choose to file your report anonymously, at least check + every so often whether your report page has something new + posted, as it probably would. + + + If the above explanations seem vague, please follow this link. + + + + + + + It is obvious that &app; absolutely needs to become a + (client-server/web-based/PHP/weblog/Javascript/C++/distributed/KDE/Motif/Tcl/Win32/C#/You-name-it) + application. When is this going to happen? + + + + The surest way to see it happen is to get it done by + yourself. Since &app; is free/open source, nobody prevents + you from taking all of the code and continuing its + development in whatever direction you see fit. In doing so, + you may consider giving your new project another name to + avoid confusion with the continuing &app; development. If + you would like the &app; project to provide advice, + expertise, filters, etc., we will gladly cooperate with your + new project, to ensure compatibility or import/export + options to your new format of a project. + + + If, however, you would like the &app; project to to adopt + your strategy, you would need to convince &app; developers + that your strategy is good for &app; and superior to the + present development strategy. + + + + diff --git a/gramps2/doc/gramps-manual/C/getstart.xml b/gramps2/doc/gramps-manual/C/getstart.xml index e99850649..02d0ed902 100644 --- a/gramps2/doc/gramps-manual/C/getstart.xml +++ b/gramps2/doc/gramps-manual/C/getstart.xml @@ -98,7 +98,8 @@ - + Shows Researcher Information Window. @@ -140,7 +141,8 @@ - + Shows Open Database Window. diff --git a/gramps2/doc/gramps-manual/C/gramps-manual.xml b/gramps2/doc/gramps-manual/C/gramps-manual.xml index 872be549c..94a24bbd4 100644 --- a/gramps2/doc/gramps-manual/C/gramps-manual.xml +++ b/gramps2/doc/gramps-manual/C/gramps-manual.xml @@ -66,9 +66,14 @@ GRAMPS Manual V&manrevision; - - 2001 Donald N. Allingham - 2003-2005 Alex Roitman + + 2001 + Donald N. Allingham + + + 2003-2005 + Alex Roitman + - GRAMPS Project + + + GRAMPS Project + &legal; - + + @@ -96,9 +107,7 @@ Roitman GRAMPS Project -
- shura@gramps-project.org -
+
shura@gramps-project.org
 @@ -106,9 +115,7 @@ Allingham GRAMPS Project -
- don@gramps-project.org -
+
don@gramps-project.org
 diff --git a/gramps2/doc/gramps-manual/C/mainwin.xml b/gramps2/doc/gramps-manual/C/mainwin.xml index 8ca22c5a4..e100c513b 100644 --- a/gramps2/doc/gramps-manual/C/mainwin.xml +++ b/gramps2/doc/gramps-manual/C/mainwin.xml @@ -288,7 +288,7 @@ - + Shows column editor dialog. diff --git a/gramps2/doc/gramps-manual/C/usage.xml b/gramps2/doc/gramps-manual/C/usage.xml index 0c3bf92e3..5d7c7f75d 100644 --- a/gramps2/doc/gramps-manual/C/usage.xml +++ b/gramps2/doc/gramps-manual/C/usage.xml @@ -3618,7 +3618,7 @@ + width="500" depth="224" scale="75"/> Shows Merge Sources dialog. @@ -4083,46 +4083,161 @@ Generating Reports - - Reports are the most common form of the output produced by - genealogical research. The majority of genealogical software - puts a lot of emphasis on developing nice looking - reports. &app; is no exception in this regard, offering a - choice of a variety of reports. &app; can generate reports in - a multitude of open formats, both text based and - graphical. &app; can also produce screen based reports that - are convenient for viewing a summary of your database. - Finally, &app; can generate a web site suitable for immediate - posting on the Internet. All of these are almost infinitely - flexible. If you wish to modify or extend the default format - of &app; report, you can design and choose the style for each - of your reports. - - - - - All reports can be accessed through the menu by choosing - - - Reports - - Report Type - - - Particular Report - - . - - Alternatively, you can browse the complete selection of - available reports along with their brief descriptions in a - Report Selection dialog invoked by - clicking the Reports icon on the - toolbar. - - + Reports are the most common form of the output produced by + genealogical research. The majority of genealogical software + puts a lot of emphasis on developing nice looking reports. &app; + is no exception in this regard, offering a choice of a variety + of reports. &app; can generate reports in a multitude of open + formats, both text based and graphical. &app; can also produce + screen based reports that are convenient for viewing a summary + of your database. Finally, &app; can generate a web site + suitable for immediate posting on the Internet. All of these are + almost infinitely flexible. If you wish to modify or extend the + default format of &app; report, you can design and choose the + style for each of your reports. + + + All reports can be accessed through the menu by choosing + + Reports + + Report Type + + + Particular Report + + . + Alternatively, you can browse the complete selection of + available reports along with their brief descriptions in a + Report Selection dialog invoked by clicking + the Reports icon on the toolbar. + + + Substitution Values + + Many of the graphical reports allow you to customize the + information on the display. Variable substituions are used + to substitute date for a particular symbol. There are two + styles of variables. The difference between the two styles + is how empty data is handled. + + + The first style of variables are preceeded by a '$'. If + the variable evaluates to an empty string, the variable is + replaced with the empty string. The second style of + variables are preceeded by a '%'. If the variable evaluates + to an empty string, the line that contains the variable is + removed from the output. + + + + $n/%n + + + Displays the person's name in the form of FirstName LastName + + + + + + $N/%N + + + Displays the person's name in the form of LastName, FirstName + + + + + + $i/%i + + + Displays the GRAMPS ID associated with the person. + + + + + + $b/%b + + + Displays the person's date of birth + + + + + + $B/%B + + + Displays the person's place of birth + + + + + + $d/%d + + + Displays the person's date of death + + + + + + $D/%D + + + Displays the person's place of death + + + + + + $s/%s + + + Displays the name of the person's preferred spouse in + the form of FirstName LastName + + + + + + $S/%S + + + Displays the name of the person's preferred spouse in + the form of LastName, FirstName. + + + + + + $m/%m + + + Displays the marriage date of the person and the preferred + spouse. + + + + + + $M/%M + + + Displays the place assocated with the marriage of the + person and the preferred spouse. + + + + + + Books