https://www.gramps-project.org/wiki/api.php?action=feedcontributions&user=Simanek&feedformat=atomGramps - User contributions [en]2024-03-28T20:41:56ZUser contributionsMediaWiki 1.31.3https://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_FAQ&diff=13925Gramps 3.0 Wiki Manual - FAQ2009-02-25T14:47:02Z<p>Simanek: /* General */ fixed some mistakes</p>
<hr />
<div>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.sourceforge.net<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}<br />
<br />
<br />
{{stub}}<br />
<br />
<br />
Also consider having a look at:<br />
*[[:Category:How do I...|How do I...]]<br />
*[[:Category:Tutorials|GRAMPS Tutorials]]<br />
<br />
<br />
[[Category:Documentation]]<br />
<br />
==General==<br />
<br />
;What is GRAMPS?<br />
:GRAMPS 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, see [[GRAMPS:About|About]].<br />
;Where do I get it and how much does it cost?<br />
:GRAMPS can be [[Installation|installed]] at no charge. GRAMPS 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.<br />
;Does GRAMPS exist in other languages?<br />
:Yes, at the moment GRAMPS is translated in 23 languages, see [[GRAMPS translations]].<br />
;How do I keep backups?<br />
:Use a recent version of GRAMPS! From 2.2.5 onwards there is an automatic backup utility.<br />
:It is extremely important to keep backups of your data, and keep them in a safe place. GRAMPS has a specific portable file format which is small, and human readable, denoted by <code>.gramps</code>. If you have allowed this in the preferences (In <tt>Edit menu->Preferences->General</tt>), GRAMPS will keep a backup of your database on exit. You can copy this backup file from time to time to a save location (eg a usb stick). <br />
:[Note: The .gramps files are compressed. Clicking them will open GRAMPS. To see the XML select them and open them with a decompressing utility (like ark, gunzip), after which you can extract the XML file which is human readable, see [[Generate_XML#How_do_I_uncompress_the_file?|details]].<br />
:'''Do not keep backups in GEDCOM'''. Not all information GRAMPS stores can be written in the GEDCOM. Hence, an export/import operation GRAMPS --> GEDCOM --> GRAMPS, will mean you '''lose''' data. Use the <code>.gramps</code> file format for backups!<br />
:'''Do not keep backups in GRDB format'''. GRDB is a database, which might be computer dependent (read, not working on a different PC). Small damage to a GRDB file can also not be repaired. Use the <code>.gramps</code> file format for backups!<br />
;Does Gramps support Unicode fonts? In particular, does it support non-Roman Unicode fonts?<br />
:Yes. GRAMPS works internally with Unicode (UTF-8), so all alphabets can be used on all entry fields. All reports fully support this, although for PDF/PS you need to work with gnome-print or openoffice.<br />
<br />
==Installation==<br />
<br />
;What is needed to install GRAMPS under Linux, Solaris, or FreeBSD?<br />
:GRAMPS is a [http://en.wikipedia.org/wiki/Gtk GTK] application. GRAMPS needs to have the [http://en.wikipedia.org/wiki/Pygtk pygtk] libraries installed on the system. As long as these libraries are installed, GRAMPS should function. It will operate under the GNOME desktop, KDE desktop, or any other desktop. If the GNOME bindings for Python are installed on the system, GRAMPS will have additional functionality. The GRAMPS project recommends version 2.8 or higher of GTK.<br />
;Does it work with Windows?<br />
:The [[Linux Genealogy CD]] can function as a live CD that you boot directly from. You can then run Linux and GRAMPS off the CD, even if your computer is entirely Windows.<br />
:A [[Windows installer]] is available, however we do not have the manpower to offer support for Windows. A [[Contact|windows mailing list]] is available however and we will do our best to solve windows related problems.<br />
:See also [[GRAMPS_and_Windows]] for a summary of hints to use GRAMPS on a Windows PC.<br />
;Does it work with the Mac?<br />
:The Fink project has ported some older versions of GRAMPS to OS X (tm). The Mac OS X port is not directly supported by the GRAMPS project, primarily because none of the GRAMPS developers have access to Mac OS X and because OS X is not Free Software.<br />
:This present version of GRAMPS (2.2.x) does not appear to have been ported by the Fink project. Please contact the Fink project for more information. However, some users have [[Mac OS X|had success]] in installing 2.2.x on Mac OSX either running in native mode or running on X11 using some of the fink packages.<br />
;What are the Minimum Specs to run GRAMPS?<br />
:We would recommend at least an 800x600 video display. For GRAMPS 2.0, the memory requirements have been reduced, and GRAMPS can run quite efficiently on a 256MB system, holding considerably more people. A system with 512MB should be able to hold around 200,000 people. Disk space requirements for databases are however considerably larger, with a typical database being several megabytes in size. For 120.000 people you must consider already 530Mb for the database. Pictures are stored on disk separately, so a large harddisk is necessary.<br />
<br />
==Preferences==<br />
;Can I change the dates in reports to 'day month year'<br />
:Yes, change in the preferences ("Edit->Preferences") the date for GRAMPS to the required format (eg YYYY-MM-DD or day month year), and make the report. Your global date preferences will be used.<br />
<br />
==Collaboration-Portability==<br />
;Is GRAMPS compatible with other genealogical software? <br />
:GRAMPS makes every effort to maintain compatibility with [[GEDCOM]], the general standard of recording genealogical information. We have import and export filters that enable GRAMPS to read and write GEDCOM files.<br />
: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 [[Contact|user feedback]]. Please feel free to inform us about any GEDCOM flavor not supported by GRAMPS, and we will do our best to support it!<br />
;Can GRAMPS read files created by other genealogy programs? <br />
:See above.<br />
;Can GRAMPS write files readable by other genealogy programs? <br />
:See above.<br />
;What standards does GRAMPS support? <br />
:The nice thing about standards is that there never is a shortage of them. GRAMPS 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.<br />
;How do I import data from another genealogy program into GRAMPS?<br />
:The best way is to create a new family tree, and select the import option in the file menu. Here you select the GEDCOM you generated with the other program, and import it. <br />
;Can I install GRAMPS on a Linux Web Server and use it via a web browser? This would enable my relations worldwide to access and update it.<br />
:While GRAMPS can generate web sites, it does not provide a web interface that allows for editing. If this is a requirement, then [http://geneweb.org GeneWeb] or [http://phpgedview.sourceforge.net PhpGedView] are programs more likely to meet your needs. However, you may wish to ask yourself the following questions:<br />
# Do I really want relatives or other people to directly edit my genealogy database?<br />
# Do I implicitly trust, without verification, any data that people may enter?<br />
# Do these people have the same understanding of good genealogy practice that I have?<br />
:A better approach may be to provide a web form interface that allows others to enter data that is then held for your examination. You can then decide if the information should be entered into your database.<br />
:You may also want to consider the effects of possible downtime of your site if you cannot afford yourself a premium webhosting service.<br />
<br />
==Reports==<br />
;Can GRAMPS print a genealogical tree for my family? <br />
: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.<br />
:GRAMPS 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.<br />
;In what formats can GRAMPS output its reports? <br />
:Text reports are available in HTML, PDF, ODT, LaTeX, and RTF formats. Graphical reports (charts and diagrams) are available in PostScript, PDF, SVG, ODS, and GraphViz formats.<br />
;How can I change the default language in reports?<br />
:The reports are in the language of your linux installation. You can change it by installing extra language packs, see [[Howto: Change the language of reports]]<br />
;Is GRAMPS compatible with the Internet? <br />
:GRAMPS 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. GRAMPS 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.<br />
;Can I create custom reports/filters/whatever? <br />
: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 GRAMPS 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.<br />
;Why are non-Latin characters displayed as garbage in PDF/PS reports? <br />
:This is a limitation of the built-in 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 <code>gnome-print</code> backend, which supports PS and PDF creation, as well as direct printing. (Note: you might need to install gnome-print separately as it is not required for GRAMPS).<br />
:If you only have Latin text, the PDF option will produce a smaller PDF compared to that created by gnome-print, simply because no font information will be embedded.<br />
;I would like to contribute to GRAMPS by writing my favorite report. How do I do that? <br />
:The easiest way to contribute to reports, filters, tools, etc. is to copy an existing GRAMPS 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 GRAMPS tool, you will need to write your own plugin from scratch. Help is available on the [[Portal:Developers|Developers Portal]], or on the [[Contact|Developers mailing list]]: gramps-devel@lists.sourceforge.net.<br />
: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 GRAMPS, create menu item, and so on.<br />
:If you are happy with your plugin and would like to contribute your code back to the GRAMPS project, you are very welcome to do so by contacting us at gramps-devel@lists.sourceforge.net<br />
<br />
==Database - GRAMPS file formats==<br />
;What is the maximum database size (bytes) GRAMPS can handle?<br />
:GRAMPS has no hard limits on the size of a database that it can handle. Starting with 2.0.0 release, GRAMPS 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, GRAMPS should have no problem using databases with [[GRAMPS Performance|tens of thousands of people]].<br />
;How many people can GRAMPS database handle? <br />
:See above. Again, this is dependent on how much memory you have, see [[GRAMPS Performance]].<br />
;My database is really big. Is there a way around loading all the data into memory?<br />
:Starting with 2.0.0 release, GRAMPS no longer loads all data into memory, which allows it to work with a much larger database than before. The fileformat used is <code>.grdb</code> which means gramps database.<br />
;Can I run GRAMPS from a database on a NFS share?<br />
:Yes you can.<br />
;Why is the database format not portable?<br />
:The biggest issue with GRAMPS portability lies with 'transactions'. With GRAMPS 2.2, we added support for atomic transactions to protect data. With atomic transactions, multiple changes are committed as a single unit. Either all the changes make it, or none of the changes make it. You are never left in a situation with a partial set of changes. A side benefit of using transactions is that database access (reads and writes) are faster.<br />
:The problem with transactions (at least using BSDDB) is that it does not allow all the data to be stored in a single file. Logging files are needed to keep track of things. These logging files are kept in a DB Environment directory. We need a separate directory for each file, otherwise the log files can interfere with each other.<br />
:In 2.2, we keep the log files under the ~/.gramps/<path> directory, creating a unique directory for each database. The problem is that your GRDB file needs the log files, which are in a different directory. Copying the GRDB file is only copying a portion of the database.<br />
<br />
==Bugs and requests==<br />
;I found a bug and I want it fixed right now! What do I do?<br />
:The best thing you can do is to fix the bug and send the patch to gramps-devel@lists.sourceforge.net :-)<br />
:If that is not possible, you should [[How to report bugs|submit a bug report]]<br />
:A good bug report would include:<br />
# Version of gramps you were using when you encountered the bug (available through Help → About menu item).<br />
# Language under which gramps was run (available by executing <code> echo $LANG</code> in your terminal).<br />
# Symptoms indicating that this is indeed a bug.<br />
# Any Traceback messages, error messages, warnings, etc, that showed up in your terminal or a in separate traceback window.<br />
:Most problems can be fixed quickly provided there is enough information. To ensure this, please follow up on your bug reports. :Then we will have a way of contacting you should we need more information.<br />
;GRAMPS should be a .... type of application<br />
:It is obvious that GRAMPS 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?<br />
:The surest way to see it happen is to get it done by yourself. Since GRAMPS 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 GRAMPS development. If you would like the GRAMPS 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.<br />
:If, however, you would like the GRAMPS project to adopt your strategy, you would need to convince GRAMPS developers that your strategy is good for GRAMPS and superior to the present development strategy.<br />
<br />
==GRAMPS Webhosting ==<br />
;How can I publish web sites generated by GRAMPS?<br />
:Since GRAMPS generates HTML pages, you can upload the pages to your personal web site. If you do not have a personal web site, and still wish to have your pages available on the internet, the GRAMPS project can provide space for you at the http://library.gramps-project.org, see [[GRAMPS:Webhosting|the webhosting article]].<br />
;How do I submit my pages to the GRAMPS library site (http://library.gramps-project.org)?<br />
:If you wish to submit pages to the GRAMPS library site, you will need to contact the GRAMPS project, typically by sending a message to the gramps-users mailing list. You will then be given a username and password that will allow you to upload your files to the site. After you upload the files (in a gzip'ed tar file), the GRAMPS project will install the pages for you on the site.<br />
;After I upload my Family Web Page to library.gramps-project.org, is the password used for write privileges only or read privileges?<br />
:In order to prevent abuse of the library.gramsp-project.org site, the password given allows uploads only. If you wish to have a username and password combination to restrict read access to your pages, you will need to contact the GRAMPS project, and we could set this up for you. However, the read and write accounts will be separate accounts.<br />
;Do I view the Family Web Page with a url into my browser? Or through a link on a list of Family Web Pages on the GRAMPS-Project.org site?<br />
:The main page on the library.gramps-project.org site will contain an index of the available family sites. However, there will be a unique URL for each site as well.<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
[[Category:Documentation]]<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_FAQ&diff=13924Gramps 3.0 Wiki Manual - FAQ2009-02-25T14:38:45Z<p>Simanek: /* GRAMPS Webhosting */ Marked up as a definition list.</p>
<hr />
<div>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.sourceforge.net<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}<br />
<br />
<br />
{{stub}}<br />
<br />
<br />
Also consider having a look at:<br />
*[[:Category:How do I...|How do I...]]<br />
*[[:Category:Tutorials|GRAMPS Tutorials]]<br />
<br />
<br />
[[Category:Documentation]]<br />
<br />
==General==<br />
<br />
;What is GRAMPS?<br />
:GRAMPS 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, see [[GRAMPS:About|About]].<br />
;Where do I get it and how much does it cost?<br />
:GRAMPS can be [[Installation|installed]] at no charge. GRAMPS 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.<br />
;Does GRAMPS exist in other languages?<br />
:Yes, at the moment GRAMPS is translated in 23 languages, see [[GRAMPS translations]].<br />
;How do I keep backups?<br />
:Use a recent version of GRAMPS! From 2.2.5 onwards there is an automatic backup utility.<br />
:It is extremely important to keep backups of your data, and keep them in a safe place. GRAMPS has a specific portable file format which is small, and human readable, denoted by <code>.gramps</code>. If you have allowed this in the preferences (In <tt>Edit menu->Preferences->General</tt>), GRAMPS will keep a backup of your database on exit. You can copy this backup file from time to time to a save location (eg a usb stick). <br />
: -<br />
:[Note: The .gramps files are compressed. Clicking them will open GRAMPS. To see the XML select them and open them with a decompressing utility (like ark, gunzip), after which you can extract the XML file which is human readable, see [[Generate_XML#How_do_I_uncompress_the_file?|details]].<br />
: -<br />
:'''Do not keep backups in GEDCOM'''. Not all information GRAMPS stores can be written in the GEDCOM. Hence, an export/import operation GRAMPS --> GEDCOM --> GRAMPS, will mean you '''lose''' data. Use the <code>.gramps</code> file format for backups!<br />
: -<br />
:'''Do not keep backups in GRDB format'''. GRDB is a database, which might be computer dependent (read, not working on a different PC). Small damage to a GRDB file can also not be repaired. Use the <code>.gramps</code> file format for backups!<br />
;Does Gramps support Unicode fonts? In particular, does it support non-Roman Unicode fonts?<br />
:Yes. GRAMPS works internally with Unicode (UTF-8), so all alphabets can be used on all entry fields. All reports fully support this, although for PDF/PS you need to work with gnome-print or openoffice.<br />
<br />
==Installation==<br />
<br />
;What is needed to install GRAMPS under Linux, Solaris, or FreeBSD?<br />
:GRAMPS is a [http://en.wikipedia.org/wiki/Gtk GTK] application. GRAMPS needs to have the [http://en.wikipedia.org/wiki/Pygtk pygtk] libraries installed on the system. As long as these libraries are installed, GRAMPS should function. It will operate under the GNOME desktop, KDE desktop, or any other desktop. If the GNOME bindings for Python are installed on the system, GRAMPS will have additional functionality. The GRAMPS project recommends version 2.8 or higher of GTK.<br />
;Does it work with Windows?<br />
:The [[Linux Genealogy CD]] can function as a live CD that you boot directly from. You can then run Linux and GRAMPS off the CD, even if your computer is entirely Windows.<br />
:A [[Windows installer]] is available, however we do not have the manpower to offer support for Windows. A [[Contact|windows mailing list]] is available however and we will do our best to solve windows related problems.<br />
:See also [[GRAMPS_and_Windows]] for a summary of hints to use GRAMPS on a Windows PC.<br />
;Does it work with the Mac?<br />
:The Fink project has ported some older versions of GRAMPS to OS X (tm). The Mac OS X port is not directly supported by the GRAMPS project, primarily because none of the GRAMPS developers have access to Mac OS X and because OS X is not Free Software.<br />
:This present version of GRAMPS (2.2.x) does not appear to have been ported by the Fink project. Please contact the Fink project for more information. However, some users have [[Mac OS X|had success]] in installing 2.2.x on Mac OSX either running in native mode or running on X11 using some of the fink packages.<br />
;What are the Minimum Specs to run GRAMPS?<br />
:We would recommend at least an 800x600 video display. For GRAMPS 2.0, the memory requirements have been reduced, and GRAMPS can run quite efficiently on a 256MB system, holding considerably more people. A system with 512MB should be able to hold around 200,000 people. Disk space requirements for databases are however considerably larger, with a typical database being several megabytes in size. For 120.000 people you must consider already 530Mb for the database. Pictures are stored on disk separately, so a large harddisk is necessary.<br />
<br />
==Preferences==<br />
;Can I change the dates in reports to 'day month year'<br />
:Yes, change in the preferences ("Edit->Preferences") the date for GRAMPS to the required format (eg YYYY-MM-DD or day month year), and make the report. Your global date preferences will be used.<br />
<br />
==Collaboration-Portability==<br />
;Is GRAMPS compatible with other genealogical software? <br />
:GRAMPS makes every effort to maintain compatibility with [[GEDCOM]], the general standard of recording genealogical information. We have import and export filters that enable GRAMPS to read and write GEDCOM files.<br />
: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 [[Contact|user feedback]]. Please feel free to inform us about any GEDCOM flavor not supported by GRAMPS, and we will do our best to support it!<br />
;Can GRAMPS read files created by other genealogy programs? <br />
:See above.<br />
;Can GRAMPS write files readable by other genealogy programs? <br />
:See above.<br />
;What standards does GRAMPS support? <br />
:The nice thing about standards is that there never is a shortage of them. GRAMPS 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.<br />
;How do I import data from another genealogy program into GRAMPS?<br />
:The best way is to create a new family tree, and select the import option in the file menu. Here you select the GEDCOM you generated with the other program, and import it. <br />
;Can I install GRAMPS on a Linux Web Server and use it via a web browser? This would enable my relations worldwide to access and update it.<br />
:While GRAMPS can generate web sites, it does not provide a web interface that allows for editing. If this is a requirement, then [http://geneweb.org GeneWeb] or [http://phpgedview.sourceforge.net PhpGedView] are programs more likely to meet your needs. However, you may wish to ask yourself the following questions:<br />
# Do I really want relatives or other people to directly edit my genealogy database?<br />
# Do I implicitly trust, without verification, any data that people may enter?<br />
# Do these people have the same understanding of good genealogy practice that I have?<br />
:A better approach may be to provide a web form interface that allows others to enter data that is then held for your examination. You can then decide if the information should be entered into your database.<br />
:You may also want to consider the effects of possible downtime of your site if you cannot afford yourself a premium webhosting service.<br />
<br />
==Reports==<br />
;Can GRAMPS print a genealogical tree for my family? <br />
: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.<br />
:GRAMPS 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.<br />
;In what formats can GRAMPS output its reports? <br />
:Text reports are available in HTML, PDF, ODT, LaTeX, and RTF formats. Graphical reports (charts and diagrams) are available in PostScript, PDF, SVG, ODS, and GraphViz formats.<br />
;How can I change the default language in reports?<br />
:The reports are in the language of your linux installation. You can change it by installing extra language packs, see [[Howto: Change the language of reports]]<br />
;Is GRAMPS compatible with the Internet? <br />
:GRAMPS 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. GRAMPS 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.<br />
;Can I create custom reports/filters/whatever? <br />
: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 GRAMPS 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.<br />
;Why are non-Latin characters displayed as garbage in PDF/PS reports? <br />
:This is a limitation of the built-in 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 <code>gnome-print</code> backend, which supports PS and PDF creation, as well as direct printing. (Note: you might need to install gnome-print separately as it is not required for GRAMPS).<br />
:If you only have Latin text, the PDF option will produce a smaller PDF compared to that created by gnome-print, simply because no font information will be embedded.<br />
;I would like to contribute to GRAMPS by writing my favorite report. How do I do that? <br />
:The easiest way to contribute to reports, filters, tools, etc. is to copy an existing GRAMPS 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 GRAMPS tool, you will need to write your own plugin from scratch. Help is available on the [[Portal:Developers|Developers Portal]], or on the [[Contact|Developers mailing list]]: gramps-devel@lists.sourceforge.net.<br />
: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 GRAMPS, create menu item, and so on.<br />
:If you are happy with your plugin and would like to contribute your code back to the GRAMPS project, you are very welcome to do so by contacting us at gramps-devel@lists.sourceforge.net<br />
<br />
==Database - GRAMPS file formats==<br />
;What is the maximum database size (bytes) GRAMPS can handle?<br />
:GRAMPS has no hard limits on the size of a database that it can handle. Starting with 2.0.0 release, GRAMPS 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, GRAMPS should have no problem using databases with [[GRAMPS Performance|tens of thousands of people]].<br />
;How many people can GRAMPS database handle? <br />
:See above. Again, this is dependent on how much memory you have, see [[GRAMPS Performance]].<br />
;My database is really big. Is there a way around loading all the data into memory?<br />
:Starting with 2.0.0 release, GRAMPS no longer loads all data into memory, which allows it to work with a much larger database than before. The fileformat used is <code>.grdb</code> which means gramps database.<br />
;Can I run GRAMPS from a database on a NFS share?<br />
:Yes you can.<br />
;Why is the database format not portable?<br />
:The biggest issue with GRAMPS portability lies with 'transactions'. With GRAMPS 2.2, we added support for atomic transactions to protect data. With atomic transactions, multiple changes are committed as a single unit. Either all the changes make it, or none of the changes make it. You are never left in a situation with a partial set of changes. A side benefit of using transactions is that database access (reads and writes) are faster.<br />
:The problem with transactions (at least using BSDDB) is that it does not allow all the data to be stored in a single file. Logging files are needed to keep track of things. These logging files are kept in a DB Environment directory. We need a separate directory for each file, otherwise the log files can interfere with each other.<br />
:In 2.2, we keep the log files under the ~/.gramps/<path> directory, creating a unique directory for each database. The problem is that your GRDB file needs the log files, which are in a different directory. Copying the GRDB file is only copying a portion of the database.<br />
<br />
==Bugs and requests==<br />
;I found a bug and I want it fixed right now! What do I do?<br />
:The best thing you can do is to fix the bug and send the patch to gramps-devel@lists.sourceforge.net :-)<br />
:If that is not possible, you should [[How to report bugs|submit a bug report]]<br />
:A good bug report would include:<br />
# Version of gramps you were using when you encountered the bug (available through Help → About menu item).<br />
# Language under which gramps was run (available by executing <code> echo $LANG</code> in your terminal).<br />
# Symptoms indicating that this is indeed a bug.<br />
# Any Traceback messages, error messages, warnings, etc, that showed up in your terminal or a in separate traceback window.<br />
:Most problems can be fixed quickly provided there is enough information. To ensure this, please follow up on your bug reports. :Then we will have a way of contacting you should we need more information.<br />
;GRAMPS should be a .... type of application<br />
:It is obvious that GRAMPS 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?<br />
:The surest way to see it happen is to get it done by yourself. Since GRAMPS 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 GRAMPS development. If you would like the GRAMPS 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.<br />
:If, however, you would like the GRAMPS project to adopt your strategy, you would need to convince GRAMPS developers that your strategy is good for GRAMPS and superior to the present development strategy.<br />
<br />
==GRAMPS Webhosting ==<br />
;How can I publish web sites generated by GRAMPS?<br />
:Since GRAMPS generates HTML pages, you can upload the pages to your personal web site. If you do not have a personal web site, and still wish to have your pages available on the internet, the GRAMPS project can provide space for you at the http://library.gramps-project.org, see [[GRAMPS:Webhosting|the webhosting article]].<br />
;How do I submit my pages to the GRAMPS library site (http://library.gramps-project.org)?<br />
:If you wish to submit pages to the GRAMPS library site, you will need to contact the GRAMPS project, typically by sending a message to the gramps-users mailing list. You will then be given a username and password that will allow you to upload your files to the site. After you upload the files (in a gzip'ed tar file), the GRAMPS project will install the pages for you on the site.<br />
;After I upload my Family Web Page to library.gramps-project.org, is the password used for write privileges only or read privileges?<br />
:In order to prevent abuse of the library.gramsp-project.org site, the password given allows uploads only. If you wish to have a username and password combination to restrict read access to your pages, you will need to contact the GRAMPS project, and we could set this up for you. However, the read and write accounts will be separate accounts.<br />
;Do I view the Family Web Page with a url into my browser? Or through a link on a list of Family Web Pages on the GRAMPS-Project.org site?<br />
:The main page on the library.gramps-project.org site will contain an index of the available family sites. However, there will be a unique URL for each site as well.<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
[[Category:Documentation]]<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_FAQ&diff=13923Gramps 3.0 Wiki Manual - FAQ2009-02-25T14:37:11Z<p>Simanek: /* Bugs and requests */ Marked up as a definition list.</p>
<hr />
<div>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.sourceforge.net<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}<br />
<br />
<br />
{{stub}}<br />
<br />
<br />
Also consider having a look at:<br />
*[[:Category:How do I...|How do I...]]<br />
*[[:Category:Tutorials|GRAMPS Tutorials]]<br />
<br />
<br />
[[Category:Documentation]]<br />
<br />
==General==<br />
<br />
;What is GRAMPS?<br />
:GRAMPS 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, see [[GRAMPS:About|About]].<br />
;Where do I get it and how much does it cost?<br />
:GRAMPS can be [[Installation|installed]] at no charge. GRAMPS 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.<br />
;Does GRAMPS exist in other languages?<br />
:Yes, at the moment GRAMPS is translated in 23 languages, see [[GRAMPS translations]].<br />
;How do I keep backups?<br />
:Use a recent version of GRAMPS! From 2.2.5 onwards there is an automatic backup utility.<br />
:It is extremely important to keep backups of your data, and keep them in a safe place. GRAMPS has a specific portable file format which is small, and human readable, denoted by <code>.gramps</code>. If you have allowed this in the preferences (In <tt>Edit menu->Preferences->General</tt>), GRAMPS will keep a backup of your database on exit. You can copy this backup file from time to time to a save location (eg a usb stick). <br />
: -<br />
:[Note: The .gramps files are compressed. Clicking them will open GRAMPS. To see the XML select them and open them with a decompressing utility (like ark, gunzip), after which you can extract the XML file which is human readable, see [[Generate_XML#How_do_I_uncompress_the_file?|details]].<br />
: -<br />
:'''Do not keep backups in GEDCOM'''. Not all information GRAMPS stores can be written in the GEDCOM. Hence, an export/import operation GRAMPS --> GEDCOM --> GRAMPS, will mean you '''lose''' data. Use the <code>.gramps</code> file format for backups!<br />
: -<br />
:'''Do not keep backups in GRDB format'''. GRDB is a database, which might be computer dependent (read, not working on a different PC). Small damage to a GRDB file can also not be repaired. Use the <code>.gramps</code> file format for backups!<br />
;Does Gramps support Unicode fonts? In particular, does it support non-Roman Unicode fonts?<br />
:Yes. GRAMPS works internally with Unicode (UTF-8), so all alphabets can be used on all entry fields. All reports fully support this, although for PDF/PS you need to work with gnome-print or openoffice.<br />
<br />
==Installation==<br />
<br />
;What is needed to install GRAMPS under Linux, Solaris, or FreeBSD?<br />
:GRAMPS is a [http://en.wikipedia.org/wiki/Gtk GTK] application. GRAMPS needs to have the [http://en.wikipedia.org/wiki/Pygtk pygtk] libraries installed on the system. As long as these libraries are installed, GRAMPS should function. It will operate under the GNOME desktop, KDE desktop, or any other desktop. If the GNOME bindings for Python are installed on the system, GRAMPS will have additional functionality. The GRAMPS project recommends version 2.8 or higher of GTK.<br />
;Does it work with Windows?<br />
:The [[Linux Genealogy CD]] can function as a live CD that you boot directly from. You can then run Linux and GRAMPS off the CD, even if your computer is entirely Windows.<br />
:A [[Windows installer]] is available, however we do not have the manpower to offer support for Windows. A [[Contact|windows mailing list]] is available however and we will do our best to solve windows related problems.<br />
:See also [[GRAMPS_and_Windows]] for a summary of hints to use GRAMPS on a Windows PC.<br />
;Does it work with the Mac?<br />
:The Fink project has ported some older versions of GRAMPS to OS X (tm). The Mac OS X port is not directly supported by the GRAMPS project, primarily because none of the GRAMPS developers have access to Mac OS X and because OS X is not Free Software.<br />
:This present version of GRAMPS (2.2.x) does not appear to have been ported by the Fink project. Please contact the Fink project for more information. However, some users have [[Mac OS X|had success]] in installing 2.2.x on Mac OSX either running in native mode or running on X11 using some of the fink packages.<br />
;What are the Minimum Specs to run GRAMPS?<br />
:We would recommend at least an 800x600 video display. For GRAMPS 2.0, the memory requirements have been reduced, and GRAMPS can run quite efficiently on a 256MB system, holding considerably more people. A system with 512MB should be able to hold around 200,000 people. Disk space requirements for databases are however considerably larger, with a typical database being several megabytes in size. For 120.000 people you must consider already 530Mb for the database. Pictures are stored on disk separately, so a large harddisk is necessary.<br />
<br />
==Preferences==<br />
;Can I change the dates in reports to 'day month year'<br />
:Yes, change in the preferences ("Edit->Preferences") the date for GRAMPS to the required format (eg YYYY-MM-DD or day month year), and make the report. Your global date preferences will be used.<br />
<br />
==Collaboration-Portability==<br />
;Is GRAMPS compatible with other genealogical software? <br />
:GRAMPS makes every effort to maintain compatibility with [[GEDCOM]], the general standard of recording genealogical information. We have import and export filters that enable GRAMPS to read and write GEDCOM files.<br />
: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 [[Contact|user feedback]]. Please feel free to inform us about any GEDCOM flavor not supported by GRAMPS, and we will do our best to support it!<br />
;Can GRAMPS read files created by other genealogy programs? <br />
:See above.<br />
;Can GRAMPS write files readable by other genealogy programs? <br />
:See above.<br />
;What standards does GRAMPS support? <br />
:The nice thing about standards is that there never is a shortage of them. GRAMPS 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.<br />
;How do I import data from another genealogy program into GRAMPS?<br />
:The best way is to create a new family tree, and select the import option in the file menu. Here you select the GEDCOM you generated with the other program, and import it. <br />
;Can I install GRAMPS on a Linux Web Server and use it via a web browser? This would enable my relations worldwide to access and update it.<br />
:While GRAMPS can generate web sites, it does not provide a web interface that allows for editing. If this is a requirement, then [http://geneweb.org GeneWeb] or [http://phpgedview.sourceforge.net PhpGedView] are programs more likely to meet your needs. However, you may wish to ask yourself the following questions:<br />
# Do I really want relatives or other people to directly edit my genealogy database?<br />
# Do I implicitly trust, without verification, any data that people may enter?<br />
# Do these people have the same understanding of good genealogy practice that I have?<br />
:A better approach may be to provide a web form interface that allows others to enter data that is then held for your examination. You can then decide if the information should be entered into your database.<br />
:You may also want to consider the effects of possible downtime of your site if you cannot afford yourself a premium webhosting service.<br />
<br />
==Reports==<br />
;Can GRAMPS print a genealogical tree for my family? <br />
: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.<br />
:GRAMPS 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.<br />
;In what formats can GRAMPS output its reports? <br />
:Text reports are available in HTML, PDF, ODT, LaTeX, and RTF formats. Graphical reports (charts and diagrams) are available in PostScript, PDF, SVG, ODS, and GraphViz formats.<br />
;How can I change the default language in reports?<br />
:The reports are in the language of your linux installation. You can change it by installing extra language packs, see [[Howto: Change the language of reports]]<br />
;Is GRAMPS compatible with the Internet? <br />
:GRAMPS 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. GRAMPS 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.<br />
;Can I create custom reports/filters/whatever? <br />
: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 GRAMPS 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.<br />
;Why are non-Latin characters displayed as garbage in PDF/PS reports? <br />
:This is a limitation of the built-in 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 <code>gnome-print</code> backend, which supports PS and PDF creation, as well as direct printing. (Note: you might need to install gnome-print separately as it is not required for GRAMPS).<br />
:If you only have Latin text, the PDF option will produce a smaller PDF compared to that created by gnome-print, simply because no font information will be embedded.<br />
;I would like to contribute to GRAMPS by writing my favorite report. How do I do that? <br />
:The easiest way to contribute to reports, filters, tools, etc. is to copy an existing GRAMPS 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 GRAMPS tool, you will need to write your own plugin from scratch. Help is available on the [[Portal:Developers|Developers Portal]], or on the [[Contact|Developers mailing list]]: gramps-devel@lists.sourceforge.net.<br />
: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 GRAMPS, create menu item, and so on.<br />
:If you are happy with your plugin and would like to contribute your code back to the GRAMPS project, you are very welcome to do so by contacting us at gramps-devel@lists.sourceforge.net<br />
<br />
==Database - GRAMPS file formats==<br />
;What is the maximum database size (bytes) GRAMPS can handle?<br />
:GRAMPS has no hard limits on the size of a database that it can handle. Starting with 2.0.0 release, GRAMPS 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, GRAMPS should have no problem using databases with [[GRAMPS Performance|tens of thousands of people]].<br />
;How many people can GRAMPS database handle? <br />
:See above. Again, this is dependent on how much memory you have, see [[GRAMPS Performance]].<br />
;My database is really big. Is there a way around loading all the data into memory?<br />
:Starting with 2.0.0 release, GRAMPS no longer loads all data into memory, which allows it to work with a much larger database than before. The fileformat used is <code>.grdb</code> which means gramps database.<br />
;Can I run GRAMPS from a database on a NFS share?<br />
:Yes you can.<br />
;Why is the database format not portable?<br />
:The biggest issue with GRAMPS portability lies with 'transactions'. With GRAMPS 2.2, we added support for atomic transactions to protect data. With atomic transactions, multiple changes are committed as a single unit. Either all the changes make it, or none of the changes make it. You are never left in a situation with a partial set of changes. A side benefit of using transactions is that database access (reads and writes) are faster.<br />
:The problem with transactions (at least using BSDDB) is that it does not allow all the data to be stored in a single file. Logging files are needed to keep track of things. These logging files are kept in a DB Environment directory. We need a separate directory for each file, otherwise the log files can interfere with each other.<br />
:In 2.2, we keep the log files under the ~/.gramps/<path> directory, creating a unique directory for each database. The problem is that your GRDB file needs the log files, which are in a different directory. Copying the GRDB file is only copying a portion of the database.<br />
<br />
==Bugs and requests==<br />
;I found a bug and I want it fixed right now! What do I do?<br />
:The best thing you can do is to fix the bug and send the patch to gramps-devel@lists.sourceforge.net :-)<br />
:If that is not possible, you should [[How to report bugs|submit a bug report]]<br />
:A good bug report would include:<br />
# Version of gramps you were using when you encountered the bug (available through Help → About menu item).<br />
# Language under which gramps was run (available by executing <code> echo $LANG</code> in your terminal).<br />
# Symptoms indicating that this is indeed a bug.<br />
# Any Traceback messages, error messages, warnings, etc, that showed up in your terminal or a in separate traceback window.<br />
:Most problems can be fixed quickly provided there is enough information. To ensure this, please follow up on your bug reports. :Then we will have a way of contacting you should we need more information.<br />
;GRAMPS should be a .... type of application<br />
:It is obvious that GRAMPS 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?<br />
:The surest way to see it happen is to get it done by yourself. Since GRAMPS 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 GRAMPS development. If you would like the GRAMPS 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.<br />
:If, however, you would like the GRAMPS project to adopt your strategy, you would need to convince GRAMPS developers that your strategy is good for GRAMPS and superior to the present development strategy.<br />
<br />
==GRAMPS Webhosting ==<br />
*How can I publish web sites generated by GRAMPS?<br />
Since GRAMPS generates HTML pages, you can upload the pages to your personal web site. If you do not have a personal web site, and still wish to have your pages available on the internet, the GRAMPS project can provide space for you at the http://library.gramps-project.org, see [[GRAMPS:Webhosting|the webhosting article]].<br />
<br />
*How do I submit my pages to the GRAMPS library site (http://library.gramps-project.org)?<br />
If you wish to submit pages to the GRAMPS library site, you will need to contact the GRAMPS project, typically by sending a message to the gramps-users mailing list. You will then be given a username and password that will allow you to upload your files to the site. After you upload the files (in a gzip'ed tar file), the GRAMPS project will install the pages for you on the site.<br />
<br />
*After I upload my Family Web Page to library.gramps-project.org, is the password used for write privileges only or read privileges?<br />
In order to prevent abuse of the library.gramsp-project.org site, the password given allows uploads only. If you wish to have a username and password combination to restrict read access to your pages, you will need to contact the GRAMPS project, and we could set this up for you. However, the read and write accounts will be separate accounts.<br />
<br />
*Do I view the Family Web Page with a url into my browser? Or through a link on a list of Family Web Pages on the GRAMPS-Project.org site?<br />
The main page on the library.gramps-project.org site will contain an index of the available family sites. However, there will be a unique URL for each site as well.<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
[[Category:Documentation]]<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_FAQ&diff=13922Gramps 3.0 Wiki Manual - FAQ2009-02-25T14:23:48Z<p>Simanek: /* Database - GRAMPS file formats */ Marked up as definition list.</p>
<hr />
<div>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.sourceforge.net<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}<br />
<br />
<br />
{{stub}}<br />
<br />
<br />
Also consider having a look at:<br />
*[[:Category:How do I...|How do I...]]<br />
*[[:Category:Tutorials|GRAMPS Tutorials]]<br />
<br />
<br />
[[Category:Documentation]]<br />
<br />
==General==<br />
<br />
;What is GRAMPS?<br />
:GRAMPS 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, see [[GRAMPS:About|About]].<br />
;Where do I get it and how much does it cost?<br />
:GRAMPS can be [[Installation|installed]] at no charge. GRAMPS 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.<br />
;Does GRAMPS exist in other languages?<br />
:Yes, at the moment GRAMPS is translated in 23 languages, see [[GRAMPS translations]].<br />
;How do I keep backups?<br />
:Use a recent version of GRAMPS! From 2.2.5 onwards there is an automatic backup utility.<br />
:It is extremely important to keep backups of your data, and keep them in a safe place. GRAMPS has a specific portable file format which is small, and human readable, denoted by <code>.gramps</code>. If you have allowed this in the preferences (In <tt>Edit menu->Preferences->General</tt>), GRAMPS will keep a backup of your database on exit. You can copy this backup file from time to time to a save location (eg a usb stick). <br />
: -<br />
:[Note: The .gramps files are compressed. Clicking them will open GRAMPS. To see the XML select them and open them with a decompressing utility (like ark, gunzip), after which you can extract the XML file which is human readable, see [[Generate_XML#How_do_I_uncompress_the_file?|details]].<br />
: -<br />
:'''Do not keep backups in GEDCOM'''. Not all information GRAMPS stores can be written in the GEDCOM. Hence, an export/import operation GRAMPS --> GEDCOM --> GRAMPS, will mean you '''lose''' data. Use the <code>.gramps</code> file format for backups!<br />
: -<br />
:'''Do not keep backups in GRDB format'''. GRDB is a database, which might be computer dependent (read, not working on a different PC). Small damage to a GRDB file can also not be repaired. Use the <code>.gramps</code> file format for backups!<br />
;Does Gramps support Unicode fonts? In particular, does it support non-Roman Unicode fonts?<br />
:Yes. GRAMPS works internally with Unicode (UTF-8), so all alphabets can be used on all entry fields. All reports fully support this, although for PDF/PS you need to work with gnome-print or openoffice.<br />
<br />
==Installation==<br />
<br />
;What is needed to install GRAMPS under Linux, Solaris, or FreeBSD?<br />
:GRAMPS is a [http://en.wikipedia.org/wiki/Gtk GTK] application. GRAMPS needs to have the [http://en.wikipedia.org/wiki/Pygtk pygtk] libraries installed on the system. As long as these libraries are installed, GRAMPS should function. It will operate under the GNOME desktop, KDE desktop, or any other desktop. If the GNOME bindings for Python are installed on the system, GRAMPS will have additional functionality. The GRAMPS project recommends version 2.8 or higher of GTK.<br />
;Does it work with Windows?<br />
:The [[Linux Genealogy CD]] can function as a live CD that you boot directly from. You can then run Linux and GRAMPS off the CD, even if your computer is entirely Windows.<br />
:A [[Windows installer]] is available, however we do not have the manpower to offer support for Windows. A [[Contact|windows mailing list]] is available however and we will do our best to solve windows related problems.<br />
:See also [[GRAMPS_and_Windows]] for a summary of hints to use GRAMPS on a Windows PC.<br />
;Does it work with the Mac?<br />
:The Fink project has ported some older versions of GRAMPS to OS X (tm). The Mac OS X port is not directly supported by the GRAMPS project, primarily because none of the GRAMPS developers have access to Mac OS X and because OS X is not Free Software.<br />
:This present version of GRAMPS (2.2.x) does not appear to have been ported by the Fink project. Please contact the Fink project for more information. However, some users have [[Mac OS X|had success]] in installing 2.2.x on Mac OSX either running in native mode or running on X11 using some of the fink packages.<br />
;What are the Minimum Specs to run GRAMPS?<br />
:We would recommend at least an 800x600 video display. For GRAMPS 2.0, the memory requirements have been reduced, and GRAMPS can run quite efficiently on a 256MB system, holding considerably more people. A system with 512MB should be able to hold around 200,000 people. Disk space requirements for databases are however considerably larger, with a typical database being several megabytes in size. For 120.000 people you must consider already 530Mb for the database. Pictures are stored on disk separately, so a large harddisk is necessary.<br />
<br />
==Preferences==<br />
;Can I change the dates in reports to 'day month year'<br />
:Yes, change in the preferences ("Edit->Preferences") the date for GRAMPS to the required format (eg YYYY-MM-DD or day month year), and make the report. Your global date preferences will be used.<br />
<br />
==Collaboration-Portability==<br />
;Is GRAMPS compatible with other genealogical software? <br />
:GRAMPS makes every effort to maintain compatibility with [[GEDCOM]], the general standard of recording genealogical information. We have import and export filters that enable GRAMPS to read and write GEDCOM files.<br />
: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 [[Contact|user feedback]]. Please feel free to inform us about any GEDCOM flavor not supported by GRAMPS, and we will do our best to support it!<br />
;Can GRAMPS read files created by other genealogy programs? <br />
:See above.<br />
;Can GRAMPS write files readable by other genealogy programs? <br />
:See above.<br />
;What standards does GRAMPS support? <br />
:The nice thing about standards is that there never is a shortage of them. GRAMPS 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.<br />
;How do I import data from another genealogy program into GRAMPS?<br />
:The best way is to create a new family tree, and select the import option in the file menu. Here you select the GEDCOM you generated with the other program, and import it. <br />
;Can I install GRAMPS on a Linux Web Server and use it via a web browser? This would enable my relations worldwide to access and update it.<br />
:While GRAMPS can generate web sites, it does not provide a web interface that allows for editing. If this is a requirement, then [http://geneweb.org GeneWeb] or [http://phpgedview.sourceforge.net PhpGedView] are programs more likely to meet your needs. However, you may wish to ask yourself the following questions:<br />
# Do I really want relatives or other people to directly edit my genealogy database?<br />
# Do I implicitly trust, without verification, any data that people may enter?<br />
# Do these people have the same understanding of good genealogy practice that I have?<br />
:A better approach may be to provide a web form interface that allows others to enter data that is then held for your examination. You can then decide if the information should be entered into your database.<br />
:You may also want to consider the effects of possible downtime of your site if you cannot afford yourself a premium webhosting service.<br />
<br />
==Reports==<br />
;Can GRAMPS print a genealogical tree for my family? <br />
: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.<br />
:GRAMPS 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.<br />
;In what formats can GRAMPS output its reports? <br />
:Text reports are available in HTML, PDF, ODT, LaTeX, and RTF formats. Graphical reports (charts and diagrams) are available in PostScript, PDF, SVG, ODS, and GraphViz formats.<br />
;How can I change the default language in reports?<br />
:The reports are in the language of your linux installation. You can change it by installing extra language packs, see [[Howto: Change the language of reports]]<br />
;Is GRAMPS compatible with the Internet? <br />
:GRAMPS 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. GRAMPS 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.<br />
;Can I create custom reports/filters/whatever? <br />
: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 GRAMPS 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.<br />
;Why are non-Latin characters displayed as garbage in PDF/PS reports? <br />
:This is a limitation of the built-in 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 <code>gnome-print</code> backend, which supports PS and PDF creation, as well as direct printing. (Note: you might need to install gnome-print separately as it is not required for GRAMPS).<br />
:If you only have Latin text, the PDF option will produce a smaller PDF compared to that created by gnome-print, simply because no font information will be embedded.<br />
;I would like to contribute to GRAMPS by writing my favorite report. How do I do that? <br />
:The easiest way to contribute to reports, filters, tools, etc. is to copy an existing GRAMPS 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 GRAMPS tool, you will need to write your own plugin from scratch. Help is available on the [[Portal:Developers|Developers Portal]], or on the [[Contact|Developers mailing list]]: gramps-devel@lists.sourceforge.net.<br />
: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 GRAMPS, create menu item, and so on.<br />
:If you are happy with your plugin and would like to contribute your code back to the GRAMPS project, you are very welcome to do so by contacting us at gramps-devel@lists.sourceforge.net<br />
<br />
==Database - GRAMPS file formats==<br />
;What is the maximum database size (bytes) GRAMPS can handle?<br />
:GRAMPS has no hard limits on the size of a database that it can handle. Starting with 2.0.0 release, GRAMPS 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, GRAMPS should have no problem using databases with [[GRAMPS Performance|tens of thousands of people]].<br />
;How many people can GRAMPS database handle? <br />
:See above. Again, this is dependent on how much memory you have, see [[GRAMPS Performance]].<br />
;My database is really big. Is there a way around loading all the data into memory?<br />
:Starting with 2.0.0 release, GRAMPS no longer loads all data into memory, which allows it to work with a much larger database than before. The fileformat used is <code>.grdb</code> which means gramps database.<br />
;Can I run GRAMPS from a database on a NFS share?<br />
:Yes you can.<br />
;Why is the database format not portable?<br />
:The biggest issue with GRAMPS portability lies with 'transactions'. With GRAMPS 2.2, we added support for atomic transactions to protect data. With atomic transactions, multiple changes are committed as a single unit. Either all the changes make it, or none of the changes make it. You are never left in a situation with a partial set of changes. A side benefit of using transactions is that database access (reads and writes) are faster.<br />
:The problem with transactions (at least using BSDDB) is that it does not allow all the data to be stored in a single file. Logging files are needed to keep track of things. These logging files are kept in a DB Environment directory. We need a separate directory for each file, otherwise the log files can interfere with each other.<br />
:In 2.2, we keep the log files under the ~/.gramps/<path> directory, creating a unique directory for each database. The problem is that your GRDB file needs the log files, which are in a different directory. Copying the GRDB file is only copying a portion of the database.<br />
<br />
==Bugs and requests==<br />
*I found a bug and I want it fixed right now! What do I do?<br />
The best thing you can do is to fix the bug and send the patch to gramps-devel@lists.sourceforge.net :-)<br />
<br />
If that is not possible, you should [[How to report bugs|submit a bug report]]<br />
<br />
A good bug report would include:<br />
# Version of gramps you were using when you encountered the bug (available through Help → About menu item).<br />
# Language under which gramps was run (available by executing <code> echo $LANG</code> in your terminal).<br />
# Symptoms indicating that this is indeed a bug.<br />
# Any Traceback messages, error messages, warnings, etc, that showed up in your terminal or a in separate traceback window.<br />
<br />
Most problems can be fixed quickly provided there is enough information. To ensure this, please follow up on your bug reports. Then we will have a way of contacting you should we need more information.<br />
<br />
*GRAMPS should be a .... type of application<br />
It is obvious that GRAMPS 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?<br />
<br />
The surest way to see it happen is to get it done by yourself. Since GRAMPS 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 GRAMPS development. If you would like the GRAMPS 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.<br />
<br />
If, however, you would like the GRAMPS project to adopt your strategy, you would need to convince GRAMPS developers that your strategy is good for GRAMPS and superior to the present development strategy.<br />
<br />
==GRAMPS Webhosting ==<br />
*How can I publish web sites generated by GRAMPS?<br />
Since GRAMPS generates HTML pages, you can upload the pages to your personal web site. If you do not have a personal web site, and still wish to have your pages available on the internet, the GRAMPS project can provide space for you at the http://library.gramps-project.org, see [[GRAMPS:Webhosting|the webhosting article]].<br />
<br />
*How do I submit my pages to the GRAMPS library site (http://library.gramps-project.org)?<br />
If you wish to submit pages to the GRAMPS library site, you will need to contact the GRAMPS project, typically by sending a message to the gramps-users mailing list. You will then be given a username and password that will allow you to upload your files to the site. After you upload the files (in a gzip'ed tar file), the GRAMPS project will install the pages for you on the site.<br />
<br />
*After I upload my Family Web Page to library.gramps-project.org, is the password used for write privileges only or read privileges?<br />
In order to prevent abuse of the library.gramsp-project.org site, the password given allows uploads only. If you wish to have a username and password combination to restrict read access to your pages, you will need to contact the GRAMPS project, and we could set this up for you. However, the read and write accounts will be separate accounts.<br />
<br />
*Do I view the Family Web Page with a url into my browser? Or through a link on a list of Family Web Pages on the GRAMPS-Project.org site?<br />
The main page on the library.gramps-project.org site will contain an index of the available family sites. However, there will be a unique URL for each site as well.<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
[[Category:Documentation]]<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_FAQ&diff=13921Gramps 3.0 Wiki Manual - FAQ2009-02-25T14:21:14Z<p>Simanek: /* Reports */ Marked up as definition list.</p>
<hr />
<div>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.sourceforge.net<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}<br />
<br />
<br />
{{stub}}<br />
<br />
<br />
Also consider having a look at:<br />
*[[:Category:How do I...|How do I...]]<br />
*[[:Category:Tutorials|GRAMPS Tutorials]]<br />
<br />
<br />
[[Category:Documentation]]<br />
<br />
==General==<br />
<br />
;What is GRAMPS?<br />
:GRAMPS 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, see [[GRAMPS:About|About]].<br />
;Where do I get it and how much does it cost?<br />
:GRAMPS can be [[Installation|installed]] at no charge. GRAMPS 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.<br />
;Does GRAMPS exist in other languages?<br />
:Yes, at the moment GRAMPS is translated in 23 languages, see [[GRAMPS translations]].<br />
;How do I keep backups?<br />
:Use a recent version of GRAMPS! From 2.2.5 onwards there is an automatic backup utility.<br />
:It is extremely important to keep backups of your data, and keep them in a safe place. GRAMPS has a specific portable file format which is small, and human readable, denoted by <code>.gramps</code>. If you have allowed this in the preferences (In <tt>Edit menu->Preferences->General</tt>), GRAMPS will keep a backup of your database on exit. You can copy this backup file from time to time to a save location (eg a usb stick). <br />
: -<br />
:[Note: The .gramps files are compressed. Clicking them will open GRAMPS. To see the XML select them and open them with a decompressing utility (like ark, gunzip), after which you can extract the XML file which is human readable, see [[Generate_XML#How_do_I_uncompress_the_file?|details]].<br />
: -<br />
:'''Do not keep backups in GEDCOM'''. Not all information GRAMPS stores can be written in the GEDCOM. Hence, an export/import operation GRAMPS --> GEDCOM --> GRAMPS, will mean you '''lose''' data. Use the <code>.gramps</code> file format for backups!<br />
: -<br />
:'''Do not keep backups in GRDB format'''. GRDB is a database, which might be computer dependent (read, not working on a different PC). Small damage to a GRDB file can also not be repaired. Use the <code>.gramps</code> file format for backups!<br />
;Does Gramps support Unicode fonts? In particular, does it support non-Roman Unicode fonts?<br />
:Yes. GRAMPS works internally with Unicode (UTF-8), so all alphabets can be used on all entry fields. All reports fully support this, although for PDF/PS you need to work with gnome-print or openoffice.<br />
<br />
==Installation==<br />
<br />
;What is needed to install GRAMPS under Linux, Solaris, or FreeBSD?<br />
:GRAMPS is a [http://en.wikipedia.org/wiki/Gtk GTK] application. GRAMPS needs to have the [http://en.wikipedia.org/wiki/Pygtk pygtk] libraries installed on the system. As long as these libraries are installed, GRAMPS should function. It will operate under the GNOME desktop, KDE desktop, or any other desktop. If the GNOME bindings for Python are installed on the system, GRAMPS will have additional functionality. The GRAMPS project recommends version 2.8 or higher of GTK.<br />
;Does it work with Windows?<br />
:The [[Linux Genealogy CD]] can function as a live CD that you boot directly from. You can then run Linux and GRAMPS off the CD, even if your computer is entirely Windows.<br />
:A [[Windows installer]] is available, however we do not have the manpower to offer support for Windows. A [[Contact|windows mailing list]] is available however and we will do our best to solve windows related problems.<br />
:See also [[GRAMPS_and_Windows]] for a summary of hints to use GRAMPS on a Windows PC.<br />
;Does it work with the Mac?<br />
:The Fink project has ported some older versions of GRAMPS to OS X (tm). The Mac OS X port is not directly supported by the GRAMPS project, primarily because none of the GRAMPS developers have access to Mac OS X and because OS X is not Free Software.<br />
:This present version of GRAMPS (2.2.x) does not appear to have been ported by the Fink project. Please contact the Fink project for more information. However, some users have [[Mac OS X|had success]] in installing 2.2.x on Mac OSX either running in native mode or running on X11 using some of the fink packages.<br />
;What are the Minimum Specs to run GRAMPS?<br />
:We would recommend at least an 800x600 video display. For GRAMPS 2.0, the memory requirements have been reduced, and GRAMPS can run quite efficiently on a 256MB system, holding considerably more people. A system with 512MB should be able to hold around 200,000 people. Disk space requirements for databases are however considerably larger, with a typical database being several megabytes in size. For 120.000 people you must consider already 530Mb for the database. Pictures are stored on disk separately, so a large harddisk is necessary.<br />
<br />
==Preferences==<br />
;Can I change the dates in reports to 'day month year'<br />
:Yes, change in the preferences ("Edit->Preferences") the date for GRAMPS to the required format (eg YYYY-MM-DD or day month year), and make the report. Your global date preferences will be used.<br />
<br />
==Collaboration-Portability==<br />
;Is GRAMPS compatible with other genealogical software? <br />
:GRAMPS makes every effort to maintain compatibility with [[GEDCOM]], the general standard of recording genealogical information. We have import and export filters that enable GRAMPS to read and write GEDCOM files.<br />
: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 [[Contact|user feedback]]. Please feel free to inform us about any GEDCOM flavor not supported by GRAMPS, and we will do our best to support it!<br />
;Can GRAMPS read files created by other genealogy programs? <br />
:See above.<br />
;Can GRAMPS write files readable by other genealogy programs? <br />
:See above.<br />
;What standards does GRAMPS support? <br />
:The nice thing about standards is that there never is a shortage of them. GRAMPS 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.<br />
;How do I import data from another genealogy program into GRAMPS?<br />
:The best way is to create a new family tree, and select the import option in the file menu. Here you select the GEDCOM you generated with the other program, and import it. <br />
;Can I install GRAMPS on a Linux Web Server and use it via a web browser? This would enable my relations worldwide to access and update it.<br />
:While GRAMPS can generate web sites, it does not provide a web interface that allows for editing. If this is a requirement, then [http://geneweb.org GeneWeb] or [http://phpgedview.sourceforge.net PhpGedView] are programs more likely to meet your needs. However, you may wish to ask yourself the following questions:<br />
# Do I really want relatives or other people to directly edit my genealogy database?<br />
# Do I implicitly trust, without verification, any data that people may enter?<br />
# Do these people have the same understanding of good genealogy practice that I have?<br />
:A better approach may be to provide a web form interface that allows others to enter data that is then held for your examination. You can then decide if the information should be entered into your database.<br />
:You may also want to consider the effects of possible downtime of your site if you cannot afford yourself a premium webhosting service.<br />
<br />
==Reports==<br />
;Can GRAMPS print a genealogical tree for my family? <br />
: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.<br />
:GRAMPS 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.<br />
;In what formats can GRAMPS output its reports? <br />
:Text reports are available in HTML, PDF, ODT, LaTeX, and RTF formats. Graphical reports (charts and diagrams) are available in PostScript, PDF, SVG, ODS, and GraphViz formats.<br />
;How can I change the default language in reports?<br />
:The reports are in the language of your linux installation. You can change it by installing extra language packs, see [[Howto: Change the language of reports]]<br />
;Is GRAMPS compatible with the Internet? <br />
:GRAMPS 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. GRAMPS 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.<br />
;Can I create custom reports/filters/whatever? <br />
: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 GRAMPS 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.<br />
;Why are non-Latin characters displayed as garbage in PDF/PS reports? <br />
:This is a limitation of the built-in 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 <code>gnome-print</code> backend, which supports PS and PDF creation, as well as direct printing. (Note: you might need to install gnome-print separately as it is not required for GRAMPS).<br />
:If you only have Latin text, the PDF option will produce a smaller PDF compared to that created by gnome-print, simply because no font information will be embedded.<br />
;I would like to contribute to GRAMPS by writing my favorite report. How do I do that? <br />
:The easiest way to contribute to reports, filters, tools, etc. is to copy an existing GRAMPS 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 GRAMPS tool, you will need to write your own plugin from scratch. Help is available on the [[Portal:Developers|Developers Portal]], or on the [[Contact|Developers mailing list]]: gramps-devel@lists.sourceforge.net.<br />
: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 GRAMPS, create menu item, and so on.<br />
:If you are happy with your plugin and would like to contribute your code back to the GRAMPS project, you are very welcome to do so by contacting us at gramps-devel@lists.sourceforge.net<br />
<br />
==Database - GRAMPS file formats==<br />
*What is the maximum database size (bytes) GRAMPS can handle?<br />
GRAMPS has no hard limits on the size of a database that it can handle. Starting with 2.0.0 release, GRAMPS 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, GRAMPS should have no problem using databases with [[GRAMPS Performance|tens of thousands of people]].<br />
<br />
*How many people can GRAMPS database handle? <br />
See above. Again, this is dependent on how much memory you have, see [[GRAMPS Performance]].<br />
<br />
*My database is really big. Is there a way around loading all the data into memory?<br />
Starting with 2.0.0 release, GRAMPS no longer loads all data into memory, which allows it to work with a much larger database than before. The fileformat used is <code>.grdb</code> which means gramps database.<br />
<br />
*Can I run GRAMPS from a database on a NFS share?<br />
Yes you can.<br />
<br />
*Why is the database format not portable?<br />
The biggest issue with GRAMPS portability lies with 'transactions'. With<br />
GRAMPS 2.2, we added support for atomic transactions to protect data.<br />
With atomic transactions, multiple changes are committed as a single<br />
unit. Either all the changes make it, or none of the changes make it.<br />
You are never left in a situation with a partial set of changes. A side<br />
benefit of using transactions is that database access (reads and writes)<br />
are faster.<br />
<br />
<br />
The problem with transactions (at least using BSDDB) is that it does not<br />
allow all the data to be stored in a single file. Logging files are<br />
needed to keep track of things. These logging files are kept in a DB<br />
Environment directory. We need a separate directory for each file,<br />
otherwise the log files can interfere with each other.<br />
<br />
<br />
In 2.2, we keep the log files under the ~/.gramps/<path> directory,<br />
creating a unique directory for each database. The problem is that your<br />
GRDB file needs the log files, which are in a different directory.<br />
Copying the GRDB file is only copying a portion of the database.<br />
<br />
==Bugs and requests==<br />
*I found a bug and I want it fixed right now! What do I do?<br />
The best thing you can do is to fix the bug and send the patch to gramps-devel@lists.sourceforge.net :-)<br />
<br />
If that is not possible, you should [[How to report bugs|submit a bug report]]<br />
<br />
A good bug report would include:<br />
# Version of gramps you were using when you encountered the bug (available through Help → About menu item).<br />
# Language under which gramps was run (available by executing <code> echo $LANG</code> in your terminal).<br />
# Symptoms indicating that this is indeed a bug.<br />
# Any Traceback messages, error messages, warnings, etc, that showed up in your terminal or a in separate traceback window.<br />
<br />
Most problems can be fixed quickly provided there is enough information. To ensure this, please follow up on your bug reports. Then we will have a way of contacting you should we need more information.<br />
<br />
*GRAMPS should be a .... type of application<br />
It is obvious that GRAMPS 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?<br />
<br />
The surest way to see it happen is to get it done by yourself. Since GRAMPS 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 GRAMPS development. If you would like the GRAMPS 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.<br />
<br />
If, however, you would like the GRAMPS project to adopt your strategy, you would need to convince GRAMPS developers that your strategy is good for GRAMPS and superior to the present development strategy.<br />
<br />
==GRAMPS Webhosting ==<br />
*How can I publish web sites generated by GRAMPS?<br />
Since GRAMPS generates HTML pages, you can upload the pages to your personal web site. If you do not have a personal web site, and still wish to have your pages available on the internet, the GRAMPS project can provide space for you at the http://library.gramps-project.org, see [[GRAMPS:Webhosting|the webhosting article]].<br />
<br />
*How do I submit my pages to the GRAMPS library site (http://library.gramps-project.org)?<br />
If you wish to submit pages to the GRAMPS library site, you will need to contact the GRAMPS project, typically by sending a message to the gramps-users mailing list. You will then be given a username and password that will allow you to upload your files to the site. After you upload the files (in a gzip'ed tar file), the GRAMPS project will install the pages for you on the site.<br />
<br />
*After I upload my Family Web Page to library.gramps-project.org, is the password used for write privileges only or read privileges?<br />
In order to prevent abuse of the library.gramsp-project.org site, the password given allows uploads only. If you wish to have a username and password combination to restrict read access to your pages, you will need to contact the GRAMPS project, and we could set this up for you. However, the read and write accounts will be separate accounts.<br />
<br />
*Do I view the Family Web Page with a url into my browser? Or through a link on a list of Family Web Pages on the GRAMPS-Project.org site?<br />
The main page on the library.gramps-project.org site will contain an index of the available family sites. However, there will be a unique URL for each site as well.<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
[[Category:Documentation]]<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_FAQ&diff=13920Gramps 3.0 Wiki Manual - FAQ2009-02-25T14:19:02Z<p>Simanek: /* Collaboration-Portability */ Marked up as definition list.</p>
<hr />
<div>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.sourceforge.net<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}<br />
<br />
<br />
{{stub}}<br />
<br />
<br />
Also consider having a look at:<br />
*[[:Category:How do I...|How do I...]]<br />
*[[:Category:Tutorials|GRAMPS Tutorials]]<br />
<br />
<br />
[[Category:Documentation]]<br />
<br />
==General==<br />
<br />
;What is GRAMPS?<br />
:GRAMPS 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, see [[GRAMPS:About|About]].<br />
;Where do I get it and how much does it cost?<br />
:GRAMPS can be [[Installation|installed]] at no charge. GRAMPS 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.<br />
;Does GRAMPS exist in other languages?<br />
:Yes, at the moment GRAMPS is translated in 23 languages, see [[GRAMPS translations]].<br />
;How do I keep backups?<br />
:Use a recent version of GRAMPS! From 2.2.5 onwards there is an automatic backup utility.<br />
:It is extremely important to keep backups of your data, and keep them in a safe place. GRAMPS has a specific portable file format which is small, and human readable, denoted by <code>.gramps</code>. If you have allowed this in the preferences (In <tt>Edit menu->Preferences->General</tt>), GRAMPS will keep a backup of your database on exit. You can copy this backup file from time to time to a save location (eg a usb stick). <br />
: -<br />
:[Note: The .gramps files are compressed. Clicking them will open GRAMPS. To see the XML select them and open them with a decompressing utility (like ark, gunzip), after which you can extract the XML file which is human readable, see [[Generate_XML#How_do_I_uncompress_the_file?|details]].<br />
: -<br />
:'''Do not keep backups in GEDCOM'''. Not all information GRAMPS stores can be written in the GEDCOM. Hence, an export/import operation GRAMPS --> GEDCOM --> GRAMPS, will mean you '''lose''' data. Use the <code>.gramps</code> file format for backups!<br />
: -<br />
:'''Do not keep backups in GRDB format'''. GRDB is a database, which might be computer dependent (read, not working on a different PC). Small damage to a GRDB file can also not be repaired. Use the <code>.gramps</code> file format for backups!<br />
;Does Gramps support Unicode fonts? In particular, does it support non-Roman Unicode fonts?<br />
:Yes. GRAMPS works internally with Unicode (UTF-8), so all alphabets can be used on all entry fields. All reports fully support this, although for PDF/PS you need to work with gnome-print or openoffice.<br />
<br />
==Installation==<br />
<br />
;What is needed to install GRAMPS under Linux, Solaris, or FreeBSD?<br />
:GRAMPS is a [http://en.wikipedia.org/wiki/Gtk GTK] application. GRAMPS needs to have the [http://en.wikipedia.org/wiki/Pygtk pygtk] libraries installed on the system. As long as these libraries are installed, GRAMPS should function. It will operate under the GNOME desktop, KDE desktop, or any other desktop. If the GNOME bindings for Python are installed on the system, GRAMPS will have additional functionality. The GRAMPS project recommends version 2.8 or higher of GTK.<br />
;Does it work with Windows?<br />
:The [[Linux Genealogy CD]] can function as a live CD that you boot directly from. You can then run Linux and GRAMPS off the CD, even if your computer is entirely Windows.<br />
:A [[Windows installer]] is available, however we do not have the manpower to offer support for Windows. A [[Contact|windows mailing list]] is available however and we will do our best to solve windows related problems.<br />
:See also [[GRAMPS_and_Windows]] for a summary of hints to use GRAMPS on a Windows PC.<br />
;Does it work with the Mac?<br />
:The Fink project has ported some older versions of GRAMPS to OS X (tm). The Mac OS X port is not directly supported by the GRAMPS project, primarily because none of the GRAMPS developers have access to Mac OS X and because OS X is not Free Software.<br />
:This present version of GRAMPS (2.2.x) does not appear to have been ported by the Fink project. Please contact the Fink project for more information. However, some users have [[Mac OS X|had success]] in installing 2.2.x on Mac OSX either running in native mode or running on X11 using some of the fink packages.<br />
;What are the Minimum Specs to run GRAMPS?<br />
:We would recommend at least an 800x600 video display. For GRAMPS 2.0, the memory requirements have been reduced, and GRAMPS can run quite efficiently on a 256MB system, holding considerably more people. A system with 512MB should be able to hold around 200,000 people. Disk space requirements for databases are however considerably larger, with a typical database being several megabytes in size. For 120.000 people you must consider already 530Mb for the database. Pictures are stored on disk separately, so a large harddisk is necessary.<br />
<br />
==Preferences==<br />
;Can I change the dates in reports to 'day month year'<br />
:Yes, change in the preferences ("Edit->Preferences") the date for GRAMPS to the required format (eg YYYY-MM-DD or day month year), and make the report. Your global date preferences will be used.<br />
<br />
==Collaboration-Portability==<br />
;Is GRAMPS compatible with other genealogical software? <br />
:GRAMPS makes every effort to maintain compatibility with [[GEDCOM]], the general standard of recording genealogical information. We have import and export filters that enable GRAMPS to read and write GEDCOM files.<br />
: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 [[Contact|user feedback]]. Please feel free to inform us about any GEDCOM flavor not supported by GRAMPS, and we will do our best to support it!<br />
;Can GRAMPS read files created by other genealogy programs? <br />
:See above.<br />
;Can GRAMPS write files readable by other genealogy programs? <br />
:See above.<br />
;What standards does GRAMPS support? <br />
:The nice thing about standards is that there never is a shortage of them. GRAMPS 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.<br />
;How do I import data from another genealogy program into GRAMPS?<br />
:The best way is to create a new family tree, and select the import option in the file menu. Here you select the GEDCOM you generated with the other program, and import it. <br />
;Can I install GRAMPS on a Linux Web Server and use it via a web browser? This would enable my relations worldwide to access and update it.<br />
:While GRAMPS can generate web sites, it does not provide a web interface that allows for editing. If this is a requirement, then [http://geneweb.org GeneWeb] or [http://phpgedview.sourceforge.net PhpGedView] are programs more likely to meet your needs. However, you may wish to ask yourself the following questions:<br />
# Do I really want relatives or other people to directly edit my genealogy database?<br />
# Do I implicitly trust, without verification, any data that people may enter?<br />
# Do these people have the same understanding of good genealogy practice that I have?<br />
:A better approach may be to provide a web form interface that allows others to enter data that is then held for your examination. You can then decide if the information should be entered into your database.<br />
:You may also want to consider the effects of possible downtime of your site if you cannot afford yourself a premium webhosting service.<br />
<br />
==Reports==<br />
*Can GRAMPS print a genealogical tree for my family? <br />
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.<br />
<br />
GRAMPS 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.<br />
<br />
*In what formats can GRAMPS output its reports? <br />
Text reports are available in HTML, PDF, ODT, LaTeX, and RTF formats. Graphical reports (charts and diagrams) are available in PostScript, PDF, SVG, ODS, and GraphViz formats.<br />
<br />
*How can I change the default language in reports?<br />
The reports are in the language of your linux installation. You can change it by installing extra language packs, see [[Howto: Change the language of reports]]<br />
<br />
*Is GRAMPS compatible with the Internet? <br />
GRAMPS 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. GRAMPS 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.<br />
<br />
*Can I create custom reports/filters/whatever? <br />
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 GRAMPS 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.<br />
<br />
*Why are non-Latin characters displayed as garbage in PDF/PS reports? <br />
This is a limitation of the built-in 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 <code>gnome-print</code> backend, which supports PS and PDF creation, as well as direct printing. (Note: you might need to install gnome-print separately as it is not required for GRAMPS).<br />
<br />
If you only have Latin text, the PDF option will produce a smaller PDF compared to that created by gnome-print, simply because no font information will be embedded.<br />
<br />
*I would like to contribute to GRAMPS by writing my favorite report. How do I do that? <br />
The easiest way to contribute to reports, filters, tools, etc. is to copy an existing GRAMPS 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 GRAMPS tool, you will need to write your own plugin from scratch. Help is available on the [[Portal:Developers|Developers Portal]], or on the [[Contact|Developers mailing list]]: gramps-devel@lists.sourceforge.net.<br />
<br />
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 GRAMPS, create menu item, and so on.<br />
<br />
If you are happy with your plugin and would like to contribute your code back to the GRAMPS project, you are very welcome to do so by contacting us at gramps-devel@lists.sourceforge.net<br />
<br />
==Database - GRAMPS file formats==<br />
*What is the maximum database size (bytes) GRAMPS can handle?<br />
GRAMPS has no hard limits on the size of a database that it can handle. Starting with 2.0.0 release, GRAMPS 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, GRAMPS should have no problem using databases with [[GRAMPS Performance|tens of thousands of people]].<br />
<br />
*How many people can GRAMPS database handle? <br />
See above. Again, this is dependent on how much memory you have, see [[GRAMPS Performance]].<br />
<br />
*My database is really big. Is there a way around loading all the data into memory?<br />
Starting with 2.0.0 release, GRAMPS no longer loads all data into memory, which allows it to work with a much larger database than before. The fileformat used is <code>.grdb</code> which means gramps database.<br />
<br />
*Can I run GRAMPS from a database on a NFS share?<br />
Yes you can.<br />
<br />
*Why is the database format not portable?<br />
The biggest issue with GRAMPS portability lies with 'transactions'. With<br />
GRAMPS 2.2, we added support for atomic transactions to protect data.<br />
With atomic transactions, multiple changes are committed as a single<br />
unit. Either all the changes make it, or none of the changes make it.<br />
You are never left in a situation with a partial set of changes. A side<br />
benefit of using transactions is that database access (reads and writes)<br />
are faster.<br />
<br />
<br />
The problem with transactions (at least using BSDDB) is that it does not<br />
allow all the data to be stored in a single file. Logging files are<br />
needed to keep track of things. These logging files are kept in a DB<br />
Environment directory. We need a separate directory for each file,<br />
otherwise the log files can interfere with each other.<br />
<br />
<br />
In 2.2, we keep the log files under the ~/.gramps/<path> directory,<br />
creating a unique directory for each database. The problem is that your<br />
GRDB file needs the log files, which are in a different directory.<br />
Copying the GRDB file is only copying a portion of the database.<br />
<br />
==Bugs and requests==<br />
*I found a bug and I want it fixed right now! What do I do?<br />
The best thing you can do is to fix the bug and send the patch to gramps-devel@lists.sourceforge.net :-)<br />
<br />
If that is not possible, you should [[How to report bugs|submit a bug report]]<br />
<br />
A good bug report would include:<br />
# Version of gramps you were using when you encountered the bug (available through Help → About menu item).<br />
# Language under which gramps was run (available by executing <code> echo $LANG</code> in your terminal).<br />
# Symptoms indicating that this is indeed a bug.<br />
# Any Traceback messages, error messages, warnings, etc, that showed up in your terminal or a in separate traceback window.<br />
<br />
Most problems can be fixed quickly provided there is enough information. To ensure this, please follow up on your bug reports. Then we will have a way of contacting you should we need more information.<br />
<br />
*GRAMPS should be a .... type of application<br />
It is obvious that GRAMPS 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?<br />
<br />
The surest way to see it happen is to get it done by yourself. Since GRAMPS 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 GRAMPS development. If you would like the GRAMPS 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.<br />
<br />
If, however, you would like the GRAMPS project to adopt your strategy, you would need to convince GRAMPS developers that your strategy is good for GRAMPS and superior to the present development strategy.<br />
<br />
==GRAMPS Webhosting ==<br />
*How can I publish web sites generated by GRAMPS?<br />
Since GRAMPS generates HTML pages, you can upload the pages to your personal web site. If you do not have a personal web site, and still wish to have your pages available on the internet, the GRAMPS project can provide space for you at the http://library.gramps-project.org, see [[GRAMPS:Webhosting|the webhosting article]].<br />
<br />
*How do I submit my pages to the GRAMPS library site (http://library.gramps-project.org)?<br />
If you wish to submit pages to the GRAMPS library site, you will need to contact the GRAMPS project, typically by sending a message to the gramps-users mailing list. You will then be given a username and password that will allow you to upload your files to the site. After you upload the files (in a gzip'ed tar file), the GRAMPS project will install the pages for you on the site.<br />
<br />
*After I upload my Family Web Page to library.gramps-project.org, is the password used for write privileges only or read privileges?<br />
In order to prevent abuse of the library.gramsp-project.org site, the password given allows uploads only. If you wish to have a username and password combination to restrict read access to your pages, you will need to contact the GRAMPS project, and we could set this up for you. However, the read and write accounts will be separate accounts.<br />
<br />
*Do I view the Family Web Page with a url into my browser? Or through a link on a list of Family Web Pages on the GRAMPS-Project.org site?<br />
The main page on the library.gramps-project.org site will contain an index of the available family sites. However, there will be a unique URL for each site as well.<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
[[Category:Documentation]]<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_FAQ&diff=13919Gramps 3.0 Wiki Manual - FAQ2009-02-25T14:16:15Z<p>Simanek: /* Preferences */ Marked up as definition list.</p>
<hr />
<div>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.sourceforge.net<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}<br />
<br />
<br />
{{stub}}<br />
<br />
<br />
Also consider having a look at:<br />
*[[:Category:How do I...|How do I...]]<br />
*[[:Category:Tutorials|GRAMPS Tutorials]]<br />
<br />
<br />
[[Category:Documentation]]<br />
<br />
==General==<br />
<br />
;What is GRAMPS?<br />
:GRAMPS 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, see [[GRAMPS:About|About]].<br />
;Where do I get it and how much does it cost?<br />
:GRAMPS can be [[Installation|installed]] at no charge. GRAMPS 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.<br />
;Does GRAMPS exist in other languages?<br />
:Yes, at the moment GRAMPS is translated in 23 languages, see [[GRAMPS translations]].<br />
;How do I keep backups?<br />
:Use a recent version of GRAMPS! From 2.2.5 onwards there is an automatic backup utility.<br />
:It is extremely important to keep backups of your data, and keep them in a safe place. GRAMPS has a specific portable file format which is small, and human readable, denoted by <code>.gramps</code>. If you have allowed this in the preferences (In <tt>Edit menu->Preferences->General</tt>), GRAMPS will keep a backup of your database on exit. You can copy this backup file from time to time to a save location (eg a usb stick). <br />
: -<br />
:[Note: The .gramps files are compressed. Clicking them will open GRAMPS. To see the XML select them and open them with a decompressing utility (like ark, gunzip), after which you can extract the XML file which is human readable, see [[Generate_XML#How_do_I_uncompress_the_file?|details]].<br />
: -<br />
:'''Do not keep backups in GEDCOM'''. Not all information GRAMPS stores can be written in the GEDCOM. Hence, an export/import operation GRAMPS --> GEDCOM --> GRAMPS, will mean you '''lose''' data. Use the <code>.gramps</code> file format for backups!<br />
: -<br />
:'''Do not keep backups in GRDB format'''. GRDB is a database, which might be computer dependent (read, not working on a different PC). Small damage to a GRDB file can also not be repaired. Use the <code>.gramps</code> file format for backups!<br />
;Does Gramps support Unicode fonts? In particular, does it support non-Roman Unicode fonts?<br />
:Yes. GRAMPS works internally with Unicode (UTF-8), so all alphabets can be used on all entry fields. All reports fully support this, although for PDF/PS you need to work with gnome-print or openoffice.<br />
<br />
==Installation==<br />
<br />
;What is needed to install GRAMPS under Linux, Solaris, or FreeBSD?<br />
:GRAMPS is a [http://en.wikipedia.org/wiki/Gtk GTK] application. GRAMPS needs to have the [http://en.wikipedia.org/wiki/Pygtk pygtk] libraries installed on the system. As long as these libraries are installed, GRAMPS should function. It will operate under the GNOME desktop, KDE desktop, or any other desktop. If the GNOME bindings for Python are installed on the system, GRAMPS will have additional functionality. The GRAMPS project recommends version 2.8 or higher of GTK.<br />
;Does it work with Windows?<br />
:The [[Linux Genealogy CD]] can function as a live CD that you boot directly from. You can then run Linux and GRAMPS off the CD, even if your computer is entirely Windows.<br />
:A [[Windows installer]] is available, however we do not have the manpower to offer support for Windows. A [[Contact|windows mailing list]] is available however and we will do our best to solve windows related problems.<br />
:See also [[GRAMPS_and_Windows]] for a summary of hints to use GRAMPS on a Windows PC.<br />
;Does it work with the Mac?<br />
:The Fink project has ported some older versions of GRAMPS to OS X (tm). The Mac OS X port is not directly supported by the GRAMPS project, primarily because none of the GRAMPS developers have access to Mac OS X and because OS X is not Free Software.<br />
:This present version of GRAMPS (2.2.x) does not appear to have been ported by the Fink project. Please contact the Fink project for more information. However, some users have [[Mac OS X|had success]] in installing 2.2.x on Mac OSX either running in native mode or running on X11 using some of the fink packages.<br />
;What are the Minimum Specs to run GRAMPS?<br />
:We would recommend at least an 800x600 video display. For GRAMPS 2.0, the memory requirements have been reduced, and GRAMPS can run quite efficiently on a 256MB system, holding considerably more people. A system with 512MB should be able to hold around 200,000 people. Disk space requirements for databases are however considerably larger, with a typical database being several megabytes in size. For 120.000 people you must consider already 530Mb for the database. Pictures are stored on disk separately, so a large harddisk is necessary.<br />
<br />
==Preferences==<br />
;Can I change the dates in reports to 'day month year'<br />
:Yes, change in the preferences ("Edit->Preferences") the date for GRAMPS to the required format (eg YYYY-MM-DD or day month year), and make the report. Your global date preferences will be used.<br />
<br />
==Collaboration-Portability==<br />
*Is GRAMPS compatible with other genealogical software? <br />
GRAMPS makes every effort to maintain compatibility with [[GEDCOM]], the general standard of recording genealogical information. We have import and export filters that enable GRAMPS to read and write GEDCOM files.<br />
<br />
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 [[Contact|user feedback]]. Please feel free to inform us about any GEDCOM flavor not supported by GRAMPS, and we will do our best to support it!<br />
<br />
*Can GRAMPS read files created by other genealogy programs? <br />
See above.<br />
<br />
*Can GRAMPS write files readable by other genealogy programs? <br />
See above.<br />
<br />
*What standards does GRAMPS support? <br />
The nice thing about standards is that there never is a shortage of them. GRAMPS 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.<br />
<br />
*How do I import data from another genealogy program into GRAMPS?<br />
The best way is to create a new family tree, and select the import option in the file menu. Here you select the GEDCOM you generated with the other program, and import it. <br />
<br />
*Can I install GRAMPS on a Linux Web Server and use it via a web browser? This would enable my relations worldwide to access and update it.<br />
While GRAMPS can generate web sites, it does not provide a web interface that allows for editing. If this is a requirement, then [http://geneweb.org GeneWeb] or [http://phpgedview.sourceforge.net PhpGedView] are programs more likely to meet your needs. However, you may wish to ask yourself the following questions:<br />
# Do I really want relatives or other people to directly edit my genealogy database?<br />
# Do I implicitly trust, without verification, any data that people may enter?<br />
# Do these people have the same understanding of good genealogy practice that I have?<br />
A better approach may be to provide a web form interface that allows others to enter data that is then held for your examination. You can then decide if the information should be entered into your database.<br />
<br />
You may also want to consider the effects of possible downtime of your site if you cannot afford yourself a premium webhosting service.<br />
<br />
==Reports==<br />
*Can GRAMPS print a genealogical tree for my family? <br />
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.<br />
<br />
GRAMPS 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.<br />
<br />
*In what formats can GRAMPS output its reports? <br />
Text reports are available in HTML, PDF, ODT, LaTeX, and RTF formats. Graphical reports (charts and diagrams) are available in PostScript, PDF, SVG, ODS, and GraphViz formats.<br />
<br />
*How can I change the default language in reports?<br />
The reports are in the language of your linux installation. You can change it by installing extra language packs, see [[Howto: Change the language of reports]]<br />
<br />
*Is GRAMPS compatible with the Internet? <br />
GRAMPS 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. GRAMPS 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.<br />
<br />
*Can I create custom reports/filters/whatever? <br />
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 GRAMPS 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.<br />
<br />
*Why are non-Latin characters displayed as garbage in PDF/PS reports? <br />
This is a limitation of the built-in 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 <code>gnome-print</code> backend, which supports PS and PDF creation, as well as direct printing. (Note: you might need to install gnome-print separately as it is not required for GRAMPS).<br />
<br />
If you only have Latin text, the PDF option will produce a smaller PDF compared to that created by gnome-print, simply because no font information will be embedded.<br />
<br />
*I would like to contribute to GRAMPS by writing my favorite report. How do I do that? <br />
The easiest way to contribute to reports, filters, tools, etc. is to copy an existing GRAMPS 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 GRAMPS tool, you will need to write your own plugin from scratch. Help is available on the [[Portal:Developers|Developers Portal]], or on the [[Contact|Developers mailing list]]: gramps-devel@lists.sourceforge.net.<br />
<br />
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 GRAMPS, create menu item, and so on.<br />
<br />
If you are happy with your plugin and would like to contribute your code back to the GRAMPS project, you are very welcome to do so by contacting us at gramps-devel@lists.sourceforge.net<br />
<br />
==Database - GRAMPS file formats==<br />
*What is the maximum database size (bytes) GRAMPS can handle?<br />
GRAMPS has no hard limits on the size of a database that it can handle. Starting with 2.0.0 release, GRAMPS 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, GRAMPS should have no problem using databases with [[GRAMPS Performance|tens of thousands of people]].<br />
<br />
*How many people can GRAMPS database handle? <br />
See above. Again, this is dependent on how much memory you have, see [[GRAMPS Performance]].<br />
<br />
*My database is really big. Is there a way around loading all the data into memory?<br />
Starting with 2.0.0 release, GRAMPS no longer loads all data into memory, which allows it to work with a much larger database than before. The fileformat used is <code>.grdb</code> which means gramps database.<br />
<br />
*Can I run GRAMPS from a database on a NFS share?<br />
Yes you can.<br />
<br />
*Why is the database format not portable?<br />
The biggest issue with GRAMPS portability lies with 'transactions'. With<br />
GRAMPS 2.2, we added support for atomic transactions to protect data.<br />
With atomic transactions, multiple changes are committed as a single<br />
unit. Either all the changes make it, or none of the changes make it.<br />
You are never left in a situation with a partial set of changes. A side<br />
benefit of using transactions is that database access (reads and writes)<br />
are faster.<br />
<br />
<br />
The problem with transactions (at least using BSDDB) is that it does not<br />
allow all the data to be stored in a single file. Logging files are<br />
needed to keep track of things. These logging files are kept in a DB<br />
Environment directory. We need a separate directory for each file,<br />
otherwise the log files can interfere with each other.<br />
<br />
<br />
In 2.2, we keep the log files under the ~/.gramps/<path> directory,<br />
creating a unique directory for each database. The problem is that your<br />
GRDB file needs the log files, which are in a different directory.<br />
Copying the GRDB file is only copying a portion of the database.<br />
<br />
==Bugs and requests==<br />
*I found a bug and I want it fixed right now! What do I do?<br />
The best thing you can do is to fix the bug and send the patch to gramps-devel@lists.sourceforge.net :-)<br />
<br />
If that is not possible, you should [[How to report bugs|submit a bug report]]<br />
<br />
A good bug report would include:<br />
# Version of gramps you were using when you encountered the bug (available through Help → About menu item).<br />
# Language under which gramps was run (available by executing <code> echo $LANG</code> in your terminal).<br />
# Symptoms indicating that this is indeed a bug.<br />
# Any Traceback messages, error messages, warnings, etc, that showed up in your terminal or a in separate traceback window.<br />
<br />
Most problems can be fixed quickly provided there is enough information. To ensure this, please follow up on your bug reports. Then we will have a way of contacting you should we need more information.<br />
<br />
*GRAMPS should be a .... type of application<br />
It is obvious that GRAMPS 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?<br />
<br />
The surest way to see it happen is to get it done by yourself. Since GRAMPS 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 GRAMPS development. If you would like the GRAMPS 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.<br />
<br />
If, however, you would like the GRAMPS project to adopt your strategy, you would need to convince GRAMPS developers that your strategy is good for GRAMPS and superior to the present development strategy.<br />
<br />
==GRAMPS Webhosting ==<br />
*How can I publish web sites generated by GRAMPS?<br />
Since GRAMPS generates HTML pages, you can upload the pages to your personal web site. If you do not have a personal web site, and still wish to have your pages available on the internet, the GRAMPS project can provide space for you at the http://library.gramps-project.org, see [[GRAMPS:Webhosting|the webhosting article]].<br />
<br />
*How do I submit my pages to the GRAMPS library site (http://library.gramps-project.org)?<br />
If you wish to submit pages to the GRAMPS library site, you will need to contact the GRAMPS project, typically by sending a message to the gramps-users mailing list. You will then be given a username and password that will allow you to upload your files to the site. After you upload the files (in a gzip'ed tar file), the GRAMPS project will install the pages for you on the site.<br />
<br />
*After I upload my Family Web Page to library.gramps-project.org, is the password used for write privileges only or read privileges?<br />
In order to prevent abuse of the library.gramsp-project.org site, the password given allows uploads only. If you wish to have a username and password combination to restrict read access to your pages, you will need to contact the GRAMPS project, and we could set this up for you. However, the read and write accounts will be separate accounts.<br />
<br />
*Do I view the Family Web Page with a url into my browser? Or through a link on a list of Family Web Pages on the GRAMPS-Project.org site?<br />
The main page on the library.gramps-project.org site will contain an index of the available family sites. However, there will be a unique URL for each site as well.<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
[[Category:Documentation]]<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_FAQ&diff=13918Gramps 3.0 Wiki Manual - FAQ2009-02-25T14:15:09Z<p>Simanek: /* Installation */ Marked up questions and answers as definition list.</p>
<hr />
<div>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.sourceforge.net<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}<br />
<br />
<br />
{{stub}}<br />
<br />
<br />
Also consider having a look at:<br />
*[[:Category:How do I...|How do I...]]<br />
*[[:Category:Tutorials|GRAMPS Tutorials]]<br />
<br />
<br />
[[Category:Documentation]]<br />
<br />
==General==<br />
<br />
;What is GRAMPS?<br />
:GRAMPS 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, see [[GRAMPS:About|About]].<br />
;Where do I get it and how much does it cost?<br />
:GRAMPS can be [[Installation|installed]] at no charge. GRAMPS 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.<br />
;Does GRAMPS exist in other languages?<br />
:Yes, at the moment GRAMPS is translated in 23 languages, see [[GRAMPS translations]].<br />
;How do I keep backups?<br />
:Use a recent version of GRAMPS! From 2.2.5 onwards there is an automatic backup utility.<br />
:It is extremely important to keep backups of your data, and keep them in a safe place. GRAMPS has a specific portable file format which is small, and human readable, denoted by <code>.gramps</code>. If you have allowed this in the preferences (In <tt>Edit menu->Preferences->General</tt>), GRAMPS will keep a backup of your database on exit. You can copy this backup file from time to time to a save location (eg a usb stick). <br />
: -<br />
:[Note: The .gramps files are compressed. Clicking them will open GRAMPS. To see the XML select them and open them with a decompressing utility (like ark, gunzip), after which you can extract the XML file which is human readable, see [[Generate_XML#How_do_I_uncompress_the_file?|details]].<br />
: -<br />
:'''Do not keep backups in GEDCOM'''. Not all information GRAMPS stores can be written in the GEDCOM. Hence, an export/import operation GRAMPS --> GEDCOM --> GRAMPS, will mean you '''lose''' data. Use the <code>.gramps</code> file format for backups!<br />
: -<br />
:'''Do not keep backups in GRDB format'''. GRDB is a database, which might be computer dependent (read, not working on a different PC). Small damage to a GRDB file can also not be repaired. Use the <code>.gramps</code> file format for backups!<br />
;Does Gramps support Unicode fonts? In particular, does it support non-Roman Unicode fonts?<br />
:Yes. GRAMPS works internally with Unicode (UTF-8), so all alphabets can be used on all entry fields. All reports fully support this, although for PDF/PS you need to work with gnome-print or openoffice.<br />
<br />
==Installation==<br />
<br />
;What is needed to install GRAMPS under Linux, Solaris, or FreeBSD?<br />
:GRAMPS is a [http://en.wikipedia.org/wiki/Gtk GTK] application. GRAMPS needs to have the [http://en.wikipedia.org/wiki/Pygtk pygtk] libraries installed on the system. As long as these libraries are installed, GRAMPS should function. It will operate under the GNOME desktop, KDE desktop, or any other desktop. If the GNOME bindings for Python are installed on the system, GRAMPS will have additional functionality. The GRAMPS project recommends version 2.8 or higher of GTK.<br />
;Does it work with Windows?<br />
:The [[Linux Genealogy CD]] can function as a live CD that you boot directly from. You can then run Linux and GRAMPS off the CD, even if your computer is entirely Windows.<br />
:A [[Windows installer]] is available, however we do not have the manpower to offer support for Windows. A [[Contact|windows mailing list]] is available however and we will do our best to solve windows related problems.<br />
:See also [[GRAMPS_and_Windows]] for a summary of hints to use GRAMPS on a Windows PC.<br />
;Does it work with the Mac?<br />
:The Fink project has ported some older versions of GRAMPS to OS X (tm). The Mac OS X port is not directly supported by the GRAMPS project, primarily because none of the GRAMPS developers have access to Mac OS X and because OS X is not Free Software.<br />
:This present version of GRAMPS (2.2.x) does not appear to have been ported by the Fink project. Please contact the Fink project for more information. However, some users have [[Mac OS X|had success]] in installing 2.2.x on Mac OSX either running in native mode or running on X11 using some of the fink packages.<br />
;What are the Minimum Specs to run GRAMPS?<br />
:We would recommend at least an 800x600 video display. For GRAMPS 2.0, the memory requirements have been reduced, and GRAMPS can run quite efficiently on a 256MB system, holding considerably more people. A system with 512MB should be able to hold around 200,000 people. Disk space requirements for databases are however considerably larger, with a typical database being several megabytes in size. For 120.000 people you must consider already 530Mb for the database. Pictures are stored on disk separately, so a large harddisk is necessary.<br />
<br />
==Preferences==<br />
*Can I change the dates in reports to 'day month year'<br />
Yes, change in the preferences ("Edit->Preferences") the date for GRAMPS to the required format (eg YYYY-MM-DD or day month year), and make the report. Your global date preferences will be used.<br />
<br />
==Collaboration-Portability==<br />
*Is GRAMPS compatible with other genealogical software? <br />
GRAMPS makes every effort to maintain compatibility with [[GEDCOM]], the general standard of recording genealogical information. We have import and export filters that enable GRAMPS to read and write GEDCOM files.<br />
<br />
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 [[Contact|user feedback]]. Please feel free to inform us about any GEDCOM flavor not supported by GRAMPS, and we will do our best to support it!<br />
<br />
*Can GRAMPS read files created by other genealogy programs? <br />
See above.<br />
<br />
*Can GRAMPS write files readable by other genealogy programs? <br />
See above.<br />
<br />
*What standards does GRAMPS support? <br />
The nice thing about standards is that there never is a shortage of them. GRAMPS 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.<br />
<br />
*How do I import data from another genealogy program into GRAMPS?<br />
The best way is to create a new family tree, and select the import option in the file menu. Here you select the GEDCOM you generated with the other program, and import it. <br />
<br />
*Can I install GRAMPS on a Linux Web Server and use it via a web browser? This would enable my relations worldwide to access and update it.<br />
While GRAMPS can generate web sites, it does not provide a web interface that allows for editing. If this is a requirement, then [http://geneweb.org GeneWeb] or [http://phpgedview.sourceforge.net PhpGedView] are programs more likely to meet your needs. However, you may wish to ask yourself the following questions:<br />
# Do I really want relatives or other people to directly edit my genealogy database?<br />
# Do I implicitly trust, without verification, any data that people may enter?<br />
# Do these people have the same understanding of good genealogy practice that I have?<br />
A better approach may be to provide a web form interface that allows others to enter data that is then held for your examination. You can then decide if the information should be entered into your database.<br />
<br />
You may also want to consider the effects of possible downtime of your site if you cannot afford yourself a premium webhosting service.<br />
<br />
==Reports==<br />
*Can GRAMPS print a genealogical tree for my family? <br />
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.<br />
<br />
GRAMPS 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.<br />
<br />
*In what formats can GRAMPS output its reports? <br />
Text reports are available in HTML, PDF, ODT, LaTeX, and RTF formats. Graphical reports (charts and diagrams) are available in PostScript, PDF, SVG, ODS, and GraphViz formats.<br />
<br />
*How can I change the default language in reports?<br />
The reports are in the language of your linux installation. You can change it by installing extra language packs, see [[Howto: Change the language of reports]]<br />
<br />
*Is GRAMPS compatible with the Internet? <br />
GRAMPS 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. GRAMPS 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.<br />
<br />
*Can I create custom reports/filters/whatever? <br />
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 GRAMPS 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.<br />
<br />
*Why are non-Latin characters displayed as garbage in PDF/PS reports? <br />
This is a limitation of the built-in 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 <code>gnome-print</code> backend, which supports PS and PDF creation, as well as direct printing. (Note: you might need to install gnome-print separately as it is not required for GRAMPS).<br />
<br />
If you only have Latin text, the PDF option will produce a smaller PDF compared to that created by gnome-print, simply because no font information will be embedded.<br />
<br />
*I would like to contribute to GRAMPS by writing my favorite report. How do I do that? <br />
The easiest way to contribute to reports, filters, tools, etc. is to copy an existing GRAMPS 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 GRAMPS tool, you will need to write your own plugin from scratch. Help is available on the [[Portal:Developers|Developers Portal]], or on the [[Contact|Developers mailing list]]: gramps-devel@lists.sourceforge.net.<br />
<br />
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 GRAMPS, create menu item, and so on.<br />
<br />
If you are happy with your plugin and would like to contribute your code back to the GRAMPS project, you are very welcome to do so by contacting us at gramps-devel@lists.sourceforge.net<br />
<br />
==Database - GRAMPS file formats==<br />
*What is the maximum database size (bytes) GRAMPS can handle?<br />
GRAMPS has no hard limits on the size of a database that it can handle. Starting with 2.0.0 release, GRAMPS 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, GRAMPS should have no problem using databases with [[GRAMPS Performance|tens of thousands of people]].<br />
<br />
*How many people can GRAMPS database handle? <br />
See above. Again, this is dependent on how much memory you have, see [[GRAMPS Performance]].<br />
<br />
*My database is really big. Is there a way around loading all the data into memory?<br />
Starting with 2.0.0 release, GRAMPS no longer loads all data into memory, which allows it to work with a much larger database than before. The fileformat used is <code>.grdb</code> which means gramps database.<br />
<br />
*Can I run GRAMPS from a database on a NFS share?<br />
Yes you can.<br />
<br />
*Why is the database format not portable?<br />
The biggest issue with GRAMPS portability lies with 'transactions'. With<br />
GRAMPS 2.2, we added support for atomic transactions to protect data.<br />
With atomic transactions, multiple changes are committed as a single<br />
unit. Either all the changes make it, or none of the changes make it.<br />
You are never left in a situation with a partial set of changes. A side<br />
benefit of using transactions is that database access (reads and writes)<br />
are faster.<br />
<br />
<br />
The problem with transactions (at least using BSDDB) is that it does not<br />
allow all the data to be stored in a single file. Logging files are<br />
needed to keep track of things. These logging files are kept in a DB<br />
Environment directory. We need a separate directory for each file,<br />
otherwise the log files can interfere with each other.<br />
<br />
<br />
In 2.2, we keep the log files under the ~/.gramps/<path> directory,<br />
creating a unique directory for each database. The problem is that your<br />
GRDB file needs the log files, which are in a different directory.<br />
Copying the GRDB file is only copying a portion of the database.<br />
<br />
==Bugs and requests==<br />
*I found a bug and I want it fixed right now! What do I do?<br />
The best thing you can do is to fix the bug and send the patch to gramps-devel@lists.sourceforge.net :-)<br />
<br />
If that is not possible, you should [[How to report bugs|submit a bug report]]<br />
<br />
A good bug report would include:<br />
# Version of gramps you were using when you encountered the bug (available through Help → About menu item).<br />
# Language under which gramps was run (available by executing <code> echo $LANG</code> in your terminal).<br />
# Symptoms indicating that this is indeed a bug.<br />
# Any Traceback messages, error messages, warnings, etc, that showed up in your terminal or a in separate traceback window.<br />
<br />
Most problems can be fixed quickly provided there is enough information. To ensure this, please follow up on your bug reports. Then we will have a way of contacting you should we need more information.<br />
<br />
*GRAMPS should be a .... type of application<br />
It is obvious that GRAMPS 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?<br />
<br />
The surest way to see it happen is to get it done by yourself. Since GRAMPS 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 GRAMPS development. If you would like the GRAMPS 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.<br />
<br />
If, however, you would like the GRAMPS project to adopt your strategy, you would need to convince GRAMPS developers that your strategy is good for GRAMPS and superior to the present development strategy.<br />
<br />
==GRAMPS Webhosting ==<br />
*How can I publish web sites generated by GRAMPS?<br />
Since GRAMPS generates HTML pages, you can upload the pages to your personal web site. If you do not have a personal web site, and still wish to have your pages available on the internet, the GRAMPS project can provide space for you at the http://library.gramps-project.org, see [[GRAMPS:Webhosting|the webhosting article]].<br />
<br />
*How do I submit my pages to the GRAMPS library site (http://library.gramps-project.org)?<br />
If you wish to submit pages to the GRAMPS library site, you will need to contact the GRAMPS project, typically by sending a message to the gramps-users mailing list. You will then be given a username and password that will allow you to upload your files to the site. After you upload the files (in a gzip'ed tar file), the GRAMPS project will install the pages for you on the site.<br />
<br />
*After I upload my Family Web Page to library.gramps-project.org, is the password used for write privileges only or read privileges?<br />
In order to prevent abuse of the library.gramsp-project.org site, the password given allows uploads only. If you wish to have a username and password combination to restrict read access to your pages, you will need to contact the GRAMPS project, and we could set this up for you. However, the read and write accounts will be separate accounts.<br />
<br />
*Do I view the Family Web Page with a url into my browser? Or through a link on a list of Family Web Pages on the GRAMPS-Project.org site?<br />
The main page on the library.gramps-project.org site will contain an index of the available family sites. However, there will be a unique URL for each site as well.<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
[[Category:Documentation]]<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_FAQ&diff=13917Gramps 3.0 Wiki Manual - FAQ2009-02-25T14:12:10Z<p>Simanek: /* General */ Markup improvements (definition list) to make the questions easier to 'scan' going down the page. The additional info on backups needs a different treatment still.</p>
<hr />
<div>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.sourceforge.net<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}<br />
<br />
<br />
{{stub}}<br />
<br />
<br />
Also consider having a look at:<br />
*[[:Category:How do I...|How do I...]]<br />
*[[:Category:Tutorials|GRAMPS Tutorials]]<br />
<br />
<br />
[[Category:Documentation]]<br />
<br />
==General==<br />
<br />
;What is GRAMPS?<br />
:GRAMPS 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, see [[GRAMPS:About|About]].<br />
;Where do I get it and how much does it cost?<br />
:GRAMPS can be [[Installation|installed]] at no charge. GRAMPS 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.<br />
;Does GRAMPS exist in other languages?<br />
:Yes, at the moment GRAMPS is translated in 23 languages, see [[GRAMPS translations]].<br />
;How do I keep backups?<br />
:Use a recent version of GRAMPS! From 2.2.5 onwards there is an automatic backup utility.<br />
:It is extremely important to keep backups of your data, and keep them in a safe place. GRAMPS has a specific portable file format which is small, and human readable, denoted by <code>.gramps</code>. If you have allowed this in the preferences (In <tt>Edit menu->Preferences->General</tt>), GRAMPS will keep a backup of your database on exit. You can copy this backup file from time to time to a save location (eg a usb stick). <br />
: -<br />
:[Note: The .gramps files are compressed. Clicking them will open GRAMPS. To see the XML select them and open them with a decompressing utility (like ark, gunzip), after which you can extract the XML file which is human readable, see [[Generate_XML#How_do_I_uncompress_the_file?|details]].<br />
: -<br />
:'''Do not keep backups in GEDCOM'''. Not all information GRAMPS stores can be written in the GEDCOM. Hence, an export/import operation GRAMPS --> GEDCOM --> GRAMPS, will mean you '''lose''' data. Use the <code>.gramps</code> file format for backups!<br />
: -<br />
:'''Do not keep backups in GRDB format'''. GRDB is a database, which might be computer dependent (read, not working on a different PC). Small damage to a GRDB file can also not be repaired. Use the <code>.gramps</code> file format for backups!<br />
;Does Gramps support Unicode fonts? In particular, does it support non-Roman Unicode fonts?<br />
:Yes. GRAMPS works internally with Unicode (UTF-8), so all alphabets can be used on all entry fields. All reports fully support this, although for PDF/PS you need to work with gnome-print or openoffice.<br />
<br />
==Installation==<br />
<br />
*What is needed to install GRAMPS under Linux, Solaris, or FreeBSD?<br />
GRAMPS is a [http://en.wikipedia.org/wiki/Gtk GTK] application. GRAMPS needs to have the [http://en.wikipedia.org/wiki/Pygtk pygtk] libraries installed on the system. As long as these libraries are installed, GRAMPS should function. It will operate under the GNOME desktop, KDE desktop, or any other desktop. If the GNOME bindings for Python are installed on the system, GRAMPS will have additional functionality. The GRAMPS project recommends version 2.8 or higher of GTK.<br />
<br />
*Does it work with Windows?<br />
<br />
The [[Linux Genealogy CD]] can function as a live CD that you boot directly from. You can then run Linux and GRAMPS off the CD, even if your computer is entirely Windows.<br />
<br />
A [[Windows installer]] is available, however we do not have the manpower to offer support for Windows. A [[Contact|windows mailing list]] is available however and we will do our best to solve windows related problems.<br />
See also [[GRAMPS_and_Windows]] for a summary of hints to use GRAMPS on a Windows PC.<br />
*Does it work with the Mac?<br />
The Fink project has ported some older versions of GRAMPS to OS X (tm). The Mac OS X port is not directly supported by the GRAMPS project, primarily because none of the GRAMPS developers have access to Mac OS X and because OS X is not Free Software.<br />
<br />
This present version of GRAMPS (2.2.x) does not appear to have been ported by the Fink project. Please contact the Fink project for more information. However, some users have [[Mac OS X|had success]] in installing 2.2.x on Mac OSX either running in native mode or running on X11 using some of the fink packages.<br />
<br />
*What are the Minimum Specs to run GRAMPS?<br />
We would recommend at least an 800x600 video display. For GRAMPS 2.0, the memory requirements have been reduced, and GRAMPS can run quite efficiently on a 256MB system, holding considerably more people. A system with 512MB should be able to hold around 200,000 people. Disk space requirements for databases are however considerably larger, with a typical database being several megabytes in size. For 120.000 people you must consider already 530Mb for the database. Pictures are stored on disk separately, so a large harddisk is necessary.<br />
<br />
==Preferences==<br />
*Can I change the dates in reports to 'day month year'<br />
Yes, change in the preferences ("Edit->Preferences") the date for GRAMPS to the required format (eg YYYY-MM-DD or day month year), and make the report. Your global date preferences will be used.<br />
<br />
==Collaboration-Portability==<br />
*Is GRAMPS compatible with other genealogical software? <br />
GRAMPS makes every effort to maintain compatibility with [[GEDCOM]], the general standard of recording genealogical information. We have import and export filters that enable GRAMPS to read and write GEDCOM files.<br />
<br />
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 [[Contact|user feedback]]. Please feel free to inform us about any GEDCOM flavor not supported by GRAMPS, and we will do our best to support it!<br />
<br />
*Can GRAMPS read files created by other genealogy programs? <br />
See above.<br />
<br />
*Can GRAMPS write files readable by other genealogy programs? <br />
See above.<br />
<br />
*What standards does GRAMPS support? <br />
The nice thing about standards is that there never is a shortage of them. GRAMPS 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.<br />
<br />
*How do I import data from another genealogy program into GRAMPS?<br />
The best way is to create a new family tree, and select the import option in the file menu. Here you select the GEDCOM you generated with the other program, and import it. <br />
<br />
*Can I install GRAMPS on a Linux Web Server and use it via a web browser? This would enable my relations worldwide to access and update it.<br />
While GRAMPS can generate web sites, it does not provide a web interface that allows for editing. If this is a requirement, then [http://geneweb.org GeneWeb] or [http://phpgedview.sourceforge.net PhpGedView] are programs more likely to meet your needs. However, you may wish to ask yourself the following questions:<br />
# Do I really want relatives or other people to directly edit my genealogy database?<br />
# Do I implicitly trust, without verification, any data that people may enter?<br />
# Do these people have the same understanding of good genealogy practice that I have?<br />
A better approach may be to provide a web form interface that allows others to enter data that is then held for your examination. You can then decide if the information should be entered into your database.<br />
<br />
You may also want to consider the effects of possible downtime of your site if you cannot afford yourself a premium webhosting service.<br />
<br />
==Reports==<br />
*Can GRAMPS print a genealogical tree for my family? <br />
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.<br />
<br />
GRAMPS 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.<br />
<br />
*In what formats can GRAMPS output its reports? <br />
Text reports are available in HTML, PDF, ODT, LaTeX, and RTF formats. Graphical reports (charts and diagrams) are available in PostScript, PDF, SVG, ODS, and GraphViz formats.<br />
<br />
*How can I change the default language in reports?<br />
The reports are in the language of your linux installation. You can change it by installing extra language packs, see [[Howto: Change the language of reports]]<br />
<br />
*Is GRAMPS compatible with the Internet? <br />
GRAMPS 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. GRAMPS 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.<br />
<br />
*Can I create custom reports/filters/whatever? <br />
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 GRAMPS 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.<br />
<br />
*Why are non-Latin characters displayed as garbage in PDF/PS reports? <br />
This is a limitation of the built-in 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 <code>gnome-print</code> backend, which supports PS and PDF creation, as well as direct printing. (Note: you might need to install gnome-print separately as it is not required for GRAMPS).<br />
<br />
If you only have Latin text, the PDF option will produce a smaller PDF compared to that created by gnome-print, simply because no font information will be embedded.<br />
<br />
*I would like to contribute to GRAMPS by writing my favorite report. How do I do that? <br />
The easiest way to contribute to reports, filters, tools, etc. is to copy an existing GRAMPS 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 GRAMPS tool, you will need to write your own plugin from scratch. Help is available on the [[Portal:Developers|Developers Portal]], or on the [[Contact|Developers mailing list]]: gramps-devel@lists.sourceforge.net.<br />
<br />
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 GRAMPS, create menu item, and so on.<br />
<br />
If you are happy with your plugin and would like to contribute your code back to the GRAMPS project, you are very welcome to do so by contacting us at gramps-devel@lists.sourceforge.net<br />
<br />
==Database - GRAMPS file formats==<br />
*What is the maximum database size (bytes) GRAMPS can handle?<br />
GRAMPS has no hard limits on the size of a database that it can handle. Starting with 2.0.0 release, GRAMPS 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, GRAMPS should have no problem using databases with [[GRAMPS Performance|tens of thousands of people]].<br />
<br />
*How many people can GRAMPS database handle? <br />
See above. Again, this is dependent on how much memory you have, see [[GRAMPS Performance]].<br />
<br />
*My database is really big. Is there a way around loading all the data into memory?<br />
Starting with 2.0.0 release, GRAMPS no longer loads all data into memory, which allows it to work with a much larger database than before. The fileformat used is <code>.grdb</code> which means gramps database.<br />
<br />
*Can I run GRAMPS from a database on a NFS share?<br />
Yes you can.<br />
<br />
*Why is the database format not portable?<br />
The biggest issue with GRAMPS portability lies with 'transactions'. With<br />
GRAMPS 2.2, we added support for atomic transactions to protect data.<br />
With atomic transactions, multiple changes are committed as a single<br />
unit. Either all the changes make it, or none of the changes make it.<br />
You are never left in a situation with a partial set of changes. A side<br />
benefit of using transactions is that database access (reads and writes)<br />
are faster.<br />
<br />
<br />
The problem with transactions (at least using BSDDB) is that it does not<br />
allow all the data to be stored in a single file. Logging files are<br />
needed to keep track of things. These logging files are kept in a DB<br />
Environment directory. We need a separate directory for each file,<br />
otherwise the log files can interfere with each other.<br />
<br />
<br />
In 2.2, we keep the log files under the ~/.gramps/<path> directory,<br />
creating a unique directory for each database. The problem is that your<br />
GRDB file needs the log files, which are in a different directory.<br />
Copying the GRDB file is only copying a portion of the database.<br />
<br />
==Bugs and requests==<br />
*I found a bug and I want it fixed right now! What do I do?<br />
The best thing you can do is to fix the bug and send the patch to gramps-devel@lists.sourceforge.net :-)<br />
<br />
If that is not possible, you should [[How to report bugs|submit a bug report]]<br />
<br />
A good bug report would include:<br />
# Version of gramps you were using when you encountered the bug (available through Help → About menu item).<br />
# Language under which gramps was run (available by executing <code> echo $LANG</code> in your terminal).<br />
# Symptoms indicating that this is indeed a bug.<br />
# Any Traceback messages, error messages, warnings, etc, that showed up in your terminal or a in separate traceback window.<br />
<br />
Most problems can be fixed quickly provided there is enough information. To ensure this, please follow up on your bug reports. Then we will have a way of contacting you should we need more information.<br />
<br />
*GRAMPS should be a .... type of application<br />
It is obvious that GRAMPS 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?<br />
<br />
The surest way to see it happen is to get it done by yourself. Since GRAMPS 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 GRAMPS development. If you would like the GRAMPS 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.<br />
<br />
If, however, you would like the GRAMPS project to adopt your strategy, you would need to convince GRAMPS developers that your strategy is good for GRAMPS and superior to the present development strategy.<br />
<br />
==GRAMPS Webhosting ==<br />
*How can I publish web sites generated by GRAMPS?<br />
Since GRAMPS generates HTML pages, you can upload the pages to your personal web site. If you do not have a personal web site, and still wish to have your pages available on the internet, the GRAMPS project can provide space for you at the http://library.gramps-project.org, see [[GRAMPS:Webhosting|the webhosting article]].<br />
<br />
*How do I submit my pages to the GRAMPS library site (http://library.gramps-project.org)?<br />
If you wish to submit pages to the GRAMPS library site, you will need to contact the GRAMPS project, typically by sending a message to the gramps-users mailing list. You will then be given a username and password that will allow you to upload your files to the site. After you upload the files (in a gzip'ed tar file), the GRAMPS project will install the pages for you on the site.<br />
<br />
*After I upload my Family Web Page to library.gramps-project.org, is the password used for write privileges only or read privileges?<br />
In order to prevent abuse of the library.gramsp-project.org site, the password given allows uploads only. If you wish to have a username and password combination to restrict read access to your pages, you will need to contact the GRAMPS project, and we could set this up for you. However, the read and write accounts will be separate accounts.<br />
<br />
*Do I view the Family Web Page with a url into my browser? Or through a link on a list of Family Web Pages on the GRAMPS-Project.org site?<br />
The main page on the library.gramps-project.org site will contain an index of the available family sites. However, there will be a unique URL for each site as well.<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Filters|Gramps 3.0 Wiki Manual - Keybindings|3.0}}<br />
<br />
[[Category:Documentation]]<br />
<br />
{{languages|Gramps_3.0_Wiki_Manual_-_FAQ}}</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Familylines_plugin&diff=13258Familylines plugin2009-02-08T17:20:04Z<p>Simanek: /* Generating graphs */ Added SVG generation command. Added names for each command option and markup as a description list.</p>
<hr />
<div>[[Image:Familylines.gif|thumb|Example of a graph generated using FamilyLines.py, without thumbnail images.]]<br />
[[Image:Familylines with thumbnails.gif|thumb|Example of a graph generated using FamilyLines.py, with thumbnail images.]]<br />
The FamilyLines.py plugin was created to generate easy-to-follow graphs. Note that FamilyLines does not display all of the people in the database -- instead, this plugin generates smaller family trees, with many options to try and restrict the number of people included.<br />
<br />
A typical use of this plugin is to generate simplified graphs printed on large plotters.<br />
<br />
==Download and installation==<br />
<br />
The plugin was created by [[User:Stephanecharette|Stéphane Charette]] and tested with Gramps version 2.2.6-1 and 2.2.8-0. On Ubuntu 6.10 and 7.04, the plugin is installed by copying the file FamilyLines.py ([http://charette.no-ip.com:1234/Charette/FamilyLines.py download FamilyLines.py]) to /usr/share/gramps/plugins/.<br />
<br />
==Using FamilyLines.py==<br />
<br />
The plugin installs itself in the same location as the Relationship Graph plugin: click on Reports, Code Generators, Family Lines Graph.<br />
<br />
This plugin makes no attempt to write to the Gramps database. It only reads from the database. (Since this is not an official Gramps plugin, you should still ensure you have the necessary up-to-date backups!)<br />
<br />
There are 5 tabs used to configure how the plugin works.<br />
<br />
===GraphViz Options===<br />
[[Image:Familylines_graphviz.png|thumb]]<br />
This plugin uses [http://www.graphviz.org/ GraphViz]. GraphViz takes the .dot files and creates the final files, such as .gif, .png, .pdf, .ps, etc.<br />
<br />
This first tab allows several GraphViz options to be set:<br />
* '''Width''': the width, in inches, of the final image. Set to a large number if generating .png or .gif files.<br />
* '''Height''': the height, in inches, of the final image. Set to a large number if generating .png or .gif files.<br />
* '''DPI''': dots-per-inch. Typically between 75 and 120 if generating .png or .gif files, but 300 or 600 if generating files to be printed.<br />
* '''Row spacing''': the whitespace to leave, in inches, between rows.<br />
* '''Columns spacing''': the whitespace to leave, in inches, between columns<br />
* '''Graph direction''': whether the tree grows from left-to-right, or right-to-left.<br />
* '''Ratio''': GraphViz uses this to determine how to position items. Only trial-and-error will help you determine the best option to use. (When in doubt, '''compress''' tends to work well.)<br />
<br clear=right><br />
<br />
===People of Interest===<br />
[[Image:Familylines_people.png|thumb]]<br />
The FamilyLines.py plugin works by starting with a list of "people of interest". This initial list of people is then used to find both ancestors and descendants. <br />
* '''People of interest''': click on "+" and "-" to add/remove people of interest. When in doubt, try adding your grandparents as a starting place.<br />
* '''Follow parents to determine family lines''': when selected, this causes FamilyLines.py to follow the parents to determine the full list of people of interest. You most likely want this selected.<br />
* '''Follow children to determine family lines''': when selected, this causes FamilyLines.py to follow the children of the people of interest.<br />
* '''Try to remove extra people and families''': when selected, this option causes FamilyLines.py to aggressively attempt to remove extra ancestors and families from the family tree.<br />
<br clear=right><br />
<br />
===Family Colours===<br />
[[Image:Familylines_family.png|thumb]]<br />
Select the colour to use for people with a specific surname. Click on "+" or "-" to add a surname. Double-click on a surname to edit the colour.<br />
<br clear=right><br />
<br />
===Individuals===<br />
[[Image:Familylines_individuals.png|thumb]]<br />
* '''Males''', '''Females''', '''Unknown''': the colour to use for people whose surname doesn't match any of the names on the "Family Colours" tab.<br />
* '''Families''': the colour to use for families (weddings).<br />
* '''Limit the number of parents''': if selected, then the number of ancestors will be limited by the amount shown. This can only be selected if "Follow parents" has also been selected on the "People of Interest" tab.<br />
* '''Limit the number of children''': if selected, then the number of children will be limited by the amount shown. This can only be selected if "Follow children" has also been selected on the "People of Interest" tab.<br />
<br clear=right><br />
<br />
===Options===<br />
[[Image:Familylines_options.png|thumb]]<br />
* '''Include dates''': date of birth, date of death, and marriage dates will be included in the graph when this is selected.<br />
* '''Include places''': place of birth, place of death, and place of marriage will be included in the graph when this is selected.<br />
* '''Include the number of children''': marriage text will include the total number of children when this is selected.<br />
* '''Include researcher and date''': a label will be placed at the bottom of the graph when this is selected.<br />
* '''Include private records''': people and events marked as private will be included in the graph when this is selected.<br />
<br clear=right><br />
<br />
==Generating graphs==<br />
Once FamilyLines.py produces the .dot output file (defaults to ''./familylines.dot''), the GraphViz package will be necessary to create the final output file. If GraphViz isn't already installed, you can download it from [http://www.graphviz.org/ http://www.graphviz.org/].<br />
<br />
Some common examples of commands used to generate graphs from the familylines.dot file are:<br />
<br />
;GIF<br />
:<pre>dot -v -Tgif -ofamilylines.gif familylines.dot</pre><br />
;PNG<br />
:<pre>dot -v -Tpng -ofamilylines.png familylines.dot</pre><br />
;PCL<br />
:<pre>dot -v -Tpcl -ofamilylines.pcl familylines.dot</pre><br />
;PostScript<br />
:<pre>dot -v -Tps -ofamilylines.ps familylines.dot</pre><br />
;SVG<br />
:<pre>dot -v -Tsvg -ofamilylines.svg familylines.dot</pre><br />
<br />
[[Category: Plugins]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Filter&diff=6175Filter2008-04-20T15:46:19Z<p>Simanek: /* How to define custom filters */ View versus View Mode confusion on my part</p>
<hr />
<div>What are filters?<br />
{{languages}}<br />
[[Category:Documentation]]<br />
<br />
==Filters==<br />
Filtering genealogical information is crucial for research, as well as for creating nice reports. <br />
Most reports of GRAMPS allow the use of filters, only displaying information about people that correspond to the filter. <br />
<br />
On the other hand, filtered data can be all the info you need, like a self constructed mini-report.<br />
<br />
==How to define custom filters==<br />
Custom filters are relative to the active View. If you are in People View you will create a Person Filter, Event View/an Event Filter, etc. In the {{man label|Edit}} menu, click the option {{man label|<View> Filter Editor}}.<br />
<br />
You can give the custom filter a name and add rules to the filter. The data will be filtered according to the rules. <br />
<br />
In some filters you can use regular expressions. For learning how to use regular expressions, see the [http://www.amk.ca/python/howto/regex/regex.html Regular Expression HOWTO].<br />
<br />
== Test a custom filter==<br />
In the {{man label|Edit}} menu, click on {{man label|Column Editor}}, and select the columns you want to view. Next, activate {{man label|Filter}}. This can be done by going to the {{man label|View}} menu, and clicking on {{man label|Filter}}.<br />
<br />
== Examples ==<br />
See [[Example filters]].<br />
To the right of the list view, a sidebar will open, allowing to filter your data. At the bottom of this, you can select the newly created Custom Filter. Click on Find, and all Persons/ Families/Events/Places/Media/Repositories matching the filter are displayed.<br />
At present (version 2.X), there is no way to print this data.<br />
<br />
In the '''3.0 version''' you will have an option {{man label|Export view}} on the {{man label|Family Trees}} menu. This gives you the opportunity to export the view as a spreadsheet with following format options:<br />
*[[Gramps_3.0_Wiki_Manual_-_Manage_Family_Trees:_CSV_Import_and_Export#Export|CSV]]<br />
*Open Document Spreadsheet<br />
<br />
Another '''3.0''' method would be that you select the {{man label|Export}} option on the {{man label|Family Trees}} menu. An '''Export Assistant''' view will be presented where you also can select the {{man button|Comma Separated Values Spreadsheet (CSV)}}. Next, click on the {{man button|Forward}} button and in the next screen you can select in the {{man label|Options}} view which filter you want to use and whether you want to include Indivuduals, Marriages and Children. Click once again on the {{man button|Forward}} button and you can save the file.<br />
<br />
== Suggestions for filter rules==<br />
What you can do with a filter depends on the rules available to you in GRAMPS.<br />
If you have a suggestion for a new usefull filter rule, do a [[How to report bugs|feature request]].</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Filter&diff=6174Filter2008-04-20T15:28:37Z<p>Simanek: /* How to define custom filters */ some copy changes to further clarify that the menu option is relative to the View Mode</p>
<hr />
<div>What are filters?<br />
{{languages}}<br />
[[Category:Documentation]]<br />
<br />
==Filters==<br />
Filtering genealogical information is crucial for research, as well as for creating nice reports. <br />
Most reports of GRAMPS allow the use of filters, only displaying information about people that correspond to the filter. <br />
<br />
On the other hand, filtered data can be all the info you need, like a self constructed mini-report.<br />
<br />
==How to define custom filters==<br />
Custom filters are relative to the active View Mode. If you are in People View Mode you will create a Person Filter, Event View Mode an Event Filter, etc. In the {{man label|Edit}} menu, click the option {{man label|<View Mode> Filter Editor}}. View Mode can be ''Person, Family, Event, Place, Media, Repository'' or ''Note''.<br />
<br />
You can give the custom filter a name and add rules to the filter. The data will be filtered according to the rules. <br />
<br />
In some filters you can use regular expressions. For learning how to use regular expressions, see the [http://www.amk.ca/python/howto/regex/regex.html Regular Expression HOWTO].<br />
<br />
== Test a custom filter==<br />
In the {{man label|Edit}} menu, click on {{man label|Column Editor}}, and select the columns you want to view. Next, activate {{man label|Filter}}. This can be done by going to the {{man label|View}} menu, and clicking on {{man label|Filter}}.<br />
<br />
== Examples ==<br />
See [[Example filters]].<br />
To the right of the list view, a sidebar will open, allowing to filter your data. At the bottom of this, you can select the newly created Custom Filter. Click on Find, and all Persons/ Families/Events/Places/Media/Repositories matching the filter are displayed.<br />
At present (version 2.X), there is no way to print this data.<br />
<br />
In the '''3.0 version''' you will have an option {{man label|Export view}} on the {{man label|Family Trees}} menu. This gives you the opportunity to export the view as a spreadsheet with following format options:<br />
*[[Gramps_3.0_Wiki_Manual_-_Manage_Family_Trees:_CSV_Import_and_Export#Export|CSV]]<br />
*Open Document Spreadsheet<br />
<br />
Another '''3.0''' method would be that you select the {{man label|Export}} option on the {{man label|Family Trees}} menu. An '''Export Assistant''' view will be presented where you also can select the {{man button|Comma Separated Values Spreadsheet (CSV)}}. Next, click on the {{man button|Forward}} button and in the next screen you can select in the {{man label|Options}} view which filter you want to use and whether you want to include Indivuduals, Marriages and Children. Click once again on the {{man button|Forward}} button and you can save the file.<br />
<br />
== Suggestions for filter rules==<br />
What you can do with a filter depends on the rules available to you in GRAMPS.<br />
If you have a suggestion for a new usefull filter rule, do a [[How to report bugs|feature request]].</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=6173Gramps 3.0 Wiki Manual - Reports2008-04-20T15:09:14Z<p>Simanek: /* Report Options */ trying to figure out the best way to present hyperlinks</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree ===<br />
[[Image:voorouderpdf.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar ===<br />
<br />
<br />
=== Descendant Tree ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
[[Image:statgraftaart.png|right|thumb|250px|Fig. a.6 Results]]<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph ===<br />
<br />
=== Hourglass Graph ===<br />
<br />
=== Relationship Graph ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report ===<br />
<br />
<br />
<br />
=== Complete Individual Report ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report ===<br />
<br />
=== Family Group Report ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report ===<br />
<br />
=== Marker Report ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site ===<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.1 Individual List Page in Mainz Style]]<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The GRAMPS 3.0 Narrated Web Site report provides improved functionality, support for web standards and additional features. The new report creates pages that closely follow the World Wide Web Consortium&#8217;s Recommendations for XHTML 1.0 Strict and CSS 1. These recommendations include a separation of content from presentation. Due to this practice, the style and appearance of the new web pages can be completely controlled from one CSS stylesheet without altering individual pages.<br />
<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as a family history.<br />
<br />
Genealogy records can generate a lot of files. Many web servers have a difficult time with a large number of files in a single directory. The Narrated Web report strives to keep the number of files per directory to a manageable level. To do this, a hierarchy of directories is created. The generated file names are not intuitive, but are unique for each person. Subsequent runs will generate identical file names, making it easy to update specific files.<br />
<br />
==== Using the Report ====<br />
The Narrated Web Site report provides the user with options that allow a wide range of customization. You can run this report via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrated Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Options''', '''Page Generation''', '''Privacy''' and '''Advanced'''. Each of those tabs are reviewed below. <br />
{{man warn|Entire Database|Be aware that if you select your entire database as a filter a large number of files will be generated (depending on the size of your database). It is recommended to start with a filter (for example: ancestors of a certain person) to simplify the output while you learn about the plugin.}}<br />
<br />
==== Report Options ====<br />
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]<br />
;Store web pages in .tar.gz archive<br />
:The large number of files and directories in this web output may make it difficult to transfer the files to an external web host. GRAMPS has the capability of saving all of your Narrative Web files in one compressed archive using the gzip and tar formats (casually known as a &#8216;tarball&#8217;). This single file can quickly be transferred to your server. Unfortunately not all web servers support saving web files in this way, so contact your hosting provider for more information.<br />
<br />
:The free genealogy site hosting provided by the GRAMPS organization will only accept your files in a compressed archive. Learn more about free genealogy site hosting here: http://library.gramps-project.org<br />
;Destination<br />
:The output of the Narrative Web report is by default saved here {{man label|/yourhomedirectory/NAVWEB}}. This option allows you to save your report output to a destination of your choice.<br />
;Filter<br />
:Like the previous web page generator and other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but custom filters can be made for your specific needs. Learn more about custom filters here: [[Filter]].<br />
;Filter Person<br />
:This option is inactive if the primary Filter option is set to &#8216;Entire Database&#8217;. Filters are generally subject to how one specific individual relates to other individuals. This option allows you to specify the primary individual. Use the {{man button|Edit}} button to select any individual in your database.<br />
;Web site title<br />
:The default site title value is '''My Family Tree'''. You can enter a custom site title in this option.<br />
;File extension<br />
:The file extension to be used for the web files. Choose between the {{man label|.html}} default value, .htm, .shtml, .php, .php3, or .cgi.<br />
;Copyright<br />
:When creating a public a web site it is important to specify the copyright conditions under which you are publishing your data. International copyright law reserves all rights of your data to your discretion. You own the data and individuals must have your permission if they wish to reuse that data. In genealogical research sharing data with other researchers is a common practice. By default the Narrative Web report uses an '''All Rights Reserved''' copyright. Other options include the Creative Commons licenses, offering a wide range of use restrictions or none at all. Learn more about the Creative Commons at http://creativecommons.org/<br />
;Character set encoding<br />
:GRAMPS is an international application developed with multiple languages and translations in mind. Because of this the default character set for HTML pages is {{man label|UTF-8}}, which supports a wide range of international characters and symbols. From the drop down menu list you can select from a variety of {{man label|ISO-8859-}} encoding sets or even a {{man label|koi8_r}} encoding set. There is support for virtually all popular character set encodings. If you are having problems with character presentation in your web pages it could be a matter of selecting a compatible character set encoding for your web server environment.<br />
[[Image:NWeb-Man-BasicSet.jpg|right|180px|thumb|fig. c.3 Basic Style - 5 Color Choices]]<br />
;Stylesheet<br />
:GRAMPS provides seven built in style sheets for you to choose from to determine the appearance or your web pages. In GRAMPS 3.0 you can choose between '''Basic''' (Ash, Cypress, Lilac, Peach or Spruce color schemes), '''Mainz''', or '''Nebraska''' styles. There is also the option of not including a stylesheet ('''No style sheet'''). Regardless of the style you choose, the style sheet file name is ''narrative.css''. You may edit this file to further customize the appearance of your web pages.<br />
<br />
:If you make modifications to your style sheet be aware that regenerating the your pages with the same output destination will overwrite your custom style sheet. To preserve your custom style sheet through subsequent web page updates select {{man label|No style sheet}}.<br />
<br />
:''figures c.1, c.2 and c.3 are examples of the styles currently included with GRAMPS 3.0''<br />
;Include ancestor graph<br />
:Checking this box will include an ancestor graph on each individual&#8217;s detail page if they have defined ancestors in your database.<br />
;Graph generations<br />
:This option is inactive if the ‘Include ancestor graph’ option is not checked. The default number of generations shown in the ancestor graphs is {{man label|4}} with options of 2, 3, 4 or 5.<br />
<br />
:The individuals represented in the ancestor graphs are the same individuals whose information is provided elsewhere in your web pages.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
<br />
==== Page Generation ====<br />
The Narrated Web Site report can be set to generate three supplemental pages: '''Home''', '''Introduction''' and '''Publisher Contact'''. From this tab you can activate the pages and assign Media or Notes items to each page. By default no content (media or text) is assigned to these pages. Content for these pages must originate as Media or Notes items. If the desired items have already been added to your database you will be able to choose them from a list of Notes or Image Objects. <br />
;Home Page, Introduction and Publisher Contact<br />
:These pages will display an individual Media Object and/or a Note of your choice. To enable any of these pages choose a Media Object and/or Note by way of the selection button to the right of the corresponding page listing.<br />
<br />
:Please use the Publisher contact page with caution if you are publishing your web pages on a publicly accessible web server.<br />
;HTML user header and HTML user footer<br />
:These elements will display an individual Note of your choice. The HTML user header text will appear directly below the site title on every web page. The HTML user footer text will appear within the footer, above the copyright statement on every web page. (This feature is in rapid development currently and may be subject to dramatic change in upcoming releases of GRAMPS.)<br />
;Include images and media objects<br />
:This option determines whether to include/exclude a gallery of media objects on your website.<br />
;Include download page<br />
:This option determines whether to include a page titled &#8216;Downloads&#8217. This page will be blank and is provided in case you would like to offer downloads of databases, media objects or references to your visitors.<br />
;Suppress GRAMPS ID<br />
:This option determines whether to include the GRAMPS ID of objects in your web page output.<br />
<br />
==== Privacy ====<br />
Privacy of personal information is an important issue. GRAMPS provides tools and settings that give you control over the privacy of your data.<br />
;Include records marked private<br />
:If your intention is to provide a complete record of your research, checking this box will include all entries marked '''private''' along with the rest of your database.<br />
;Living People<br />
:You can control the display of sensitive information based on whether or not an individual is currently alive. However, since GRAMPS is a research tool, it is likely that there are individuals with no known date of death in your database. To deduce if an individual is ''possibly still alive'' GRAMPS employs an algorithm that compares death dates, birth dates, baptism/christening dates, death dates of ancestors and birth dates of ancestors. The algorithm assumes that each individual is ''possibly still alive'' unless the cross-referenced dates make the individual&#8217;s ''possibility of being alive'' unlikely.<br />
:*'''Include''' &#8211; Include all information of all individuals even if they are ''possibly still alive''<br />
:*'''Exclude''' &#8211; Exclude all information of all individuals who are ''possibly still alive''<br />
:*'''Restrict''' &#8211; Exclude all information of all individuals who are ''possibly still alive'', but display their relationship with other individuals while replacing their first name with the word &#8220;Living&#8221;<br />
;Years from death to consider living<br />
:This option is inactive if the ‘Living People’ option is set to '''Include'''. Some countries have laws that specify a certain number of years after death before an individual&#8217;s information can be published. Here you can specify the number of years after death needed to comply with such laws. The default value is 30 years. <br />
<br />
:Please note that compliance with privacy laws and individuals&#8217; privacy concerns is the researcher&#8217;s responsibility. GRAMPS cannot be held responsible for privacy law compliance or other privacy issues.<br />
<br />
==== Advanced ====<br />
[[Image:NWeb-Man-Print.jpg|right|300px|thumb|fig. c.4 The default appearance of pages printed from a Narrative Website web page]]<br />
The current advanced settings primarily address the amount of information displayed on the Surname detail and Individual index web pages. They are simple on-or-off options which can be understood with little explanation.<br />
* include a link to home person on every page<br />
* include a column for birth dates on the index pages<br />
* include a column for death dates on the index pages<br />
* include a column for partners on the index pages<br />
* include a column for parents on the index pages<br />
* include a column for half-siblings on the index pages<br />
<br />
=== Web Calendar ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=6172Gramps 3.0 Wiki Manual - Reports2008-04-20T14:59:42Z<p>Simanek: /* Privacy */ changed 'until the cross-referenced' to 'unless the cross-referenced</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree ===<br />
[[Image:voorouderpdf.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar ===<br />
<br />
<br />
=== Descendant Tree ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
[[Image:statgraftaart.png|right|thumb|250px|Fig. a.6 Results]]<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph ===<br />
<br />
=== Hourglass Graph ===<br />
<br />
=== Relationship Graph ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report ===<br />
<br />
<br />
<br />
=== Complete Individual Report ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report ===<br />
<br />
=== Family Group Report ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report ===<br />
<br />
=== Marker Report ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site ===<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.1 Individual List Page in Mainz Style]]<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The GRAMPS 3.0 Narrated Web Site report provides improved functionality, support for web standards and additional features. The new report creates pages that closely follow the World Wide Web Consortium&#8217;s Recommendations for XHTML 1.0 Strict and CSS 1. These recommendations include a separation of content from presentation. Due to this practice, the style and appearance of the new web pages can be completely controlled from one CSS stylesheet without altering individual pages.<br />
<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as a family history.<br />
<br />
Genealogy records can generate a lot of files. Many web servers have a difficult time with a large number of files in a single directory. The Narrated Web report strives to keep the number of files per directory to a manageable level. To do this, a hierarchy of directories is created. The generated file names are not intuitive, but are unique for each person. Subsequent runs will generate identical file names, making it easy to update specific files.<br />
<br />
==== Using the Report ====<br />
The Narrated Web Site report provides the user with options that allow a wide range of customization. You can run this report via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrated Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Options''', '''Page Generation''', '''Privacy''' and '''Advanced'''. Each of those tabs are reviewed below. <br />
{{man warn|Entire Database|Be aware that if you select your entire database as a filter a large number of files will be generated (depending on the size of your database). It is recommended to start with a filter (for example: ancestors of a certain person) to simplify the output while you learn about the plugin.}}<br />
<br />
==== Report Options ====<br />
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]<br />
;Store web pages in .tar.gz archive<br />
:The large number of files and directories in this web output may make it difficult to transfer the files to an external web host. GRAMPS has the capability of saving all of your Narrative Web files in one compressed archive using the gzip and tar formats (casually known as a &#8216;tarball&#8217;). This single file can quickly be transferred to your server. Unfortunately not all web servers support saving web files in this way, so contact your hosting provider for more information.<br />
<br />
:The free genealogy site hosting provided by the GRAMPS organization will only accept your files in a compressed archive. Learn more about free genealogy site hosting at http://library.gramps-project.org/<br />
;Destination<br />
:The output of the Narrative Web report is by default saved here {{man label|/yourhomedirectory/NAVWEB}}. This option allows you to save your report output to a destination of your choice.<br />
;Filter<br />
:Like the previous web page generator and other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but custom filters can be made for your specific needs. Learn more about custom filters at http://gramps-project.org/wiki/index.php?title=Filter.<br />
;Filter Person<br />
:This option is inactive if the primary Filter option is set to &#8216;Entire Database&#8217;. Filters are generally subject to how one specific individual relates to other individuals. This option allows you to specify the primary individual. Use the {{man button|Edit}} button to select any individual in your database.<br />
;Web site title<br />
:The default site title value is '''My Family Tree'''. You can enter a custom site title in this option.<br />
;File extension<br />
:The file extension to be used for the web files. Choose between the {{man label|.html}} default value, .htm, .shtml, .php, .php3, or .cgi.<br />
;Copyright<br />
:When creating a public a web site it is important to specify the copyright conditions under which you are publishing your data. International copyright law reserves all rights of your data to your discretion. You own the data and individuals must have your permission if they wish to reuse that data. In genealogical research sharing data with other researchers is a common practice. By default the Narrative Web report uses an '''All Rights Reserved''' copyright. Other options include the Creative Commons licenses, offering a wide range of use restrictions or none at all. Learn more about the Creative Commons at http://creativecommons.org/<br />
;Character set encoding<br />
:GRAMPS is an international application developed with multiple languages and translations in mind. Because of this the default character set for HTML pages is {{man label|UTF-8}}, which supports a wide range of international characters and symbols. From the drop down menu list you can select from a variety of {{man label|ISO-8859-}} encoding sets or even a {{man label|koi8_r}} encoding set. There is support for virtually all popular character set encodings. If you are having problems with character presentation in your web pages it could be a matter of selecting a compatible character set encoding for your web server environment.<br />
[[Image:NWeb-Man-BasicSet.jpg|right|180px|thumb|fig. c.3 Basic Style - 5 Color Choices]]<br />
;Stylesheet<br />
:GRAMPS provides seven built in style sheets for you to choose from to determine the appearance or your web pages. In GRAMPS 3.0 you can choose between '''Basic''' (Ash, Cypress, Lilac, Peach or Spruce color schemes), '''Mainz''', or '''Nebraska''' styles. There is also the option of not including a stylesheet ('''No style sheet'''). Regardless of the style you choose, the style sheet file name is ''narrative.css''. You may edit this file to further customize the appearance of your web pages.<br />
<br />
:If you make modifications to your style sheet be aware that regenerating the your pages with the same output destination will overwrite your custom style sheet. To preserve your custom style sheet through subsequent web page updates select {{man label|No style sheet}}.<br />
<br />
:''figures c.1, c.2 and c.3 are examples of the styles currently included with GRAMPS 3.0''<br />
;Include ancestor graph<br />
:Checking this box will include an ancestor graph on each individual&#8217;s detail page if they have defined ancestors in your database.<br />
;Graph generations<br />
:This option is inactive if the ‘Include ancestor graph’ option is not checked. The default number of generations shown in the ancestor graphs is {{man label|4}} with options of 2, 3, 4 or 5.<br />
<br />
:The individuals represented in the ancestor graphs are the same individuals whose information is provided elsewhere in your web pages.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
<br />
==== Page Generation ====<br />
The Narrated Web Site report can be set to generate three supplemental pages: '''Home''', '''Introduction''' and '''Publisher Contact'''. From this tab you can activate the pages and assign Media or Notes items to each page. By default no content (media or text) is assigned to these pages. Content for these pages must originate as Media or Notes items. If the desired items have already been added to your database you will be able to choose them from a list of Notes or Image Objects. <br />
;Home Page, Introduction and Publisher Contact<br />
:These pages will display an individual Media Object and/or a Note of your choice. To enable any of these pages choose a Media Object and/or Note by way of the selection button to the right of the corresponding page listing.<br />
<br />
:Please use the Publisher contact page with caution if you are publishing your web pages on a publicly accessible web server.<br />
;HTML user header and HTML user footer<br />
:These elements will display an individual Note of your choice. The HTML user header text will appear directly below the site title on every web page. The HTML user footer text will appear within the footer, above the copyright statement on every web page. (This feature is in rapid development currently and may be subject to dramatic change in upcoming releases of GRAMPS.)<br />
;Include images and media objects<br />
:This option determines whether to include/exclude a gallery of media objects on your website.<br />
;Include download page<br />
:This option determines whether to include a page titled &#8216;Downloads&#8217. This page will be blank and is provided in case you would like to offer downloads of databases, media objects or references to your visitors.<br />
;Suppress GRAMPS ID<br />
:This option determines whether to include the GRAMPS ID of objects in your web page output.<br />
<br />
==== Privacy ====<br />
Privacy of personal information is an important issue. GRAMPS provides tools and settings that give you control over the privacy of your data.<br />
;Include records marked private<br />
:If your intention is to provide a complete record of your research, checking this box will include all entries marked '''private''' along with the rest of your database.<br />
;Living People<br />
:You can control the display of sensitive information based on whether or not an individual is currently alive. However, since GRAMPS is a research tool, it is likely that there are individuals with no known date of death in your database. To deduce if an individual is ''possibly still alive'' GRAMPS employs an algorithm that compares death dates, birth dates, baptism/christening dates, death dates of ancestors and birth dates of ancestors. The algorithm assumes that each individual is ''possibly still alive'' unless the cross-referenced dates make the individual&#8217;s ''possibility of being alive'' unlikely.<br />
:*'''Include''' &#8211; Include all information of all individuals even if they are ''possibly still alive''<br />
:*'''Exclude''' &#8211; Exclude all information of all individuals who are ''possibly still alive''<br />
:*'''Restrict''' &#8211; Exclude all information of all individuals who are ''possibly still alive'', but display their relationship with other individuals while replacing their first name with the word &#8220;Living&#8221;<br />
;Years from death to consider living<br />
:This option is inactive if the ‘Living People’ option is set to '''Include'''. Some countries have laws that specify a certain number of years after death before an individual&#8217;s information can be published. Here you can specify the number of years after death needed to comply with such laws. The default value is 30 years. <br />
<br />
:Please note that compliance with privacy laws and individuals&#8217; privacy concerns is the researcher&#8217;s responsibility. GRAMPS cannot be held responsible for privacy law compliance or other privacy issues.<br />
<br />
==== Advanced ====<br />
[[Image:NWeb-Man-Print.jpg|right|300px|thumb|fig. c.4 The default appearance of pages printed from a Narrative Website web page]]<br />
The current advanced settings primarily address the amount of information displayed on the Surname detail and Individual index web pages. They are simple on-or-off options which can be understood with little explanation.<br />
* include a link to home person on every page<br />
* include a column for birth dates on the index pages<br />
* include a column for death dates on the index pages<br />
* include a column for partners on the index pages<br />
* include a column for parents on the index pages<br />
* include a column for half-siblings on the index pages<br />
<br />
=== Web Calendar ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=6171Gramps 3.0 Wiki Manual - Reports2008-04-20T14:58:21Z<p>Simanek: /* Privacy */ Resolved confusion regarding the 'Living People' option</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree ===<br />
[[Image:voorouderpdf.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar ===<br />
<br />
<br />
=== Descendant Tree ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
[[Image:statgraftaart.png|right|thumb|250px|Fig. a.6 Results]]<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph ===<br />
<br />
=== Hourglass Graph ===<br />
<br />
=== Relationship Graph ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report ===<br />
<br />
<br />
<br />
=== Complete Individual Report ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report ===<br />
<br />
=== Family Group Report ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report ===<br />
<br />
=== Marker Report ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site ===<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.1 Individual List Page in Mainz Style]]<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The GRAMPS 3.0 Narrated Web Site report provides improved functionality, support for web standards and additional features. The new report creates pages that closely follow the World Wide Web Consortium&#8217;s Recommendations for XHTML 1.0 Strict and CSS 1. These recommendations include a separation of content from presentation. Due to this practice, the style and appearance of the new web pages can be completely controlled from one CSS stylesheet without altering individual pages.<br />
<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as a family history.<br />
<br />
Genealogy records can generate a lot of files. Many web servers have a difficult time with a large number of files in a single directory. The Narrated Web report strives to keep the number of files per directory to a manageable level. To do this, a hierarchy of directories is created. The generated file names are not intuitive, but are unique for each person. Subsequent runs will generate identical file names, making it easy to update specific files.<br />
<br />
==== Using the Report ====<br />
The Narrated Web Site report provides the user with options that allow a wide range of customization. You can run this report via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrated Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Options''', '''Page Generation''', '''Privacy''' and '''Advanced'''. Each of those tabs are reviewed below. <br />
{{man warn|Entire Database|Be aware that if you select your entire database as a filter a large number of files will be generated (depending on the size of your database). It is recommended to start with a filter (for example: ancestors of a certain person) to simplify the output while you learn about the plugin.}}<br />
<br />
==== Report Options ====<br />
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]<br />
;Store web pages in .tar.gz archive<br />
:The large number of files and directories in this web output may make it difficult to transfer the files to an external web host. GRAMPS has the capability of saving all of your Narrative Web files in one compressed archive using the gzip and tar formats (casually known as a &#8216;tarball&#8217;). This single file can quickly be transferred to your server. Unfortunately not all web servers support saving web files in this way, so contact your hosting provider for more information.<br />
<br />
:The free genealogy site hosting provided by the GRAMPS organization will only accept your files in a compressed archive. Learn more about free genealogy site hosting at http://library.gramps-project.org/<br />
;Destination<br />
:The output of the Narrative Web report is by default saved here {{man label|/yourhomedirectory/NAVWEB}}. This option allows you to save your report output to a destination of your choice.<br />
;Filter<br />
:Like the previous web page generator and other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but custom filters can be made for your specific needs. Learn more about custom filters at http://gramps-project.org/wiki/index.php?title=Filter.<br />
;Filter Person<br />
:This option is inactive if the primary Filter option is set to &#8216;Entire Database&#8217;. Filters are generally subject to how one specific individual relates to other individuals. This option allows you to specify the primary individual. Use the {{man button|Edit}} button to select any individual in your database.<br />
;Web site title<br />
:The default site title value is '''My Family Tree'''. You can enter a custom site title in this option.<br />
;File extension<br />
:The file extension to be used for the web files. Choose between the {{man label|.html}} default value, .htm, .shtml, .php, .php3, or .cgi.<br />
;Copyright<br />
:When creating a public a web site it is important to specify the copyright conditions under which you are publishing your data. International copyright law reserves all rights of your data to your discretion. You own the data and individuals must have your permission if they wish to reuse that data. In genealogical research sharing data with other researchers is a common practice. By default the Narrative Web report uses an '''All Rights Reserved''' copyright. Other options include the Creative Commons licenses, offering a wide range of use restrictions or none at all. Learn more about the Creative Commons at http://creativecommons.org/<br />
;Character set encoding<br />
:GRAMPS is an international application developed with multiple languages and translations in mind. Because of this the default character set for HTML pages is {{man label|UTF-8}}, which supports a wide range of international characters and symbols. From the drop down menu list you can select from a variety of {{man label|ISO-8859-}} encoding sets or even a {{man label|koi8_r}} encoding set. There is support for virtually all popular character set encodings. If you are having problems with character presentation in your web pages it could be a matter of selecting a compatible character set encoding for your web server environment.<br />
[[Image:NWeb-Man-BasicSet.jpg|right|180px|thumb|fig. c.3 Basic Style - 5 Color Choices]]<br />
;Stylesheet<br />
:GRAMPS provides seven built in style sheets for you to choose from to determine the appearance or your web pages. In GRAMPS 3.0 you can choose between '''Basic''' (Ash, Cypress, Lilac, Peach or Spruce color schemes), '''Mainz''', or '''Nebraska''' styles. There is also the option of not including a stylesheet ('''No style sheet'''). Regardless of the style you choose, the style sheet file name is ''narrative.css''. You may edit this file to further customize the appearance of your web pages.<br />
<br />
:If you make modifications to your style sheet be aware that regenerating the your pages with the same output destination will overwrite your custom style sheet. To preserve your custom style sheet through subsequent web page updates select {{man label|No style sheet}}.<br />
<br />
:''figures c.1, c.2 and c.3 are examples of the styles currently included with GRAMPS 3.0''<br />
;Include ancestor graph<br />
:Checking this box will include an ancestor graph on each individual&#8217;s detail page if they have defined ancestors in your database.<br />
;Graph generations<br />
:This option is inactive if the ‘Include ancestor graph’ option is not checked. The default number of generations shown in the ancestor graphs is {{man label|4}} with options of 2, 3, 4 or 5.<br />
<br />
:The individuals represented in the ancestor graphs are the same individuals whose information is provided elsewhere in your web pages.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
<br />
==== Page Generation ====<br />
The Narrated Web Site report can be set to generate three supplemental pages: '''Home''', '''Introduction''' and '''Publisher Contact'''. From this tab you can activate the pages and assign Media or Notes items to each page. By default no content (media or text) is assigned to these pages. Content for these pages must originate as Media or Notes items. If the desired items have already been added to your database you will be able to choose them from a list of Notes or Image Objects. <br />
;Home Page, Introduction and Publisher Contact<br />
:These pages will display an individual Media Object and/or a Note of your choice. To enable any of these pages choose a Media Object and/or Note by way of the selection button to the right of the corresponding page listing.<br />
<br />
:Please use the Publisher contact page with caution if you are publishing your web pages on a publicly accessible web server.<br />
;HTML user header and HTML user footer<br />
:These elements will display an individual Note of your choice. The HTML user header text will appear directly below the site title on every web page. The HTML user footer text will appear within the footer, above the copyright statement on every web page. (This feature is in rapid development currently and may be subject to dramatic change in upcoming releases of GRAMPS.)<br />
;Include images and media objects<br />
:This option determines whether to include/exclude a gallery of media objects on your website.<br />
;Include download page<br />
:This option determines whether to include a page titled &#8216;Downloads&#8217. This page will be blank and is provided in case you would like to offer downloads of databases, media objects or references to your visitors.<br />
;Suppress GRAMPS ID<br />
:This option determines whether to include the GRAMPS ID of objects in your web page output.<br />
<br />
==== Privacy ====<br />
Privacy of personal information is an important issue. GRAMPS provides tools and settings that give you control over the privacy of your data.<br />
;Include records marked private<br />
:If your intention is to provide a complete record of your research, checking this box will include all entries marked '''private''' along with the rest of your database.<br />
;Living People<br />
:You can control the display of sensitive information based on whether or not an individual is currently alive. However, since GRAMPS is a research tool, it is likely that there are individuals with no known date of death in your database. To deduce if an individual is ''possibly still alive'' GRAMPS employs an algorithm that compares death dates, birth dates, baptism/christening dates, death dates of ancestors and birth dates of ancestors. The algorithm assumes that each individual is ''possibly still alive'' until the cross-referenced dates make the individual&#8217;s ''possibility of being alive'' unlikely.<br />
:*'''Include''' &#8211; Include all information of all individuals even if they are ''possibly still alive''<br />
:*'''Exclude''' &#8211; Exclude all information of all individuals who are ''possibly still alive''<br />
:*'''Restrict''' &#8211; Exclude all information of all individuals who are ''possibly still alive'', but display their relationship with other individuals while replacing their first name with the word &#8220;Living&#8221;<br />
;Years from death to consider living<br />
:This option is inactive if the ‘Living People’ option is set to '''Include'''. Some countries have laws that specify a certain number of years after death before an individual&#8217;s information can be published. Here you can specify the number of years after death needed to comply with such laws. The default value is 30 years. <br />
<br />
:Please note that compliance with privacy laws and individuals&#8217; privacy concerns is the researcher&#8217;s responsibility. GRAMPS cannot be held responsible for privacy law compliance or other privacy issues.<br />
<br />
==== Advanced ====<br />
[[Image:NWeb-Man-Print.jpg|right|300px|thumb|fig. c.4 The default appearance of pages printed from a Narrative Website web page]]<br />
The current advanced settings primarily address the amount of information displayed on the Surname detail and Individual index web pages. They are simple on-or-off options which can be understood with little explanation.<br />
* include a link to home person on every page<br />
* include a column for birth dates on the index pages<br />
* include a column for death dates on the index pages<br />
* include a column for partners on the index pages<br />
* include a column for parents on the index pages<br />
* include a column for half-siblings on the index pages<br />
<br />
=== Web Calendar ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=6168Gramps 3.0 Wiki Manual - Reports2008-04-19T22:54:01Z<p>Simanek: /* Narrated Web Site */ moved note about random file names and directories from end of N. Web to the Introduction</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree ===<br />
[[Image:voorouderpdf.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar ===<br />
<br />
<br />
=== Descendant Tree ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
[[Image:statgraftaart.png|right|thumb|250px|Fig. a.6 Results]]<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph ===<br />
<br />
=== Hourglass Graph ===<br />
<br />
=== Relationship Graph ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report ===<br />
<br />
<br />
<br />
=== Complete Individual Report ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report ===<br />
<br />
=== Family Group Report ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report ===<br />
<br />
=== Marker Report ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site ===<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.1 Individual List Page in Mainz Style]]<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The GRAMPS 3.0 Narrated Web Site report provides improved functionality, support for web standards and additional features. The new report creates pages that closely follow the World Wide Web Consortium&#8217;s Recommendations for XHTML 1.0 Strict and CSS 1. These recommendations include a separation of content from presentation. Due to this practice, the style and appearance of the new web pages can be completely controlled from one CSS stylesheet without altering individual pages.<br />
<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as a family history.<br />
<br />
Genealogy records can generate a lot of files. Many web servers have a difficult time with a large number of files in a single directory. The Narrated Web report strives to keep the number of files per directory to a manageable level. To do this, a hierarchy of directories is created. The generated file names are not intuitive, but are unique for each person. Subsequent runs will generate identical file names, making it easy to update specific files.<br />
<br />
==== Using the Report ====<br />
The Narrated Web Site report provides the user with options that allow a wide range of customization. You can run this report via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrated Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Options''', '''Page Generation''', '''Privacy''' and '''Advanced'''. Each of those tabs are reviewed below. <br />
{{man warn|Entire Database|Be aware that if you select your entire database as a filter a large number of files will be generated (depending on the size of your database). It is recommended to start with a filter (for example: ancestors of a certain person) to simplify the output while you learn about the plugin.}}<br />
<br />
==== Report Options ====<br />
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]<br />
;Store web pages in .tar.gz archive<br />
:The large number of files and directories in this web output may make it difficult to transfer the files to an external web host. GRAMPS has the capability of saving all of your Narrative Web files in one compressed archive using the gzip and tar formats (casually known as a &#8216;tarball&#8217;). This single file can quickly be transferred to your server. Unfortunately not all web servers support saving web files in this way, so contact your hosting provider for more information.<br />
<br />
:The free genealogy site hosting provided by the GRAMPS organization will only accept your files in a compressed archive. Learn more about free genealogy site hosting at http://library.gramps-project.org/<br />
;Destination<br />
:The output of the Narrative Web report is by default saved here {{man label|/yourhomedirectory/NAVWEB}}. This option allows you to save your report output to a destination of your choice.<br />
;Filter<br />
:Like the previous web page generator and other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but custom filters can be made for your specific needs. Learn more about custom filters at http://gramps-project.org/wiki/index.php?title=Filter.<br />
;Filter Person<br />
:This option is inactive if the primary Filter option is set to &#8216;Entire Database&#8217;. Filters are generally subject to how one specific individual relates to other individuals. This option allows you to specify the primary individual. Use the {{man button|Edit}} button to select any individual in your database.<br />
;Web site title<br />
:The default site title value is '''My Family Tree'''. You can enter a custom site title in this option.<br />
;File extension<br />
:The file extension to be used for the web files. Choose between the {{man label|.html}} default value, .htm, .shtml, .php, .php3, or .cgi.<br />
;Copyright<br />
:When creating a public a web site it is important to specify the copyright conditions under which you are publishing your data. International copyright law reserves all rights of your data to your discretion. You own the data and individuals must have your permission if they wish to reuse that data. In genealogical research sharing data with other researchers is a common practice. By default the Narrative Web report uses an '''All Rights Reserved''' copyright. Other options include the Creative Commons licenses, offering a wide range of use restrictions or none at all. Learn more about the Creative Commons at http://creativecommons.org/<br />
;Character set encoding<br />
:GRAMPS is an international application developed with multiple languages and translations in mind. Because of this the default character set for HTML pages is {{man label|UTF-8}}, which supports a wide range of international characters and symbols. From the drop down menu list you can select from a variety of {{man label|ISO-8859-}} encoding sets or even a {{man label|koi8_r}} encoding set. There is support for virtually all popular character set encodings. If you are having problems with character presentation in your web pages it could be a matter of selecting a compatible character set encoding for your web server environment.<br />
[[Image:NWeb-Man-BasicSet.jpg|right|180px|thumb|fig. c.3 Basic Style - 5 Color Choices]]<br />
;Stylesheet<br />
:GRAMPS provides seven built in style sheets for you to choose from to determine the appearance or your web pages. In GRAMPS 3.0 you can choose between '''Basic''' (Ash, Cypress, Lilac, Peach or Spruce color schemes), '''Mainz''', or '''Nebraska''' styles. There is also the option of not including a stylesheet ('''No style sheet'''). Regardless of the style you choose, the style sheet file name is ''narrative.css''. You may edit this file to further customize the appearance of your web pages.<br />
<br />
:If you make modifications to your style sheet be aware that regenerating the your pages with the same output destination will overwrite your custom style sheet. To preserve your custom style sheet through subsequent web page updates select {{man label|No style sheet}}.<br />
<br />
:''figures c.1, c.2 and c.3 are examples of the styles currently included with GRAMPS 3.0''<br />
;Include ancestor graph<br />
:Checking this box will include an ancestor graph on each individual&#8217;s detail page if they have defined ancestors in your database.<br />
;Graph generations<br />
:This option is inactive if the ‘Include ancestor graph’ option is not checked. The default number of generations shown in the ancestor graphs is {{man label|4}} with options of 2, 3, 4 or 5.<br />
<br />
:The individuals represented in the ancestor graphs are the same individuals whose information is provided elsewhere in your web pages.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
<br />
==== Page Generation ====<br />
The Narrated Web Site report can be set to generate three supplemental pages: '''Home''', '''Introduction''' and '''Publisher Contact'''. From this tab you can activate the pages and assign Media or Notes items to each page. By default no content (media or text) is assigned to these pages. Content for these pages must originate as Media or Notes items. If the desired items have already been added to your database you will be able to choose them from a list of Notes or Image Objects. <br />
;Home Page, Introduction and Publisher Contact<br />
:These pages will display an individual Media Object and/or a Note of your choice. To enable any of these pages choose a Media Object and/or Note by way of the selection button to the right of the corresponding page listing.<br />
<br />
:Please use the Publisher contact page with caution if you are publishing your web pages on a publicly accessible web server.<br />
;HTML user header and HTML user footer<br />
:These elements will display an individual Note of your choice. The HTML user header text will appear directly below the site title on every web page. The HTML user footer text will appear within the footer, above the copyright statement on every web page. (This feature is in rapid development currently and may be subject to dramatic change in upcoming releases of GRAMPS.)<br />
;Include images and media objects<br />
:This option determines whether to include/exclude a gallery of media objects on your website.<br />
;Include download page<br />
:This option determines whether to include a page titled &#8216;Downloads&#8217. This page will be blank and is provided in case you would like to offer downloads of databases, media objects or references to your visitors.<br />
;Suppress GRAMPS ID<br />
:This option determines whether to include the GRAMPS ID of objects in your web page output.<br />
<br />
==== Privacy ====<br />
Privacy of personal information is an important issue. GRAMPS provides tools and settings that give you control over the privacy of your data.<br />
;Include records marked private<br />
:If your intention is to provide a complete record of your research, checking this box will include all entries marked '''private''' along with the rest of your database.<br />
;Living People<br />
:You can inhibit the display of sensitive information related to living people. In this option you can choose to '''Include''' all information of all living people, '''Exclude''' all information of all living people, or '''Restrict''' some information for all living people. If you select {{man label|Restrict}} GRAMPS will determine which people have the potential of still being alive and will omit them from the report output.<br />
;Years from death to consider living<br />
:This option is inactive if the ‘Living People’ option is set to '''Include'''. Some countries have laws that specify a certain number of years after death before an individual&#8217;s information can be published. Here you can specify the number of years after death needed to comply with such laws. The default value is 30 years. <br />
<br />
:Please note that compliance with privacy laws and individuals&#8217; privacy concerns is the researcher&#8217;s responsibility. GRAMPS cannot be held responsible for privacy law compliance or other privacy issues.<br />
<br />
==== Advanced ====<br />
[[Image:NWeb-Man-Print.jpg|right|300px|thumb|fig. c.4 The default appearance of pages printed from a Narrative Website web page]]<br />
The current advanced settings primarily address the amount of information displayed on the Surname detail and Individual index web pages. They are simple on-or-off options which can be understood with little explanation.<br />
* include a link to home person on every page<br />
* include a column for birth dates on the index pages<br />
* include a column for death dates on the index pages<br />
* include a column for partners on the index pages<br />
* include a column for parents on the index pages<br />
* include a column for half-siblings on the index pages<br />
<br />
=== Web Calendar ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=6167Gramps 3.0 Wiki Manual - Reports2008-04-19T22:28:51Z<p>Simanek: /* Advanced */ copy change</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree ===<br />
[[Image:voorouderpdf.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar ===<br />
<br />
<br />
=== Descendant Tree ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
[[Image:statgraftaart.png|right|thumb|250px|Fig. a.6 Results]]<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph ===<br />
<br />
=== Hourglass Graph ===<br />
<br />
=== Relationship Graph ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report ===<br />
<br />
<br />
<br />
=== Complete Individual Report ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report ===<br />
<br />
=== Family Group Report ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report ===<br />
<br />
=== Marker Report ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site ===<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.1 Individual List Page in Mainz Style]]<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The GRAMPS 3.0 Narrated Web Site report provides improved functionality, support for web standards and additional features. The new report creates pages that closely follow the World Wide Web Consortium&#8217;s Recommendations for XHTML 1.0 Strict and CSS 1. These recommendations include a separation of content from presentation. Due to this practice, the style and appearance of the new web pages can be completely controlled from one CSS stylesheet without altering individual pages.<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as a family history.<br />
<br />
==== Using the Report ====<br />
The Narrated Web Site report provides the user with options that allow a wide range of customization. You can run this report via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrated Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Options''', '''Page Generation''', '''Privacy''' and '''Advanced'''. Each of those tabs are reviewed below. <br />
{{man warn|Entire Database|Be aware that if you select your entire database as a filter a large number of files will be generated (depending on the size of your database). It is recommended to start with a filter (for example: ancestors of a certain person) to simplify the output while you learn about the plugin.}}<br />
<br />
==== Report Options ====<br />
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]<br />
;Store web pages in .tar.gz archive<br />
:The large number of files and directories in this web output may make it difficult to transfer the files to an external web host. GRAMPS has the capability of saving all of your Narrative Web files in one compressed archive using the gzip and tar formats (casually known as a &#8216;tarball&#8217;). This single file can quickly be transferred to your server. Unfortunately not all web servers support saving web files in this way, so contact your hosting provider for more information.<br />
<br />
:The free genealogy site hosting provided by the GRAMPS organization will only accept your files in a compressed archive. Learn more about free genealogy site hosting at http://library.gramps-project.org/<br />
;Destination<br />
:The output of the Narrative Web report is by default saved here {{man label|/yourhomedirectory/NAVWEB}}. This option allows you to save your report output to a destination of your choice.<br />
;Filter<br />
:Like the previous web page generator and other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but custom filters can be made for your specific needs. Learn more about custom filters at http://gramps-project.org/wiki/index.php?title=Filter.<br />
;Filter Person<br />
:This option is inactive if the primary Filter option is set to &#8216;Entire Database&#8217;. Filters are generally subject to how one specific individual relates to other individuals. This option allows you to specify the primary individual. Use the {{man button|Edit}} button to select any individual in your database.<br />
;Web site title<br />
:The default site title value is '''My Family Tree'''. You can enter a custom site title in this option.<br />
;File extension<br />
:The file extension to be used for the web files. Choose between the {{man label|.html}} default value, .htm, .shtml, .php, .php3, or .cgi.<br />
;Copyright<br />
:When creating a public a web site it is important to specify the copyright conditions under which you are publishing your data. International copyright law reserves all rights of your data to your discretion. You own the data and individuals must have your permission if they wish to reuse that data. In genealogical research sharing data with other researchers is a common practice. By default the Narrative Web report uses an '''All Rights Reserved''' copyright. Other options include the Creative Commons licenses, offering a wide range of use restrictions or none at all. Learn more about the Creative Commons at http://creativecommons.org/<br />
;Character set encoding<br />
:GRAMPS is an international application developed with multiple languages and translations in mind. Because of this the default character set for HTML pages is {{man label|UTF-8}}, which supports a wide range of international characters and symbols. From the drop down menu list you can select from a variety of {{man label|ISO-8859-}} encoding sets or even a {{man label|koi8_r}} encoding set. There is support for virtually all popular character set encodings. If you are having problems with character presentation in your web pages it could be a matter of selecting a compatible character set encoding for your web server environment.<br />
[[Image:NWeb-Man-BasicSet.jpg|right|180px|thumb|fig. c.3 Basic Style - 5 Color Choices]]<br />
;Stylesheet<br />
:GRAMPS provides seven built in style sheets for you to choose from to determine the appearance or your web pages. In GRAMPS 3.0 you can choose between '''Basic''' (Ash, Cypress, Lilac, Peach or Spruce color schemes), '''Mainz''', or '''Nebraska''' styles. There is also the option of not including a stylesheet ('''No style sheet'''). Regardless of the style you choose, the style sheet file name is ''narrative.css''. You may edit this file to further customize the appearance of your web pages.<br />
<br />
:If you make modifications to your style sheet be aware that regenerating the your pages with the same output destination will overwrite your custom style sheet. To preserve your custom style sheet through subsequent web page updates select {{man label|No style sheet}}.<br />
<br />
:''figures c.1, c.2 and c.3 are examples of the styles currently included with GRAMPS 3.0''<br />
;Include ancestor graph<br />
:Checking this box will include an ancestor graph on each individual&#8217;s detail page if they have defined ancestors in your database.<br />
;Graph generations<br />
:This option is inactive if the ‘Include ancestor graph’ option is not checked. The default number of generations shown in the ancestor graphs is {{man label|4}} with options of 2, 3, 4 or 5.<br />
<br />
:The individuals represented in the ancestor graphs are the same individuals whose information is provided elsewhere in your web pages.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
<br />
==== Page Generation ====<br />
The Narrated Web Site report can be set to generate three supplemental pages: '''Home''', '''Introduction''' and '''Publisher Contact'''. From this tab you can activate the pages and assign Media or Notes items to each page. By default no content (media or text) is assigned to these pages. Content for these pages must originate as Media or Notes items. If the desired items have already been added to your database you will be able to choose them from a list of Notes or Image Objects. <br />
;Home Page, Introduction and Publisher Contact<br />
:These pages will display an individual Media Object and/or a Note of your choice. To enable any of these pages choose a Media Object and/or Note by way of the selection button to the right of the corresponding page listing.<br />
<br />
:Please use the Publisher contact page with caution if you are publishing your web pages on a publicly accessible web server.<br />
;HTML user header and HTML user footer<br />
:These elements will display an individual Note of your choice. The HTML user header text will appear directly below the site title on every web page. The HTML user footer text will appear within the footer, above the copyright statement on every web page. (This feature is in rapid development currently and may be subject to dramatic change in upcoming releases of GRAMPS.)<br />
;Include images and media objects<br />
:This option determines whether to include/exclude a gallery of media objects on your website.<br />
;Include download page<br />
:This option determines whether to include a page titled &#8216;Downloads&#8217. This page will be blank and is provided in case you would like to offer downloads of databases, media objects or references to your visitors.<br />
;Suppress GRAMPS ID<br />
:This option determines whether to include the GRAMPS ID of objects in your web page output.<br />
<br />
==== Privacy ====<br />
Privacy of personal information is an important issue. GRAMPS provides tools and settings that give you control over the privacy of your data.<br />
;Include records marked private<br />
:If your intention is to provide a complete record of your research, checking this box will include all entries marked '''private''' along with the rest of your database.<br />
;Living People<br />
:You can inhibit the display of sensitive information related to living people. In this option you can choose to '''Include''' all information of all living people, '''Exclude''' all information of all living people, or '''Restrict''' some information for all living people. If you select {{man label|Restrict}} GRAMPS will determine which people have the potential of still being alive and will omit them from the report output.<br />
;Years from death to consider living<br />
:This option is inactive if the ‘Living People’ option is set to '''Include'''. Some countries have laws that specify a certain number of years after death before an individual&#8217;s information can be published. Here you can specify the number of years after death needed to comply with such laws. The default value is 30 years. <br />
<br />
:Please note that compliance with privacy laws and individuals&#8217; privacy concerns is the researcher&#8217;s responsibility. GRAMPS cannot be held responsible for privacy law compliance or other privacy issues.<br />
<br />
==== Advanced ====<br />
[[Image:NWeb-Man-Print.jpg|right|300px|thumb|fig. c.4 The default appearance of pages printed from a Narrative Website web page]]<br />
The current advanced settings primarily address the amount of information displayed on the Surname detail and Individual index web pages. They are simple on-or-off options which can be understood with little explanation.<br />
* include a link to home person on every page<br />
* include a column for birth dates on the index pages<br />
* include a column for death dates on the index pages<br />
* include a column for partners on the index pages<br />
* include a column for parents on the index pages<br />
* include a column for half-siblings on the index pages<br />
<br />
=== Web Calendar ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=6166Gramps 3.0 Wiki Manual - Reports2008-04-19T22:27:51Z<p>Simanek: /* Advanced */ more copy changes</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree ===<br />
[[Image:voorouderpdf.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar ===<br />
<br />
<br />
=== Descendant Tree ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
[[Image:statgraftaart.png|right|thumb|250px|Fig. a.6 Results]]<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph ===<br />
<br />
=== Hourglass Graph ===<br />
<br />
=== Relationship Graph ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report ===<br />
<br />
<br />
<br />
=== Complete Individual Report ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report ===<br />
<br />
=== Family Group Report ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report ===<br />
<br />
=== Marker Report ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site ===<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.1 Individual List Page in Mainz Style]]<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The GRAMPS 3.0 Narrated Web Site report provides improved functionality, support for web standards and additional features. The new report creates pages that closely follow the World Wide Web Consortium&#8217;s Recommendations for XHTML 1.0 Strict and CSS 1. These recommendations include a separation of content from presentation. Due to this practice, the style and appearance of the new web pages can be completely controlled from one CSS stylesheet without altering individual pages.<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as a family history.<br />
<br />
==== Using the Report ====<br />
The Narrated Web Site report provides the user with options that allow a wide range of customization. You can run this report via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrated Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Options''', '''Page Generation''', '''Privacy''' and '''Advanced'''. Each of those tabs are reviewed below. <br />
{{man warn|Entire Database|Be aware that if you select your entire database as a filter a large number of files will be generated (depending on the size of your database). It is recommended to start with a filter (for example: ancestors of a certain person) to simplify the output while you learn about the plugin.}}<br />
<br />
==== Report Options ====<br />
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]<br />
;Store web pages in .tar.gz archive<br />
:The large number of files and directories in this web output may make it difficult to transfer the files to an external web host. GRAMPS has the capability of saving all of your Narrative Web files in one compressed archive using the gzip and tar formats (casually known as a &#8216;tarball&#8217;). This single file can quickly be transferred to your server. Unfortunately not all web servers support saving web files in this way, so contact your hosting provider for more information.<br />
<br />
:The free genealogy site hosting provided by the GRAMPS organization will only accept your files in a compressed archive. Learn more about free genealogy site hosting at http://library.gramps-project.org/<br />
;Destination<br />
:The output of the Narrative Web report is by default saved here {{man label|/yourhomedirectory/NAVWEB}}. This option allows you to save your report output to a destination of your choice.<br />
;Filter<br />
:Like the previous web page generator and other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but custom filters can be made for your specific needs. Learn more about custom filters at http://gramps-project.org/wiki/index.php?title=Filter.<br />
;Filter Person<br />
:This option is inactive if the primary Filter option is set to &#8216;Entire Database&#8217;. Filters are generally subject to how one specific individual relates to other individuals. This option allows you to specify the primary individual. Use the {{man button|Edit}} button to select any individual in your database.<br />
;Web site title<br />
:The default site title value is '''My Family Tree'''. You can enter a custom site title in this option.<br />
;File extension<br />
:The file extension to be used for the web files. Choose between the {{man label|.html}} default value, .htm, .shtml, .php, .php3, or .cgi.<br />
;Copyright<br />
:When creating a public a web site it is important to specify the copyright conditions under which you are publishing your data. International copyright law reserves all rights of your data to your discretion. You own the data and individuals must have your permission if they wish to reuse that data. In genealogical research sharing data with other researchers is a common practice. By default the Narrative Web report uses an '''All Rights Reserved''' copyright. Other options include the Creative Commons licenses, offering a wide range of use restrictions or none at all. Learn more about the Creative Commons at http://creativecommons.org/<br />
;Character set encoding<br />
:GRAMPS is an international application developed with multiple languages and translations in mind. Because of this the default character set for HTML pages is {{man label|UTF-8}}, which supports a wide range of international characters and symbols. From the drop down menu list you can select from a variety of {{man label|ISO-8859-}} encoding sets or even a {{man label|koi8_r}} encoding set. There is support for virtually all popular character set encodings. If you are having problems with character presentation in your web pages it could be a matter of selecting a compatible character set encoding for your web server environment.<br />
[[Image:NWeb-Man-BasicSet.jpg|right|180px|thumb|fig. c.3 Basic Style - 5 Color Choices]]<br />
;Stylesheet<br />
:GRAMPS provides seven built in style sheets for you to choose from to determine the appearance or your web pages. In GRAMPS 3.0 you can choose between '''Basic''' (Ash, Cypress, Lilac, Peach or Spruce color schemes), '''Mainz''', or '''Nebraska''' styles. There is also the option of not including a stylesheet ('''No style sheet'''). Regardless of the style you choose, the style sheet file name is ''narrative.css''. You may edit this file to further customize the appearance of your web pages.<br />
<br />
:If you make modifications to your style sheet be aware that regenerating the your pages with the same output destination will overwrite your custom style sheet. To preserve your custom style sheet through subsequent web page updates select {{man label|No style sheet}}.<br />
<br />
:''figures c.1, c.2 and c.3 are examples of the styles currently included with GRAMPS 3.0''<br />
;Include ancestor graph<br />
:Checking this box will include an ancestor graph on each individual&#8217;s detail page if they have defined ancestors in your database.<br />
;Graph generations<br />
:This option is inactive if the ‘Include ancestor graph’ option is not checked. The default number of generations shown in the ancestor graphs is {{man label|4}} with options of 2, 3, 4 or 5.<br />
<br />
:The individuals represented in the ancestor graphs are the same individuals whose information is provided elsewhere in your web pages.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
<br />
==== Page Generation ====<br />
The Narrated Web Site report can be set to generate three supplemental pages: '''Home''', '''Introduction''' and '''Publisher Contact'''. From this tab you can activate the pages and assign Media or Notes items to each page. By default no content (media or text) is assigned to these pages. Content for these pages must originate as Media or Notes items. If the desired items have already been added to your database you will be able to choose them from a list of Notes or Image Objects. <br />
;Home Page, Introduction and Publisher Contact<br />
:These pages will display an individual Media Object and/or a Note of your choice. To enable any of these pages choose a Media Object and/or Note by way of the selection button to the right of the corresponding page listing.<br />
<br />
:Please use the Publisher contact page with caution if you are publishing your web pages on a publicly accessible web server.<br />
;HTML user header and HTML user footer<br />
:These elements will display an individual Note of your choice. The HTML user header text will appear directly below the site title on every web page. The HTML user footer text will appear within the footer, above the copyright statement on every web page. (This feature is in rapid development currently and may be subject to dramatic change in upcoming releases of GRAMPS.)<br />
;Include images and media objects<br />
:This option determines whether to include/exclude a gallery of media objects on your website.<br />
;Include download page<br />
:This option determines whether to include a page titled &#8216;Downloads&#8217. This page will be blank and is provided in case you would like to offer downloads of databases, media objects or references to your visitors.<br />
;Suppress GRAMPS ID<br />
:This option determines whether to include the GRAMPS ID of objects in your web page output.<br />
<br />
==== Privacy ====<br />
Privacy of personal information is an important issue. GRAMPS provides tools and settings that give you control over the privacy of your data.<br />
;Include records marked private<br />
:If your intention is to provide a complete record of your research, checking this box will include all entries marked '''private''' along with the rest of your database.<br />
;Living People<br />
:You can inhibit the display of sensitive information related to living people. In this option you can choose to '''Include''' all information of all living people, '''Exclude''' all information of all living people, or '''Restrict''' some information for all living people. If you select {{man label|Restrict}} GRAMPS will determine which people have the potential of still being alive and will omit them from the report output.<br />
;Years from death to consider living<br />
:This option is inactive if the ‘Living People’ option is set to '''Include'''. Some countries have laws that specify a certain number of years after death before an individual&#8217;s information can be published. Here you can specify the number of years after death needed to comply with such laws. The default value is 30 years. <br />
<br />
:Please note that compliance with privacy laws and individuals&#8217; privacy concerns is the researcher&#8217;s responsibility. GRAMPS cannot be held responsible for privacy law compliance or other privacy issues.<br />
<br />
==== Advanced ====<br />
[[Image:NWeb-Man-Print.jpg|right|300px|thumb|fig. c.4 The default appearance of pages printed from a Narrative Website web page]]<br />
The current advanced settings primarily address the amount of information displayed on the Surname detail and Individual index web pages. They are simple on-or-off options which can be understood with little explanation.<br />
* include a link to home person on every page<br />
* include a column for birth dates on the index pages<br />
* include a column for death dates on the index pages<br />
* include a column for partners on the index pages<br />
* include a column for parents on the index pages<br />
* include a column for half-siblings on the index pages<br />
<br />
{{man tip|Do not forget to check the no style sheet option. Otherwise you will overwrite your custom style sheet.}}<br />
<br />
=== Web Calendar ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=6165Gramps 3.0 Wiki Manual - Reports2008-04-19T21:51:05Z<p>Simanek: /* Privacy */ more copy changes</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree ===<br />
[[Image:voorouderpdf.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar ===<br />
<br />
<br />
=== Descendant Tree ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
[[Image:statgraftaart.png|right|thumb|250px|Fig. a.6 Results]]<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph ===<br />
<br />
=== Hourglass Graph ===<br />
<br />
=== Relationship Graph ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report ===<br />
<br />
<br />
<br />
=== Complete Individual Report ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report ===<br />
<br />
=== Family Group Report ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report ===<br />
<br />
=== Marker Report ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site ===<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.1 Individual List Page in Mainz Style]]<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The GRAMPS 3.0 Narrated Web Site report provides improved functionality, support for web standards and additional features. The new report creates pages that closely follow the World Wide Web Consortium&#8217;s Recommendations for XHTML 1.0 Strict and CSS 1. These recommendations include a separation of content from presentation. Due to this practice, the style and appearance of the new web pages can be completely controlled from one CSS stylesheet without altering individual pages.<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as a family history.<br />
<br />
==== Using the Report ====<br />
The Narrated Web Site report provides the user with options that allow a wide range of customization. You can run this report via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrated Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Options''', '''Page Generation''', '''Privacy''' and '''Advanced'''. Each of those tabs are reviewed below. <br />
{{man warn|Entire Database|Be aware that if you select your entire database as a filter a large number of files will be generated (depending on the size of your database). It is recommended to start with a filter (for example: ancestors of a certain person) to simplify the output while you learn about the plugin.}}<br />
<br />
==== Report Options ====<br />
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]<br />
;Store web pages in .tar.gz archive<br />
:The large number of files and directories in this web output may make it difficult to transfer the files to an external web host. GRAMPS has the capability of saving all of your Narrative Web files in one compressed archive using the gzip and tar formats (casually known as a &#8216;tarball&#8217;). This single file can quickly be transferred to your server. Unfortunately not all web servers support saving web files in this way, so contact your hosting provider for more information.<br />
<br />
:The free genealogy site hosting provided by the GRAMPS organization will only accept your files in a compressed archive. Learn more about free genealogy site hosting at http://library.gramps-project.org/<br />
;Destination<br />
:The output of the Narrative Web report is by default saved here {{man label|/yourhomedirectory/NAVWEB}}. This option allows you to save your report output to a destination of your choice.<br />
;Filter<br />
:Like the previous web page generator and other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but custom filters can be made for your specific needs. Learn more about custom filters at http://gramps-project.org/wiki/index.php?title=Filter.<br />
;Filter Person<br />
:This option is inactive if the primary Filter option is set to &#8216;Entire Database&#8217;. Filters are generally subject to how one specific individual relates to other individuals. This option allows you to specify the primary individual. Use the {{man button|Edit}} button to select any individual in your database.<br />
;Web site title<br />
:The default site title value is '''My Family Tree'''. You can enter a custom site title in this option.<br />
;File extension<br />
:The file extension to be used for the web files. Choose between the {{man label|.html}} default value, .htm, .shtml, .php, .php3, or .cgi.<br />
;Copyright<br />
:When creating a public a web site it is important to specify the copyright conditions under which you are publishing your data. International copyright law reserves all rights of your data to your discretion. You own the data and individuals must have your permission if they wish to reuse that data. In genealogical research sharing data with other researchers is a common practice. By default the Narrative Web report uses an '''All Rights Reserved''' copyright. Other options include the Creative Commons licenses, offering a wide range of use restrictions or none at all. Learn more about the Creative Commons at http://creativecommons.org/<br />
;Character set encoding<br />
:GRAMPS is an international application developed with multiple languages and translations in mind. Because of this the default character set for HTML pages is {{man label|UTF-8}}, which supports a wide range of international characters and symbols. From the drop down menu list you can select from a variety of {{man label|ISO-8859-}} encoding sets or even a {{man label|koi8_r}} encoding set. There is support for virtually all popular character set encodings. If you are having problems with character presentation in your web pages it could be a matter of selecting a compatible character set encoding for your web server environment.<br />
[[Image:NWeb-Man-BasicSet.jpg|right|180px|thumb|fig. c.3 Basic Style - 5 Color Choices]]<br />
;Stylesheet<br />
:GRAMPS provides seven built in style sheets for you to choose from to determine the appearance or your web pages. In GRAMPS 3.0 you can choose between '''Basic''' (Ash, Cypress, Lilac, Peach or Spruce color schemes), '''Mainz''', or '''Nebraska''' styles. There is also the option of not including a stylesheet ('''No style sheet'''). Regardless of the style you choose, the style sheet file name is ''narrative.css''. You may edit this file to further customize the appearance of your web pages.<br />
<br />
:If you make modifications to your style sheet be aware that regenerating the your pages with the same output destination will overwrite your custom style sheet. To preserve your custom style sheet through subsequent web page updates select {{man label|No style sheet}}.<br />
<br />
:''figures c.1, c.2 and c.3 are examples of the styles currently included with GRAMPS 3.0''<br />
;Include ancestor graph<br />
:Checking this box will include an ancestor graph on each individual&#8217;s detail page if they have defined ancestors in your database.<br />
;Graph generations<br />
:This option is inactive if the ‘Include ancestor graph’ option is not checked. The default number of generations shown in the ancestor graphs is {{man label|4}} with options of 2, 3, 4 or 5.<br />
<br />
:The individuals represented in the ancestor graphs are the same individuals whose information is provided elsewhere in your web pages.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
<br />
==== Page Generation ====<br />
The Narrated Web Site report can be set to generate three supplemental pages: '''Home''', '''Introduction''' and '''Publisher Contact'''. From this tab you can activate the pages and assign Media or Notes items to each page. By default no content (media or text) is assigned to these pages. Content for these pages must originate as Media or Notes items. If the desired items have already been added to your database you will be able to choose them from a list of Notes or Image Objects. <br />
;Home Page, Introduction and Publisher Contact<br />
:These pages will display an individual Media Object and/or a Note of your choice. To enable any of these pages choose a Media Object and/or Note by way of the selection button to the right of the corresponding page listing.<br />
<br />
:Please use the Publisher contact page with caution if you are publishing your web pages on a publicly accessible web server.<br />
;HTML user header and HTML user footer<br />
:These elements will display an individual Note of your choice. The HTML user header text will appear directly below the site title on every web page. The HTML user footer text will appear within the footer, above the copyright statement on every web page. (This feature is in rapid development currently and may be subject to dramatic change in upcoming releases of GRAMPS.)<br />
;Include images and media objects<br />
:This option determines whether to include/exclude a gallery of media objects on your website.<br />
;Include download page<br />
:This option determines whether to include a page titled &#8216;Downloads&#8217. This page will be blank and is provided in case you would like to offer downloads of databases, media objects or references to your visitors.<br />
;Suppress GRAMPS ID<br />
:This option determines whether to include the GRAMPS ID of objects in your web page output.<br />
<br />
==== Privacy ====<br />
Privacy of personal information is an important issue. GRAMPS provides tools and settings that give you control over the privacy of your data.<br />
;Include records marked private<br />
:If your intention is to provide a complete record of your research, checking this box will include all entries marked '''private''' along with the rest of your database.<br />
;Living People<br />
:You can inhibit the display of sensitive information related to living people. In this option you can choose to '''Include''' all information of all living people, '''Exclude''' all information of all living people, or '''Restrict''' some information for all living people. If you select {{man label|Restrict}} GRAMPS will determine which people have the potential of still being alive and will omit them from the report output.<br />
;Years from death to consider living<br />
:This option is inactive if the ‘Living People’ option is set to '''Include'''. Some countries have laws that specify a certain number of years after death before an individual&#8217;s information can be published. Here you can specify the number of years after death needed to comply with such laws. The default value is 30 years. <br />
<br />
:Please note that compliance with privacy laws and individuals&#8217; privacy concerns is the researcher&#8217;s responsibility. GRAMPS cannot be held responsible for privacy law compliance or other privacy issues.<br />
<br />
==== Advanced ====<br />
[[Image:NWeb-Man-Print.jpg|right|300px|thumb|fig. c.4 The default appearance of pages printed from a Narrative Website web page]]<br />
in this tab page you can determine which columns will show up in your web pages. those options are controlled via check boxes.<br />
* include a link to home person on every page<br />
* include a column for birth dates on the index pages<br />
* include a column for death dates on the index pages<br />
* include a column for partners on the index pages<br />
* include a column for parents on the index pages<br />
* include a column for half-siblings on the index pages<br />
* Organization of the web pages. A lot of files and directories are generated. Default you can find this directory structure under the {{man label|NAVWEB}} directory. <br />
** Directories: Following directories are made: ''images'', ''img'', ''plc'', ''ppl'', ''src'', ''srn'', ''thumb''. Each directory contains many subdirectories: /homedir/NAVWEB/src/1/5/15CF2WIFLGOGFRJMLY.html. This last file is unique. If you regenerate web pages or add records and regenerate your web site those file names remain the same.<br />
** HTML files: if you choose to generate HTML files following files will be generated: start page : ''index.html'', ''gallery.html'', if clicked a ''download.html'' page, ''places.html'', ''sources.html'', and ''surname_count.html''.<br />
** CSS files: two style sheet files are generated: ''narrative.css'' and ''narrative-print.css''<br />
<br />
* Customize your CSS files: You can alter and change the made CSS file very easy. The advantage of a style sheet is that changes you do on this text file, you see immediately the effects on the lay-out and color schemes. <br />
<br />
You can customize your style sheet to provide additional formatting and positioning information to control sections.<br />
<br />
{{man tip|Do not forget to check the no style sheet option. Otherwise you will overwrite your custom style sheet.}}<br />
<br />
=== Web Calendar ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=6164Gramps 3.0 Wiki Manual - Reports2008-04-19T21:38:02Z<p>Simanek: /* Privacy */ more copy changes</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree ===<br />
[[Image:voorouderpdf.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar ===<br />
<br />
<br />
=== Descendant Tree ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
[[Image:statgraftaart.png|right|thumb|250px|Fig. a.6 Results]]<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph ===<br />
<br />
=== Hourglass Graph ===<br />
<br />
=== Relationship Graph ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report ===<br />
<br />
<br />
<br />
=== Complete Individual Report ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report ===<br />
<br />
=== Family Group Report ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report ===<br />
<br />
=== Marker Report ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site ===<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.1 Individual List Page in Mainz Style]]<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The GRAMPS 3.0 Narrated Web Site report provides improved functionality, support for web standards and additional features. The new report creates pages that closely follow the World Wide Web Consortium&#8217;s Recommendations for XHTML 1.0 Strict and CSS 1. These recommendations include a separation of content from presentation. Due to this practice, the style and appearance of the new web pages can be completely controlled from one CSS stylesheet without altering individual pages.<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as a family history.<br />
<br />
==== Using the Report ====<br />
The Narrated Web Site report provides the user with options that allow a wide range of customization. You can run this report via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrated Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Options''', '''Page Generation''', '''Privacy''' and '''Advanced'''. Each of those tabs are reviewed below. <br />
{{man warn|Entire Database|Be aware that if you select your entire database as a filter a large number of files will be generated (depending on the size of your database). It is recommended to start with a filter (for example: ancestors of a certain person) to simplify the output while you learn about the plugin.}}<br />
<br />
==== Report Options ====<br />
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]<br />
;Store web pages in .tar.gz archive<br />
:The large number of files and directories in this web output may make it difficult to transfer the files to an external web host. GRAMPS has the capability of saving all of your Narrative Web files in one compressed archive using the gzip and tar formats (casually known as a &#8216;tarball&#8217;). This single file can quickly be transferred to your server. Unfortunately not all web servers support saving web files in this way, so contact your hosting provider for more information.<br />
<br />
:The free genealogy site hosting provided by the GRAMPS organization will only accept your files in a compressed archive. Learn more about free genealogy site hosting at http://library.gramps-project.org/<br />
;Destination<br />
:The output of the Narrative Web report is by default saved here {{man label|/yourhomedirectory/NAVWEB}}. This option allows you to save your report output to a destination of your choice.<br />
;Filter<br />
:Like the previous web page generator and other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but custom filters can be made for your specific needs. Learn more about custom filters at http://gramps-project.org/wiki/index.php?title=Filter.<br />
;Filter Person<br />
:This option is inactive if the primary Filter option is set to &#8216;Entire Database&#8217;. Filters are generally subject to how one specific individual relates to other individuals. This option allows you to specify the primary individual. Use the {{man button|Edit}} button to select any individual in your database.<br />
;Web site title<br />
:The default site title value is '''My Family Tree'''. You can enter a custom site title in this option.<br />
;File extension<br />
:The file extension to be used for the web files. Choose between the {{man label|.html}} default value, .htm, .shtml, .php, .php3, or .cgi.<br />
;Copyright<br />
:When creating a public a web site it is important to specify the copyright conditions under which you are publishing your data. International copyright law reserves all rights of your data to your discretion. You own the data and individuals must have your permission if they wish to reuse that data. In genealogical research sharing data with other researchers is a common practice. By default the Narrative Web report uses an '''All Rights Reserved''' copyright. Other options include the Creative Commons licenses, offering a wide range of use restrictions or none at all. Learn more about the Creative Commons at http://creativecommons.org/<br />
;Character set encoding<br />
:GRAMPS is an international application developed with multiple languages and translations in mind. Because of this the default character set for HTML pages is {{man label|UTF-8}}, which supports a wide range of international characters and symbols. From the drop down menu list you can select from a variety of {{man label|ISO-8859-}} encoding sets or even a {{man label|koi8_r}} encoding set. There is support for virtually all popular character set encodings. If you are having problems with character presentation in your web pages it could be a matter of selecting a compatible character set encoding for your web server environment.<br />
[[Image:NWeb-Man-BasicSet.jpg|right|180px|thumb|fig. c.3 Basic Style - 5 Color Choices]]<br />
;Stylesheet<br />
:GRAMPS provides seven built in style sheets for you to choose from to determine the appearance or your web pages. In GRAMPS 3.0 you can choose between '''Basic''' (Ash, Cypress, Lilac, Peach or Spruce color schemes), '''Mainz''', or '''Nebraska''' styles. There is also the option of not including a stylesheet ('''No style sheet'''). Regardless of the style you choose, the style sheet file name is ''narrative.css''. You may edit this file to further customize the appearance of your web pages.<br />
<br />
:If you make modifications to your style sheet be aware that regenerating the your pages with the same output destination will overwrite your custom style sheet. To preserve your custom style sheet through subsequent web page updates select {{man label|No style sheet}}.<br />
<br />
:''figures c.1, c.2 and c.3 are examples of the styles currently included with GRAMPS 3.0''<br />
;Include ancestor graph<br />
:Checking this box will include an ancestor graph on each individual&#8217;s detail page if they have defined ancestors in your database.<br />
;Graph generations<br />
:This option is inactive if the ‘Include ancestor graph’ option is not checked. The default number of generations shown in the ancestor graphs is {{man label|4}} with options of 2, 3, 4 or 5.<br />
<br />
:The individuals represented in the ancestor graphs are the same individuals whose information is provided elsewhere in your web pages.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
<br />
==== Page Generation ====<br />
The Narrated Web Site report can be set to generate three supplemental pages: '''Home''', '''Introduction''' and '''Publisher Contact'''. From this tab you can activate the pages and assign Media or Notes items to each page. By default no content (media or text) is assigned to these pages. Content for these pages must originate as Media or Notes items. If the desired items have already been added to your database you will be able to choose them from a list of Notes or Image Objects. <br />
;Home Page, Introduction and Publisher Contact<br />
:These pages will display an individual Media Object and/or a Note of your choice. To enable any of these pages choose a Media Object and/or Note by way of the selection button to the right of the corresponding page listing.<br />
<br />
:Please use the Publisher contact page with caution if you are publishing your web pages on a publicly accessible web server.<br />
;HTML user header and HTML user footer<br />
:These elements will display an individual Note of your choice. The HTML user header text will appear directly below the site title on every web page. The HTML user footer text will appear within the footer, above the copyright statement on every web page. (This feature is in rapid development currently and may be subject to dramatic change in upcoming releases of GRAMPS.)<br />
;Include images and media objects<br />
:This option determines whether to include/exclude a gallery of media objects on your website.<br />
;Include download page<br />
:This option determines whether to include a page titled &#8216;Downloads&#8217. This page will be blank and is provided in case you would like to offer downloads of databases, media objects or references to your visitors.<br />
;Suppress GRAMPS ID<br />
:This option determines whether to include the GRAMPS ID of objects in your web page output.<br />
<br />
==== Privacy ====<br />
Privacy of personal information is an important issue. GRAMPS provides tools and settings that give you control over the privacy of your data.<br />
;Include records marked private<br />
:If your intention is to provide a complete record of your research, checking this box will include all entries marked '''private''' along with the rest of your database.<br />
;Living People<br />
:You can inhibit the display of sensitive information related to living people. In this option you can choose to '''Include''' all information of all living people, '''Exclude''' all information of all living people, or '''Restrict''' some information for all living people. If you select {{man label|Restrict}} GRAMPS will determine which people have the potential of still being alive and will omit them from the report output.<br />
;Years from death to consider living<br />
:Some countries have laws that indicate that a certain number of years must pass after someone's death before information can be published. in the input field you can give the amount of years to consider. The default value is 30 years. The {{man label|Years to restrict from person's death}} option allows you to specify how many years a person must be deceased before the information is included. Please note that it is your responsibility to double check all information in the pages for any privacy information. GRAMPS cannot be held responsible for any privacy issues.<br />
<br />
==== Advanced ====<br />
[[Image:NWeb-Man-Print.jpg|right|300px|thumb|fig. c.4 The default appearance of pages printed from a Narrative Website web page]]<br />
in this tab page you can determine which columns will show up in your web pages. those options are controlled via check boxes.<br />
* include a link to home person on every page<br />
* include a column for birth dates on the index pages<br />
* include a column for death dates on the index pages<br />
* include a column for partners on the index pages<br />
* include a column for parents on the index pages<br />
* include a column for half-siblings on the index pages<br />
* Organization of the web pages. A lot of files and directories are generated. Default you can find this directory structure under the {{man label|NAVWEB}} directory. <br />
** Directories: Following directories are made: ''images'', ''img'', ''plc'', ''ppl'', ''src'', ''srn'', ''thumb''. Each directory contains many subdirectories: /homedir/NAVWEB/src/1/5/15CF2WIFLGOGFRJMLY.html. This last file is unique. If you regenerate web pages or add records and regenerate your web site those file names remain the same.<br />
** HTML files: if you choose to generate HTML files following files will be generated: start page : ''index.html'', ''gallery.html'', if clicked a ''download.html'' page, ''places.html'', ''sources.html'', and ''surname_count.html''.<br />
** CSS files: two style sheet files are generated: ''narrative.css'' and ''narrative-print.css''<br />
<br />
* Customize your CSS files: You can alter and change the made CSS file very easy. The advantage of a style sheet is that changes you do on this text file, you see immediately the effects on the lay-out and color schemes. <br />
<br />
You can customize your style sheet to provide additional formatting and positioning information to control sections.<br />
<br />
{{man tip|Do not forget to check the no style sheet option. Otherwise you will overwrite your custom style sheet.}}<br />
<br />
=== Web Calendar ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=6162Gramps 3.0 Wiki Manual - Reports2008-04-19T21:05:16Z<p>Simanek: /* Page Generation */</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree ===<br />
[[Image:voorouderpdf.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar ===<br />
<br />
<br />
=== Descendant Tree ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
[[Image:statgraftaart.png|right|thumb|250px|Fig. a.6 Results]]<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph ===<br />
<br />
=== Hourglass Graph ===<br />
<br />
=== Relationship Graph ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report ===<br />
<br />
<br />
<br />
=== Complete Individual Report ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report ===<br />
<br />
=== Family Group Report ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report ===<br />
<br />
=== Marker Report ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site ===<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.1 Individual List Page in Mainz Style]]<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The GRAMPS 3.0 Narrated Web Site report provides improved functionality, support for web standards and additional features. The new report creates pages that closely follow the World Wide Web Consortium&#8217;s Recommendations for XHTML 1.0 Strict and CSS 1. These recommendations include a separation of content from presentation. Due to this practice, the style and appearance of the new web pages can be completely controlled from one CSS stylesheet without altering individual pages.<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as a family history.<br />
<br />
==== Using the Report ====<br />
The Narrated Web Site report provides the user with options that allow a wide range of customization. You can run this report via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrated Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Options''', '''Page Generation''', '''Privacy''' and '''Advanced'''. Each of those tabs are reviewed below. <br />
{{man warn|Entire Database|Be aware that if you select your entire database as a filter a large number of files will be generated (depending on the size of your database). It is recommended to start with a filter (for example: ancestors of a certain person) to simplify the output while you learn about the plugin.}}<br />
<br />
==== Report Options ====<br />
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]<br />
;Store web pages in .tar.gz archive<br />
:The large number of files and directories in this web output may make it difficult to transfer the files to an external web host. GRAMPS has the capability of saving all of your Narrative Web files in one compressed archive using the gzip and tar formats (casually known as a &#8216;tarball&#8217;). This single file can quickly be transferred to your server. Unfortunately not all web servers support saving web files in this way, so contact your hosting provider for more information.<br />
<br />
:The free genealogy site hosting provided by the GRAMPS organization will only accept your files in a compressed archive. Learn more about free genealogy site hosting at http://library.gramps-project.org/<br />
;Destination<br />
:The output of the Narrative Web report is by default saved here {{man label|/yourhomedirectory/NAVWEB}}. This option allows you to save your report output to a destination of your choice.<br />
;Filter<br />
:Like the previous web page generator and other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but custom filters can be made for your specific needs. Learn more about custom filters at http://gramps-project.org/wiki/index.php?title=Filter.<br />
;Filter Person<br />
:This option is inactive if the primary Filter option is set to &#8216;Entire Database&#8217;. Filters are generally subject to how one specific individual relates to other individuals. This option allows you to specify the primary individual. Use the {{man button|Edit}} button to select any individual in your database.<br />
;Web site title<br />
:The default site title value is '''My Family Tree'''. You can enter a custom site title in this option.<br />
;File extension<br />
:The file extension to be used for the web files. Choose between the {{man label|.html}} default value, .htm, .shtml, .php, .php3, or .cgi.<br />
;Copyright<br />
:When creating a public a web site it is important to specify the copyright conditions under which you are publishing your data. International copyright law reserves all rights of your data to your discretion. You own the data and individuals must have your permission if they wish to reuse that data. In genealogical research sharing data with other researchers is a common practice. By default the Narrative Web report uses an '''All Rights Reserved''' copyright. Other options include the Creative Commons licenses, offering a wide range of use restrictions or none at all. Learn more about the Creative Commons at http://creativecommons.org/<br />
;Character set encoding<br />
:GRAMPS is an international application developed with multiple languages and translations in mind. Because of this the default character set for HTML pages is {{man label|UTF-8}}, which supports a wide range of international characters and symbols. From the drop down menu list you can select from a variety of {{man label|ISO-8859-}} encoding sets or even a {{man label|koi8_r}} encoding set. There is support for virtually all popular character set encodings. If you are having problems with character presentation in your web pages it could be a matter of selecting a compatible character set encoding for your web server environment.<br />
[[Image:NWeb-Man-BasicSet.jpg|right|180px|thumb|fig. c.3 Basic Style - 5 Color Choices]]<br />
;Stylesheet<br />
:GRAMPS provides seven built in style sheets for you to choose from to determine the appearance or your web pages. In GRAMPS 3.0 you can choose between '''Basic''' (Ash, Cypress, Lilac, Peach or Spruce color schemes), '''Mainz''', or '''Nebraska''' styles. There is also the option of not including a stylesheet ('''No style sheet'''). Regardless of the style you choose, the style sheet file name is ''narrative.css''. You may edit this file to further customize the appearance of your web pages.<br />
<br />
:If you make modifications to your style sheet be aware that regenerating the your pages with the same output destination will overwrite your custom style sheet. To preserve your custom style sheet through subsequent web page updates select {{man label|No style sheet}}.<br />
<br />
:''figures c.1, c.2 and c.3 are examples of the styles currently included with GRAMPS 3.0''<br />
;Include ancestor graph<br />
:Checking this box will include an ancestor graph on each individual&#8217;s detail page if they have defined ancestors in your database.<br />
;Graph generations<br />
:This option is inactive if the ‘Include ancestor graph’ option is not checked. The default number of generations shown in the ancestor graphs is {{man label|4}} with options of 2, 3, 4 or 5.<br />
<br />
:The individuals represented in the ancestor graphs are the same individuals whose information is provided elsewhere in your web pages.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
<br />
==== Page Generation ====<br />
The Narrated Web Site report can be set to generate three supplemental pages: '''Home''', '''Introduction''' and '''Publisher Contact'''. From this tab you can activate the pages and assign Media or Notes items to each page. By default no content (media or text) is assigned to these pages. Content for these pages must originate as Media or Notes items. If the desired items have already been added to your database you will be able to choose them from a list of Notes or Image Objects. <br />
;Home Page, Introduction and Publisher Contact<br />
:These pages will display an individual Media Object and/or a Note of your choice. To enable any of these pages choose a Media Object and/or Note by way of the selection button to the right of the corresponding page listing.<br />
<br />
:Please use the Publisher contact page with caution if you are publishing your web pages on a publicly accessible web server.<br />
;HTML user header and HTML user footer<br />
:These elements will display an individual Note of your choice. The HTML user header text will appear directly below the site title on every web page. The HTML user footer text will appear within the footer, above the copyright statement on every web page. (This feature is in rapid development currently and may be subject to dramatic change in upcoming releases of GRAMPS.)<br />
;Include images and media objects<br />
:This option determines whether to include/exclude a gallery of media objects on your website.<br />
;Include download page<br />
:This option determines whether to include a page titled &#8216;Downloads&#8217. This page will be blank and is provided in case you would like to offer downloads of databases, media objects or references to your visitors.<br />
;Suppress GRAMPS ID<br />
:This option determines whether to include the GRAMPS ID of objects in your web page output.<br />
<br />
==== Privacy ====<br />
Privacy of personal information is an important issue on the web today. GRAMPS tries to give you control over the information that is presented.<br />
* check box include records marked private: GRAMPS provides two options to control the privacy of your information. If you do not select the {{man label|Include records marked private}} option, any data that is marked as private will not be displayed on the generated site.<br />
* Living People: The drop down menu let you choose between '''Exclude''', '''Restrict''', and '''Include'''. If you select {{man label|Restrict information on living people}} , GRAMPS will attempt to determine which people have the potential of still being alive, and will omit these people from the database. Some countries have laws that indicate that a certain number of years must pass after someone's death before information can be published.<br />
* Years from death to consider living: in the input field you can give the amount of years to consider. The default value is 30 years. The {{man label|Years to restrict from person's death}} option allows you to specify how many years a person must be deceased before the information is included. Please note that it is your responsibility to double check all information in the pages for any privacy information. GRAMPS cannot be held responsible for any privacy issues.<br />
<br />
==== Advanced ====<br />
[[Image:NWeb-Man-Print.jpg|right|300px|thumb|fig. c.4 The default appearance of pages printed from a Narrative Website web page]]<br />
in this tab page you can determine which columns will show up in your web pages. those options are controlled via check boxes.<br />
* include a link to home person on every page<br />
* include a column for birth dates on the index pages<br />
* include a column for death dates on the index pages<br />
* include a column for partners on the index pages<br />
* include a column for parents on the index pages<br />
* include a column for half-siblings on the index pages<br />
* Organization of the web pages. A lot of files and directories are generated. Default you can find this directory structure under the {{man label|NAVWEB}} directory. <br />
** Directories: Following directories are made: ''images'', ''img'', ''plc'', ''ppl'', ''src'', ''srn'', ''thumb''. Each directory contains many subdirectories: /homedir/NAVWEB/src/1/5/15CF2WIFLGOGFRJMLY.html. This last file is unique. If you regenerate web pages or add records and regenerate your web site those file names remain the same.<br />
** HTML files: if you choose to generate HTML files following files will be generated: start page : ''index.html'', ''gallery.html'', if clicked a ''download.html'' page, ''places.html'', ''sources.html'', and ''surname_count.html''.<br />
** CSS files: two style sheet files are generated: ''narrative.css'' and ''narrative-print.css''<br />
<br />
* Customize your CSS files: You can alter and change the made CSS file very easy. The advantage of a style sheet is that changes you do on this text file, you see immediately the effects on the lay-out and color schemes. <br />
<br />
You can customize your style sheet to provide additional formatting and positioning information to control sections.<br />
<br />
{{man tip|Do not forget to check the no style sheet option. Otherwise you will overwrite your custom style sheet.}}<br />
<br />
=== Web Calendar ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=6161Gramps 3.0 Wiki Manual - Reports2008-04-19T21:04:25Z<p>Simanek: /* Page Generation */ More copy changes</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree ===<br />
[[Image:voorouderpdf.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar ===<br />
<br />
<br />
=== Descendant Tree ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
[[Image:statgraftaart.png|right|thumb|250px|Fig. a.6 Results]]<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph ===<br />
<br />
=== Hourglass Graph ===<br />
<br />
=== Relationship Graph ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report ===<br />
<br />
<br />
<br />
=== Complete Individual Report ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report ===<br />
<br />
=== Family Group Report ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report ===<br />
<br />
=== Marker Report ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site ===<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.1 Individual List Page in Mainz Style]]<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The GRAMPS 3.0 Narrated Web Site report provides improved functionality, support for web standards and additional features. The new report creates pages that closely follow the World Wide Web Consortium&#8217;s Recommendations for XHTML 1.0 Strict and CSS 1. These recommendations include a separation of content from presentation. Due to this practice, the style and appearance of the new web pages can be completely controlled from one CSS stylesheet without altering individual pages.<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as a family history.<br />
<br />
==== Using the Report ====<br />
The Narrated Web Site report provides the user with options that allow a wide range of customization. You can run this report via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrated Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Options''', '''Page Generation''', '''Privacy''' and '''Advanced'''. Each of those tabs are reviewed below. <br />
{{man warn|Entire Database|Be aware that if you select your entire database as a filter a large number of files will be generated (depending on the size of your database). It is recommended to start with a filter (for example: ancestors of a certain person) to simplify the output while you learn about the plugin.}}<br />
<br />
==== Report Options ====<br />
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]<br />
;Store web pages in .tar.gz archive<br />
:The large number of files and directories in this web output may make it difficult to transfer the files to an external web host. GRAMPS has the capability of saving all of your Narrative Web files in one compressed archive using the gzip and tar formats (casually known as a &#8216;tarball&#8217;). This single file can quickly be transferred to your server. Unfortunately not all web servers support saving web files in this way, so contact your hosting provider for more information.<br />
<br />
:The free genealogy site hosting provided by the GRAMPS organization will only accept your files in a compressed archive. Learn more about free genealogy site hosting at http://library.gramps-project.org/<br />
;Destination<br />
:The output of the Narrative Web report is by default saved here {{man label|/yourhomedirectory/NAVWEB}}. This option allows you to save your report output to a destination of your choice.<br />
;Filter<br />
:Like the previous web page generator and other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but custom filters can be made for your specific needs. Learn more about custom filters at http://gramps-project.org/wiki/index.php?title=Filter.<br />
;Filter Person<br />
:This option is inactive if the primary Filter option is set to &#8216;Entire Database&#8217;. Filters are generally subject to how one specific individual relates to other individuals. This option allows you to specify the primary individual. Use the {{man button|Edit}} button to select any individual in your database.<br />
;Web site title<br />
:The default site title value is '''My Family Tree'''. You can enter a custom site title in this option.<br />
;File extension<br />
:The file extension to be used for the web files. Choose between the {{man label|.html}} default value, .htm, .shtml, .php, .php3, or .cgi.<br />
;Copyright<br />
:When creating a public a web site it is important to specify the copyright conditions under which you are publishing your data. International copyright law reserves all rights of your data to your discretion. You own the data and individuals must have your permission if they wish to reuse that data. In genealogical research sharing data with other researchers is a common practice. By default the Narrative Web report uses an '''All Rights Reserved''' copyright. Other options include the Creative Commons licenses, offering a wide range of use restrictions or none at all. Learn more about the Creative Commons at http://creativecommons.org/<br />
;Character set encoding<br />
:GRAMPS is an international application developed with multiple languages and translations in mind. Because of this the default character set for HTML pages is {{man label|UTF-8}}, which supports a wide range of international characters and symbols. From the drop down menu list you can select from a variety of {{man label|ISO-8859-}} encoding sets or even a {{man label|koi8_r}} encoding set. There is support for virtually all popular character set encodings. If you are having problems with character presentation in your web pages it could be a matter of selecting a compatible character set encoding for your web server environment.<br />
[[Image:NWeb-Man-BasicSet.jpg|right|180px|thumb|fig. c.3 Basic Style - 5 Color Choices]]<br />
;Stylesheet<br />
:GRAMPS provides seven built in style sheets for you to choose from to determine the appearance or your web pages. In GRAMPS 3.0 you can choose between '''Basic''' (Ash, Cypress, Lilac, Peach or Spruce color schemes), '''Mainz''', or '''Nebraska''' styles. There is also the option of not including a stylesheet ('''No style sheet'''). Regardless of the style you choose, the style sheet file name is ''narrative.css''. You may edit this file to further customize the appearance of your web pages.<br />
<br />
:If you make modifications to your style sheet be aware that regenerating the your pages with the same output destination will overwrite your custom style sheet. To preserve your custom style sheet through subsequent web page updates select {{man label|No style sheet}}.<br />
<br />
:''figures c.1, c.2 and c.3 are examples of the styles currently included with GRAMPS 3.0''<br />
;Include ancestor graph<br />
:Checking this box will include an ancestor graph on each individual&#8217;s detail page if they have defined ancestors in your database.<br />
;Graph generations<br />
:This option is inactive if the ‘Include ancestor graph’ option is not checked. The default number of generations shown in the ancestor graphs is {{man label|4}} with options of 2, 3, 4 or 5.<br />
<br />
:The individuals represented in the ancestor graphs are the same individuals whose information is provided elsewhere in your web pages.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
<br />
==== Page Generation ====<br />
The Narrated Web Site report can be set to generate three supplemental pages: '''Home''', '''Introduction''' and '''Publisher Contact'''. From this tab you can activate the pages and assign Media or Notes items to each page. By default no content (media or text) is assigned to these pages. Content for these pages must originate as Media or Notes items. If the desired items have already been added to your database you will be able to choose them from a list of Notes or Image Objects. <br />
;Home Page, Introduction and Publisher Contact<br />
:These pages will display an individual Media Object and/or a Note of your choice. To enable any of these pages choose a Media Object and/or Note by way of the selection button to the right of the corresponding page listing.<br />
<br />
:Please use the Publisher contact page with caution if you are publishing your web pages on a publicly accessible web server.<br />
;HTML user header and HTML user footer<br />
:These elements will display an individual Note of your choice. The HTML user header text will appear directly below the site title on every web page. The HTML user footer text will appear within the footer, above the copyright statement on every web page. (This feature is in rapid development currently and may be subject to dramatic change in upcoming releases of GRAMPS.)<br />
;Include images and media objects<br />
:This option determines whether to include/exclude a gallery of media objects on your website.<br />
;Include download page<br />
:This option determines whether to include a page titled &#8216;Downloads&#8217. This page will be blank and is provided in case you would like to offer downloads of databases, media objects or references to your visitors.<br />
;Suppress GRAMPS ID<br />
:This option determines whether to include the GRAMPS ID of objects in the web pages.<br />
<br />
==== Privacy ====<br />
Privacy of personal information is an important issue on the web today. GRAMPS tries to give you control over the information that is presented.<br />
* check box include records marked private: GRAMPS provides two options to control the privacy of your information. If you do not select the {{man label|Include records marked private}} option, any data that is marked as private will not be displayed on the generated site.<br />
* Living People: The drop down menu let you choose between '''Exclude''', '''Restrict''', and '''Include'''. If you select {{man label|Restrict information on living people}} , GRAMPS will attempt to determine which people have the potential of still being alive, and will omit these people from the database. Some countries have laws that indicate that a certain number of years must pass after someone's death before information can be published.<br />
* Years from death to consider living: in the input field you can give the amount of years to consider. The default value is 30 years. The {{man label|Years to restrict from person's death}} option allows you to specify how many years a person must be deceased before the information is included. Please note that it is your responsibility to double check all information in the pages for any privacy information. GRAMPS cannot be held responsible for any privacy issues.<br />
<br />
==== Advanced ====<br />
[[Image:NWeb-Man-Print.jpg|right|300px|thumb|fig. c.4 The default appearance of pages printed from a Narrative Website web page]]<br />
in this tab page you can determine which columns will show up in your web pages. those options are controlled via check boxes.<br />
* include a link to home person on every page<br />
* include a column for birth dates on the index pages<br />
* include a column for death dates on the index pages<br />
* include a column for partners on the index pages<br />
* include a column for parents on the index pages<br />
* include a column for half-siblings on the index pages<br />
* Organization of the web pages. A lot of files and directories are generated. Default you can find this directory structure under the {{man label|NAVWEB}} directory. <br />
** Directories: Following directories are made: ''images'', ''img'', ''plc'', ''ppl'', ''src'', ''srn'', ''thumb''. Each directory contains many subdirectories: /homedir/NAVWEB/src/1/5/15CF2WIFLGOGFRJMLY.html. This last file is unique. If you regenerate web pages or add records and regenerate your web site those file names remain the same.<br />
** HTML files: if you choose to generate HTML files following files will be generated: start page : ''index.html'', ''gallery.html'', if clicked a ''download.html'' page, ''places.html'', ''sources.html'', and ''surname_count.html''.<br />
** CSS files: two style sheet files are generated: ''narrative.css'' and ''narrative-print.css''<br />
<br />
* Customize your CSS files: You can alter and change the made CSS file very easy. The advantage of a style sheet is that changes you do on this text file, you see immediately the effects on the lay-out and color schemes. <br />
<br />
You can customize your style sheet to provide additional formatting and positioning information to control sections.<br />
<br />
{{man tip|Do not forget to check the no style sheet option. Otherwise you will overwrite your custom style sheet.}}<br />
<br />
=== Web Calendar ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=6160Gramps 3.0 Wiki Manual - Reports2008-04-19T20:38:40Z<p>Simanek: /* Report Options */ A copy-editing overall of the 'Report Options' tab instructions</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree ===<br />
[[Image:voorouderpdf.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar ===<br />
<br />
<br />
=== Descendant Tree ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
[[Image:statgraftaart.png|right|thumb|250px|Fig. a.6 Results]]<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph ===<br />
<br />
=== Hourglass Graph ===<br />
<br />
=== Relationship Graph ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report ===<br />
<br />
<br />
<br />
=== Complete Individual Report ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report ===<br />
<br />
=== Family Group Report ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report ===<br />
<br />
=== Marker Report ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site ===<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.1 Individual List Page in Mainz Style]]<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The GRAMPS 3.0 Narrated Web Site report provides improved functionality, support for web standards and additional features. The new report creates pages that closely follow the World Wide Web Consortium&#8217;s Recommendations for XHTML 1.0 Strict and CSS 1. These recommendations include a separation of content from presentation. Due to this practice, the style and appearance of the new web pages can be completely controlled from one CSS stylesheet without altering individual pages.<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as a family history.<br />
<br />
==== Using the Report ====<br />
The Narrated Web Site report provides the user with options that allow a wide range of customization. You can run this report via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrated Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Options''', '''Page Generation''', '''Privacy''' and '''Advanced'''. Each of those tabs are reviewed below. <br />
{{man warn|Entire Database|Be aware that if you select your entire database as a filter a large number of files will be generated (depending on the size of your database). It is recommended to start with a filter (for example: ancestors of a certain person) to simplify the output while you learn about the plugin.}}<br />
<br />
==== Report Options ====<br />
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]<br />
;Store web pages in .tar.gz archive<br />
:The large number of files and directories in this web output may make it difficult to transfer the files to an external web host. GRAMPS has the capability of saving all of your Narrative Web files in one compressed archive using the gzip and tar formats (casually known as a &#8216;tarball&#8217;). This single file can quickly be transferred to your server. Unfortunately not all web servers support saving web files in this way, so contact your hosting provider for more information.<br />
<br />
:The free genealogy site hosting provided by the GRAMPS organization will only accept your files in a compressed archive. Learn more about free genealogy site hosting at http://library.gramps-project.org/<br />
;Destination<br />
:The output of the Narrative Web report is by default saved here {{man label|/yourhomedirectory/NAVWEB}}. This option allows you to save your report output to a destination of your choice.<br />
;Filter<br />
:Like the previous web page generator and other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but custom filters can be made for your specific needs. Learn more about custom filters at http://gramps-project.org/wiki/index.php?title=Filter.<br />
;Filter Person<br />
:This option is inactive if the primary Filter option is set to &#8216;Entire Database&#8217;. Filters are generally subject to how one specific individual relates to other individuals. This option allows you to specify the primary individual. Use the {{man button|Edit}} button to select any individual in your database.<br />
;Web site title<br />
:The default site title value is '''My Family Tree'''. You can enter a custom site title in this option.<br />
;File extension<br />
:The file extension to be used for the web files. Choose between the {{man label|.html}} default value, .htm, .shtml, .php, .php3, or .cgi.<br />
;Copyright<br />
:When creating a public a web site it is important to specify the copyright conditions under which you are publishing your data. International copyright law reserves all rights of your data to your discretion. You own the data and individuals must have your permission if they wish to reuse that data. In genealogical research sharing data with other researchers is a common practice. By default the Narrative Web report uses an '''All Rights Reserved''' copyright. Other options include the Creative Commons licenses, offering a wide range of use restrictions or none at all. Learn more about the Creative Commons at http://creativecommons.org/<br />
;Character set encoding<br />
:GRAMPS is an international application developed with multiple languages and translations in mind. Because of this the default character set for HTML pages is {{man label|UTF-8}}, which supports a wide range of international characters and symbols. From the drop down menu list you can select from a variety of {{man label|ISO-8859-}} encoding sets or even a {{man label|koi8_r}} encoding set. There is support for virtually all popular character set encodings. If you are having problems with character presentation in your web pages it could be a matter of selecting a compatible character set encoding for your web server environment.<br />
[[Image:NWeb-Man-BasicSet.jpg|right|180px|thumb|fig. c.3 Basic Style - 5 Color Choices]]<br />
;Stylesheet<br />
:GRAMPS provides seven built in style sheets for you to choose from to determine the appearance or your web pages. In GRAMPS 3.0 you can choose between '''Basic''' (Ash, Cypress, Lilac, Peach or Spruce color schemes), '''Mainz''', or '''Nebraska''' styles. There is also the option of not including a stylesheet ('''No style sheet'''). Regardless of the style you choose, the style sheet file name is ''narrative.css''. You may edit this file to further customize the appearance of your web pages.<br />
<br />
:If you make modifications to your style sheet be aware that regenerating the your pages with the same output destination will overwrite your custom style sheet. To preserve your custom style sheet through subsequent web page updates select {{man label|No style sheet}}.<br />
<br />
:''figures c.1, c.2 and c.3 are examples of the styles currently included with GRAMPS 3.0''<br />
;Include ancestor graph<br />
:Checking this box will include an ancestor graph on each individual&#8217;s detail page if they have defined ancestors in your database.<br />
;Graph generations<br />
:This option is inactive if the ‘Include ancestor graph’ option is not checked. The default number of generations shown in the ancestor graphs is {{man label|4}} with options of 2, 3, 4 or 5.<br />
<br />
:The individuals represented in the ancestor graphs are the same individuals whose information is provided elsewhere in your web pages.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
<br />
==== Page Generation ====<br />
The Narrated Web report can be set to generate three supplemental pages: Home, Introduction and Publisher Contact pages. From this tab you can activate the pages and assign Media or Notes items to each page. By default no content (media or text) is assigned to these pages. Content for these pages must originate as Media or Notes items. If the desired items have already been added to your database, you can select them by way of the {{man button|Select}} buttons to the right of each listed page or insert point. <br />
;Home Page<br />
:you can add a Note and an Image. The Home page is a page that will display an image and a whatever text you wish. To enable this page, choose a Media Object from the {{man label|Home Media/Note ID}} menu on the {{man label|Page Generation}} tab. If the Media Object contains an image, the image is displayed at the top of the page. If the Media Object contains a Note, the Note's text is used for the text of the page.<br />
;Introduction Page<br />
:you can add a Note and an Image. Just choose the Media Object in the {{man label|Introduction Media/Note ID}} menu.<br />
;Publisher contact Page<br />
:you can add a Note and an Image. Please use this page with caution, since you may consider your contact information to be private.<br />
;HTML user header and user footer<br />
:you can add Notes to have a customized header and footer on each of the generated pages.<br />
;three additional check boxes are available: <br />
** include images and media objects: whether to include/exclude a gallery of media objects.<br />
** include download page: whether to include a database download option.<br />
** Suppress GRAMPS ID: whether to include the GRAMPS ID of objects.<br />
<br />
==== Privacy ====<br />
Privacy of personal information is an important issue on the web today. GRAMPS tries to give you control over the information that is presented.<br />
* check box include records marked private: GRAMPS provides two options to control the privacy of your information. If you do not select the {{man label|Include records marked private}} option, any data that is marked as private will not be displayed on the generated site.<br />
* Living People: The drop down menu let you choose between '''Exclude''', '''Restrict''', and '''Include'''. If you select {{man label|Restrict information on living people}} , GRAMPS will attempt to determine which people have the potential of still being alive, and will omit these people from the database. Some countries have laws that indicate that a certain number of years must pass after someone's death before information can be published.<br />
* Years from death to consider living: in the input field you can give the amount of years to consider. The default value is 30 years. The {{man label|Years to restrict from person's death}} option allows you to specify how many years a person must be deceased before the information is included. Please note that it is your responsibility to double check all information in the pages for any privacy information. GRAMPS cannot be held responsible for any privacy issues.<br />
<br />
==== Advanced ====<br />
[[Image:NWeb-Man-Print.jpg|right|300px|thumb|fig. c.4 The default appearance of pages printed from a Narrative Website web page]]<br />
in this tab page you can determine which columns will show up in your web pages. those options are controlled via check boxes.<br />
* include a link to home person on every page<br />
* include a column for birth dates on the index pages<br />
* include a column for death dates on the index pages<br />
* include a column for partners on the index pages<br />
* include a column for parents on the index pages<br />
* include a column for half-siblings on the index pages<br />
* Organization of the web pages. A lot of files and directories are generated. Default you can find this directory structure under the {{man label|NAVWEB}} directory. <br />
** Directories: Following directories are made: ''images'', ''img'', ''plc'', ''ppl'', ''src'', ''srn'', ''thumb''. Each directory contains many subdirectories: /homedir/NAVWEB/src/1/5/15CF2WIFLGOGFRJMLY.html. This last file is unique. If you regenerate web pages or add records and regenerate your web site those file names remain the same.<br />
** HTML files: if you choose to generate HTML files following files will be generated: start page : ''index.html'', ''gallery.html'', if clicked a ''download.html'' page, ''places.html'', ''sources.html'', and ''surname_count.html''.<br />
** CSS files: two style sheet files are generated: ''narrative.css'' and ''narrative-print.css''<br />
<br />
* Customize your CSS files: You can alter and change the made CSS file very easy. The advantage of a style sheet is that changes you do on this text file, you see immediately the effects on the lay-out and color schemes. <br />
<br />
You can customize your style sheet to provide additional formatting and positioning information to control sections.<br />
<br />
{{man tip|Do not forget to check the no style sheet option. Otherwise you will overwrite your custom style sheet.}}<br />
<br />
=== Web Calendar ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=5946Gramps 3.0 Wiki Manual - Reports2008-04-05T17:08:22Z<p>Simanek: /* Web Pages */ Page Generation text and markup edit</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree ===<br />
[[Image:ancestor.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar ===<br />
<br />
<br />
=== Descendant Tree ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph ===<br />
<br />
=== Hourglass Graph ===<br />
<br />
=== Relationship Graph ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report ===<br />
<br />
<br />
<br />
=== Complete Individual Report ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report ===<br />
<br />
=== Family Group Report ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report ===<br />
<br />
=== Marker Report ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site ===<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.1 Individual List Page in Mainz Style]]<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The GRAMPS 3.0 Narrated Web Site report provides improved functionality, support for web standards and additional features. The new report creates pages that closely follow the World Wide Web Consortium&#8217;s Recommendations for XHTML 1.0 Strict and CSS 1. These recommendations include a separation of content from presentation. Due to this practice, the style and appearance of the new web pages can be completely controlled from one CSS stylesheet without altering individual pages.<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as a family history.<br />
<br />
==== Using the Report ====<br />
The Narrated Web Site report provides the user with options that allow a wide range of customization. You can run this report via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrated Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Options''', '''Page Generation''', '''Privacy''' and '''Advanced'''. Each of those tabs are reviewed below. <br />
{{man warn|Entire Database|Be aware that if you select your entire database as a filter a large number of files will be generated (depending on the size of your database). It is recommended to start with a filter (for example: ancestors of a certain person) to simplify the output while you learn about the plugin.}}<br />
<br />
==== Report Options ====<br />
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]<br />
;Store web pages in .tar.gz archive<br />
:By default, the output files are written to the specified directory. Because of the number of files and directories that are created, it may be difficult to transfer the files to an external web host. To aid in this, you may directly create a gzip'd tar file to more easily upload the data. This is the format that should be used if you would like to take advantage of the free genealogy page hosting at the GRAMPS web hosting site. To select the gzip'd tar file, select the {{man label|Store web pages in .tar.gz archive}} option.<br />
;Destination<br />
:The destination directory for the web files. Default value is the {{man label|/yourhomedirectory/NAVWEB}} directory. Genealogy records can generate a lot of files. Many web servers have a difficult time with many files in a single directory. The Narrated Web report strives to keep the number of files per directory to a manageable level. To do this, a hierarchy of directories is created. The generated files names are not intuitive, but are unique per person. Subsequent runs will generate identical file names, making it easy to replace files.<br />
;Filter<br />
:Like the previous web page generator, and most of the other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but you are free to use the Custom Filter Editor tool to create your own.<br />
;Filter Person<br />
:Filter Person is only available if you did not select the entire database. Use the {{man button|Edit}} button to select a different person.<br />
;Web site title<br />
:In this text field you can change the default value '''My Family Tree'''<br />
;File extension<br />
:The extension to be used for the web files. Choose between the {{man label|.html}} default value, and .htm, .shtml, .php, .php3, and .cgi.<br />
;Copyright<br />
:The copyright to be used for the web files. International copyright law reserves all rights to your data. You own the data, and people must get your permission to use it. In genealogy, however, sharing data is a common ideal. It this case, you may wish to grant the user more rights. While the default for GRAMPS is to place a notice indicating that all rights are reserved, we give you the option to place your site under one of several of the Create Commons licenses. With a Creative Commons license, you grant user's certain permission to use your data without requiring them to contact you directly for permission. See the Creative Commons web site for more information. Choose between the {{man label|Standard Copyright}} default and seven other possibilities varying from Creative Commons -By attribution, Non-commercial to No copyright notice.<br />
;Character set encoding<br />
:The encoding to be used for the web files. Because of GRAMPS internationalization ability, the default character set for the HTML pages is {{man label|UTF-8}}. From the drop down menu list you can select a lot of {{man label|ISO-8859-}} encoding sets and even a {man label|koi8_r}} encoding set.This provides support for virtually all characters. The Apache web server is sometimes misconfigured to override the character set specified in an HTML page. This causes problems with the UTF-8 character set generated by GRAMPS, distorting characters on the screen.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
:If your web server is misconfigured and you do not have privilege to fix the configuration, you may solve this problem by overriding the default character set to match what your web server may be expecting.<br />
[[Image:NWeb-Man-BasicSet.jpg|right|180px|thumb|fig. c.3 Basic Style - 5 Color Choices]]<br />
;Stylesheet<br />
:The style sheet to be used for the web page. GRAMPS provides seven built in style sheets for your web page. Each of these style sheets produces a unique look for your pages. At the moment you can choose between the '''Basic styles''': '''Ash''', '''Cypress''', '''Lilac''', '''Peach''', and '''Spruce''' and the style '''Mainz''' or '''Nebraska'''. Or you can use the '''No style sheet''' option. The generated style sheet is named ''narrative.css''. You may edit this file if you wish to further customize your site.<br />
:''figures c.1, c.2 and c.3 are examples of the styles currently included with GRAMPS 3.0''<br />
:If you make modifications to your style sheet, you need to be aware the regenerating the pages with the same output directory will overwrite your changes to this file. To prevent this from happening, make sure you choose {{man label|No style sheet}} for subsequent runs.<br />
;Include ancestor graph<br />
:whether to include an ancestor graph on each individual page. If you click this box a ancestor graph will be shown. The amount of generations is determined by the next option.<br />
;Graph generations<br />
:the number og generations to include in the ancestor graph. Default value {{man label|4}}. You can choose via the drop down list: 2, 3 4 or 5 generations.<br />
:Any person matching this filter who is not excluded due to the privacy rules, will be included in the output. The default filter includes all people in the database.<br />
<br />
==== Page Generation ====<br />
The Narrated Web report can be set to generate three supplemental pages: Home, Introduction and Publisher Contact pages. From this tab you can activate the pages and assign Media or Notes items to each page. By default no content (media or text) is assigned to these pages. Content for these pages must originate as Media or Notes items. If the desired items have already been added to your database, you can select them by way of the {{man button|Select}} buttons to the right of each listed page or insert point. <br />
;Home Page<br />
:you can add a Note and an Image. The Home page is a page that will display an image and a whatever text you wish. To enable this page, choose a Media Object from the {{man label|Home Media/Note ID}} menu on the {{man label|Page Generation}} tab. If the Media Object contains an image, the image is displayed at the top of the page. If the Media Object contains a Note, the Note's text is used for the text of the page.<br />
;Introduction Page<br />
:you can add a Note and an Image. Just choose the Media Object in the {{man label|Introduction Media/Note ID}} menu.<br />
;Publisher contact Page<br />
:you can add a Note and an Image. Please use this page with caution, since you may consider your contact information to be private.<br />
;HTML user header and user footer<br />
:you can add Notes to have a customized header and footer on each of the generated pages.<br />
;three additional check boxes are available: <br />
** include images and media objects: whether to include/exclude a gallery of media objects.<br />
** include download page: whether to include a database download option.<br />
** Suppress GRAMPS ID: whether to include the GRAMPS ID of objects.<br />
<br />
==== Privacy ====<br />
Privacy of personal information is an important issue on the web today. GRAMPS tries to give you control over the information that is presented.<br />
* check box include records marked private: GRAMPS provides two options to control the privacy of your information. If you do not select the {{man label|Include records marked private}} option, any data that is marked as private will not be displayed on the generated site.<br />
* Living People: The drop down menu let you choose between '''Exclude''', '''Restrict''', and '''Include'''. If you select {{man label|Restrict information on living people}} , GRAMPS will attempt to determine which people have the potential of still being alive, and will omit these people from the database. Some countries have laws that indicate that a certain number of years must pass after someone's death before information can be published.<br />
* Years from death to consider living: in the input field you can give the amount of years to consider. The default value is 30 years. The {{man label|Years to restrict from person's death}} option allows you to specify how many years a person must be deceased before the information is included. Please note that it is your responsibility to double check all information in the pages for any privacy information. GRAMPS cannot be held responsible for any privacy issues.<br />
<br />
==== Advanced ====<br />
[[Image:NWeb-Man-Print.jpg|right|300px|thumb|fig. c.4 The default appearance of pages printed from a Narrative Website web page]]<br />
in this tab page you can determine which columns will show up in your web pages. those options are controlled via check boxes.<br />
* include a link to home person on every page<br />
* include a column for birth dates on the index pages<br />
* include a column for death dates on the index pages<br />
* include a column for partners on the index pages<br />
* include a column for parents on the index pages<br />
* include a column for half-siblings on the index pages<br />
* Organization of the web pages. A lot of files and directories are generated. Default you can find this directory structure under the {{man label|NAVWEB}} directory. <br />
** Directories: Following directories are made: ''images'', ''img'', ''plc'', ''ppl'', ''src'', ''srn'', ''thumb''. Each directory contains many subdirectories: /homedir/NAVWEB/src/1/5/15CF2WIFLGOGFRJMLY.html. This last file is unique. If you regenerate web pages or add records and regenerate your web site those file names remain the same.<br />
** HTML files: if you choose to generate HTML files following files will be generated: start page : ''index.html'', ''gallery.html'', if clicked a ''download.html'' page, ''places.html'', ''sources.html'', and ''surname_count.html''.<br />
** CSS files: two style sheet files are generated: ''narrative.css'' and ''narrative-print.css''<br />
<br />
* Customize your CSS files: You can alter and change the made CSS file very easy. The advantage of a style sheet is that changes you do on this text file, you see immediately the effects on the lay-out and color schemes. <br />
<br />
You can customize your style sheet to provide additional formatting and positioning information to control sections.<br />
<br />
{{man tip|Do not forget to check the no style sheet option. Otherwise you will overwrite your custom style sheet.}}<br />
<br />
=== Web Calendar ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=5945Gramps 3.0 Wiki Manual - Reports2008-04-05T16:50:40Z<p>Simanek: /* Narrated Web Site */ copy changes, markup changes for 'Report Options'</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree ===<br />
[[Image:ancestor.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar ===<br />
<br />
<br />
=== Descendant Tree ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph ===<br />
<br />
=== Hourglass Graph ===<br />
<br />
=== Relationship Graph ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report ===<br />
<br />
<br />
<br />
=== Complete Individual Report ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report ===<br />
<br />
=== Family Group Report ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report ===<br />
<br />
=== Marker Report ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site ===<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.1 Individual List Page in Mainz Style]]<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The GRAMPS 3.0 Narrative Web Site report provides improved functionality, support for web standards and additional features. The new report creates pages that closely follow the World Wide Web Consortium&#8217;s Recommendations for XHTML 1.0 Strict and CSS 1. These recommendations include a separation of content from presentation. Due to this practice, the style and appearance of the new web pages can be completely controlled from one CSS stylesheet without altering individual pages.<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as a family history.<br />
<br />
==== Using the Report ====<br />
The Narrative Web Site report provides the user with options that allow a wide range of customization. You can run this report via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrative Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Options''', '''Page Generation''', '''Privacy''' and '''Advanced'''. Each of those tabs are reviewed below. <br />
{{man warn|Entire Database|Be aware that if you select your entire database as a filter a large number of files will be generated (depending on the size of your database). It is recommended to start with a filter (for example: ancestors of a certain person) to simplify the output while you learn about the plugin.}}<br />
<br />
==== Report Options ====<br />
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]<br />
;Store web pages in .tar.gz archive<br />
:By default, the output files are written to the specified directory. Because of the number of files and directories that are created, it may be difficult to transfer the files to an external web host. To aid in this, you may directly create a gzip'd tar file to more easily upload the data. This is the format that should be used if you would like to take advantage of the free genealogy page hosting at the GRAMPS web hosting site. To select the gzip'd tar file, select the {{man label|Store web pages in .tar.gz archive}} option.<br />
;Destination<br />
:The destination directory for the web files. Default value is the {{man label|/yourhomedirectory/NAVWEB}} directory. Genealogy records can generate a lot of files. Many web servers have a difficult time with many files in a single directory. The Narrative Web Generator strives to keep the number of files per directory to a manageable level. To do this, a hierarchy of directories is created. The generated files names are not intuitive, but are unique per person. Subsequent runs will generate identical file names, making it easy to replace files.<br />
;Filter<br />
:Like the previous web page generator, and most of the other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but you are free to use the Custom Filter Editor tool to create your own.<br />
;Filter Person<br />
:Filter Person is only available if you did not select the entire database. Use the {{man button|Edit}} button to select a different person.<br />
;Web site title<br />
:In this text field you can change the default value '''My Family Tree'''<br />
;File extension<br />
:The extension to be used for the web files. Choose between the {{man label|.html}} default value, and .htm, .shtml, .php, .php3, and .cgi.<br />
;Copyright<br />
:The copyright to be used for the web files. International copyright law reserves all rights to your data. You own the data, and people must get your permission to use it. In genealogy, however, sharing data is a common ideal. It this case, you may wish to grant the user more rights. While the default for GRAMPS is to place a notice indicating that all rights are reserved, we give you the option to place your site under one of several of the Create Commons licenses. With a Creative Commons license, you grant user's certain permission to use your data without requiring them to contact you directly for permission. See the Creative Commons web site for more information. Choose between the {{man label|Standard Copyright}} default and seven other possibilities varying from Creative Commons -By attribution, Non-commercial to No copyright notice.<br />
;Character set encoding<br />
:The encoding to be used for the web files. Because of GRAMPS internationalization ability, the default character set for the HTML pages is {{man label|UTF-8}}. From the drop down menu list you can select a lot of {{man label|ISO-8859-}} encoding sets and even a {man label|koi8_r}} encoding set.This provides support for virtually all characters. The Apache web server is sometimes misconfigured to override the character set specified in an HTML page. This causes problems with the UTF-8 character set generated by GRAMPS, distorting characters on the screen.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
:If your web server is misconfigured and you do not have privilege to fix the configuration, you may solve this problem by overriding the default character set to match what your web server may be expecting.<br />
[[Image:NWeb-Man-BasicSet.jpg|right|180px|thumb|fig. c.3 Basic Style - 5 Color Choices]]<br />
;Stylesheet<br />
:The style sheet to be used for the web page. GRAMPS provides seven built in style sheets for your web page. Each of these style sheets produces a unique look for your pages. At the moment you can choose between the '''Basic styles''': '''Ash''', '''Cypress''', '''Lilac''', '''Peach''', and '''Spruce''' and the style '''Mainz''' or '''Nebraska'''. Or you can use the '''No style sheet''' option. The generated style sheet is named ''narrative.css''. You may edit this file if you wish to further customize your site.<br />
:''figures c.1, c.2 and c.3 are examples of the styles currently included with GRAMPS 3.0''<br />
:If you make modifications to your style sheet, you need to be aware the regenerating the pages with the same output directory will overwrite your changes to this file. To prevent this from happening, make sure you choose {{man label|No style sheet}} for subsequent runs.<br />
;Include ancestor graph<br />
:whether to include an ancestor graph on each individual page. If you click this box a ancestor graph will be shown. The amount of generations is determined by the next option.<br />
;Graph generations<br />
:the number og generations to include in the ancestor graph. Default value {{man label|4}}. You can choose via the drop down list: 2, 3 4 or 5 generations.<br />
:Any person matching this filter who is not excluded due to the privacy rules, will be included in the output. The default filter includes all people in the database.<br />
<br />
==== Page Generation ====<br />
Here you can generate three additional pages by the web page generator. Initially, for all additional pages no note nor image is given. So must first make some media objects or notes. If those objects or notes exist, you can select those needed with the {{man button|Select}} buttons on the very right hand side off the screen. <br />
* Home Page: you can add a Note and an Image. The Home page is a page that will display an image and a whatever text you wish. To enable this page, choose a Media Object from the {{man label|Home Media/Note ID}} menu on the {{man label|Page Generation}} tab. If the Media Object contains an image, the image is displayed at the top of the page. If the Media Object contains a Note, the Note's text is used for the text of the page.<br />
* Introduction Page: you can add a Note and an Image. Just choose the Media Object in the {{man label|Introduction Media/Note ID}} menu.<br />
* Publisher contact Page : you can add a Note and an Image. Please use this page with caution, since you may consider your contact information to be private.<br />
* HTML user header and user footer: you can add Notes to have a customized header and footer on each of the generated pages.<br />
* three additional check boxes are available: <br />
** include images and media objects: whether to include/exclude a gallery of media objects.<br />
** include download page: whether to include a database download option.<br />
** Suppress GRAMPS ID: whether to include the GRAMPS ID of objects.<br />
<br />
==== Privacy ====<br />
Privacy of personal information is an important issue on the web today. GRAMPS tries to give you control over the information that is presented.<br />
* check box include records marked private: GRAMPS provides two options to control the privacy of your information. If you do not select the {{man label|Include records marked private}} option, any data that is marked as private will not be displayed on the generated site.<br />
* Living People: The drop down menu let you choose between '''Exclude''', '''Restrict''', and '''Include'''. If you select {{man label|Restrict information on living people}} , GRAMPS will attempt to determine which people have the potential of still being alive, and will omit these people from the database. Some countries have laws that indicate that a certain number of years must pass after someone's death before information can be published.<br />
* Years from death to consider living: in the input field you can give the amount of years to consider. The default value is 30 years. The {{man label|Years to restrict from person's death}} option allows you to specify how many years a person must be deceased before the information is included. Please note that it is your responsibility to double check all information in the pages for any privacy information. GRAMPS cannot be held responsible for any privacy issues.<br />
<br />
==== Advanced ====<br />
[[Image:NWeb-Man-Print.jpg|right|300px|thumb|fig. c.4 The default appearance of pages printed from a Narrative Website web page]]<br />
in this tab page you can determine which columns will show up in your web pages. those options are controlled via check boxes.<br />
* include a link to home person on every page<br />
* include a column for birth dates on the index pages<br />
* include a column for death dates on the index pages<br />
* include a column for partners on the index pages<br />
* include a column for parents on the index pages<br />
* include a column for half-siblings on the index pages<br />
* Organization of the web pages. A lot of files and directories are generated. Default you can find this directory structure under the {{man label|NAVWEB}} directory. <br />
** Directories: Following directories are made: ''images'', ''img'', ''plc'', ''ppl'', ''src'', ''srn'', ''thumb''. Each directory contains many subdirectories: /homedir/NAVWEB/src/1/5/15CF2WIFLGOGFRJMLY.html. This last file is unique. If you regenerate web pages or add records and regenerate your web site those file names remain the same.<br />
** HTML files: if you choose to generate HTML files following files will be generated: start page : ''index.html'', ''gallery.html'', if clicked a ''download.html'' page, ''places.html'', ''sources.html'', and ''surname_count.html''.<br />
** CSS files: two style sheet files are generated: ''narrative.css'' and ''narrative-print.css''<br />
<br />
* Customize your CSS files: You can alter and change the made CSS file very easy. The advantage of a style sheet is that changes you do on this text file, you see immediately the effects on the lay-out and color schemes. <br />
<br />
You can customize your style sheet to provide additional formatting and positioning information to control sections.<br />
<br />
{{man tip|Do not forget to check the no style sheet option. Otherwise you will overwrite your custom style sheet.}}<br />
<br />
=== Web Calendar ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=5902Gramps 3.0 Wiki Manual - Reports2008-04-03T01:26:21Z<p>Simanek: /* Advanced */ printed page image caption update</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree... ===<br />
[[Image:ancestor.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar... ===<br />
<br />
<br />
=== Descendant Tree... ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart... ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart... ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart... ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph... ===<br />
<br />
=== Hourglass Graph... ===<br />
<br />
=== Relationship Graph... ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report... ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report... ===<br />
<br />
<br />
<br />
=== Complete Individual Report... ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report... ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report... ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report... ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report... ===<br />
<br />
=== Family Group Report... ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report... ===<br />
<br />
=== Marker Report... ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related... ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors... ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database... ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site... ===<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.1 Individual List Page in Mainz Style]]<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The new Narrative Web Site report provides improved functionality, support for web standards and additional features. Instead of using HTML templates to customize the pages, CSS style sheets are used.<br />
<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as family history.<br />
<br />
This report provides the user with a large number of options to allow for a wide range of customization. You can run this report view via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrative Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Option''', '''Page Generation''','''Privacy''', and '''Advanced'''. Let's have a look on all those options. <br />
{{man warn|Entire Database|If you select as a filter your entire database, you must be aware that depending on the size of your database, the amount of web files that are generated can be huge. May be a better approach is to start with a filter (say ancestors of a certain person) so you can start to find out what the generated output is.}}<br />
<br />
==== Report options ====<br />
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]<br />
* check box archive: By default, the output files are written to the specified directory. Because of the number of files and directories that are created, it may be difficult to transfer the files to an external web host. To aid in this, you may directly create a gzip'd tar file to more easily upload the data. This is the format that should be used if you would like to take advantage of the free genealogy page hosting at the GRAMPS web hosting site. To select the gzip'd tar file, select the {{man label|Store web pages in .tar.gz archive}} option.<br />
* Destination: the destination directory for the web files. Default value is the {{man label|/yourhomedirectory/NAVWEB}} directory. Genealogy records can generate a lot of files. Many web servers have a difficult time with many files in a single directory. The Narrative Web Generator strives to keep the number of files per directory to a manageable level. To do this, a hierarchy of directories is created. The generated files names are not intuitive, but are unique per person. Subsequent runs will generate identical file names, making it easy to replace files.<br />
* Filter: Like the previous web page generator, and most of the other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but you are free to use the Custom Filter Editor tool to create your own.<br />
* Filter Person: becomes available only if you did not select the entire database. Use the {{man button|Edit}} button to select a different person.<br />
* Web site title: in this text field you can change the default value '''My Family Tree'''<br />
* File extension: the extension to be used for the web files. Choose between the {{man label|.html}} default value, and .htm, .shtml, .php, .php3, and .cgi. <br />
* Copyright: The copyright to be used for the web files. International copyright law reserves all rights to your data. You own the data, and people must get your permission to use it. In genealogy, however, sharing data is a common ideal. It this case, you may wish to grant the user more rights. While the default for GRAMPS is to place a notice indicating that all rights are reserved, we give you the option to place your site under one of several of the Create Commons licenses. With a Creative Commons license, you grant user's certain permission to use your data without requiring them to contact you directly for permission. See the Creative Commons web site for more information. Choose between the {{man label|Standard Copyright}} default and seven other possibilities varying from Creative Commons -By attribution, Non-commercial to No copyright notice.<br />
* Character set encoding: The encoding to be used for the web files. Because of GRAMPS internationalization ability, the default character set for the HTML pages is {{man label|UTF-8}}. From the drop down menu list you can select a lot of {{man label|ISO-8859-}} encoding sets and even a {man label|koi8_r}} encoding set.This provides support for virtually all characters. The Apache web server is sometimes misconfigured to override the character set specified in an HTML page. This causes problems with the UTF-8 character set generated by GRAMPS, distorting characters on the screen.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
If your web server is misconfigured and you do not have privilege to fix the configuration, you may solve this problem by overriding the default character set to match what your web server may be expecting.<br />
<br />
[[Image:NWeb-Man-BasicSet.jpg|right|180px|thumb|fig. c.3 Basic Style - 5 Color Choices]]<br />
==== Stylesheet ====<br />
The style sheet to be used for the web page. GRAMPS provides seven built in style sheets for your web page. Each of these style sheets produces a unique look for your pages. At the moment you can choose between the '''Basic styles''': '''Ash''', '''Cypress''', '''Lilac''', '''Peach''', and '''Spruce''' and the style '''Mainz''' or '''Nebraska'''. Or you can use the '''No style sheet''' option. The generated style sheet is named ''narrative.css''. You may edit this file if you wish to further customize your site.<br />
<br />
To give an impression on the available color schemes, images are included for the different styles and pages.<br />
If you make modifications to your style sheet, you need to be aware the regenerating the pages with the same output directory will overwrite your changes to this file. To prevent this from happening, make sure you choose {{man label|No style sheet}} for subsequent runs.<br />
* check box: Include ancestor graph: whether to include an ancestor graph on each individual page. If you click this box a ancestor graph will be shown. The amount of generations is determined by the next option.<br />
* Graph generations: the number og generations to include in the ancestor graph. Default value {{man label|4}}. You can choose via the drop down list: 2, 3 4 or 5 generations.<br />
<br />
Any person matching this filter who is not excluded due to the privacy rules, will be included in the output. The default filter includes all people in the database.<br />
<br />
==== Page Generation ====<br />
Here you can generate three additional pages by the web page generator. Initially, for all additional pages no note nor image is given. So must first make some media objects or notes. If those objects or notes exist, you can select those needed with the {{man button|Select}} buttons on the very right hand side off the screen. <br />
* Home Page: you can add a Note and an Image. The Home page is a page that will display an image and a whatever text you wish. To enable this page, choose a Media Object from the {{man label|Home Media/Note ID}} menu on the {{man label|Page Generation}} tab. If the Media Object contains an image, the image is displayed at the top of the page. If the Media Object contains a Note, the Note's text is used for the text of the page.<br />
* Introduction Page: you can add a Note and an Image. Just choose the Media Object in the {{man label|Introduction Media/Note ID}} menu.<br />
* Publisher contact Page : you can add a Note and an Image. Please use this page with caution, since you may consider your contact information to be private.<br />
* HTML user header and user footer: you can add Notes to have a customized header and footer on each of the generated pages.<br />
* three additional check boxes are available: <br />
** include images and media objects: whether to include/exclude a gallery of media objects.<br />
** include download page: whether to include a database download option.<br />
** Suppress GRAMPS ID: whether to include the GRAMPS ID of objects.<br />
<br />
==== Privacy ====<br />
Privacy of personal information is an important issue on the web today. GRAMPS tries to give you control over the information that is presented.<br />
* check box include records marked private: GRAMPS provides two options to control the privacy of your information. If you do not select the {{man label|Include records marked private}} option, any data that is marked as private will not be displayed on the generated site.<br />
* Living People: The drop down menu let you choose between '''Exclude''', '''Restrict''', and '''Include'''. If you select {{man label|Restrict information on living people}} , GRAMPS will attempt to determine which people have the potential of still being alive, and will omit these people from the database. Some countries have laws that indicate that a certain number of years must pass after someone's death before information can be published.<br />
* Years from death to consider living: in the input field you can give the amount of years to consider. The default value is 30 years. The {{man label|Years to restrict from person's death}} option allows you to specify how many years a person must be deceased before the information is included. Please note that it is your responsibility to double check all information in the pages for any privacy information. GRAMPS cannot be held responsible for any privacy issues.<br />
<br />
==== Advanced ====<br />
[[Image:NWeb-Man-Print.jpg|right|300px|thumb|fig. c.4 The default appearance of pages printed from a Narrative Website web page]]<br />
in this tab page you can determine which columns will show up in your web pages. those options are controlled via check boxes.<br />
* include a link to home person on every page<br />
* include a column for birth dates on the index pages<br />
* include a column for death dates on the index pages<br />
* include a column for partners on the index pages<br />
* include a column for parents on the index pages<br />
* include a column for half-siblings on the index pages<br />
* Organization of the web pages. A lot of files and directories are generated. Default you can find this directory structure under the {{man label|NAVWEB}} directory. <br />
** Directories: Following directories are made: ''images'', ''img'', ''plc'', ''ppl'', ''src'', ''srn'', ''thumb''. Each directory contains many subdirectories: /homedir/NAVWEB/src/1/5/15CF2WIFLGOGFRJMLY.html. This last file is unique. If you regenerate web pages or add records and regenerate your web site those file names remain the same.<br />
** HTML files: if you choose to generate HTML files following files will be generated: start page : ''index.html'', ''gallery.html'', if clicked a ''download.html'' page, ''places.html'', ''sources.html'', and ''surname_count.html''.<br />
** CSS files: two style sheet files are generated: ''narrative.css'' and ''narrative-print.css''<br />
<br />
* Customize your CSS files: You can alter and change the made CSS file very easy. The advantage of a style sheet is that changes you do on this text file, you see immediately the effects on the lay-out and color schemes. <br />
<br />
You can customize your style sheet to provide additional formatting and positioning information to control sections.<br />
<br />
{{man tip|Do not forget to check the no style sheet option. Otherwise you will overwrite your custom style sheet.}}<br />
<br />
=== Web Calendar... ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=5901Gramps 3.0 Wiki Manual - Reports2008-04-03T01:23:29Z<p>Simanek: /* Web Pages */ Additional example image of default print style output</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree... ===<br />
[[Image:ancestor.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar... ===<br />
<br />
<br />
=== Descendant Tree... ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart... ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart... ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart... ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph... ===<br />
<br />
=== Hourglass Graph... ===<br />
<br />
=== Relationship Graph... ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report... ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report... ===<br />
<br />
<br />
<br />
=== Complete Individual Report... ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report... ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report... ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report... ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report... ===<br />
<br />
=== Family Group Report... ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report... ===<br />
<br />
=== Marker Report... ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related... ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors... ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database... ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site... ===<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.1 Individual List Page in Mainz Style]]<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The new Narrative Web Site report provides improved functionality, support for web standards and additional features. Instead of using HTML templates to customize the pages, CSS style sheets are used.<br />
<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as family history.<br />
<br />
This report provides the user with a large number of options to allow for a wide range of customization. You can run this report view via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrative Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Option''', '''Page Generation''','''Privacy''', and '''Advanced'''. Let's have a look on all those options. <br />
{{man warn|Entire Database|If you select as a filter your entire database, you must be aware that depending on the size of your database, the amount of web files that are generated can be huge. May be a better approach is to start with a filter (say ancestors of a certain person) so you can start to find out what the generated output is.}}<br />
<br />
==== Report options ====<br />
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]<br />
* check box archive: By default, the output files are written to the specified directory. Because of the number of files and directories that are created, it may be difficult to transfer the files to an external web host. To aid in this, you may directly create a gzip'd tar file to more easily upload the data. This is the format that should be used if you would like to take advantage of the free genealogy page hosting at the GRAMPS web hosting site. To select the gzip'd tar file, select the {{man label|Store web pages in .tar.gz archive}} option.<br />
* Destination: the destination directory for the web files. Default value is the {{man label|/yourhomedirectory/NAVWEB}} directory. Genealogy records can generate a lot of files. Many web servers have a difficult time with many files in a single directory. The Narrative Web Generator strives to keep the number of files per directory to a manageable level. To do this, a hierarchy of directories is created. The generated files names are not intuitive, but are unique per person. Subsequent runs will generate identical file names, making it easy to replace files.<br />
* Filter: Like the previous web page generator, and most of the other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but you are free to use the Custom Filter Editor tool to create your own.<br />
* Filter Person: becomes available only if you did not select the entire database. Use the {{man button|Edit}} button to select a different person.<br />
* Web site title: in this text field you can change the default value '''My Family Tree'''<br />
* File extension: the extension to be used for the web files. Choose between the {{man label|.html}} default value, and .htm, .shtml, .php, .php3, and .cgi. <br />
* Copyright: The copyright to be used for the web files. International copyright law reserves all rights to your data. You own the data, and people must get your permission to use it. In genealogy, however, sharing data is a common ideal. It this case, you may wish to grant the user more rights. While the default for GRAMPS is to place a notice indicating that all rights are reserved, we give you the option to place your site under one of several of the Create Commons licenses. With a Creative Commons license, you grant user's certain permission to use your data without requiring them to contact you directly for permission. See the Creative Commons web site for more information. Choose between the {{man label|Standard Copyright}} default and seven other possibilities varying from Creative Commons -By attribution, Non-commercial to No copyright notice.<br />
* Character set encoding: The encoding to be used for the web files. Because of GRAMPS internationalization ability, the default character set for the HTML pages is {{man label|UTF-8}}. From the drop down menu list you can select a lot of {{man label|ISO-8859-}} encoding sets and even a {man label|koi8_r}} encoding set.This provides support for virtually all characters. The Apache web server is sometimes misconfigured to override the character set specified in an HTML page. This causes problems with the UTF-8 character set generated by GRAMPS, distorting characters on the screen.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
If your web server is misconfigured and you do not have privilege to fix the configuration, you may solve this problem by overriding the default character set to match what your web server may be expecting.<br />
<br />
[[Image:NWeb-Man-BasicSet.jpg|right|180px|thumb|fig. c.3 Basic Style - 5 Color Choices]]<br />
==== Stylesheet ====<br />
The style sheet to be used for the web page. GRAMPS provides seven built in style sheets for your web page. Each of these style sheets produces a unique look for your pages. At the moment you can choose between the '''Basic styles''': '''Ash''', '''Cypress''', '''Lilac''', '''Peach''', and '''Spruce''' and the style '''Mainz''' or '''Nebraska'''. Or you can use the '''No style sheet''' option. The generated style sheet is named ''narrative.css''. You may edit this file if you wish to further customize your site.<br />
<br />
To give an impression on the available color schemes, images are included for the different styles and pages.<br />
If you make modifications to your style sheet, you need to be aware the regenerating the pages with the same output directory will overwrite your changes to this file. To prevent this from happening, make sure you choose {{man label|No style sheet}} for subsequent runs.<br />
* check box: Include ancestor graph: whether to include an ancestor graph on each individual page. If you click this box a ancestor graph will be shown. The amount of generations is determined by the next option.<br />
* Graph generations: the number og generations to include in the ancestor graph. Default value {{man label|4}}. You can choose via the drop down list: 2, 3 4 or 5 generations.<br />
<br />
Any person matching this filter who is not excluded due to the privacy rules, will be included in the output. The default filter includes all people in the database.<br />
<br />
==== Page Generation ====<br />
Here you can generate three additional pages by the web page generator. Initially, for all additional pages no note nor image is given. So must first make some media objects or notes. If those objects or notes exist, you can select those needed with the {{man button|Select}} buttons on the very right hand side off the screen. <br />
* Home Page: you can add a Note and an Image. The Home page is a page that will display an image and a whatever text you wish. To enable this page, choose a Media Object from the {{man label|Home Media/Note ID}} menu on the {{man label|Page Generation}} tab. If the Media Object contains an image, the image is displayed at the top of the page. If the Media Object contains a Note, the Note's text is used for the text of the page.<br />
* Introduction Page: you can add a Note and an Image. Just choose the Media Object in the {{man label|Introduction Media/Note ID}} menu.<br />
* Publisher contact Page : you can add a Note and an Image. Please use this page with caution, since you may consider your contact information to be private.<br />
* HTML user header and user footer: you can add Notes to have a customized header and footer on each of the generated pages.<br />
* three additional check boxes are available: <br />
** include images and media objects: whether to include/exclude a gallery of media objects.<br />
** include download page: whether to include a database download option.<br />
** Suppress GRAMPS ID: whether to include the GRAMPS ID of objects.<br />
<br />
==== Privacy ====<br />
Privacy of personal information is an important issue on the web today. GRAMPS tries to give you control over the information that is presented.<br />
* check box include records marked private: GRAMPS provides two options to control the privacy of your information. If you do not select the {{man label|Include records marked private}} option, any data that is marked as private will not be displayed on the generated site.<br />
* Living People: The drop down menu let you choose between '''Exclude''', '''Restrict''', and '''Include'''. If you select {{man label|Restrict information on living people}} , GRAMPS will attempt to determine which people have the potential of still being alive, and will omit these people from the database. Some countries have laws that indicate that a certain number of years must pass after someone's death before information can be published.<br />
* Years from death to consider living: in the input field you can give the amount of years to consider. The default value is 30 years. The {{man label|Years to restrict from person's death}} option allows you to specify how many years a person must be deceased before the information is included. Please note that it is your responsibility to double check all information in the pages for any privacy information. GRAMPS cannot be held responsible for any privacy issues.<br />
<br />
==== Advanced ====<br />
[[Image:NWeb-Man-Print.jpg|right|300px|thumb|fig. c.4 The Appearance of Pages Printed from a Narrative Web Report website]]<br />
in this tab page you can determine which columns will show up in your web pages. those options are controlled via check boxes.<br />
* include a link to home person on every page<br />
* include a column for birth dates on the index pages<br />
* include a column for death dates on the index pages<br />
* include a column for partners on the index pages<br />
* include a column for parents on the index pages<br />
* include a column for half-siblings on the index pages<br />
* Organization of the web pages. A lot of files and directories are generated. Default you can find this directory structure under the {{man label|NAVWEB}} directory. <br />
** Directories: Following directories are made: ''images'', ''img'', ''plc'', ''ppl'', ''src'', ''srn'', ''thumb''. Each directory contains many subdirectories: /homedir/NAVWEB/src/1/5/15CF2WIFLGOGFRJMLY.html. This last file is unique. If you regenerate web pages or add records and regenerate your web site those file names remain the same.<br />
** HTML files: if you choose to generate HTML files following files will be generated: start page : ''index.html'', ''gallery.html'', if clicked a ''download.html'' page, ''places.html'', ''sources.html'', and ''surname_count.html''.<br />
** CSS files: two style sheet files are generated: ''narrative.css'' and ''narrative-print.css''<br />
<br />
* Customize your CSS files: You can alter and change the made CSS file very easy. The advantage of a style sheet is that changes you do on this text file, you see immediately the effects on the lay-out and color schemes. <br />
<br />
You can customize your style sheet to provide additional formatting and positioning information to control sections.<br />
<br />
{{man tip|Do not forget to check the no style sheet option. Otherwise you will overwrite your custom style sheet.}}<br />
<br />
=== Web Calendar... ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=File:NWeb-Man-Print.jpg&diff=5900File:NWeb-Man-Print.jpg2008-04-03T01:08:58Z<p>Simanek: Example of print style output pages</p>
<hr />
<div>Example of print style output pages</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=5899Gramps 3.0 Wiki Manual - Reports2008-04-03T01:02:09Z<p>Simanek: /* Web Pages */ minor changes to page's list structure</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree... ===<br />
[[Image:ancestor.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar... ===<br />
<br />
<br />
=== Descendant Tree... ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart... ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart... ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart... ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph... ===<br />
<br />
=== Hourglass Graph... ===<br />
<br />
=== Relationship Graph... ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report... ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report... ===<br />
<br />
<br />
<br />
=== Complete Individual Report... ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report... ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report... ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report... ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report... ===<br />
<br />
=== Family Group Report... ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report... ===<br />
<br />
=== Marker Report... ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related... ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors... ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database... ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site... ===<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.1 Individual List Page in Mainz Style]]<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The new Narrative Web Site report provides improved functionality, support for web standards and additional features. Instead of using HTML templates to customize the pages, CSS style sheets are used.<br />
<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as family history.<br />
<br />
This report provides the user with a large number of options to allow for a wide range of customization. You can run this report view via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrative Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Option''', '''Page Generation''','''Privacy''', and '''Advanced'''. Let's have a look on all those options. <br />
{{man warn|Entire Database|If you select as a filter your entire database, you must be aware that depending on the size of your database, the amount of web files that are generated can be huge. May be a better approach is to start with a filter (say ancestors of a certain person) so you can start to find out what the generated output is.}}<br />
<br />
==== Report options ====<br />
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]<br />
* check box archive: By default, the output files are written to the specified directory. Because of the number of files and directories that are created, it may be difficult to transfer the files to an external web host. To aid in this, you may directly create a gzip'd tar file to more easily upload the data. This is the format that should be used if you would like to take advantage of the free genealogy page hosting at the GRAMPS web hosting site. To select the gzip'd tar file, select the {{man label|Store web pages in .tar.gz archive}} option.<br />
* Destination: the destination directory for the web files. Default value is the {{man label|/yourhomedirectory/NAVWEB}} directory. Genealogy records can generate a lot of files. Many web servers have a difficult time with many files in a single directory. The Narrative Web Generator strives to keep the number of files per directory to a manageable level. To do this, a hierarchy of directories is created. The generated files names are not intuitive, but are unique per person. Subsequent runs will generate identical file names, making it easy to replace files.<br />
* Filter: Like the previous web page generator, and most of the other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but you are free to use the Custom Filter Editor tool to create your own.<br />
* Filter Person: becomes available only if you did not select the entire database. Use the {{man button|Edit}} button to select a different person.<br />
* Web site title: in this text field you can change the default value '''My Family Tree'''<br />
* File extension: the extension to be used for the web files. Choose between the {{man label|.html}} default value, and .htm, .shtml, .php, .php3, and .cgi. <br />
* Copyright: The copyright to be used for the web files. International copyright law reserves all rights to your data. You own the data, and people must get your permission to use it. In genealogy, however, sharing data is a common ideal. It this case, you may wish to grant the user more rights. While the default for GRAMPS is to place a notice indicating that all rights are reserved, we give you the option to place your site under one of several of the Create Commons licenses. With a Creative Commons license, you grant user's certain permission to use your data without requiring them to contact you directly for permission. See the Creative Commons web site for more information. Choose between the {{man label|Standard Copyright}} default and seven other possibilities varying from Creative Commons -By attribution, Non-commercial to No copyright notice.<br />
* Character set encoding: The encoding to be used for the web files. Because of GRAMPS internationalization ability, the default character set for the HTML pages is {{man label|UTF-8}}. From the drop down menu list you can select a lot of {{man label|ISO-8859-}} encoding sets and even a {man label|koi8_r}} encoding set.This provides support for virtually all characters. The Apache web server is sometimes misconfigured to override the character set specified in an HTML page. This causes problems with the UTF-8 character set generated by GRAMPS, distorting characters on the screen.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
If your web server is misconfigured and you do not have privilege to fix the configuration, you may solve this problem by overriding the default character set to match what your web server may be expecting.<br />
<br />
==== Stylesheet ====<br />
[[Image:NWeb-Man-BasicSet.jpg|right|200px|thumb|fig. c.3 Basic Style - 5 Color Choices]]<br />
The style sheet to be used for the web page. GRAMPS provides seven built in style sheets for your web page. Each of these style sheets produces a unique look for your pages. At the moment you can choose between the '''Basic styles''': '''Ash''', '''Cypress''', '''Lilac''', '''Peach''', and '''Spruce''' and the style '''Mainz''' or '''Nebraska'''. Or you can use the '''No style sheet''' option. The generated style sheet is named ''narrative.css''. You may edit this file if you wish to further customize your site.<br />
<br />
To give an impression on the available color schemes, images are included for the different styles and pages.<br />
If you make modifications to your style sheet, you need to be aware the regenerating the pages with the same output directory will overwrite your changes to this file. To prevent this from happening, make sure you choose {{man label|No style sheet}} for subsequent runs.<br />
* check box: Include ancestor graph: whether to include an ancestor graph on each individual page. If you click this box a ancestor graph will be shown. The amount of generations is determined by the next option.<br />
* Graph generations: the number og generations to include in the ancestor graph. Default value {{man label|4}}. You can choose via the drop down list: 2, 3 4 or 5 generations.<br />
<br />
Any person matching this filter who is not excluded due to the privacy rules, will be included in the output. The default filter includes all people in the database.<br />
<br />
==== Page Generation ====<br />
Here you can generate three additional pages by the web page generator. Initially, for all additional pages no note nor image is given. So must first make some media objects or notes. If those objects or notes exist, you can select those needed with the {{man button|Select}} buttons on the very right hand side off the screen. <br />
* Home Page: you can add a Note and an Image. The Home page is a page that will display an image and a whatever text you wish. To enable this page, choose a Media Object from the {{man label|Home Media/Note ID}} menu on the {{man label|Page Generation}} tab. If the Media Object contains an image, the image is displayed at the top of the page. If the Media Object contains a Note, the Note's text is used for the text of the page.<br />
* Introduction Page: you can add a Note and an Image. Just choose the Media Object in the {{man label|Introduction Media/Note ID}} menu.<br />
* Publisher contact Page : you can add a Note and an Image. Please use this page with caution, since you may consider your contact information to be private.<br />
* HTML user header and user footer: you can add Notes to have a customized header and footer on each of the generated pages.<br />
* three additional check boxes are available: <br />
** include images and media objects: whether to include/exclude a gallery of media objects.<br />
** include download page: whether to include a database download option.<br />
** Suppress GRAMPS ID: whether to include the GRAMPS ID of objects.<br />
<br />
==== Privacy ====<br />
Privacy of personal information is an important issue on the web today. GRAMPS tries to give you control over the information that is presented.<br />
* check box include records marked private: GRAMPS provides two options to control the privacy of your information. If you do not select the {{man label|Include records marked private}} option, any data that is marked as private will not be displayed on the generated site.<br />
* Living People: The drop down menu let you choose between '''Exclude''', '''Restrict''', and '''Include'''. If you select {{man label|Restrict information on living people}} , GRAMPS will attempt to determine which people have the potential of still being alive, and will omit these people from the database. Some countries have laws that indicate that a certain number of years must pass after someone's death before information can be published.<br />
* Years from death to consider living: in the input field you can give the amount of years to consider. The default value is 30 years. The {{man label|Years to restrict from person's death}} option allows you to specify how many years a person must be deceased before the information is included. Please note that it is your responsibility to double check all information in the pages for any privacy information. GRAMPS cannot be held responsible for any privacy issues.<br />
<br />
==== Advanced ====<br />
in this tab page you can determine which columns will show up in your web pages. those options are controlled via check boxes.<br />
* include a link to home person on every page<br />
* include a column for birth dates on the index pages<br />
* include a column for death dates on the index pages<br />
* include a column for partners on the index pages<br />
* include a column for parents on the index pages<br />
* include a column for half-siblings on the index pages<br />
* Organization of the web pages. A lot of files and directories are generated. Default you can find this directory structure under the {{man label|NAVWEB}} directory. <br />
** Directories: Following directories are made: ''images'', ''img'', ''plc'', ''ppl'', ''src'', ''srn'', ''thumb''. Each directory contains many subdirectories: /homedir/NAVWEB/src/1/5/15CF2WIFLGOGFRJMLY.html. This last file is unique. If you regenerate web pages or add records and regenerate your web site those file names remain the same.<br />
** HTML files: if you choose to generate HTML files following files will be generated: start page : ''index.html'', ''gallery.html'', if clicked a ''download.html'' page, ''places.html'', ''sources.html'', and ''surname_count.html''.<br />
** CSS files: two style sheet files are generated: ''narrative.css'' and ''narrative-print.css''<br />
<br />
* Customize your CSS files: You can alter and change the made CSS file very easy. The advantage of a style sheet is that changes you do on this text file, you see immediately the effects on the lay-out and color schemes. <br />
<br />
You can customize your style sheet to provide additional formatting and positioning information to control sections.<br />
<br />
{{man tip|Do not forget to check the no style sheet option. Otherwise you will overwrite your custom style sheet.}}<br />
<br />
=== Web Calendar... ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=5895Gramps 3.0 Wiki Manual - Reports2008-04-02T13:50:27Z<p>Simanek: /* Narrated Web Site... */ Image updates, corresponding copy changes to come</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree... ===<br />
[[Image:ancestor.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar... ===<br />
<br />
<br />
=== Descendant Tree... ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart... ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart... ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart... ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph... ===<br />
<br />
=== Hourglass Graph... ===<br />
<br />
=== Relationship Graph... ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report... ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report... ===<br />
<br />
<br />
<br />
=== Complete Individual Report... ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report... ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report... ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report... ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report... ===<br />
<br />
=== Family Group Report... ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report... ===<br />
<br />
=== Marker Report... ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related... ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors... ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database... ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site... ===<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.1 Individual List Page in Mainz Style]]<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The new Narrative Web Site report provides improved functionality, support for web standards and additional features. Instead of using HTML templates to customize the pages, CSS style sheets are used.<br />
<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as family history.<br />
<br />
This report provides the user with a large number of options to allow for a wide range of customization. You can run this report view via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrative Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Option''', '''Page Generation''','''Privacy''', and '''Advanced'''. Let's have a look on all those options. <br />
{{man warn|Entire Database|If you select as a filter your entire database, you must be aware that depending on the size of your database, the amount of web files that are generated can be huge. May be a better approach is to start with a filter (say ancestors of a certain person) so you can start to find out what the generated output is.}}<br />
<br />
==== Report options ====<br />
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]<br />
** check box archive: By default, the output files are written to the specified directory. Because of the number of files and directories that are created, it may be difficult to transfer the files to an external web host. To aid in this, you may directly create a gzip'd tar file to more easily upload the data. This is the format that should be used if you would like to take advantage of the free genealogy page hosting at the GRAMPS web hosting site. To select the gzip'd tar file, select the {{man label|Store web pages in .tar.gz archive}} option.<br />
** Destination: the destination directory for the web files. Default value is the {{man label|/yourhomedirectory/NAVWEB}} directory. Genealogy records can generate a lot of files. Many web servers have a difficult time with many files in a single directory. The Narrative Web Generator strives to keep the number of files per directory to a manageable level. To do this, a hierarchy of directories is created. The generated files names are not intuitive, but are unique per person. Subsequent runs will generate identical file names, making it easy to replace files.<br />
** Filter: Like the previous web page generator, and most of the other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but you are free to use the Custom Filter Editor tool to create your own.<br />
** Filter Person: becomes available only if you did not select the entire database. Use the {{man button|Edit}} button to select a different person.<br />
** Web site title: in this text field you can change the default value '''My Family Tree'''<br />
** File extension: the extension to be used for the web files. Choose between the {{man label|.html}} default value, and .htm, .shtml, .php, .php3, and .cgi. <br />
** Copyright: The copyright to be used for the web files. International copyright law reserves all rights to your data. You own the data, and people must get your permission to use it. In genealogy, however, sharing data is a common ideal. It this case, you may wish to grant the user more rights. While the default for GRAMPS is to place a notice indicating that all rights are reserved, we give you the option to place your site under one of several of the Create Commons licenses. With a Creative Commons license, you grant user's certain permission to use your data without requiring them to contact you directly for permission. See the Creative Commons web site for more information. Choose between the {{man label|Standard Copyright}} default and seven other possibilities varying from Creative Commons -By attribution, Non-commercial to No copyright notice.<br />
** Character set encoding: The encoding to be used for the web files. Because of GRAMPS internationalization ability, the default character set for the HTML pages is {{man label|UTF-8}}. From the drop down menu list you can select a lot of {{man label|ISO-8859-}} encoding sets and even a {man label|koi8_r}} encoding set.This provides support for virtually all characters. The Apache web server is sometimes misconfigured to override the character set specified in an HTML page. This causes problems with the UTF-8 character set generated by GRAMPS, distorting characters on the screen.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
If your web server is misconfigured and you do not have privilege to fix the configuration, you may solve this problem by overriding the default character set to match what your web server may be expecting.<br />
<br />
==== Stylesheet ====<br />
[[Image:NWeb-Man-BasicSet.jpg|right|200px|thumb|fig. c.3 Basic Style - 5 Color Choices]]<br />
The style sheet to be used for the web page. GRAMPS provides seven built in style sheets for your web page. Each of these style sheets produces a unique look for your pages. At the moment you can choose between the '''Basic styles''': '''Ash''', '''Cypress''', '''Lilac''', '''Peach''', and '''Spruce''' and the style '''Mainz''' or '''Nebraska'''. Or you can use the '''No style sheet''' option. The generated style sheet is named ''narrative.css''. You may edit this file if you wish to further customize your site.<br />
<br />
To give an impression on the available color schemes, images are included for the different styles and pages.<br />
If you make modifications to your style sheet, you need to be aware the regenerating the pages with the same output directory will overwrite your changes to this file. To prevent this from happening, make sure you choose {{man label|No style sheet}} for subsequent runs.<br />
** check box: Include ancestor graph: whether to include an ancestor graph on each individual page. If you click this box a ancestor graph will be shown. The amount of generations is determined by the next option.<br />
** Graph generations: the number og generations to include in the ancestor graph. Default value {{man label|4}}. You can choose via the drop down list: 2, 3 4 or 5 generations.<br />
<br />
Any person matching this filter who is not excluded due to the privacy rules, will be included in the output. The default filter includes all people in the database.<br />
<br />
==== Page Generation ====<br />
Here you can generate three additional pages by the web page generator. Initially, for all additional pages no note nor image is given. So must first make some media objects or notes. If those objects or notes exist, you can select those needed with the {{man button|Select}} buttons on the very right hand side off the screen. <br />
** Home Page: you can add a Note and an Image. The Home page is a page that will display an image and a whatever text you wish. To enable this page, choose a Media Object from the {{man label|Home Media/Note ID}} menu on the {{man label|Page Generation}} tab. If the Media Object contains an image, the image is displayed at the top of the page. If the Media Object contains a Note, the Note's text is used for the text of the page.<br />
** Introduction Page: you can add a Note and an Image. Just choose the Media Object in the {{man label|Introduction Media/Note ID}} menu.<br />
** Publisher contact Page : you can add a Note and an Image. Please use this page with caution, since you may consider your contact information to be private.<br />
** HTML user header and user footer: you can add Notes to have a customized header and footer on each of the generated pages.<br />
** three additional check boxes are available: <br />
*** include images and media objects: whether to include/exclude a gallery of media objects.<br />
*** include download page: whether to include a database download option.<br />
*** Suppress GRAMPS ID: whether to include the GRAMPS ID of objects.<br />
*Privacy: Privacy of personal information is an important issue on the web today. GRAMPS tries to give you control over the information that is presented.<br />
** check box include records marked private: GRAMPS provides two options to control the privacy of your information. If you do not select the {{man label|Include records marked private}} option, any data that is marked as private will not be displayed on the generated site.<br />
** Living People: The drop down menu let you choose between '''Exclude''', '''Restrict''', and '''Include'''. If you select {{man label|Restrict information on living people}} , GRAMPS will attempt to determine which people have the potential of still being alive, and will omit these people from the database. Some countries have laws that indicate that a certain number of years must pass after someone's death before information can be published.<br />
** Years from death to consider living: in the input field you can give the amount of years to consider. The default value is 30 years. The {{man label|Years to restrict from person's death}} option allows you to specify how many years a person must be deceased before the information is included. Please note that it is your responsibility to double check all information in the pages for any privacy information. GRAMPS cannot be held responsible for any privacy issues.<br />
<br />
* Advanced: in this tab page you can determine which columns will show up in your web pages. those options are controlled via check boxes.<br />
** include a link to home person on every page<br />
** include a column for birth dates on the index pages<br />
** include a column for death dates on the index pages<br />
** include a column for partners on the index pages<br />
** include a column for parents on the index pages<br />
** include a column for half-siblings on the index pages<br />
<br />
* Organization of the web pages. A lot of files and directories are generated. Default you can find this directory structure under the {{man label|NAVWEB}} directory. <br />
** Directories: Following directories are made: ''images'', ''img'', ''plc'', ''ppl'', ''src'', ''srn'', ''thumb''. Each directory contains many subdirectories: /homedir/NAVWEB/src/1/5/15CF2WIFLGOGFRJMLY.html. This last file is unique. If you regenerate web pages or add records and regenerate your web site those file names remain the same.<br />
** HTML files: if you choose to generate HTML files following files will be generated: start page : ''index.html'', ''gallery.html'', if clicked a ''download.html'' page, ''places.html'', ''sources.html'', and ''surname_count.html''.<br />
** CSS files: two style sheet files are generated: ''narrative.css'' and ''narrative-print.css''<br />
<br />
* Customize your CSS files: You can alter and change the made CSS file very easy. The advantage of a style sheet is that changes you do on this text file, you see immediately the effects on the lay-out and color schemes. <br />
<br />
You can customize your style sheet to provide additional formatting and positioning information to control sections.<br />
<br />
{{man tip|Do not forget to check the no style sheet option. Otherwise you will overwrite your custom style sheet.}}<br />
<br />
=== Web Calendar... ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=5894Gramps 3.0 Wiki Manual - Reports2008-04-02T13:33:51Z<p>Simanek: /* Stylesheet */ New thumbnails that aren't skewed, plus the Mainz example now includes the bkgd images</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree... ===<br />
[[Image:ancestor.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar... ===<br />
<br />
<br />
=== Descendant Tree... ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart... ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart... ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart... ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph... ===<br />
<br />
=== Hourglass Graph... ===<br />
<br />
=== Relationship Graph... ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report... ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report... ===<br />
<br />
<br />
<br />
=== Complete Individual Report... ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report... ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report... ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report... ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report... ===<br />
<br />
=== Family Group Report... ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report... ===<br />
<br />
=== Marker Report... ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related... ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors... ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database... ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site... ===<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The new Narrative Web Site report provides improved functionality, support for web standards and additional features. Instead of using HTML templates to customize the pages, CSS style sheets are used.<br />
<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as family history.<br />
<br />
This report provides the user with a large number of options to allow for a wide range of customization. You can run this report view via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrative Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Option''', '''Page Generation''','''Privacy''', and '''Advanced'''. Let's have a look on all those options. <br />
{{man warn|Entire Database|If you select as a filter your entire database, you must be aware that depending on the size of your database, the amount of web files that are generated can be huge. May be a better approach is to start with a filter (say ancestors of a certain person) so you can start to find out what the generated output is.}}<br />
* Report options:<br />
** check box archive: By default, the output files are written to the specified directory. Because of the number of files and directories that are created, it may be difficult to transfer the files to an external web host. To aid in this, you may directly create a gzip'd tar file to more easily upload the data. This is the format that should be used if you would like to take advantage of the free genealogy page hosting at the GRAMPS web hosting site. To select the gzip'd tar file, select the {{man label|Store web pages in .tar.gz archive}} option.<br />
** Destination: the destination directory for the web files. Default value is the {{man label|/yourhomedirectory/NAVWEB}} directory. Genealogy records can generate a lot of files. Many web servers have a difficult time with many files in a single directory. The Narrative Web Generator strives to keep the number of files per directory to a manageable level. To do this, a hierarchy of directories is created. The generated files names are not intuitive, but are unique per person. Subsequent runs will generate identical file names, making it easy to replace files.<br />
** Filter: Like the previous web page generator, and most of the other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but you are free to use the Custom Filter Editor tool to create your own.<br />
** Filter Person: becomes available only if you did not select the entire database. Use the {{man button|Edit}} button to select a different person.<br />
** Web site title: in this text field you can change the default value '''My Family Tree'''<br />
** File extension: the extension to be used for the web files. Choose between the {{man label|.html}} default value, and .htm, .shtml, .php, .php3, and .cgi. <br />
** Copyright: The copyright to be used for the web files. International copyright law reserves all rights to your data. You own the data, and people must get your permission to use it. In genealogy, however, sharing data is a common ideal. It this case, you may wish to grant the user more rights. While the default for GRAMPS is to place a notice indicating that all rights are reserved, we give you the option to place your site under one of several of the Create Commons licenses. With a Creative Commons license, you grant user's certain permission to use your data without requiring them to contact you directly for permission. See the Creative Commons web site for more information. Choose between the {{man label|Standard Copyright}} default and seven other possibilities varying from Creative Commons -By attribution, Non-commercial to No copyright notice.<br />
** Character set encoding: The encoding to be used for the web files. Because of GRAMPS internationalization ability, the default character set for the HTML pages is {{man label|UTF-8}}. From the drop down menu list you can select a lot of {{man label|ISO-8859-}} encoding sets and even a {man label|koi8_r}} encoding set.This provides support for virtually all characters. The Apache web server is sometimes misconfigured to override the character set specified in an HTML page. This causes problems with the UTF-8 character set generated by GRAMPS, distorting characters on the screen.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
If your web server is misconfigured and you do not have privilege to fix the configuration, you may solve this problem by overriding the default character set to match what your web server may be expecting.<br />
<br />
==== Stylesheet ====<br />
[[Image:NWeb-Man-BasicSet.jpg|right|200px|thumb|fig. c.1 Basic Style - 5 Colors]]<br />
<br />
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. c.5 Mainz Style]]<br />
<br />
The style sheet to be used for the web page. GRAMPS provides seven built in style sheets for your web page. Each of these style sheets produces a unique look for your pages. At the moment you can choose between the '''Basic styles''': '''Ash''', '''Cypress''', '''Lilac''', '''Peach''', and '''Spruce''' and the style '''Mainz''' or '''Nebraska'''. Or you can use the '''No style sheet''' option. The generated style sheet is named ''narrative.css''. You may edit this file if you wish to further customize your site.<br />
<br />
To give an impression on the available color schemes, images are included for the different styles and pages.<br />
If you make modifications to your style sheet, you need to be aware the regenerating the pages with the same output directory will overwrite your changes to this file. To prevent this from happening, make sure you choose {{man label|No style sheet}} for subsequent runs.<br />
** check box: Include ancestor graph: whether to include an ancestor graph on each individual page. If you click this box a ancestor graph will be shown. The amount of generations is determined by the next option.<br />
** Graph generations: the number og generations to include in the ancestor graph. Default value {{man label|4}}. You can choose via the drop down list: 2, 3 4 or 5 generations.<br />
<br />
Any person matching this filter who is not excluded due to the privacy rules, will be included in the output. The default filter includes all people in the database.<br />
<br />
==== Page Generation ====<br />
Here you can generate three additional pages by the web page generator. Initially, for all additional pages no note nor image is given. So must first make some media objects or notes. If those objects or notes exist, you can select those needed with the {{man button|Select}} buttons on the very right hand side off the screen. <br />
** Home Page: you can add a Note and an Image. The Home page is a page that will display an image and a whatever text you wish. To enable this page, choose a Media Object from the {{man label|Home Media/Note ID}} menu on the {{man label|Page Generation}} tab. If the Media Object contains an image, the image is displayed at the top of the page. If the Media Object contains a Note, the Note's text is used for the text of the page.<br />
** Introduction Page: you can add a Note and an Image. Just choose the Media Object in the {{man label|Introduction Media/Note ID}} menu.<br />
** Publisher contact Page : you can add a Note and an Image. Please use this page with caution, since you may consider your contact information to be private.<br />
** HTML user header and user footer: you can add Notes to have a customized header and footer on each of the generated pages.<br />
** three additional check boxes are available: <br />
*** include images and media objects: whether to include/exclude a gallery of media objects.<br />
*** include download page: whether to include a database download option.<br />
*** Suppress GRAMPS ID: whether to include the GRAMPS ID of objects.<br />
*Privacy: Privacy of personal information is an important issue on the web today. GRAMPS tries to give you control over the information that is presented.<br />
** check box include records marked private: GRAMPS provides two options to control the privacy of your information. If you do not select the {{man label|Include records marked private}} option, any data that is marked as private will not be displayed on the generated site.<br />
** Living People: The drop down menu let you choose between '''Exclude''', '''Restrict''', and '''Include'''. If you select {{man label|Restrict information on living people}} , GRAMPS will attempt to determine which people have the potential of still being alive, and will omit these people from the database. Some countries have laws that indicate that a certain number of years must pass after someone's death before information can be published.<br />
** Years from death to consider living: in the input field you can give the amount of years to consider. The default value is 30 years. The {{man label|Years to restrict from person's death}} option allows you to specify how many years a person must be deceased before the information is included. Please note that it is your responsibility to double check all information in the pages for any privacy information. GRAMPS cannot be held responsible for any privacy issues.<br />
<br />
* Advanced: in this tab page you can determine which columns will show up in your web pages. those options are controlled via check boxes.<br />
** include a link to home person on every page<br />
** include a column for birth dates on the index pages<br />
** include a column for death dates on the index pages<br />
** include a column for partners on the index pages<br />
** include a column for parents on the index pages<br />
** include a column for half-siblings on the index pages<br />
<br />
* Organization of the web pages. A lot of files and directories are generated. Default you can find this directory structure under the {{man label|NAVWEB}} directory. <br />
** Directories: Following directories are made: ''images'', ''img'', ''plc'', ''ppl'', ''src'', ''srn'', ''thumb''. Each directory contains many subdirectories: /homedir/NAVWEB/src/1/5/15CF2WIFLGOGFRJMLY.html. This last file is unique. If you regenerate web pages or add records and regenerate your web site those file names remain the same.<br />
** HTML files: if you choose to generate HTML files following files will be generated: start page : ''index.html'', ''gallery.html'', if clicked a ''download.html'' page, ''places.html'', ''sources.html'', and ''surname_count.html''.<br />
** CSS files: two style sheet files are generated: ''narrative.css'' and ''narrative-print.css''<br />
<br />
* Customize your CSS files: You can alter and change the made CSS file very easy. The advantage of a style sheet is that changes you do on this text file, you see immediately the effects on the lay-out and color schemes. <br />
<br />
You can customize your style sheet to provide additional formatting and positioning information to control sections.<br />
<br />
{{man tip|Do not forget to check the no style sheet option. Otherwise you will overwrite your custom style sheet.}}<br />
<br />
=== Web Calendar... ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=File:NWeb-Man-BasicSet.jpg&diff=5893File:NWeb-Man-BasicSet.jpg2008-04-02T13:29:43Z<p>Simanek: Narrative Web Report: 5 Basic Styles</p>
<hr />
<div>Narrative Web Report: 5 Basic Styles</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=File:NWeb-Man-Nebr.jpg&diff=5892File:NWeb-Man-Nebr.jpg2008-04-02T13:24:08Z<p>Simanek: Narrative Web Report: Nebraska Style</p>
<hr />
<div>Narrative Web Report: Nebraska Style</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=File:NWeb-Man-Mainz.jpg&diff=5891File:NWeb-Man-Mainz.jpg2008-04-02T13:22:33Z<p>Simanek: Narrative Web Report: Mainz Style</p>
<hr />
<div>Narrative Web Report: Mainz Style</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=File:NWeb-Man-5.jpg&diff=5890File:NWeb-Man-5.jpg2008-04-02T13:20:24Z<p>Simanek: Narrative Web Report: Spruce Style</p>
<hr />
<div>Narrative Web Report: Spruce Style</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=File:NWeb-Man-4.jpg&diff=5889File:NWeb-Man-4.jpg2008-04-02T13:19:31Z<p>Simanek: Narrative Web Report: Peach Style</p>
<hr />
<div>Narrative Web Report: Peach Style</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=File:NWeb-Man-3.jpg&diff=5888File:NWeb-Man-3.jpg2008-04-02T13:17:03Z<p>Simanek: Narrative Web Report: Lilac Style</p>
<hr />
<div>Narrative Web Report: Lilac Style</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=File:NWeb-Man-2.jpg&diff=5887File:NWeb-Man-2.jpg2008-04-02T13:15:15Z<p>Simanek: Narrative Web Report: Cypress Style</p>
<hr />
<div>Narrative Web Report: Cypress Style</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=File:NWeb-Man-1.jpg&diff=5886File:NWeb-Man-1.jpg2008-04-02T13:12:14Z<p>Simanek: Narrative Web Report: Ash Style</p>
<hr />
<div>Narrative Web Report: Ash Style</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=File:NWeb-Man_1_Ash.jpg&diff=5885File:NWeb-Man 1 Ash.jpg2008-04-02T13:05:31Z<p>Simanek: Narrative Web Report: Ash Style</p>
<hr />
<div>Narrative Web Report: Ash Style</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=5883Gramps 3.0 Wiki Manual - Reports2008-04-02T04:35:22Z<p>Simanek: /* Narrated Web Site... */ more mild copy changes, more yet to come</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree... ===<br />
[[Image:ancestor.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar... ===<br />
<br />
<br />
=== Descendant Tree... ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart... ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart... ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart... ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph... ===<br />
<br />
=== Hourglass Graph... ===<br />
<br />
=== Relationship Graph... ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report... ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report... ===<br />
<br />
<br />
<br />
=== Complete Individual Report... ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report... ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report... ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report... ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report... ===<br />
<br />
=== Family Group Report... ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report... ===<br />
<br />
=== Marker Report... ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related... ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors... ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database... ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site... ===<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The new Narrative Web Site report provides improved functionality, support for web standards and additional features. Instead of using HTML templates to customize the pages, CSS style sheets are used.<br />
<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as family history.<br />
<br />
This report provides the user with a large number of options to allow for a wide range of customization. You can run this report view via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrative Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Option''', '''Page Generation''','''Privacy''', and '''Advanced'''. Let's have a look on all those options. <br />
{{man warn|Entire Database|If you select as a filter your entire database, you must be aware that depending on the size of your database, the amount of web files that are generated can be hugh. May be a better approach is to start with a filter (say ancestors of a certain person) so you can start to find out what the generated output is.}}<br />
* Report options:<br />
** check box archive: By default, the output files are written to the specified directory. Because of the number of files and directories that are created, it may be difficult to transfer the files to an external web host. To aid in this, you may directly create a gzip'd tar file to more easily upload the data. This is the format that should be used if you would like to take advantage of the free genealogy page hosting at the GRAMPS web hosting site. To select the gzip'd tar file, select the {{man label|Store web pages in .tar.gz archive}} option.<br />
** Destination: the destination directory for the web files. Default value is the {{man label|/yourhomedirectory/NAVWEB}} directory. Genealogy records can generate a lot of files. Many web servers have a difficult time with many files in a single directory. The Narrative Web Generator strives to keep the number of files per directory to a manageable level. To do this, a hierarchy of directories is created. The generated files names are not intuitive, but are unique per person. Subsequent runs will generate identical file names, making it easy to replace files.<br />
** Filter: Like the previous web page generator, and most of the other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but you are free to use the Custom Filter Editor tool to create your own.<br />
** Filter Person: becomes available only if you did not select the entire database. Use the {{man button|Edit}} button to select a different person.<br />
** Web site title: in this text field you can change the default value '''My Family Tree'''<br />
** File extension: the extension to be used for the web files. Choose between the {{man label|.html}} default value, and .htm, .shtml, .php, .php3, and .cgi. <br />
** Copyright: The copyright to be used for the web files. International copyright law reserves all rights to your data. You own the data, and people must get your permission to use it. In genealogy, however, sharing data is a common ideal. It this case, you may wish to grant the user more rights. While the default for GRAMPS is to place a notice indicating that all rights are reserved, we give you the option to place your site under one of several of the Create Commons licenses. With a Creative Commons license, you grant user's certain permission to use your data without requiring them to contact you directly for permission. See the Creative Commons web site for more information. Choose between the {{man label|Standard Copyright}} default and seven other possibilities varying from Creative Commons -By attribution, Non-commercial to No copyright notice.<br />
** Character set encoding: The encoding to be used for the web files. Because of GRAMPS internationalization ability, the default character set for the HTML pages is {{man label|UTF-8}}. From the drop down menu list you can select a lot of {{man label|ISO-8859-}} encoding sets and even a {man label|koi8_r}} encoding set.This provides support for virtually all characters. The Apache web server is sometimes misconfigured to override the character set specified in an HTML page. This causes problems with the UTF-8 character set generated by GRAMPS, distorting characters on the screen.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
If your web server is misconfigured and you do not have privilege to fix the configuration, you may solve this problem by overriding the default character set to match what your web server may be expecting.<br />
<br />
==== Stylesheet ====<br />
The style sheet to be used for the web page. GRAMPS provides seven built in style sheets for your web page. Each of these style sheets produces a unique look for your pages. At the moment you can choose between the '''Basic styles''': '''Ash''', '''Cypress''', '''Lilac''', '''Peach''', and '''Spruce''' and the style '''Mainz''' or '''Nesbraka'''. Or you can use the '''No style sheet''' option. The generated style sheet is named ''narrative.css'' . You may edit this file if you wish to further customize your site.<br />
[[Image:navash.png|left|150px|thumb|fig. c.1 Ash]]<br />
To give an impression on the available color schemes, images are included for the different styles and pages.<br />
[[Image:navcypres.png|right|150px|thumb|fig. c.2 Cypress]]<br />
If you make modifications to your style sheet, you need to be aware the regenerating the pages with the same output directory will overwrite your changes to this file. To prevent this from happening, make sure you choose {{man label|No style sheet}} for subsequent runs.<br />
[[Image:navlilac.png|left|150px|thumb|fig. c.3 Lilac]]<br />
** check box: Include ancestor graph: whether to include an ancestor graph on each individual page. If you click this box a ancestor graph will be shown. The amount of generations is deterlined by the next option.<br />
[[Image:navmainz.png|right|150px|thumb|fig. c.4 Mainz]]<br />
** Graph generations: the number og generations to include in the ancestor graph. Default value {{man label|4}}. You can cj-hoose via the drop down list: 2, 3 4 or 5 generations.<br />
[[Image:navnebrask.png|left|150px|thumb|fig. c.5 Nebraska]]<br />
[[Image:navnocss.png|right|150px|thumb|fig. c.6 No CSS]]<br />
[[Image:navpeach.png|left|150px|thumb|fig. c.7 Peach]]<br />
[[Image:navspruce.png|right|150px|thumb|fig. c.8 Spruce]]<br />
Any person matching this filter who is not excluded due to the privacy rules, will be included in the output. The default filter includes all people in the database.<br />
<br />
==== Page Generation ====<br />
Here you can generate three additional pages by the web page generator. Initially, for all additional pages no note nor image is given. So must first make some media objects or notes. If those objects or notes exist, you can select those needed with the {{man button|Select}} buttons on the very right hand side off the screen. <br />
** Home Page: you can add a Note and an Image. The Home page is a page that will display an image and a whatever text you wish. To enable this page, choose a Media Object from the {{man label|Home Media/Note ID}} menu on the {{man label|Page Generation}} tab. If the Media Object contains an image, the image is displayed at the top of the page. If the Media Object contains a Note, the Note's text is used for the text of the page.<br />
** Introduction Page: you can add a Note and an Image. Just choose the Media Object in the {{man label|Introduction Media/Note ID}} menu.<br />
** Publisher contact Page : you can add a Note and an Image. Please use this page with caution, since you may consider your contact information to be private.<br />
** HTML user header and user footer: you can add Notes to have a customized header and footer on each of the generated pages.<br />
** three additional check boxes are available: <br />
*** include images and media objects: whether to include/exclude a gallery of media objects.<br />
*** include download page: whether to include a database download option.<br />
*** Suppress GRAMPS ID: whether to include the GRAMPS ID of objects.<br />
*Privacy: Privacy of personal information is an important issue on the web today. GRAMPS tries to give you control over the information that is presented.<br />
** check box include records marked private: GRAMPS provides two options to control the privacy of your information. If you do not select the {{man label|Include records marked private}} option, any data that is marked as private will not be displayed on the generated site.<br />
** Living People: The drop down menu let you choose between '''Exclude''', '''Restrict''', and '''Include'''. If you select {{man label|Restrict information on living people}} , GRAMPS will attempt to determine which people have the potential of still being alive, and will omit these people from the database. Some countries have laws that indicate that a certain number of years must pass after someone's death before information can be published.<br />
** Years from death to consider living: in the input field you can give the amount of years to consider. The default value is 30 years. The {{man label|Years to restrict from person's death}} option allows you to specify how many years a person must be deceased before the information is included. Please note that it is your responsibility to double check all information in the pages for any privacy information. GRAMPS cannot be held responsible for any privacy issues.<br />
<br />
* Advanced: in this tab page you can determine which columns will show up in your web pages. those options are controlled via check boxes.<br />
** include a link to home person on every page<br />
** include a column for birth dates on the index pages<br />
** include a column for death dates on the index pages<br />
** include a column for partners on the index pages<br />
** include a column for parents on the index pages<br />
** include a column for half-siblings on the index pages<br />
<br />
* Organization of the web pages. A lot of files and directories are generated. Default you can find this directory structure under the {{man label|NAVWEB}} directory. <br />
** Directories: Following directories are made: ''images'', ''img'', ''plc'', ''ppl'', ''src'', ''srn'', ''thumb''. Each directory contains many subdirectories: /homedir/NAVWEB/src/1/5/15CF2WIFLGOGFRJMLY.html. This last file is unique. If you regenerate web pages or add records and regenerate your web site those file names remain the same.<br />
** HTML files: if you choose to generate HTML files following files will be generated: start page : ''index.html'', ''gallery.html'', if clicked a ''download.html'' page, ''places.html'', ''sources.html'', and ''surname_count.html''.<br />
** CSS files: two style sheet files are generated: ''narrative.css'' and ''narrative-print.css''<br />
<br />
* Customize your CSS files: You can alter and change the made CSS file very easy. The advantage of a style sheet is that changes you do on this text file, you see immediately the effects on the lay-out and color schemes. <br />
<br />
You can customize your style sheet to provide additional formatting and positioning information to control sections.<br />
<br />
{{man tip|Do not forget to check the no style sheet option. Otherwise you will overwrite your custom style sheet.}}<br />
<br />
=== Web Calendar... ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanekhttps://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Reports&diff=5880Gramps 3.0 Wiki Manual - Reports2008-04-01T13:38:21Z<p>Simanek: /* Narrated Web Site... */ more to come, headers improve legibility--easier to scan, some copy changes</p>
<hr />
<div>This sections describes the different reports available in GRAMPS.<br />
<br />
<br />
{{grampsmanualcopyright}}<br />
<br />
<br />
{{languages}}<br />
<br />
<br />
== Generating Reports ==<br />
<br />
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. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS 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 GRAMPS report, you can design and choose the style for each of your reports.<br />
<br />
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 {{man label|Report Selection}} dialog invoked by clicking the {{man button|Reports}} icon on the toolbar.<br />
<br />
== Substitution Values ==<br />
<br />
Many of the graphical reports allow you to customize the information on the display. Variable substitutions 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.<br />
<br />
The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.<br />
<br />
*$n/%n<br />
<br />
Displays the person's name in the form of FirstName LastName<br />
<br />
*$N/%N<br />
<br />
Displays the person's name in the form of LastName, FirstName<br />
<br />
*$i/%i<br />
<br />
Displays the GRAMPS ID associated with the person.<br />
<br />
*$b/%b<br />
<br />
Displays the person's date of birth<br />
<br />
*$B/%B<br />
<br />
Displays the person's place of birth<br />
<br />
*$d/%d<br />
<br />
Displays the person's date of death<br />
<br />
*$D/%D<br />
<br />
Displays the person's place of death<br />
<br />
*$s/%s<br />
<br />
Displays the name of the person's preferred spouse in the form of FirstName LastName<br />
<br />
*$S/%S<br />
<br />
Displays the name of the person's preferred spouse in the form of LastName, FirstName.<br />
<br />
*$m/%m<br />
<br />
Displays the marriage date of the person and the preferred spouse.<br />
<br />
*$M/%M<br />
<br />
Displays the place associated with the marriage of the person and the preferred spouse.<br />
<br />
Substitution values can be combined:e.g. <br />
$n $i<br />
$b $B<br />
$d $D<br />
<br />
this will give a lot of information in the displayed boxes.<br />
<br />
== Books ==<br />
<br />
Currently, the only available report under this category is the Book Report.<br />
<br />
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 GRAMPS can produce.<br />
<br />
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:<br />
<br />
[[Image:bookreport.png|thumb|200x|Fig. a.1 Book report]]<br />
<br />
The {{man label|Book name}} text entry field is used to save the book (a set of configured selections) for future use. The top pane {{man label|Available items}} lists the items available for inclusion in the book. The bottom panel {{man label|Current book}} lists the currently selected items in the order they will appear in the book.<br />
<br />
The horizontal set of buttons by the {{man label|Book name}} field operates on the whole book. Click the {{man button|Clear}} button (clear the book) to clear all items from the current book. Click the {{man button|Save}} button to save the current book (under the name typed in the {{man label|Book name}} text entry field) for future use. This saves the current set of configured selections.<br />
<br />
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}<br />
<br />
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.<br />
<br />
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).<br />
<br />
The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the {{man button|Add}} button to add selected item from the available list to the current book. Click the {{man button|Remove}} button to remove an item from the current book. Use {{man button|Up}} and {{man button|Down}} to change the items order in the current book. Click the {{man button|Setup}} button to configure the options of the selected item of the current book.<br />
<br />
The configuration dialogs invoked by {{man button|Setup}} are item-specific. If you choose not to configure the item, same 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.<br />
<br />
If all selections of the reports to be included are made, click the {{man button|OK}} button. This will invoke a {{man label|GRAMPS Book}} window. There is one tab with available {{man label|Paper Options}} where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.<br />
<br />
In the lower part of the window you can change some {{man label|Document Options}}:<br />
*Output Format: drop down menu let you choose between: '''Open Document Text''', '''PDF document''' or '''Print...'''. Click box is available to open in OpenOffice.org Word Processor<br />
*Filename: default value is /yourhomedir/book.odt. Click the {{man button|Save as}} button and you can change the file name settings in the usual way.<br />
<br />
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:<br />
<br />
*Title Page<br />
If you selected the {{man label|Title page}} item and clicked the {{man button|Add}} button to put this item in your book and you click {{man button|Preferences}} button (Configure currently selected item) you will get a {{man label|Title Page}} window.<br />
Two tabs are available: '''Text''' and '''Image'''. In the {{man label|Text}} tab you have three text input fields available where you can change the '''Title''', the '''subtitle''' and a '''Footer''' (default Copyright 2008).<br />
<br />
The lower window part shows some '''Document Options''': here you can choose the '''Style'''. You can choose the default style or click on the {{man button|Style Editor...}} button. This brings up a {{man label|Style Editor}} window where you can add and remove Styles.<br />
<br />
TODO link to Style Editor window <br />
<br />
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer. <br />
There is {{man label|Preview}} facility and with the {{man button|from gallery...}} button you can select via the {{man label|Select Media Object}} dialogue the image you want. You can also change the {{man label|Size}}<br />
<br />
Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.<br />
<br />
*Custom Text<br />
<br />
This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. <br />
The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.<br />
<br />
== Graphical Reports ==<br />
<br />
Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following graphical reports are currently available in GRAMPS:<br />
<br />
=== Ancestor Tree... ===<br />
[[Image:ancestor.png|thumb|200x|Fig. a.2 PDF Output ancestor tree]]<br />
This report generates the chart of people who are ancestors of the Active Person. <br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
=== Calendar... ===<br />
<br />
<br />
=== Descendant Tree... ===<br />
<br />
This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file). <br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered. The input field {{man label|Display Format}} gives you the opportunity to change the default settings for the displayed entries (see [#Substitution Values]).<br />
Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.<br />
<br />
{{man warn|Single page vs. multiple pages|Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!}}<br />
<br />
<br />
=== Fan Chart... ===<br />
[[Image:fanchartoptions.png|right|thumb|200px|Fig. a.3 Options Fan chart]]<br />
This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.<br />
[[Image:fanchartpdf.png|left|thumb|200px|Fig. a.4 Fan chart]]<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options: First the Center Person is displayed. Using the {{man button|Edit}} button you can select a different person. With the next input field {{man label|Generations}} you can change the number of generations considered.<br />
Next input field {{man label|Type of graph}}: choose via the drop down menu: full, half , or quarter circle.<br />
Next input field {{man label|Background color}}: choose white or generation dependant.<br />
Next input field {{man label|Orientation of radial text}} : choose upright or roundabout<br />
<br />
===Statistics Chart... ===<br />
[[Image:statistic.png|right|thumb|200px|Fig. a.5 Statistics chart]]<br />
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 pie chart instead. The '''Chart Selection''' tab allows you to check which charts you want to include in your report.<br />
*Paper options: With the {{man label|Paper Options}} you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.<br />
*Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A {{man label|check box}} is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).<br />
*Report Options:<br />
** Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.<br />
** Filter person: The center person for the filter: only available if as filter not entire database selected. {{man button|Edit}} button let you choose another filter person.<br />
** Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.<br />
** check box: sort in reverse order<br />
** People born after: Birth year from which to include people: fill in a year to start from<br />
** People born before: Birth year until which to include people: fill in a year<br />
** check box: Whether to include people without known birth years<br />
** Gender included: Select which genders are included into statistics. Choose both, men, or women.<br />
** Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.<br />
[[Image:statistic1.png|right|thumb|200px|Fig. a.6 Statistics chart options]]<br />
* Charts 1: 9 check boxes are available to include charts with indicated data:<br />
** Age<br />
** Death place<br />
** Death month<br />
** Age when first child born<br />
** Title<br />
** Age when last child born<br />
** Birth month<br />
** Age at marriage<br />
** Age at death<br />
* Charts 2: 10 check boxes are available to include charts with indicated data:<br />
** Event type<br />
** Number of children<br />
** Marriage place <br />
** Number of relationships<br />
** Surname<br />
** Death year<br />
** Gender<br />
** Forename<br />
** Birth year<br />
** Birth place<br />
[[Image:statistic2.png|right|thumb|200px|Fig. a7 Results]]<br />
<br />
If all needed info is filled in click on {{man button|OK}} to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
The image shows the result of '''Age of first child''' for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.<br />
<br />
=== Timeline Chart... ===<br />
<br />
This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.<br />
<br />
----<br />
<br />
*Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.<br />
<br />
<br />
<br />
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.<br />
<br />
{{man tip| Tip |The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== Graphs ==<br />
<br />
=== Family Lines Graph... ===<br />
<br />
=== Hourglass Graph... ===<br />
<br />
=== Relationship Graph... ===<br />
<br />
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through 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.<br />
<br />
The report produces files that are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program. The only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.<br />
<br />
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site]. Specific options for this report include filter and number of generations considered, etc.<br />
<br />
<br />
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)<br />
<br />
Ubuntu Hardy will support the 2.16 version. <br />
<br />
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}<br />
<br />
== Text Reports ==<br />
<br />
Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section. The options which are specific to a given report will be described directly in that report's entry.<br />
<br />
The following text reports are currently available in GRAMPS:<br />
<br />
=== Ahnentafel Report... ===<br />
<br />
This report lists the Active Person and his or her ancestors along with their vital data. The people are numbered in a special way which is an established standard called Ahnentafel. The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively. This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers. Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.<br />
<br />
=== Birthday and Anniversary Report... ===<br />
<br />
<br />
<br />
=== Complete Individual Report... ===<br />
This report provides individual summaries similar to that of the Individual Summary report. The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.<br />
<br />
=== Descendant Report... ===<br />
This report produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.<br />
<br />
=== Detailed Ancestral Report... ===<br />
This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.<br />
<br />
=== Detailed Descendant Report... ===<br />
This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.<br />
<br />
=== End of Line Report... ===<br />
<br />
=== Family Group Report... ===<br />
This creates a family group report, showing information on a set of parents and their children. Specific options: the spouse (available only if the Active Person has more than one spouse).<br />
<br />
<br />
=== Kinship Report... ===<br />
<br />
=== Marker Report... ===<br />
<br />
<br />
<br />
<br />
----<br />
*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.<br />
*FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.<br />
*FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.<br />
*Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.<br />
<br />
----<br />
<br />
Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.<br />
<br />
{{man tip|Tip|The options used in reports are persistent: each report remembers its options used last time.}}<br />
<br />
== View ==<br />
<br />
View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:<br />
<br />
=== Not Related... ===<br />
[[Image:notrelated.png|right|thumb|200px|Fig. a.a Not related]]<br />
This report will find people who are not related to the selected person. You can run this view via the menu '''Reports-->View-->Not Related...'''.<br />
<br />
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.<br />
<br />
This list gives you:<br />
* Name<br />
* ID<br />
* Parents<br />
* Marker<br />
<br />
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.<br />
<br />
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the person. This marker will then show up in the right hand side column.<br />
<br />
=== Number of Ancestors... ===<br />
[[Image:numberanc.png|right|thumb|200px|Fig. a.a Number of Ancestors]]<br />
<br />
<br />
This report displays the number of ancestors of the active person.<br />
<br />
<br />
Just choose a person and click on the menu '''Report-->View-->Number of Ancestors...'''.<br />
<br />
The window will show up listing the details:<br />
<br />
generation 1 has 1 individual : 100% : this is the person you started with<br />
generation 2 has 2 individuals : 100% : both parents are known<br />
<br />
<br />
generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.<br />
<br />
Total ancestors in generation 2 to .. is also given in numbers and percentages.<br />
<br />
With the {{man button|Close}} button you close the window and this report.<br />
<br />
=== Summary of the Database... ===<br />
[[Image:sumdata.png|right|thumb|200px|Fig. a.b Summary]]<br />
<br />
This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.<br />
<br />
You can run this report via the menu '''Report-->View-->Summary of the database...'''.<br />
<br />
* Individuals: the numbers in the different categories are shown<br />
** Number of individuals: <br />
** Males:<br />
** Females:<br />
** Individuals with unknown gender:<br />
** Individuals with incomplete names:<br />
** Individuals missing birth dates:<br />
** Disconnected individuals:<br />
<br />
* Family information:<br />
** number of families:<br />
** Unique surnames:<br />
<br />
* Media Objects:<br />
** Individuals with Media Objects:<br />
** Total number of media object references:<br />
** Number of unique media objects:<br />
** Total size of media objects: in bytes<br />
<br />
* Missing Media Objects: this will show the full path and file names of any missing media object.<br />
<br />
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.0_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]<br />
<br />
== Web Pages ==<br />
=== Narrated Web Site... ===<br />
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.<br />
<br />
==== Introduction ====<br />
GRAMPS 2.0.6 introduced the Narrative Web generator. The new Narrative Web Site report provides improved functionality, support for web standards and additional features. Instead of using HTML templates to customize the pages, CSS style sheets are used.<br />
<br />
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as family history.<br />
<br />
This report provides the user with a large number of options to allow for a wide range of customization. You can run this report view via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.<br />
<br />
The Narrative Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Option''', '''Page Generation''','''Privacy''', and '''Advanced'''. Let's have a look on all those options. <br />
{{man warn|Entire Database|If you select as a filter your entire database, you must be aware that depending on the size of your database, the amount of web files that are generated can be hugh. May be a better approach is to start with a filter (say ancestors of a certain person) so you can start to find out what the generated output is.}}<br />
* Report options:<br />
** check box archive: By default, the output files are written to the specified directory. Because of the number of files and directories that are created, it may be difficult to transfer the files to an external web host. To aid in this, you may directly create a gzip'd tar file to more easily upload the data. This is the format that should be used if you would like to take advantage of the free genealogy page hosting at the GRAMPS web hosting site. To select the gzip'd tar file, select the {{man label|Store web pages in .tar.gz archive}} option.<br />
** Destination: the destination directory for the web files. Default value is the {{man label|/yourhomedirectory/NAVWEB}} directory. Genealogy records can generate a lot of files. Many web servers have a difficult time with many files in a single directory. The Narrative Web Generator strives to keep the number of files per directory to a manageable level. To do this, a hierarchy of directories is created. The generated files names are not intuitive, but are unique per person. Subsequent runs will generate identical file names, making it easy to replace files.<br />
** Filter: Like the previous web page generator, and most of the other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but you are free to use the Custom Filter Editor tool to create your own.<br />
** Filter Person: becomes available only if you did not select the entire database. Use the {{man button|Edit}} button to select a different person.<br />
** Web site title: in this text field you can change the default value '''My Family Tree'''<br />
** File extension: the extension to be used for the web files. Choose between the {{man label|.html}} default value, and .htm, .shtml, .php, .php3, and .cgi. <br />
** Copyright: The copyright to be used for the web files. International copyright law reserves all rights to your data. You own the data, and people must get your permission to use it. In genealogy, however, sharing data is a common ideal. It this case, you may wish to grant the user more rights. While the default for GRAMPS is to place a notice indicating that all rights are reserved, we give you the option to place your site under one of several of the Create Commons licenses. With a Creative Commons license, you grant user's certain permission to use your data without requiring them to contact you directly for permission. See the Creative Commons web site for more information. Choose between the {{man label|Standard Copyright}} default and seven other possibilities varying from Creative Commons -By attribution, Non-commercial to No copyright notice.<br />
** Character set encoding: The encoding to be used for the web files. Because of GRAMPS internationalization ability, the default character set for the HTML pages is {{man label|UTF-8}}. From the drop down menu list you can select a lot of {{man label|ISO-8859-}} encoding sets and even a {man label|koi8_r}} encoding set.This provides support for virtually all characters. The Apache web server is sometimes misconfigured to override the character set specified in an HTML page. This causes problems with the UTF-8 character set generated by GRAMPS, distorting characters on the screen.<br />
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}<br />
If your web server is misconfigured and you do not have privilege to fix the configuration, you may solve this problem by overriding the default character set to match what your web server may be expecting.<br />
** Stylesheet: The style sheet to be used for the web page. GRAMPS provides seven built in style sheets for your web page. Each of these style sheets produces a unique look for your pages. At the moment you can choose between the '''Basic styles''': '''Ash''', '''Cypress''', '''Lilac''', '''Peach''', and '''Spruce''' and the style '''Mainz''' or '''Nesbraka'''. Or you can use the '''No style sheet''' option. The generated style sheet is named ''narrative.css'' . You may edit this file if you wish to further customize your site.<br />
[[Image:navash.png|left|150px|thumb|fig. c.1 Ash]]<br />
To give an impression on the available color schemes, images are included for the different styles and pages.<br />
[[Image:navcypres.png|right|150px|thumb|fig. c.2 Cypress]]<br />
If you make modifications to your style sheet, you need to be aware the regenerating the pages with the same output directory will overwrite your changes to this file. To prevent this from happening, make sure you choose {{man label|No style sheet}} for subsequent runs.<br />
[[Image:navlilac.png|left|150px|thumb|fig. c.3 Lilac]]<br />
** check box: Include ancestor graph: whether to include an ancestor graph on each individual page. If you click this box a ancestor graph will be shown. The amount of generations is deterlined by the next option.<br />
[[Image:navmainz.png|right|150px|thumb|fig. c.4 Mainz]]<br />
** Graph generations: the number og generations to include in the ancestor graph. Default value {{man label|4}}. You can cj-hoose via the drop down list: 2, 3 4 or 5 generations.<br />
[[Image:navnebrask.png|left|150px|thumb|fig. c.5 Nebraska]]<br />
[[Image:navnocss.png|right|150px|thumb|fig. c.6 No CSS]]<br />
[[Image:navpeach.png|left|150px|thumb|fig. c.7 Peach]]<br />
[[Image:navspruce.png|right|150px|thumb|fig. c.8 Spruce]]<br />
Any person matching this filter who is not excluded due to the privacy rules, will be included in the output. The default filter includes all people in the database.<br />
<br />
* Page Generation: Here you can generate three additional pages by the web page generator. Initially, for all additional pages no note nor image is given. So must first make some media objects or notes. If those objects or notes exist, you can select those needed with the {{man button|Select}} buttons on the very right hand side off the screen. <br />
** Home Page: you can add a Note and an Image. The Home page is a page that will display an image and a whatever text you wish. To enable this page, choose a Media Object from the {{man label|Home Media/Note ID}} menu on the {{man label|Page Generation}} tab. If the Media Object contains an image, the image is displayed at the top of the page. If the Media Object contains a Note, the Note's text is used for the text of the page.<br />
** Introduction Page: you can add a Note and an Image. Just choose the Media Object in the {{man label|Introduction Media/Note ID}} menu.<br />
** Publisher contact Page : you can add a Note and an Image. Please use this page with caution, since you may consider your contact information to be private.<br />
** HTML user header and user footer: you can add Notes to have a customized header and footer on each of the generated pages.<br />
** three additional check boxes are available: <br />
*** include images and media objects: whether to include/exclude a gallery of media objects.<br />
*** include download page: whether to include a database download option.<br />
*** Suppress GRAMPS ID: whether to include the GRAMPS ID of objects.<br />
*Privacy: Privacy of personal information is an important issue on the web today. GRAMPS tries to give you control over the information that is presented.<br />
** check box include records marked private: GRAMPS provides two options to control the privacy of your information. If you do not select the {{man label|Include records marked private}} option, any data that is marked as private will not be displayed on the generated site.<br />
** Living People: The drop down menu let you choose between '''Exclude''', '''Restrict''', and '''Include'''. If you select {{man label|Restrict information on living people}} , GRAMPS will attempt to determine which people have the potential of still being alive, and will omit these people from the database. Some countries have laws that indicate that a certain number of years must pass after someone's death before information can be published.<br />
** Years from death to consider living: in the input field you can give the amount of years to consider. The default value is 30 years. The {{man label|Years to restrict from person's death}} option allows you to specify how many years a person must be deceased before the information is included. Please note that it is your responsibility to double check all information in the pages for any privacy information. GRAMPS cannot be held responsible for any privacy issues.<br />
<br />
* Advanced: in this tab page you can determine which columns will show up in your web pages. those options are controlled via check boxes.<br />
** include a link to home person on every page<br />
** include a column for birth dates on the index pages<br />
** include a column for death dates on the index pages<br />
** include a column for partners on the index pages<br />
** include a column for parents on the index pages<br />
** include a column for half-siblings on the index pages<br />
<br />
* Organization of the web pages. A lot of files and directories are generated. Default you can find this directory structure under the {{man label|NAVWEB}} directory. <br />
** Directories: Following directories are made: ''images'', ''img'', ''plc'', ''ppl'', ''src'', ''srn'', ''thumb''. Each directory contains many subdirectories: /homedir/NAVWEB/src/1/5/15CF2WIFLGOGFRJMLY.html. This last file is unique. If you regenerate web pages or add records and regenerate your web site those file names remain the same.<br />
** HTML files: if you choose to generate HTML files following files will be generated: start page : ''index.html'', ''gallery.html'', if clicked a ''download.html'' page, ''places.html'', ''sources.html'', and ''surname_count.html''.<br />
** CSS files: two style sheet files are generated: ''narrative.css'' and ''narrative-print.css''<br />
<br />
* Customize your CSS files: You can alter and change the made CSS file very easy. The advantage of a style sheet is that changes you do on this text file, you see immediately the effects on the lay-out and color schemes. <br />
<br />
You can customize your style sheet to provide additional formatting and positioning information to control sections.<br />
<br />
{{man tip|Do not forget to check the no style sheet option. Otherwise you will overwrite your custom style sheet.}}<br />
<br />
=== Web Calendar... ===<br />
<br />
<br />
{{man index|Gramps 3.0 Wiki Manual - Gramplets|Gramps 3.0 Wiki Manual - Tools}}<br />
<br />
<br />
[[Category:Documentation]]</div>Simanek