[[Gramps 3.1 Wiki Manual - Reports - part 1|Generating Reports]]
[[Gramps 3.1 Wiki Manual - Reports - part 2|Substitution Values]]
[[Gramps 3.1 Wiki Manual - Reports - part 3|Books]]
[[Gramps 3.1 Wiki Manual - Reports - part 4|Graphical Reports]]
[[Gramps 3.1 Wiki Manual - Reports - part 5|Graphs]]
[[Gramps 3.1 Wiki Manual - Reports - part 6|Text Reports]]
[[Gramps 3.1 Wiki Manual - Reports - part 7|Web Pages and Quick Reports]]
==Substitution Values==
Many of the graphical reports allow you to customize the information on the display. Variable substitution is used to substitute date for a particular symbol. There are two styles of variables. The difference between the two styles is how empty data is handled.
#The first style of variables are preceded by a '''$'''. The line is printed and the variable is printed as found in your family tree.
#: Example: 'Born: $b' will show as 'Born: 2001' if a birth date is found, and 'Born: ', if no date is found
#The second style of variables are preceded by a '''%'''. If the variable evaluates to an empty string, the ''entire'' line that contains the variable is removed from the output!
#: Example: '$n - Born: %b' will show as 'John Doe - Born: 2001' if a birth date is found, whereas the line will not be present if no date is found
===Overview of the different substitution keys===
*$n/%n
:Displays the person's name in the form of FirstName LastName
*$N/%N
:Displays the person's name in the form of LastName, FirstName
*$i/%i
:Displays the GRAMPS ID associated with the person.
*$b/%b
:Displays the person's date of birth
*$B/%B
:Displays the person's place of birth
*$d/%d
:Displays the person's date of death
*$D/%D
:Displays the person's place of death
*$s/%s
:Displays the name of the person's preferred spouse in the form of FirstName LastName
*$S/%S
:Displays the name of the person's preferred spouse in the form of LastName, FirstName.
*$m/%m
:Displays the marriage date of the person and the preferred spouse.
*$M/%M
:Displays the place associated with the marriage of the person and the preferred spouse.
Substitution values can be combined:e.g.
$n $i
$b $B
$d $D
this will give a lot of information in the displayed boxes.
==Common Options==
# Ancestors of Smith, Edwin Michael
# People with common ancestor with Smith, Edwin Michael
==Books==
[[Image:Bookreport.png|thumb|250x|right|Fig. 8.1 Book report]]
Currently, the only available report under this category is the Book Report.
The Book Report creates a single document (i.e. a Book) containing a collection of graphical and textual reports. Consequently, this allows for a very rich set of documents that GRAMPS can produce.
When '''Reports-->Books-->Book Report...''' is selected, the following {{man label|book configuration}} dialog appears:
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.
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.
{{man tip|Save configuration|Saving the book also saves the configuration for each item.}}
Click the {{man button|Open}} button to load the book (Open previously created book) from the list of previously saved books.
Finally, click the {{man button|Edit books}} button to invoke the editable list of available books (Manage previously created books).
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.
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.
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.
In the lower part of the window you can change some {{man label|Document Options}}:
*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
*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.
Almost all items available for inclusion in the book are textual or graphical reports, and are therefore available in the form of standalone reports. The exception is the following items which are only available as book items:
*Title Page
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.
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).
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.
TODO link to Style Editor window
In the {{man label|Image}} tab an image can be optionally placed between the subtitle and the footer.
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}}
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.
*Custom Text
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.
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 clear="all"/>
==Graphical Reports==
