gramps/src/plugins/DetAncestralReport.py

870 lines
35 KiB
Python
Raw Normal View History

2002-10-20 19:55:16 +05:30
#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2000-2002 Bruce J. DeGrasse
* src/TreeViews/_PersonTreeView.py: Use name_displayer. * src/ReportBase/_ReportUtils.py: Use name_displayer. * src/ReportBase/_CommandLineReport.py: Use name_displayer. * src/ReportBase/_BareReportDialog.py: Use name_displayer. * src/PluginUtils/_Tool.py: Use name_displayer. * src/plugins/TimeLine.py: Use name_displayer. * src/plugins/RelCalc.py: Use name_displayer. * src/plugins/ReadGrdb.py: Use name_displayer. * src/plugins/NarrativeWeb.py: Use name_displayer. * src/plugins/IndivComplete.py: Use name_displayer. * src/plugins/GraphViz.py: Use name_displayer. * src/plugins/FindDupes.py: Use name_displayer. * src/plugins/FamilyGroup.py: Use name_displayer. * src/plugins/DetDescendantReport.py: Use name_displayer. * src/plugins/DetAncestralReport.py: Use name_displayer. * src/plugins/DesGraph.py: Use name_displayer. * src/plugins/DescendReport.py: Use name_displayer. * src/plugins/DescendChart.py: Use name_displayer. * src/plugins/Check.py: Use name_displayer. * src/plugins/Ancestors.py: Use name_displayer. * src/plugins/AncestorReport.py: Use name_displayer. * src/plugins/AncestorChart2.py: Use name_displayer. * src/ObjectSelector/_PersonTreeFrame.py: Use name_displayer. * src/ObjectSelector/_PersonFrame.py: Use name_displayer. * src/Merge/_MergePerson.py: Use name_displayer. * src/GrampsDbUtils/_WriteGedcom.py: Use name_displayer. * src/GrampsDbUtils/_ReadXML.py: Use name_displayer. * src/GrampsDbUtils/_GedcomParse.py: Use name_displayer. * src/FilterEditor/_ShowResults.py: Use name_displayer. * src/FilterEditor/_EditRule.py: Use name_displayer. * src/Editors/_EditPrimary.py: Use name_displayer. * src/Editors/_EditPersonRef.py: Use name_displayer. * src/Editors/_EditPerson.py: Use name_displayer. * src/Editors/_EditName.py: Use name_displayer. * src/Editors/_EditLdsOrd.py: Use name_displayer. * src/Editors/_EditFamily.py: Use name_displayer. * src/DisplayTabs/_PersonRefModel.py: Use name_displayer. * src/DisplayTabs/_NameModel.py: Use name_displayer. * src/DisplayTabs/_ChildModel.py: Use name_displayer. * src/DisplayTabs/_BackRefModel.py: Use name_displayer. * src/DisplayModels/_PeopleModel.py: Use name_displayer. * src/DisplayModels/_FamilyModel.py: Use name_displayer. * src/DataViews/_PersonView.py: Use name_displayer. * src/DataViews/_RelationView.py: Use name_displayer. * src/DataViews/_PedigreeView.py: Use name_displayer. * src/Utils.py: Use name_displayer. * src/SubstKeywords.py: Use name_displayer. * src/Sort.py: Use name_displayer. * src/Reorder.py: Use name_displayer. * src/PageView.py (BookMarkView.add_bookmark): Use name_displayer. * src/Navigation.py: Use name_displayer. * src/DisplayState.py: Use name_displayer. * src/GrampsCfg.py: Use name_displayer. * src/Bookmarks.py (Bookmarks.make_label): Use name_displayer. * src/GrampsDb/Makefile.am (pkgdata_PYTHON): Ship new files. * src/Makefile.am (gdir_PYTHON): Ship ProgressDialog.py svn: r8680
2007-06-28 11:11:40 +05:30
# Copyright (C) 2000-2007 Donald N. Allingham
# Copyright (C) 2007-2008 Brian G. Matherly
2002-10-20 19:55:16 +05:30
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# $Id$
2002-10-20 19:55:16 +05:30
"Generate files/Detailed Ancestral Report"
#------------------------------------------------------------------------
#
# standard python modules
#
#------------------------------------------------------------------------
from gettext import gettext as _
2002-10-20 19:55:16 +05:30
#------------------------------------------------------------------------
#
# GRAMPS modules
#
#------------------------------------------------------------------------
import gen.lib
from PluginUtils import register_report, NumberOption, \
BooleanOption, PersonOption
from ReportBase import Report, ReportUtils, MenuReportOptions, \
CATEGORY_TEXT, MODE_GUI, MODE_BKI, MODE_CLI
from ReportBase import Bibliography, Endnotes
import BaseDoc
import DateHandler
* src/TreeViews/_PersonTreeView.py: Use name_displayer. * src/ReportBase/_ReportUtils.py: Use name_displayer. * src/ReportBase/_CommandLineReport.py: Use name_displayer. * src/ReportBase/_BareReportDialog.py: Use name_displayer. * src/PluginUtils/_Tool.py: Use name_displayer. * src/plugins/TimeLine.py: Use name_displayer. * src/plugins/RelCalc.py: Use name_displayer. * src/plugins/ReadGrdb.py: Use name_displayer. * src/plugins/NarrativeWeb.py: Use name_displayer. * src/plugins/IndivComplete.py: Use name_displayer. * src/plugins/GraphViz.py: Use name_displayer. * src/plugins/FindDupes.py: Use name_displayer. * src/plugins/FamilyGroup.py: Use name_displayer. * src/plugins/DetDescendantReport.py: Use name_displayer. * src/plugins/DetAncestralReport.py: Use name_displayer. * src/plugins/DesGraph.py: Use name_displayer. * src/plugins/DescendReport.py: Use name_displayer. * src/plugins/DescendChart.py: Use name_displayer. * src/plugins/Check.py: Use name_displayer. * src/plugins/Ancestors.py: Use name_displayer. * src/plugins/AncestorReport.py: Use name_displayer. * src/plugins/AncestorChart2.py: Use name_displayer. * src/ObjectSelector/_PersonTreeFrame.py: Use name_displayer. * src/ObjectSelector/_PersonFrame.py: Use name_displayer. * src/Merge/_MergePerson.py: Use name_displayer. * src/GrampsDbUtils/_WriteGedcom.py: Use name_displayer. * src/GrampsDbUtils/_ReadXML.py: Use name_displayer. * src/GrampsDbUtils/_GedcomParse.py: Use name_displayer. * src/FilterEditor/_ShowResults.py: Use name_displayer. * src/FilterEditor/_EditRule.py: Use name_displayer. * src/Editors/_EditPrimary.py: Use name_displayer. * src/Editors/_EditPersonRef.py: Use name_displayer. * src/Editors/_EditPerson.py: Use name_displayer. * src/Editors/_EditName.py: Use name_displayer. * src/Editors/_EditLdsOrd.py: Use name_displayer. * src/Editors/_EditFamily.py: Use name_displayer. * src/DisplayTabs/_PersonRefModel.py: Use name_displayer. * src/DisplayTabs/_NameModel.py: Use name_displayer. * src/DisplayTabs/_ChildModel.py: Use name_displayer. * src/DisplayTabs/_BackRefModel.py: Use name_displayer. * src/DisplayModels/_PeopleModel.py: Use name_displayer. * src/DisplayModels/_FamilyModel.py: Use name_displayer. * src/DataViews/_PersonView.py: Use name_displayer. * src/DataViews/_RelationView.py: Use name_displayer. * src/DataViews/_PedigreeView.py: Use name_displayer. * src/Utils.py: Use name_displayer. * src/SubstKeywords.py: Use name_displayer. * src/Sort.py: Use name_displayer. * src/Reorder.py: Use name_displayer. * src/PageView.py (BookMarkView.add_bookmark): Use name_displayer. * src/Navigation.py: Use name_displayer. * src/DisplayState.py: Use name_displayer. * src/GrampsCfg.py: Use name_displayer. * src/Bookmarks.py (Bookmarks.make_label): Use name_displayer. * src/GrampsDb/Makefile.am (pkgdata_PYTHON): Ship new files. * src/Makefile.am (gdir_PYTHON): Ship ProgressDialog.py svn: r8680
2007-06-28 11:11:40 +05:30
from BasicUtils import name_displayer as _nd
2002-10-20 19:55:16 +05:30
#------------------------------------------------------------------------
#
# Constants
#
#------------------------------------------------------------------------
EMPTY_ENTRY = "_____________"
2002-10-20 19:55:16 +05:30
#------------------------------------------------------------------------
#
#
#
#------------------------------------------------------------------------
class DetAncestorReport(Report):
2003-02-16 04:33:48 +05:30
def __init__(self,database,person,options_class):
"""
Creates the DetAncestorReport object that produces the report.
The arguments are:
database - the GRAMPS database instance
person - currently selected person
options_class - instance of the Options class for this report
This report needs the following parameters (class variables)
that come in the options class.
gen - Maximum number of generations to include.
pagebgg - Whether to include page breaks between generations.
firstName - Whether to use first names instead of pronouns.
fullDate - Whether to use full dates instead of just year.
listChildren - Whether to list children.
includeNotes - Whether to include notes.
includeAttrs - Whether to include attributes
blankPlace - Whether to replace missing Places with ___________.
blankDate - Whether to replace missing Dates with ___________.
calcAgeFlag - Whether to compute age.
dupPerson - Whether to omit duplicate ancestors (e.g. when distant cousins mary).
verbose - Whether to use complete sentences
childRef - Whether to add descendant references in child list.
addImages - Whether to include images.
pid - The Gramps ID of the center person for the report.
"""
Report.__init__(self,database,person,options_class)
2002-10-20 19:55:16 +05:30
self.map = {}
self.max_generations = options_class.handler.options_dict['gen']
self.pgbrk = options_class.handler.options_dict['pagebbg']
self.fullDate = options_class.handler.options_dict['fulldates']
self.listChildren = options_class.handler.options_dict['listc']
self.includeNotes = options_class.handler.options_dict['incnotes']
self.usecall = options_class.handler.options_dict['usecall']
self.blankPlace = options_class.handler.options_dict['repplace']
self.blankDate = options_class.handler.options_dict['repdate']
self.calcAgeFlag = options_class.handler.options_dict['computeage']
self.dupPerson = options_class.handler.options_dict['omitda']
self.verbose = options_class.handler.options_dict['verbose']
self.childRef = options_class.handler.options_dict['desref']
self.addImages = options_class.handler.options_dict['incphotos']
self.includeNames = options_class.handler.options_dict['incnames']
self.includeEvents = options_class.handler.options_dict['incevents']
self.includeAddr = options_class.handler.options_dict['incaddresses']
self.includeSources= options_class.handler.options_dict['incsources']
self.includeAttrs = options_class.handler.options_dict['incattrs']
pid = options_class.handler.options_dict['pid']
self.center_person = database.get_person_from_gramps_id(pid)
self.gen_handles = {}
self.prev_gen_handles= {}
if self.blankDate:
self.EMPTY_DATE = EMPTY_ENTRY
else:
self.EMPTY_DATE = ""
if self.blankPlace:
self.EMPTY_PLACE = EMPTY_ENTRY
else:
self.EMPTY_PLACE = ""
2002-10-20 19:55:16 +05:30
self.bibli = Bibliography(Bibliography.MODE_PAGE)
def apply_filter(self,person_handle,index):
if (not person_handle) or (index >= 2**self.max_generations):
2002-10-20 19:55:16 +05:30
return
self.map[index] = person_handle
2002-10-20 19:55:16 +05:30
person = self.database.get_person_from_handle(person_handle)
family_handle = person.get_main_parents_family_handle()
if family_handle:
* PeopleModel.py: simplify model interface * EditPerson.py: get_family_from_handle fixes * EditSource.py: get_family_from_handle fixes * GraphLayout.py: get_family_from_handle fixes * ImageSelect.py: get_family_from_handle fixes * MediaView.py: get_family_from_handle fixes * MergeData.py: get_family_from_handle fixes * PlaceView.py: get_family_from_handle fixes * ReadXML.py: get_family_from_handle fixes * RelLib.py: get_family_from_handle fixes * Relationship.py: get_family_from_handle fixes * SelectChild.py: get_family_from_handle fixes * SourceView.py: get_family_from_handle fixes * SubstKeywords.py: get_family_from_handle fixes * WriteXML.py: get_family_from_handle fixes * gramps_main.py: get_family_from_handle fixes * plugins/AncestorChart.py: get_family_from_handle fixes * plugins/AncestorChart2.py: get_family_from_handle fixes * plugins/AncestorReport.py: get_family_from_handle fixes * plugins/Ancestors.py: get_family_from_handle fixes * plugins/Check.py: get_family_from_handle fixes * plugins/CountAncestors.py: get_family_from_handle fixes * plugins/Desbrowser.py: get_family_from_handle fixes * plugins/DescendReport.py: get_family_from_handle fixes * plugins/DetAncestralReport.py: get_family_from_handle fixes * plugins/DetDescendantReport.py: get_family_from_handle fixes * plugins/FamilyGroup.py: get_family_from_handle fixes * plugins/FanChart.py: get_family_from_handle fixes * plugins/FtmStyleAncestors.py: get_family_from_handle fixes * plugins/FtmStyleDescendants.py: get_family_from_handle fixes * plugins/GraphViz.py: get_family_from_handle fixes * plugins/IndivComplete.py: get_family_from_handle fixes * plugins/IndivSummary.py: get_family_from_handle fixes * plugins/Merge.py: get_family_from_handle fixes * plugins/RelGraph.py: get_family_from_handle fixes * plugins/Verify.py: get_family_from_handle fixes * plugins/WebPage.py: get_family_from_handle fixes * plugins/WriteCD.py: get_family_from_handle fixes * plugins/WritePkg.py: get_family_from_handle fixes * plugins/rel_de.py: get_family_from_handle fixes * plugins/rel_hu.py: get_family_from_handle fixes * plugins/rel_ru.py: get_family_from_handle fixes svn: r3443
2004-08-20 03:05:16 +05:30
family = self.database.get_family_from_handle(family_handle)
self.apply_filter(family.get_father_handle(),index*2)
self.apply_filter(family.get_mother_handle(),(index*2)+1)
2002-10-20 19:55:16 +05:30
def write_report(self):
self.apply_filter(self.center_person.get_handle(),1)
2002-10-20 19:55:16 +05:30
name = _nd.display_name(self.center_person.get_primary_name())
self.doc.start_paragraph("DAR-Title")
2005-12-06 12:08:09 +05:30
title = _("Ancestral Report for %s") % name
2006-06-04 09:56:28 +05:30
mark = BaseDoc.IndexMark(title,BaseDoc.INDEX_TYPE_TOC,1)
self.doc.write_text(title,mark)
self.doc.end_paragraph()
keys = self.map.keys()
keys.sort()
generation = 0
need_header = 1
for key in keys :
if generation == 0 or key >= 2**generation:
if self.pgbrk and generation > 0:
self.doc.page_break()
self.doc.start_paragraph("DAR-Generation")
2005-12-06 12:08:09 +05:30
text = _("Generation %d") % (generation+1)
2006-06-04 09:56:28 +05:30
mark = BaseDoc.IndexMark(text,BaseDoc.INDEX_TYPE_TOC,2)
self.doc.write_text(text,mark)
self.doc.end_paragraph()
generation = generation + 1
if self.childRef:
self.prev_gen_handles= self.gen_handles.copy()
self.gen_handles.clear()
person_handle = self.map[key]
person = self.database.get_person_from_handle(person_handle)
self.gen_handles[person_handle] = key
dupPerson = self.write_person(key)
if dupPerson == 0: # Is this a duplicate ind record
if self.listChildren or self.includeEvents:
for family_handle in person.get_family_handle_list():
family = self.database.get_family_from_handle(family_handle)
mother_handle = family.get_mother_handle()
if mother_handle == None or \
person.get_gender() == gen.lib.Person.FEMALE:
if self.listChildren:
self.write_children(family)
if self.includeEvents:
self.write_family_events(family)
if self.includeSources:
Endnotes.write_endnotes(self.bibli,self.database,self.doc)
def write_person(self, key):
"""Output birth, death, parentage, marriage and notes information """
person_handle = self.map[key]
person = self.database.get_person_from_handle(person_handle)
2005-12-06 12:08:09 +05:30
plist = person.get_media_list()
if self.addImages and len(plist) > 0:
photo = plist[0]
ReportUtils.insert_image(self.database,self.doc,photo)
self.doc.start_paragraph("DAR-First-Entry","%s." % str(key))
2005-12-06 12:08:09 +05:30
name = _nd.display_formal(person)
mark = ReportUtils.get_person_mark(self.database, person)
self.doc.start_bold()
self.doc.write_text(name,mark)
2005-12-06 12:08:09 +05:30
if name[-1:] == '.':
self.doc.write_text("%s " % self.endnotes(person))
2005-12-06 12:08:09 +05:30
else:
self.doc.write_text("%s. " % self.endnotes(person))
self.doc.end_bold()
if self.dupPerson:
# Check for duplicate record (result of distant cousins marrying)
keys = self.map.keys()
keys.sort()
for dkey in keys:
if dkey >= key:
break
if self.map[key] == self.map[dkey]:
2005-12-06 12:08:09 +05:30
self.doc.write_text(
_("%(name)s is the same person as [%(id_str)s].") %
{ 'name' : '', 'id_str' : str(dkey) })
self.doc.end_paragraph()
return 1 # Duplicate person
# Check birth record
2005-12-06 12:08:09 +05:30
first = ReportUtils.common_name(person,self.usecall)
if not self.verbose:
self.write_parents(person, first)
text = ReportUtils.born_str(self.database,person,first,self.verbose,
2005-12-06 12:08:09 +05:30
self.EMPTY_DATE,self.EMPTY_PLACE)
if text:
birth_ref = person.get_birth_ref()
if birth_ref:
birth = self.database.get_event_from_handle(birth_ref.ref)
text = text.rstrip(". ")
text = text + self.endnotes(birth) + ". "
self.doc.write_text(text)
2005-12-06 12:08:09 +05:30
first = 0
age,units = self.calc_age(person)
text = ReportUtils.died_str(self.database,person,first,self.verbose,
self.EMPTY_DATE,self.EMPTY_PLACE,age,units)
2005-12-06 12:08:09 +05:30
if text:
death_ref = person.get_death_ref()
if death_ref:
death = self.database.get_event_from_handle(death_ref.ref)
text = text.rstrip(". ")
text = text + self.endnotes(death) + ". "
self.doc.write_text(text)
2005-12-06 12:08:09 +05:30
first = 0
2005-12-06 12:08:09 +05:30
text = ReportUtils.buried_str(self.database,person,first,
self.EMPTY_DATE,self.EMPTY_PLACE)
if text:
self.doc.write_text(text)
first = ReportUtils.common_name(person,self.usecall)
2005-12-06 12:08:09 +05:30
if self.verbose:
self.write_parents(person, first)
if not key % 2 or key == 1:
self.write_marriage(person)
self.doc.end_paragraph()
if key == 1:
self.write_mate(person)
2007-03-27 09:48:14 +05:30
notelist = person.get_note_list()
if len(notelist) > 0 and self.includeNotes:
self.doc.start_paragraph("DAR-NoteHeader")
self.doc.write_text(_("Notes for %s") % name)
self.doc.end_paragraph()
2007-03-27 09:48:14 +05:30
for notehandle in notelist:
note = self.database.get_note_from_handle(notehandle)
self.doc.write_note(note.get(),note.get_format(),"DAR-Entry")
2005-12-06 12:08:09 +05:30
first = True
if self.includeNames:
for alt_name in person.get_alternate_names():
if first:
self.doc.start_paragraph('DAR-MoreHeader')
self.doc.write_text(_('More about %(person_name)s:') % {
'person_name' : name })
self.doc.end_paragraph()
2005-12-06 12:08:09 +05:30
first = False
self.doc.start_paragraph('DAR-MoreDetails')
atype = str( alt_name.get_type() )
2005-12-06 12:08:09 +05:30
self.doc.write_text(
_('%(name_kind)s: %(name)s%(endnotes)s') % {
'name_kind' : atype,
'name' : alt_name.get_regular_name(),
'endnotes' : self.endnotes(alt_name),
})
self.doc.end_paragraph()
if self.includeEvents:
birth_ref = person.get_birth_ref()
death_ref = person.get_death_ref()
for event_ref in person.get_primary_event_ref_list():
if event_ref == birth_ref or event_ref == death_ref:
continue
if first:
self.doc.start_paragraph('DAR-MoreHeader')
self.doc.write_text(_('More about %(person_name)s:') % {
2005-12-06 12:08:09 +05:30
'person_name' : _nd.display(person) })
self.doc.end_paragraph()
first = 0
self.write_event(event_ref)
if self.includeAddr:
for addr in person.get_address_list():
if first:
self.doc.start_paragraph('DAR-MoreHeader')
self.doc.write_text(_('More about %(person_name)s:') % {
'person_name' : name })
self.doc.end_paragraph()
first = False
self.doc.start_paragraph('DAR-MoreDetails')
text = ReportUtils.get_address_str(addr)
date = DateHandler.get_date(addr)
self.doc.write_text(_('Address: '))
if date:
self.doc.write_text( '%s, ' % date )
self.doc.write_text( text )
self.doc.write_text( self.endnotes(addr) )
self.doc.end_paragraph()
if self.includeAttrs:
attrs = person.get_attribute_list()
if first and attrs:
self.doc.start_paragraph('DAR-MoreHeader')
self.doc.write_text(_('More about %(person_name)s:') % {
'person_name' : name })
self.doc.end_paragraph()
first = False
for attr in attrs:
self.doc.start_paragraph('DAR-MoreDetails')
text = _("%(type)s: %(value)s%(endnotes)s") % {
'type' : attr.get_type(),
'value' : attr.get_value(),
'endnotes' : self.endnotes(attr) }
self.doc.write_text( text )
self.doc.end_paragraph()
return 0 # Not duplicate person
def write_event(self, event_ref):
text = ""
event = self.database.get_event_from_handle(event_ref.ref)
date = DateHandler.get_date(event)
ph = event.get_place_handle()
if ph:
place = self.database.get_place_from_handle(ph).get_title()
else:
place = u''
self.doc.start_paragraph('DAR-MoreDetails')
evtName = str( event.get_type() )
if date and place:
text += _('%(event_name)s: %(date)s, %(place)s') % {
'event_name' : _(evtName),
'date' : date,
'place' : place }
elif date:
text += _('%(event_name)s: %(date)s') % {
'event_name' : _(evtName),
'date' : date}
elif place:
text += _('%(event_name)s: %(place)s') % {
'event_name' : _(evtName),
'place' : place }
else:
text += _('%(event_name)s: ') % {'event_name' : _(evtName)}
if event.get_description():
if text:
text += ". "
text += event.get_description()
if text:
text += _('%(endnotes)s.') % { 'endnotes' : self.endnotes(event) }
self.doc.write_text(text)
if self.includeAttrs:
text = ""
attr_list = event.get_attribute_list()
attr_list.extend(event_ref.get_attribute_list())
for attr in attr_list:
if text:
text += "; "
text += _("%(type)s: %(value)s%(endnotes)s") % {
'type' : attr.get_type(),
'value' : attr.get_value(),
'endnotes' : self.endnotes(attr) }
text = " " + text
self.doc.write_text(text)
self.doc.end_paragraph()
if self.includeNotes:
# if the event or event reference has a note attached to it,
# get the text and format it correctly
notelist = event.get_note_list()
notelist.extend(event_ref.get_note_list())
for notehandle in notelist:
note = self.database.get_note_from_handle(notehandle)
self.doc.start_paragraph('DAR-MoreDetails')
self.doc.write_text(note.get())
self.doc.end_paragraph()
def write_parents(self, person, firstName):
family_handle = person.get_main_parents_family_handle()
if family_handle:
family = self.database.get_family_from_handle(family_handle)
mother_handle = family.get_mother_handle()
father_handle = family.get_father_handle()
if mother_handle:
mother = self.database.get_person_from_handle(mother_handle)
mother_name = _nd.display_name(mother.get_primary_name())
mother_mark = ReportUtils.get_person_mark(self.database, mother)
else:
mother_name = ""
mother_mark = ""
if father_handle:
father = self.database.get_person_from_handle(father_handle)
father_name = _nd.display_name(father.get_primary_name())
father_mark = ReportUtils.get_person_mark(self.database, father)
else:
father_name = ""
father_mark = ""
2005-12-06 12:08:09 +05:30
text = ReportUtils.child_str(person, father_name, mother_name,
bool(person.get_death_ref()),
firstName,self.verbose)
if text:
self.doc.write_text(text)
if father_mark:
self.doc.write_text("",father_mark)
if mother_mark:
self.doc.write_text("",mother_mark)
def write_marriage(self, person):
"""
Output marriage sentence.
"""
is_first = True
for family_handle in person.get_family_handle_list():
family = self.database.get_family_from_handle(family_handle)
spouse_handle = ReportUtils.find_spouse(person,family)
spouse = self.database.get_person_from_handle(spouse_handle)
text = ""
spouse_mark = ReportUtils.get_person_mark(self.database, spouse)
text = ReportUtils.married_str(self.database,person,family,
self.verbose,
self.endnotes,
self.EMPTY_DATE,self.EMPTY_PLACE,
is_first)
if text:
self.doc.write_text(text,spouse_mark)
is_first = False
def write_children(self, family):
""" List children.
2002-10-20 19:55:16 +05:30
"""
if not family.get_child_ref_list():
return
mother_handle = family.get_mother_handle()
if mother_handle:
mother = self.database.get_person_from_handle(mother_handle)
mother_name = _nd.display(mother)
else:
mother_name = _("unknown")
father_handle = family.get_father_handle()
if father_handle:
father = self.database.get_person_from_handle(father_handle)
father_name = _nd.display(father)
else:
father_name = _("unknown")
2002-10-20 19:55:16 +05:30
self.doc.start_paragraph("DAR-ChildTitle")
self.doc.write_text(
_("Children of %(mother_name)s and %(father_name)s") %
{'father_name': father_name,
'mother_name': mother_name} )
self.doc.end_paragraph()
2005-12-06 12:08:09 +05:30
cnt = 1
for child_ref in family.get_child_ref_list():
child_handle = child_ref.ref
child = self.database.get_person_from_handle(child_handle)
child_name = _nd.display(child)
child_mark = ReportUtils.get_person_mark(self.database,child)
2002-10-20 19:55:16 +05:30
if self.childRef and self.prev_gen_handles.get(child_handle):
2005-12-06 12:08:09 +05:30
value = str(self.prev_gen_handles.get(child_handle))
child_name += " [%s]" % value
2005-12-06 12:08:09 +05:30
self.doc.start_paragraph("DAR-ChildList",ReportUtils.roman(cnt).lower() + ".")
cnt += 1
self.doc.write_text("%s. " % child_name,child_mark)
self.doc.write_text(
ReportUtils.born_str(self.database, child, 0,
self.verbose, self.EMPTY_DATE, self.EMPTY_PLACE))
self.doc.write_text(
ReportUtils.died_str(self.database, child, 0,
self.verbose, self.EMPTY_DATE, self.EMPTY_PLACE))
2005-12-06 12:08:09 +05:30
self.doc.end_paragraph()
2002-10-20 19:55:16 +05:30
def write_family_events(self,family):
if not family.get_event_ref_list():
return
mother_handle = family.get_mother_handle()
if mother_handle:
mother = self.database.get_person_from_handle(mother_handle)
mother_name = _nd.display(mother)
else:
mother_name = _("unknown")
father_handle = family.get_father_handle()
if father_handle:
father = self.database.get_person_from_handle(father_handle)
father_name = _nd.display(father)
else:
father_name = _("unknown")
first = 1
for event_ref in family.get_event_ref_list():
if first:
self.doc.start_paragraph('DAR-MoreHeader')
self.doc.write_text(
_('More about %(mother_name)s and %(father_name)s:') % {
'mother_name' : mother_name,
'father_name' : father_name })
self.doc.end_paragraph()
first = 0
self.write_event(event_ref)
def write_mate(self, mate):
2002-10-20 19:55:16 +05:30
"""Output birth, death, parentage, marriage and notes information """
for family_handle in mate.get_family_handle_list():
family = self.database.get_family_from_handle(family_handle)
person_name = ""
ind_handle = None
has_info = False
person_key = ""
if mate.get_gender() == gen.lib.Person.MALE:
ind_handle = family.get_mother_handle()
else:
ind_handle = family.get_father_handle()
if ind_handle:
ind = self.database.get_person_from_handle(ind_handle)
person_name = _nd.display(ind)
person_mark = ReportUtils.get_person_mark(self.database,ind)
firstName = ReportUtils.common_name(ind,self.usecall)
for event_ref in ind.get_primary_event_ref_list():
event = self.database.get_event_from_handle(event_ref.ref)
if event:
etype = event.get_type()
if etype == gen.lib.EventType.BURIAL or \
etype == gen.lib.EventType.BIRTH or \
etype == gen.lib.EventType.DEATH :
has_info = True
break
if not has_info:
family_handle = ind.get_main_parents_family_handle()
if family_handle:
f = self.database.get_family_from_handle(family_handle)
if f.get_mother_handle() or f.get_father_handle():
has_info = True
2005-12-06 12:08:09 +05:30
else:
firstName = 0
print_name = ""
if person_name and has_info:
self.doc.start_paragraph("DAR-Entry")
2002-10-20 19:55:16 +05:30
self.doc.write_text(person_name,person_key)
self.doc.write_text(". ")
text = ReportUtils.born_str(self.database,ind,print_name,
self.verbose, self.EMPTY_DATE,self.EMPTY_PLACE)
if text:
self.doc.write_text(text)
print_name = 0;
age,units = self.calc_age(ind)
text = ReportUtils.died_str(self.database,ind,print_name,
self.verbose, self.EMPTY_DATE,self.EMPTY_PLACE,
age,units)
if text:
self.doc.write_text(text)
print_name = 0;
text = ReportUtils.buried_str(self.database,ind,print_name,
self.EMPTY_DATE,self.EMPTY_PLACE)
if text:
self.doc.write_text(text)
print_name = 0;
if print_name == 0:
print_name = firstName
self.write_parents(ind, print_name)
2002-10-20 19:55:16 +05:30
self.doc.end_paragraph()
if person_name and mate.get_gender()==gen.lib.Person.MALE:
if self.listChildren:
self.write_children(family)
if self.includeEvents:
self.write_family_events(family)
2002-10-20 19:55:16 +05:30
def calc_age(self,ind):
"""
Calulate age.
Returns a tuple (age,units) where units is an integer representing
time units:
no age info: 0
years: 1
months: 2
days: 3
"""
if self.calcAgeFlag:
return ReportUtils.old_calc_age(self.database,ind)
else:
return (0,0)
def endnotes(self,obj):
2005-12-06 12:08:09 +05:30
if not obj or not self.includeSources:
return ""
txt = Endnotes.cite_source(self.bibli,obj)
if txt:
txt = '<super>' + txt + '</super>'
return txt
#------------------------------------------------------------------------
#
# DetAncestorOptions
#
#------------------------------------------------------------------------
class DetAncestorOptions(MenuReportOptions):
"""
Defines options and provides handling interface.
"""
def __init__(self,name,dbstate=None):
MenuReportOptions.__init__(self,name,dbstate)
def add_menu_options(self,menu,dbstate):
category_name = _("Report Options")
pid = PersonOption(_("Center Person"))
pid.set_help(_("The center person for the report"))
menu.add_option(category_name, "pid", pid)
gen = NumberOption(_("Generations"),10,1,100)
gen.set_help(_("The number of generations to include in the report"))
menu.add_option(category_name,"gen",gen)
pagebbg = BooleanOption(_("Page break between generations"),False)
pagebbg.set_help(
_("Whether to start a new page after each generation."))
menu.add_option(category_name,"pagebbg",pagebbg)
category_name = _("Content")
usecall = BooleanOption(_("Use callname for common name"),False)
usecall.set_help(_("Whether to use the call name as the first name."))
menu.add_option(category_name,"usecall",usecall)
fulldates = BooleanOption(
_("Use full dates instead of only the year"),True)
fulldates.set_help(_("Whether to use full dates instead of just year."))
menu.add_option(category_name,"fulldates",fulldates)
listc = BooleanOption(_("List children"),True)
listc.set_help(_("Whether to list children."))
menu.add_option(category_name,"listc",listc)
computeage = BooleanOption(_("Compute age"),True)
computeage.set_help(_("Whether to compute age."))
menu.add_option(category_name,"computeage",computeage)
omitda = BooleanOption(_("Omit duplicate ancestors"),True)
omitda.set_help(_("Whether to omit duplicate ancestors."))
menu.add_option(category_name,"omitda",omitda)
verbose = BooleanOption(_("Use Complete Sentences"),True)
verbose.set_help(
_("Whether to use complete sentences or succinct language."))
menu.add_option(category_name,"verbose",verbose)
desref = BooleanOption(_("Add descendant reference in child list"),True)
desref.set_help(
_("Whether to add descendant references in child list."))
menu.add_option(category_name,"desref",desref)
category_name = _("Include")
incnotes = BooleanOption(_("Include notes"),True)
incnotes.set_help(_("Whether to include notes."))
menu.add_option(category_name,"incnotes",incnotes)
incattrs = BooleanOption(_("Include attributes"),False)
incattrs.set_help(_("Whether to include attributes."))
menu.add_option(category_name,"incattrs",incattrs)
incphotos = BooleanOption(_("Include Photo/Images from Gallery"),False)
incphotos.set_help(_("Whether to include images."))
menu.add_option(category_name,"incphotos",incphotos)
incnames = BooleanOption(_("Include alternative names"),False)
incnames.set_help(_("Whether to include other names."))
menu.add_option(category_name,"incnames",incnames)
incevents = BooleanOption(_("Include events"),False)
incevents.set_help(_("Whether to include events."))
menu.add_option(category_name,"incevents",incevents)
incaddresses = BooleanOption(_("Include addresses"),False)
incaddresses.set_help(_("Whether to include addresses."))
menu.add_option(category_name,"incaddresses",incaddresses)
incsources = BooleanOption(_("Include sources"),False)
incsources.set_help(_("Whether to include source references."))
menu.add_option(category_name,"incsources",incsources)
category_name = _("Missing information")
repplace = BooleanOption(_("Replace missing places with ______"),False)
repplace.set_help(_("Whether to replace missing Places with blanks."))
menu.add_option(category_name,"repplace",repplace)
repdate = BooleanOption(_("Replace missing dates with ______"),False)
repdate.set_help(_("Whether to replace missing Dates with blanks."))
menu.add_option(category_name,"repdate",repdate)
def make_default_style(self,default_style):
"""Make the default output style for the Detailed Ancestral Report"""
font = BaseDoc.FontStyle()
font.set(face=BaseDoc.FONT_SANS_SERIF,size=16,bold=1)
para = BaseDoc.ParagraphStyle()
para.set_font(font)
para.set_header_level(1)
2005-12-06 12:08:09 +05:30
para.set_top_margin(0.25)
para.set_bottom_margin(0.25)
2006-06-04 09:56:28 +05:30
para.set_alignment(BaseDoc.PARA_ALIGN_CENTER)
para.set_description(_('The style used for the title of the page.'))
default_style.add_paragraph_style("DAR-Title",para)
font = BaseDoc.FontStyle()
font.set(face=BaseDoc.FONT_SANS_SERIF,size=14,italic=1)
para = BaseDoc.ParagraphStyle()
para.set_font(font)
para.set_header_level(2)
2005-12-06 12:08:09 +05:30
para.set_top_margin(0.25)
para.set_bottom_margin(0.25)
para.set_description(_('The style used for the generation header.'))
default_style.add_paragraph_style("DAR-Generation",para)
font = BaseDoc.FontStyle()
2005-12-06 12:08:09 +05:30
font.set(face=BaseDoc.FONT_SANS_SERIF,size=10,italic=0, bold=1)
para = BaseDoc.ParagraphStyle()
para.set_font(font)
para.set_left_margin(1.0) # in centimeters
2005-12-06 12:08:09 +05:30
para.set_top_margin(0.25)
para.set_bottom_margin(0.25)
para.set_description(_('The style used for the children list title.'))
default_style.add_paragraph_style("DAR-ChildTitle",para)
font = BaseDoc.FontStyle()
2005-12-06 12:08:09 +05:30
font.set(size=10)
para = BaseDoc.ParagraphStyle()
para.set_font(font)
2005-12-06 12:08:09 +05:30
para.set(first_indent=-0.75,lmargin=1.75)
para.set_top_margin(0.25)
para.set_bottom_margin(0.25)
para.set_description(_('The style used for the children list.'))
default_style.add_paragraph_style("DAR-ChildList",para)
2005-12-06 12:08:09 +05:30
font = BaseDoc.FontStyle()
font.set(face=BaseDoc.FONT_SANS_SERIF,size=10,italic=0, bold=1)
para = BaseDoc.ParagraphStyle()
2005-12-06 12:08:09 +05:30
para.set_font(font)
para.set(first_indent=0.0,lmargin=1.0)
para.set_top_margin(0.25)
para.set_bottom_margin(0.25)
default_style.add_paragraph_style("DAR-NoteHeader",para)
para = BaseDoc.ParagraphStyle()
2005-12-06 12:08:09 +05:30
para.set(lmargin=1.0)
para.set_top_margin(0.25)
para.set_bottom_margin(0.25)
para.set_description(_('The basic style used for the text display.'))
default_style.add_paragraph_style("DAR-Entry",para)
para = BaseDoc.ParagraphStyle()
2005-12-06 12:08:09 +05:30
para.set(first_indent=-1.0,lmargin=1.0)
para.set_top_margin(0.25)
para.set_bottom_margin(0.25)
para.set_description(_('The style used for the first personal entry.'))
default_style.add_paragraph_style("DAR-First-Entry",para)
font = BaseDoc.FontStyle()
2005-12-06 12:08:09 +05:30
font.set(size=10,face=BaseDoc.FONT_SANS_SERIF,bold=1)
para = BaseDoc.ParagraphStyle()
para.set_font(font)
2005-12-06 12:08:09 +05:30
para.set(first_indent=0.0,lmargin=1.0)
para.set_top_margin(0.25)
para.set_bottom_margin(0.25)
para.set_description(_('The style used for the More About header.'))
default_style.add_paragraph_style("DAR-MoreHeader",para)
font = BaseDoc.FontStyle()
2005-12-06 12:08:09 +05:30
font.set(face=BaseDoc.FONT_SERIF,size=10)
para = BaseDoc.ParagraphStyle()
para.set_font(font)
2005-12-06 12:08:09 +05:30
para.set(first_indent=0.0,lmargin=1.0)
para.set_top_margin(0.25)
para.set_bottom_margin(0.25)
para.set_description(_('The style used for additional detail data.'))
default_style.add_paragraph_style("DAR-MoreDetails",para)
Endnotes.add_endnote_styles(default_style)
2002-10-20 19:55:16 +05:30
#------------------------------------------------------------------------
#
#
#
#------------------------------------------------------------------------
register_report(
name = 'det_ancestor_report',
category = CATEGORY_TEXT,
report_class = DetAncestorReport,
options_class = DetAncestorOptions,
modes = MODE_GUI | MODE_BKI | MODE_CLI,
translated_name = _("Detailed Ancestral Report"),
2002-10-20 19:55:16 +05:30
status=(_("Beta")),
description= _("Produces a detailed ancestral report"),
2003-02-08 22:58:41 +05:30
author_name="Bruce DeGrasse",
author_email="bdegrasse1@attbi.com"
2002-10-20 19:55:16 +05:30
)