Gramps 3.4 Wiki Manual - Reports - part 3
This section describes the Book report available in GRAMPS.
|Special copyright notice: All edits to this page need to be under two different copyright licenses:
These licenses allow the Gramps project to maximally use this wiki manual as free content in future Gramps versions. If you do not agree with this dual license, then do not edit this page. You may only link to other pages within the wiki which fall only under the GFDL license via external links (using the syntax: [http://www.gramps-project.org/...]), not via internal links.
Back to Index of Reports.
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 book configuration dialog appears:
The Book name text entry field shows the name of the current book. It may be used to save the book (a set of configured selections) for future use, in which case you may first alter the field to contain whatever name you want. If you load a saved-away book (see below) it will show that book's name -- which may then be changed if you want to save a slightly-different configuration.
The top pane Available items lists the items available for inclusion in the book. The bottom panel Current book lists the currently selected items in the order they will appear in the book.
The left two of the horizontal set of buttons by the Book name field operate on the whole book. Click the Clear button ("clear the book") to clear all items from the current book. Click the Save button ("save current set of configured selections") to save the current book (under the name typed in the Book name text entry field) for future use.
Saving the book also saves the configuration for each item.
The right two of the horizontal set of buttons by the Book name field enable operations upon the whole set of previously-saved books. Click the Open button ("open previously created book") to invoke an Available Books window which shows all your previously-saved books. In that box either double-click on a particular book name or first select it and then hit OK to then load the book.
Or click the Edit books button ("manage previously created books") to invoke a slightly different Available Books window which shows an editable list of available books, in case you want to delete a book you already saved away.
The vertical set of buttons to the right of the bottom pane operates on a selected book item. Click the Add button ("add an item to the book") to add the selected item from the top Available items list to the current book. Double-clicking the (top list's) selected item will also add it. Click the Remove button ("remove currently selected item from the book") to remove an item from the bottom Current book list. Use the Up button ("move current selection one step up in the book") and the Down button ("move current selection one step down in the book") to change the item's order in the current book. Click the Setup button ("configure currently selected item") to configure the options of the selected item of the current book -- but you must select the item first. Double-clicking an item will also start a configuration dialog.
The configuration dialogs invoked by Setup are item-specific. If you choose not to configure the item, some 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 have been made, and possibly configured (or reconfigured) click the OK button. This will invoke another Book Report window. There is one tab with available Paper Options where you can change the Size and Orientation for the Paper Format, and all Margins. A click box is available to use metric values instead.
In the lower part of the window you can change some 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 LibreOffice Word Processor
- Filename: if you choose Open Document Text the default value is /yourhomedir/book.odt, while if you chose PDF document the default value is /yourhomedir/book.pdf instead.
You can edit the name (and directory) to be whatever you want, or you can click the Save as button to invoke a Save As window where 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 (see Index of Reports for their individual documentation). The exceptions are the two following items which are only available as book items, in a book report:
- Title Page
If you selected the Title page item and clicked the Add button to put this item in your book and you click Preferences button (Configure currently selected item) you will get a Title Page window. Two tabs are available: Text and Image. In the Text tab you have three text input fields available where you can change the Title, the subtitle and a Footer (default Copyright <current-year>).
The lower window part shows some Document Options: here you can choose the Style. You can choose the default style or click on the Style Editor... button. This brings up a Style Editor window where you can add and remove Styles.
TODO link to Style Editor window
In the Image tab an image can be optionally placed between the subtitle and the footer. There is Preview facility and with the from gallery... button you can select via the Select Media Object dialogue the image you want. You can also change the Size
Because 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.
- Alphabetical Index
This item produces page(s) with an alphabetical index of people noted into selected textual reports.
- Table of contents (TOC)
This item produces a resume of sections into the generated book.