Personal tools
User menu

Plugins - Gedart

From Ancestris Free Genealogy Program

Jump to: navigation, search
This page is under construction. Please be patient. Wink

Info This is one of many plugins for Ancestris, all created with the purpose of ease your work and embellish your genealogy.


Information sheets for Persons/Families
(Plug-in Gedart)

This tool is not exactly a plug-in, it's more a report. However, it has a tendency to become a plug-in, once is development is finished, that's why it is here, between the plug-ins. More, due to it's complexity, it realy deserves being here.


Author: Daniel ANDRÉ
Version 3.0 (5/12/2007)

no mistakes This report only works with version 0.8, which is a development version, although stable enough for now. To install it, see the download section of this site.

Reports list (click to enlarge)
no mistake Even if we call it here Information sheets, or Gedart, on Ancestris it will show as 'Information Sheets for Persons/Families', so don't choose the wrong report....
Example of one possible output of this report


Contents

How to use Gedart report

An important note - this report can be launched:

Menu
  • from the main menu, Lists and reports and then choosing it to act over all the Gedcom;
Context menu
  • from an individuals context menu, with a right click of the mouse, Tools and reports -> Run Report on individual I'XX' -> Report (under development) -> Information sheets Individuals/Families;

One way or the other, before anything else, you must set the parameters on 'Options' tab, right side of the list.

No need to explain how to launch the report. It works just like any other.

The context menu option can be used from an individual or family, from the table view, from the tree view, or any other view you like.

Little help for the sheets output

You have carefully followed all the templates installation advices (see below). You start Ancestris, select the 'Information Sheets' report; in 'Options', select the desired model, you have a choice thanks to the different G.U.S. [1]. After choosing the template from the dropdown list, don't forget to click on the screen, so that your selection is taken in consideration ! Next, return to the editor and the individual you want to get a report for, right click him, start the report (see above), choose a file name and path, and click OK.

To see the great job you get, browse to the location you previously chose, and open the file with your web browser (Internet explorer, Firefox, Chrome, Safari or other...) And that it! (Vbouton December 30, 2007, 19:23 (CEST))

Download - Installation

Version 3.0 is the latest available.

This version is automatically installed with Ancestris, no need for you to do nothing.

Important

If the report Information Sheets doesn't show in the section "Under development" in Ancestris reports list, update your java version, from here for Linux and here for Windows.

The philosophy of the report

This version is a completely rewritten "'Information Sheets for Persons/Families' report. The point of this is to make this kind of sheets easily adaptable to any desired situation. The report developer, Daniel André, made the decision of supplying the user a means to create his/her sheets with the selected informations and the desired page design. It was, obviously, out of question, that this possibility would pass through programming skills, like it was before. This report now stands on a templates system, easily changeable by the user.

The current version offers an individual sheet with most of the information (except the sources, for the moment) in the Gedcom file. We can see personal informations, civil states, parents, families, spouses, sons and daughters, events, associated persons (godfather, godmother, witnesses, ...) .

The output is only html, for now.

Currently, we have only several options. Just open the options tab and set your preferences. They pretty much explain themselves.

For the curious, the template is the indiSheet.vm file.

Sheet templates

As this report allows us to display our individual or family sheets as we please (we can add informations, change design, etc.), it can be interesting trading templates created by us between ourselves.

If you created one or more sheets, and agree to share them with other Ancestris users, just send an email with a zip file, called "YourName_NameOfYourSheet.zip" (replace YourName with your own name and do the same with the sheet's name) in which you will include the file indiSheet.vm and/or famSheet.vm.

Here are the currently available files :

) Daniel Durand's templates :

After September 2009, all Daniel's templates were regrouped in one single archive. Just download the file from the link below and extract it to the 'gedart' folder, in Ancestris installation directory.

For example, under Linux, Ancestris parameters folder is usually at /home/yourname/.ancestris/0.7/ (yourname to replace with the name of your personal folder, and in this example, 0.7 is the version number of Ancestris).

François, please check if the locations are correct! Above is said that only version 0.8 can be used.

The folder where you should place the templates is:

/home/your/.ancestris/0.7/ancestris/gedart

So, once you have the file in this folder, "/home/yourname/.ancestris/0.7/ancestris/gedart", unzip it. This will create automatically the tree of files.

The examples below will give you a good idea of what each template will display as final result. To consume without moderation, as we say. Daniel Durand's templates include - Ancestors trees :

  • Ascendants Table, mono-page with 5 generations - (Output result in pdf) - The '5 generations tree' displays, on a single page, a tree, or horizontal table with five ancestors generations and there civil state informations.
  • Ancestors tree, multi-pages, 10 generations - (Output result in pdf) - This sheet displays ten generations of a selected individual's ancestors, creating sheets of five generations, printed in different pages. The report generates a html file, in which are included page breaks. This report usually works well in Firefox with a 'serif 14' font set in the browser preferences.
  • Fancy tree - (Output result in pdf) - This sheet displays, on a single page, a vertical tree with four generations of ancestors and their civil state informations. It will be displayed over a background image (by default).(Attention you must remember something for this report, if you create your .html file in another folder, THINK OF MAKING ALSO A COPY of the background, otherwise, the tree will be displayed on a blank page)
  • Patronymic sheet with 7 generations - (Output result in pdf) - This sheet displays, on a single page, a tree with seven generations of your ancestors, following the patronymic affiliation : that is to say according to the name of the father with the name of the spouse and their civil state informations. Ex : if your start individual is called Durand, you will have his first seven ancestors called Durand. NB : This sheet is most desired in the genealogical associations, to establish names and patronymics studied by the associates. If you want to have the creators name in the report, you should create a default supplier (right click over individual), you can even include your associates number.)

- Individual or family sheets :

  • Succinct informations (same report : 'ChriDan Person(s) and Family(ies)' can be launch for an individual, or a family:
   - for an individual - (Output result in pdf) - This sheet displays the essential information about an individual ; it will not display citations from sources for events associated with someone on your data base (for that, use the sheet 'COMPLETE INDIVIDUAL' sheet).
   - for a family - (Output result in pdf) - This sheet will display different informations about a couple in your genealogy, as well as their links to their respective parents, their children, their residences and professions. It will also display the text from marriages and marriage contracts. A photo of the couple will also be displayed, if the OBJE is under FAM.
  • Complete informations for an individual - (Output result in pdf) - This sheet displays exhaustive informations , including source citations for events linked to an individual (and his unions). It displays, if existing : - photo of the individual (if OBJE is under INDI) - photos of the residences (if OBJE is under RESI) - the text of the source citations (transcriptions of events) if they are indicated like this (which is recommended) : BAPM or BIRT,BURI, DEAT, MARR, MARC, DIV) ---> SOUR ---> DATA --> TXT. - The sheet allows also to display photos of the individual's homes at the end of the sheet.
  • Family Group : (same report : "ChriDan Group(s) of Person(s) and Group(s) of Family(ies) can be launch for an individual, or a family:
  - for an individual - (Output result in pdf) - This sheet will display a graphical vue of an individual's parents and grandparents, his/her spouse(s) and children.
   - for a family - (Output result in pdf) - This sheet will display a graphical vue of an individual's parents and grandparents, his/her spouse(s) and children.

- Narrative sheets :

  • A generations book about a century of an individual - (Output result in pdf) -'The report 'A century of generations for an individual' creates a book including informations about three patronymic generations. After a title page, you can see a graphical representation of three generations for the selected individual : spouse and children, parents and grandparents. Nest follows the complete individual sheet of the source individual, his/her father and grandfather. First two sheets are slightly reduced to avoid redundancies. The report works like a standard genealogical input but, it supplies more types of interesting supplementary elements.
  • A 'Biography builder or AUOT-BIO' - (Output result in pdf) - Writing a biography is not difficult but requires a little method. This report is intended to ease this work for you. Enter the text in the fields offered for it, following the tips and consulting the base information of the individual, used as context in this report. Once you have filled all fields, click at 'Generate a draft' to get a first draft of your biography. Select it with the mouse and copy it. And then, in your genealogy, you will create a note under your individual (note) and there you paste your text. When you edit the report 'Complete individual Sheet', your new biography will appear at the beginning of sheet !


- Reports not updated but always active :

  • The report "Life - habitats and professions" - (Output result in pdf) displays different places of residence and professional activities for an individual on your data base, as well as about his/her spouse, parents, grandparents and children.

) François's templates : François create two base templates : an individual sheet and a family sheet. These templates are now included with Ancestris, starting in version 0.8. If, by any chance, you don't have them, download them here. This archive in .zip format, contains both sheets, individual and family.

Check the output results :


Using the output examples

These examples (in html format), shown by François, and the ones from Daniel Durand (in pdf format), give you an idea of what can be done with this report, Gedart.

These examples are based on templates created by François and Daniel. They are real examples, taken from their own genealogies. Maybe not all possible informations are displayed in the report, because they were simply not present in their records.

Now, you can create your own templates. To create a personal template, you must have Ancestris version 0.8. Just create a folder at .ancestris/trunk/ancestris/gedart/contrib-templates, with your template's name (for example, .ancestris/trunk/ancestris/gedart/contrib-templates/my-template) and place the files *.vm in it (endDoc.vm, indexSheet.vm, index.vm, indiSheet.vm, report.vm, resources.properties, startDoc.vm;, sumSheet.vm, TOC.vm), supplied with any one of the examples above.

A place to debate and exchange ideas

A page has been created to gather your requests, comments, etc, concerning this report. There is work to be done, as Daniel André, the authos announced, it's important that you use this space to give your opinion, no matter what. It will be taken in consideration in future develoments.

Page for gathering opinions and ideas for this report

Small FAQ about Gedart

History of the report

This report was born after the ToDO report that Daniel André wrote, some time ago, and allows, amongst other, sorting individual and family sheets for persons and families with tasks to be done, for example, facilitate working in Government Archives. This old report was used by many people but had a few faults:

  • it only allowed to display people with ToDo tasks;
  • it missed some informations, and not always the same ones;
  • the output was very rigid, preventing, for example, the use of < div > and style sheets.

Daniel started then to build a report, allowing the user to sort the individual and family sheets as pleased, adopting choices to give the user the most freedom possible.

Possibilities of this report

With Ancestris there is an opportunity to make reports as well as the designer planned. This is one of the main reasons which led Daniel André to adopt this software. He was seeking a software that can run as well under GNU/Linux as under Windows, allowing to achieve its own reports and had not yet found what he sought in existing tools such as Lifelines,


This ability to achieve your own reports is fantastic and is used by a number of people you know. However, the public concerned is a public of programmers because it is necessary to write these reports in Java. The user has no competence or such knowledge, he/she cannot do anything but ask a good soul to encode this or that report or modify the aspect (adding information, presentation, ... ) .It is a shame!

So, Daniel reworked is TODO report trying to solve the above problems, arriving at this report, still in development but already perfectly usable. The internal name of this report is gedart.

What does gedart means?

It's named gedart for two reasons:

  • first of all, it's an English acronym, 'GEnealogical Data Analysis and Report Tool';
  • next, in gedart we have two parts: GED and ART, which means presentig genealogical data in an artistic way or 'explore your art talents over your genealogical data'.

I can't see the report in the reports window

If the report 'Information Sheets doesn't show in the reports window, section 'Under development', you should check if the report was properly installed:

  1. Determine the installation directory of Ancestris. It's the one containing the executable file (ancestris.exe or ancestris.sh)
  2. There should be a sub-folder 'report';
  3. In this sub-folder 'report' must be a sub-sub-folder 'gedart', where should be all files needed;
  4. If it's not the case, reinstall the report.

Restart Ancestris to recognize the report.

If, despite all that, you still don't have the report, check your Java version.

For that, see FAQ - I have the correct Java but this doesn't work

How does this report work?

It is made of two parts:

  • one fully codded in Java, that prepares the data for the report's final result;
  • another, the presentation part that will create the intended file. This is called template and is meant to be changed by you, the user without programming skills, to customize your reports.

What can you do with this report?

This report is conceived to not impose any (or the minimum possible) limitations to the output of informations. For example, although the templates supplied produce a .html file, they could as well export to .txt, .rtf or .csv.

Who can create a template

Anyone!

Like we said above, gedart was conceived in such a way that the creation and modification of templates is accessible to the greatest number of users. However, it is required to understand some formalities and being capable of changing, for example, .html files with the help of a text editor. Obviously, some of these changes, although not complex, will be a bit difficult for a new user. We will try to create more and more accessible templates.

Where are the templates placed?

ATTENTION, this refers to the templates, not the report it self.

The templates are sub-folders of the instalation folder/trunk/ancestris/gedart/contrib-templates. Be sure this folder exists and create it if necessary. The name of the folder will be the name of your template. Next we need an index.vm file on this folder. If it doesn't exist, the folder won't be recognized as a template and, therefor, won't be present on the list of choices. You can simply copy the .vm files present in one of the supplied templates.

Hard to follow? Let's have some explanations.

Things are a bit different, depending on the operating system.

1°) Under Windows, it is possible that the Ancestris parameters folder is at C:\Documents and Settings\your name\Application Data\Ancestris.

François, please check this section

Si cependant, vous avez modifié le fichier de démarrage de Ancestris (le fichier run.bat), en ayant ajouté le paramètre -Duser.home=., le répertoire des paramètres de Ancestris, sera sous C:\Programs Files\GenealogyJ\.Ancestris\.

Attention, "Application Data" is an hidden folder. [2]. Here is a screen capture of that folder tree. As you can remember, we must have a folder named 'gedart' at C:\Documents and Settings\your name\Application Data\Ancestris, so, if it isn't there, we must create one, naming it 'gedart'. We will have this tree: C:\Documents and Settings\your name\Application Data\Ancestris\gedart\.

François, please check this section

Vous pouvez vous poser la question : Est ce que l'autre répertoire C:\Programs Files\GenealogyJ\report\gedart va encore me servir? Bien sûr. Le répertoire que vous venez de créer est celui qui contient les modèles, alors que le second, celui sur lequel vous vous posez la question, contient le rapport lui-même, le programme. Donc ne pas l'effacer bien sûr, vous avez besoin des deux.

That's it? How sweet Wink .

We have work a bit more Wink .

Open the folder you just created, (gedart), and create a new one called 'contrib-templates'.

Question: may I use another word, like 'modèles', instead of 'templates'?. NOOOOOO. You must use 'templates'.

Well, work almost done. Now open this new folder, contrib-templates, and here is where you must create the sub-folders of the templates you just downloaded. If, for example, you downloaded the latest version of 'Island', in templates, you will create a sub-folder called 'island'.

Question: what do we do now?
Let's go back for a while, in case you're lost.
The downloaded templates are installed at: C:\Documents and Settings\your name\Application Data\Ancestris\gedart\contrib-templates\ (this is the folder we just create, with all it's sub-folder, the one that matters).
The report it self should be at: C:\Program Files\GenealogyJ\report\gedart\ (no need to mess with this folder).

Clear? OK, let's continue...

Assuming you have installed the 'Island' template, and proceeded as described above, you created a folder called 'island'. And copied ALL .vm files into it, from the folder of the report it self.

Lost?

OK, go to C:\Program Files\GenealogyJ\report\gedart\ and copy all files with the extension .vm, famSheet.vm, indexSheet.vm, index.vm, indiSheet.vm, startDoc.vm, TOC.vm, endDoc.vm, report.vm, sumSheet.vm

to C:\Documents and Settings\your name\Application Data\Ancestris\gedart\contrib-templates\island\

Attention, 'copy', NOT move'. Just make a copy of the files.

Next, download the template 'island' (check it's name in the download section), and place it at C:\Documents and Settings\your name\Application Data\Ancestris\gedart\contrib-templates\island\

Extract the files. A message will ask if you want to replace indiSheet.vm and/or famSheet.vm. Maybe more. Say yes. You MUST NOT have sub-folders here.

Do you want more templates? Easy, just repeat this process. Note that most of the work is already done. Only two steps to take:

  • creation of a sub-folder with the name of the template (just like you did for 'island', and replacing the name with the one you want, for example, 'chridan', something like this: C:\Documents and Settings\your name\Application Data\Ancestris\gedart\contrib-templates\chridan\
  • copy of all .vm files to "chridan".

And that's it, simple isn't it? Wink


2°) Under Linux, the installation folder is .ancestris (a folder beginning with a dot). It's where we find all the parameter files for Ancestris, ancestris.properties, ancestris-report.properties, ancestris.log, etc... Not the root directory for Ancestris.

If you can't find this folder, search below, we will tell you how..

Templates Installation under Windows :

François, please check this section

Une expérience en direct live par notre ami phi31

L'installation des différents modèles, suppose dans un premier temps que l'on sache où sont situés les fichiers de configuration de Ancestris sous Windows. En effet, les fichiers contenant les modèles doivent se placer et être décompactés à partir de ce répertoire des paramètres.

Donc question : Il nous faut trouver où Ancestris positionne ses fichiers de configuration sous Windows.

Si vous ne savez pas où cela peut être, ou/et si vous n'avez pas activé l'option de Ancestris qui vous permet de le déterminer, il faut commencer par là.

Ouvrez le menu "Visualisations", tout en bas, vous choisissez "Options", s'ouvre alors le menu des options de Ancestris.

Dans la première partie de ce menu, cherchez une ligne qui s'appelle "Répertoire des paramètres de Ancestris (user.home.Ancestris)". Cliquez sur le petit bouton avec trois points, à droite en face de cette ligne. Il va falloir identifier/remplir cette case avec le chemin de l'explorateur Windows .

Vous pouvez simplement d'entrée taper dans le champ adéquat :

"C:\WINDOWS\explorer.exe"

... et faire la recherche comme ci-dessous si cela ne fonctionne pas !

Vous devez pour cela vous promener dans l'arborescence pour trouver l'exécutable de votre choix, en le recherchant comme ci-dessous :

File:Windows menu executer1.jpg
Commencer par "Menu Démarrer"

Donc avec votre souris, vous cliquez sur le bouton "Démarrer" (c'est celui qui vous sert pour arrêter votre session Windows (éteindre votre ordinateur)).

Puis dans le menu déroulant qui s'ouvre, vous allez sur la ligne "Exécuter".

Vous confirmez en cliquant sur cette ligne.

File:Windows menu executer2.jpg
Puis faire "Executer"

Il s'ouvre une fenêtre dans laquelle apparaît un champ.

Il est possible que ce champ soit déjà rempli avec une commande, genre "regedit", ou autre chose. Vous devez mettre dans cette ligne "Ouvrir", la commande "cmd"

Vous confirmez par un clic sur "OK".

File:Windows menu executer3.jpg
Ouverture d'un Terminal - le répertoire vous est indiqué

Dans la fenêtre qui s'ouvre, vous devez taper plusieurs commandes :

cd \ 
cd windows
dir explorer.exe

(n'oubliez pas l'espace entre "cd" et "\" dans la première commande)

Là vous devriez voir quelque chose qui s'affiche qui ressemble à la capture d'écran ci-contre.

Si tel est le cas, cela veut dire que votre exécutable "explorer.exe", se trouve bien sous "C:\WINDOWS\explorer.exe"

Une fenêtre s'ouvre vous présentant tous les fichiers de configuration de Ancestris. Leur emplacement est indiqué dans le champ "dossier" ( en haut à l'intérieur de la barre "bleue" - selon votre présentation). Notez le bien, c'est là que va se positionner l'arborescence nécessaire à l'installation des fiches.

Vous n'avez à faire cette manipulation qu'une fois.


Templates Installation under Linux :

The installation under Linux is similar to the one under Windows.

Here too we must know where the configuration files are placed Usually, they are at /home/your name/.ancestris. If you don't know where that is, and/or you don't have the option of allowing Ancestris to determine it, follow this procedure.


François, please check this section

Vous ouvrez le menu "Visualisations", tout en bas, vous choisissez "Options". Il s'ouvre devant vous le menu des options de Ancestris.

Dans la première partie de ce menu, vous trouverez une ligne qui s'appelle "Répertoire des paramètres de Ancestris (user.home.Ancestris)". Cliquez sur le petit bouton avec trois points, en face de cette ligne. Il va s'ouvrir la fenêtre dont la capture d'écran est ci-dessous :

Vous pouvez vous promener dans l'arborescence pour trouver l'exécutable de votre choix, mais vous pouvez aussi tout simplement taper dans le champ adéquat "/usr/bin/dolphin". Oh miracle de l'informatique, crac boum hue, une fenêtre s'ouvre vous présentant tous les fichiers de configuration de Ancestris. Leur emplacement est indiqué dans le champ "Emplacement" de Dolphin. Notez-le bien, c'est là que va se positionner l'arborescence nécessaire à l'installation des fiches.

Well, that's for KDE, but, as someone kindly mentioned, there are Gnome users. So, for these, instead of Konqueror, use /usr/bin/gnome-open

These steps you just took are only necessary once. Now you are cool.

Two more minutes to end the configuration, don't be hasty, the worst is done. Wink


Now, you can choose:

  • either you are a command line fan, in which case we have nothing to teach you. Just place the zip file with the template in your parameters folder, and unzip it, 'unzip indiSheet_chridan.zip'. Everything will go into place.
  • or you drag&drop on a graphic interface, and place the zip file in the parameters folder. Again, unzip it and you are "up and running".

Isn't life beautiful !!!!

Enjoy this superb report and the sheets G.U.S. [1] made for you.


Templates Installation under Mac OS :

François, please check this section
  1. Téléchargez les modèles qui vous intéressent dans la section 4 plus haut sur cette même page.
  2. Allez dans le dossier où vous avez téléchargé ces fichiers et ouvrez-les (par un double-clic, par exemple) pour les décompresser.
  3. Pour chaque fichier téléchargé vous obtenez un dossier portant exactement le même nom. Placez ce(s) dossier(s) dans le dossier "templates" de Ancestris. Pour localiser le dossier "templates", allez dans le dossier où se trouve Ancestris, avec le fichier run.jar. Il y a plusieurs dossiers dont un dossier "report". Celui-ci contient à son tour un dossier "gedart" qui contient lui-même un dossier "templates". Le chemin d'accès sera donc probablement quelque chose comme : "Applications/votre_dossier_Ancestris/report/gedart/templates/"
  4. Une fois le(s) dossier(s) des modèles souhaités bien placé(s) dans le dossier "templates", vous pourrez mettre les fichiers téléchargés à la corbeille si vous le souhaitez.
  5. Si Ancestris n'est pas déjà lancé, relancez-le. S'il est déjà lancé, il vous suffit d'ouvrir la fenêtre des rapports, de choisir le rapport "Fiches de renseignements", puis de cliquer sur le bouton "Recharger les scripts de lancement des rapports" représenté par les 2 flèches vertes en cercle. Ceci permet à Ancestris de prendre en compte les nouveaux modèles que vous devriez voir apparaître dans le menu "Modèle utilisé" dans l'onglet "Options" du rapport.

How does this templates system works?

A template is a folder containing an index.vm file. This file is mandatory and it's part is exactly, as said above, establish the link between data and display.

Templates Examples

The first example is supplied with the report. Attention, this template is very hard to understand! To create your first template from sheets supplied with the report, just create .Ancestris/gedart/contrib-templates/mytemplate and copy all *.vm file from GenealogyJ/report/gedart. Next, after reloading the report, you'll have another available choice (mytemplate) in the report options. Now you can change the template at your desire.

What is the syntax of the templates?

The templates use an engine named Velocity, check their documentation here. For an initial idea of this syntax, open Indisheet.vm from the template you want to edit. Use a text editor like Kate or Gedit under Linux, Notepad under Windows. You will find resemblences to Html syntax and with BASIC programming language also.

What genealogical informations are usable by the template?

A template can use all information available about the selected individual and/or families.

While waiting for a more dettailed chapter, see the templates supplied. Don't hesitate making comments or asking for features to the developers. Use Ancestris discussion list.

Notes

  1. 1.0 1.1 G.U.S. (Gentils Utilisateurs Sympas (Copyright (C) 2007 Arvernes System)Wink (Kind and Friendly Users))
  2. To display hidden files and folders in Windows, change the options in Windows Explorer.
  • This page was last modified on 25 September 2014, at 10:06.
  • This page has been accessed 9,155 times.