[Gramps-devel] Argument specs for RelGraph.py (Was: [Gramps-users]Creating relationship graph for all, or a loth of persons)

[Frode J. <fro...@sk...>]

Hi all.

Just wants to know if I'm on the right track.

I have looked at the Relationship Graph, and  tried to enter what I found, and 
formated it like Alex's example. I'm not sure about all the short names used 
for the arguments, so if anyone have any bether suggestions, sing out.



Report/Plugin: "Generate files/Relationship graph"
Physical file:  RelGraph.py

Name:  Output filename
Description: What to name the output file
Value:  Output filename:of=/full/path/to/file -- full path and filename

Name:  Output format
Description: Output file format
Value:  output format:format=dot -- This is the only format available

Name:  Paper Options
Description: Paper size, and orientation to use
Value:  Paper size:psize=[Letter|A4|A3|.....|Custom] -- should default to ->
   if LC_PAPER then psize=LC_PAPER else psize=Letter. (?comments)
   Paper orientation:porient=[Landscape|Portrait] -- default to Portrait
   Paper size custom values: pcustx=##.## -- values for paper hight
         pcusty=##.## -- values for paper width
         Should this be inch|mm ?

Name:   Filter
Description: Selecting data scope
Values:  Entire database:ent
   Ancestors:anc,id=ID -- needs person ID
   Descendants:dec,id=ID -- needs person ID
   Descendant family members:dfm,id=ID -- needs person ID
   People with common ancestors:pca,id=ID -- needs person ID

Name:  Generations
Description: Number of generations in the scope
Value:  Number:gen=# -- needs a number between 1-31, default 10

Name:  Font Options
Description: Font to use
Value:  Font:font=[tt|ps] -- tt=TrueType, ps=PostScript -- 
   should we have other options ?

Name:  Arrowhead Options
Description:  Witch way the arrow points
Value:  Arrowhead:arrow=[d|u|b|n] -- d=down, u=up, b=both, n=none 

Name:  Show family
Description: How to display family's
Value:  Show family as:sfa=[s|n] -- s=a stack, n=nodes

Name:  Include IDs
Description: Include IDs in graph
Value:  Include IDs:incid=[true|false] -- default to false

Name:  Include Birth, Marriage and Death Dates
Description: Include dates in graph
Value:  Include dates:incdates=[true|false] -- default to true
   Limit to years:yearsonly=[true|false] -- default to false
   Place/cause when no date:replaceblank=[true|false] -- default to true

Name:  Include URLs
Description: Include URLs to the individual html page in the graph
Value:  URLs:url=[true|false] -- default to true

Name:  Colorize graph
Description: Colorize the graph based on the individuals sex
Value:  Colorize:colorize=[true|false] -- default to true

Name:  Indicate non-birth relationships with dashed lines
Description: Indicate non-birth relationships with dashed lines
Value:  non-birth relationships:dashedlines=[true|false] -- default to true

Name:  Page options
Description: Margins on page, and number of pages
Value:  Top & buttom margins:tbmarg=#.## -- number, should defalt to 0.50
   Left & right margins:lrmarg=#.## -- number, should default to 0.50
   Number of horizontal pages:hpages=# --number, should default to 1
   Number of vertical pages:vpages=# --number, should default to 1

What about the decimal deliminator problem we had a couple of months ago... 
Will this surfice again ?


-- 
-Frode

Friction is a drag.