# Detailed plugin option reference

## Reports

### Common Options

`style`: =name

  Style name.

  - default

`pagebbg`: =0/1

  Page break between generations.

`off`: =format

  Output file format.

  - print

  - sxw

  - ps

  - pdf

  - svg

`of`: =filename

  Output file name. MANDATORY

  Value: `/home/shura/whatever_name`

`papero`: =num

  Paper orientation number.

  - 0 Portrait

  - 1 Landscape

`gen`: =num

  Number of generations to follow.

`filter`: =num

  Filter number.

`template`: =name

  Template name (HTML only).

  Value: `/home/shura/whatever_name`

`papers`: =name

  Paper size name.

  - Letter

  - Legal

  - A0

  - A1

  - A2

  - A3

  - A4

  - A5

  - B0

  - B1

  - B2

  - B3

  - B4

  - B5

  - B6

  - B

  - C

  - D

  - E

`dispf`: =str

  Display format for the outputbox.

`id`: =ID

  Gramps ID of a central person. MANDATORY

### Ancestor Chart

`name`:

  ancestor_chart

### Ancestor Chart (Wall Chart)

`name`:

  ancestor_chart2

`singlep`: =0/1

  Whether to scale to fit on a single page.

  1. Do not scale to fit

  2. Scale to fit

`compress`: =0/1

  Whether to compress chart.

  1. Do not compress chart

  2. Compress chart

`title`: =str

  Title string for the report

  Value: `Whatever String You Wish`

### Ahnentafel Report

`name`:

  ancestor_report

### Comprehensive Ancestors Report

`name`:

  ancestors_report

`cites`: =0/1

  Whether to cite sources.

  1. Do not cite sources

  2. Cite sources

### Descendant Graph

`name`:

  descendant_graph

### Descendant Report

`name`:

  descend_report

### Detailed Ancestral Report

`name`:

  det_ancestor_report

`repdate`: =0/1

  Whether to replace missing Dates with blanks.

  1. Do not replace missing Dates

  2. Replace missing Dates

`incsources`: =0/1

  Whether to include source references.

  1. Do not include sources

  2. Include sources

`incphotos`: =0/1

  Whether to include images.

  1. Do not include images

  2. Include images

`desref`: =0/1

  Whether to add descendant references in child list.

  1. Do not add references

  2. Add references

`computeage`: =0/1

  Whether to compute age.

  1. Do not compute age

  2. Compute age

`fulldates`: =0/1

  Whether to use full dates instead of just year.

  1. Do not use full dates

  2. Use full dates

`incnames`: =0/1

  Whether to include other names.

  1. Do not include other names

  2. Include other names

`listc`: =0/1

  Whether to list children.

  1. Do not list children

  2. List children

`incevents`: =0/1

  Whether to include events.

  1. Do not include events

  2. Include events

`usenick`: =0/1

  Whether to use the nick name as the first name.

  1. Do not use nick name

  2. Use nick name

`incnotes`: =0/1

  Whether to include notes.

  1. Do not include notes

  2. Include notes

`omitda`: =0/1

  Whether to omit duplicate ancestors.

  1. Do not omit duplicates

  2. Omit duplicates

`repplace`: =0/1

  Whether to replace missing Places with blanks.

  1. Do not replace missing Places

  2. Replace missing Places

### Detailed Descendant Report

`name`:

  det_descendant_report

`repdate`: =0/1

  Whether to replace missing Dates with blanks.

  1. Do not replace missing Dates

  2. Replace missing Dates

`incsources`: =0/1

  Whether to include source references.

  1. Do not include sources

  2. Include sources

`incphotos`: =0/1

  Whether to include images.

  1. Do not include images

  2. Include images

`desref`: =0/1

  Whether to add descendant references in child list.

  1. Do not add references

  2. Add references

`computeage`: =0/1

  Whether to compute age.

  1. Do not compute age

  2. Compute age

`fulldates`: =0/1

  Whether to use full dates instead of just year.

  1. Do not use full dates

  2. Use full dates

`incnames`: =0/1

  Whether to include other names.

  1. Do not include other names

  2. Include other names

`listc`: =0/1

  Whether to list children.

  1. Do not list children

  2. List children

`incevents`: =0/1

  Whether to include events.

  1. Do not include events

  2. Include events

`usenick`: =0/1

  Whether to use the nick name as the first name.

  1. Do not use nick name

  2. Use nick name

`incnotes`: =0/1

  Whether to include notes.

  1. Do not include notes

  2. Include notes

`omitda`: =0/1

  Whether to omit duplicate ancestors.

  1. Do not omit duplicates

  2. Omit duplicates

`repplace`: =0/1

  Whether to replace missing Places with blanks.

  1. Do not replace missing Places

  2. Replace missing Places

### Family Group Report

`name`:

  family_group

`spouse_id`: =ID

  Gramps ID of the person's spouse.

  Value: `Use show=id to get ID list.`

### Fan Chart

`name`:

  fan_chart

### FTM Style Ancestor Report

`name`:

  ftm_ancestor_report

### FTM Style Descendant Report

`name`:

  ftm_descendant_report

### Relationship Graph

`name`:

  rel_graph

`rankdir`: =str

  Graph direction.

  - LR Horizontal

  - RL Vertical

`justyears`: =0/1

  Whether to use years only.

  1. Do not use years only

  2. Use years only

`latin`: =0/1

  Needs to be set if font doesn't support unicode.

  1. Supports unicode

  2. Supports only Latin1

`arrow`: =str

  Arrow styles for heads and tails.

  - d Descendants <- Ancestors

  - a Descendants -> Ancestors

  - da Descendants <-> Ancestors

  - Descendants - Ancestors

`dashedl`: =0/1

  Whether to use dotted lines for non-birth relationships.

  1. Do not use dotted lines

  2. Use dotted lines

`url`: =0/1

  Whether to include URLs.

  1. Do not include URLs

  2. Include URLs

`pagesh`: =num

  Number of pages in horizontal direction.

  Value: `Integer values`

`placecause`: =0/1

  Whether to replace missing dates with place/cause.

  1. Do not replace blank dates

  2. Replace blank dates

`gvof`: =str

  Output format to convert dot file into.

  - ps Postscript

  - svg Structured Vector Graphics (SVG)

  - svgz Compressed Structured Vector Graphics (SVG)

  - png PNG image

  - jpg JPEG image

  - gif GIF image

`color`: =str

  Whether and how to colorize graph.

  - outline B&W Outline

  - colored Colored outline

  - filled Color fill

`incid`: =0/1

  Whether to include IDs.

  1. Do not include IDs

  2. Include IDs

`incdate`: =0/1

  Whether to include dates.

  1. Do not include dates

  2. Include dates

`pagesv`: =num

  Number of pages in vertical direction.

  Value: `Integer values`

`font`: =str

  Font to use in the report.

  - Default

  - Helvetica Postscript / Helvetica

  - FreeSans Truetype / FreeSans

`margin`: =num

  Margin size.

  Value: `Floating point value, in cm`

`showfamily`: =0/1

  Whether to show family nodes.

  1. Do not show family nodes

  2. Show family nodes

### Relationship Graph

`name`:

  rel_graph2

`rankdir`: =str

  Graph direction.

  - LR Horizontal

  - RL Vertical

`justyears`: =0/1

  Whether to use years only.

  1. Do not use years only

  2. Use years only

`latin`: =0/1

  Needs to be set if font doesn't support unicode.

  1. Supports unicode

  2. Supports only Latin1

`arrow`: =str

  Arrow styles for heads and tails.

  - d Descendants <- Ancestors

  - a Descendants -> Ancestors

  - da Descendants <-> Ancestors

  - Descendants - Ancestors

`dashedl`: =0/1

  Whether to use dotted lines for non-birth relationships.

  1. Do not use dotted lines

  2. Use dotted lines

`url`: =0/1

  Whether to include URLs.

  1. Do not include URLs

  2. Include URLs

`pagesh`: =num

  Number of pages in horizontal direction.

  Value: `Integer values`

`placecause`: =0/1

  Whether to replace missing dates with place/cause.

  1. Do not replace blank dates

  2. Replace blank dates

`gvof`: =str

  Output format to convert dot file into.

  - ps Postscript

  - svg Structured Vector Graphics (SVG)

  - svgz Compressed Structured Vector Graphics (SVG)

  - png PNG image

  - jpg JPEG image

  - gif GIF image

`color`: =str

  Whether and how to colorize graph.

  - outline B&W Outline

  - colored Colored outline

  - filled Color fill

`incid`: =0/1

  Whether to include IDs.

  1. Do not include IDs

  2. Include IDs

`incdate`: =0/1

  Whether to include dates.

  1. Do not include dates

  2. Include dates

`pagesv`: =num

  Number of pages in vertical direction.

  Value: `Integer values`

`font`: =str

  Font to use in the report.

  - Default

  - Helvetica Postscript / Helvetica

  - FreeSans Truetype / FreeSans

`margin`: =num

  Margin size.

  Value: `Floating point value, in cm`

`showfamily`: =0/1

  Whether to show family nodes.

  1. Do not show family nodes

  2. Show family nodes

### Complete Individual Report

`name`:

  indiv_complete

`cites`: =0/1

  Whether to cite sources.

  1. Do not cite sources

  2. Cite sources

### Individual Summary

`name`:

  individual_summary

### Generate Web Site (deprecated)

`name`:

  webpage

`HTMLidurl`: =str

  URL for links from GRAMPS IDs

  Value: `the_url_value`

`HTMLext`: =str

  Extension for generated files

  Value: `Any extension you like: html, htm, php, asp, etc.`

`HTMLimagedir`: =str

  Image subdirectory

  Value: `image_subdir_name`

`HTMLsplita`: =0/1

  Split alphabetical sections to different pages

  1. Do not split sections

  2. Split sections

`HTMLincpriv`: =0/1

  Inclusion of people marked private

  1. Do not include

  2. Include

`HTMLincid`: =0/1

  Include GRAMPS ID in the report

  1. Do not include

  2. Include

`HTMLidxcol`: =num

  Number of columns in the index page

  Value: `Any integer number`

`HTMLcmtxtsi`: =0/1

  Inclusion of comments and text in source information

  1. Do not include

  2. Include

`HTMLlnktoalphabet`: =0/1

  Include links to alphabetical sections in index page

  1. Do not include

  2. Include

`HTMLgendex`: =0/1

  Create a GENDEX index

  1. Do not create

  2. Create

`HTMLtreed`: =num

  Depth of ancestor tree

  Value: `Any integer number`

`HTMLidxt`: =str

  Template name for the index page

  Value: `/full/path/to/the/tpkg`

`HTMLlinktidx`: =0/1

  Include links to the index page

  1. Do not include

  2. Include

`HTMLrestrictinfo`: =0/1

  Restrict information on living people

  1. Do not restrict

  2. Restrict

`HTMLyearso`: =0/1

  Use only birth year on the index page

  1. Use full date

  2. Use just year

`HTMLidxbirth`: =0/1

  Append birth dates to the names on the index page

  1. Do not append

  2. Append

`HTMLshorttree`: =0/1

  Include short ancestor tree

  1. Do not include

  2. Include

`HTMLimg`: =num

  Inclusion of images

  1. No images at all

  2. No images for living people

  3. Images for all people

`HTMLod`: =str

  Output directory for the web site

  Value: `/full/name/of/the/dir`

`HTMLplaceidx`: =0/1

  Create an index of all Places

  1. Do not create

  2. Create

### Book Report

`name`:

  book

`bookname`: =name

  Name of the book. MANDATORY

### Descendant Wall Chart

`name`:

  descend_chart2

`singlep`: =0/1

  Whether to scale to fit on a single page.

  1. Do not scale to fit

  2. Scale to fit

`title`: =str

  Title string for the report

  Value: `Whatever String You Wish`

## Tools

### Common Options

`filter`: =num

  Filter number.

`id`: =ID

  Gramps ID of a central person.

### Rename personal event types

`name`:

  chtype

`fromtype`: =str

  Type of events to replace

  Value: `Event type string`

`totype`: =str

  New type replacing the old one

  Value: `Event type string`

### Check and repair database

`name`:

  check

### Reorder GRAMPS IDs

`name`:

  reorder_ids

### Verify the database

`name`:

  verify

`lngwdw`: =num

  Maximum number of consecutive years of widowhood

  Value: `Number of years`

`mxchildmom`: =num

  Maximum number of children for a woman

  Value: `Number of children`

`wedder`: =num

  Maximum number of spouses for a person

  Value: `Number of spouses`

`mxchilddad`: =num

  Maximum number of children for a man

  Value: `Number of chidlren`

`estimate_age`: =0/1

  Whether to estimate missing dates

  1. Do not estimate

  2. Estimate dates

`yngmar`: =num

  Minimum age to marry

  Value: `Age in years`

`oldmar`: =num

  Maximum age to marry

  Value: `Age in years`

`cbspan`: =num

  Maximum span of years for all children

  Value: `Span in years`

`oldage`: =num

  Maximum age

  Value: `Age in years`

`olddad`: =num

  Maximum age to father a child

  Value: `Age in years`

`hwdif`: =num

  Maximum husband-wife age difference

  Value: `Age difference in years`

`yngmom`: =num

  Minimum age to bear a child

  Value: `Age in years`

`yngdad`: =num

  Minimum age to father a child

  Value: `Age in years`

`oldmom`: =num

  Maximum age to bear a child

  Value: `Age in years`

`cspace`: =num

  Maximum number of years between children

  Value: `Number of years`

### Generate Testcases for persons and families

`name`:

  testcasegenerator

`dates`: =0/1

  Whether to create test for date handling.

  1. Skip test

  2. Create date tests

`person_count`: =int

  Number of dummy persons to generate

  Value: `Number of persons`

`no_trans`: =0/1

  Wheter to use one transaction or multiple small ones

  1. One transaction

  2. Multiple transactions

`long_names`: =0/1

  Wheter to create short or long names

  1. Short names

  2. Long names

`bugs`: =0/1

  Whether to create invalid database references.

  1. Skip test

  2. Create invalid Database references

`persons`: =0/1

  Whether to create a bunch of dummy persons

  1. Dont create persons

  2. Create dummy persons

`add_serial`: =0/1

  Wheter to add a serial number to every text field

  1. No serial

  2. Add serial number

`specialchars`: =0/1

  Wheter to ass some special characters to every text field

  1. No special characters

  2. Add special characters

### Checkpoint the database

`name`:

  chkpoint

`crcmd`: =str

  Custom command line for retrieval

  Value: `Custom command string`

`cacmd`: =str

  Custom command line for archiving

  Value: `Custom command string`

`archive`: =0/1

  Whether to archive or retrieve.

  1. Retrieve

  2. Archive

`rcs`: =0/1

  Whether to use RCS (ignores custom commands).

  1. Do not use RCS

  2. Use RCS

### Rebuild secondary indices

`name`:

  rebuild

### Dumps gender statistics

`name`:

  dgenstats

### Generate Commandline Plugin Reference

`name`:

  cmdref

`include`: =0/1

  Whether to include into the manual

  1. Do not include

  2. Include

`target`: =str

  Pathname to the target file

  Value: `Any valid pathname`