Personal tools

HGene

From HaskellWiki

Revision as of 20:10, 16 December 2006 by Mark Wassell (Talk | contribs)

Jump to: navigation, search

Contents

1 HGene - Geneological Authoring Tool

1.1 Vision

Acknowledging...

  • Geneological information forms a graph.
  • Charts need to be intelligent. For example, selecting a box showing a person, the user can view details for the person and add these details to the chart.
  • Charts are not just one shot. Once a chart is generated, users will want to add (and remove) people from the chart. For example, select a person and right mouse click to add the children or the parents of the person to the chart if they are not already present.
  • A person can appear in more than one chart. Charts can be tailored to show a particular fragment of the overall graph.
  • User wants to group people and charts to form chapters and these into books and to output these to HTML or PDF.

1.2 Features

  • RDBMS to store data.
  • Internally, information is stored as an FGL graph.
  • Use of GraphViz to generate chart layout to PNG or SVG.
  • Chart editor that can read GraphViz SVG output and save out.
  • Tool to import GedXML files into database.
  • Basic query and navigation features.
  • Capability to arrange people and charts into books with the ultimate aim of generating a book as a set of HTML pages or PDF.
  • Sample database based on geneology of families involved in English Wars of the Roses[1]. This is a good example showing that geneology information does indeed form a graph.

Note: There is no update facility provided as yet and no immediate plans to. In theory geneological data is 'write once' data.

1.3 Libraries used

  • Gtk2Hs - Provides GUI front end. [2]
  • FGL - For internal representation of data. [3]
  • HaXML - For reading and writing SVG files and importing GEDXML files. [4]
  • HSQL - For access to back end data base. [5]


1.4 Architecture

HGeneDataFlowArchitecture.png


Description of the components shown in the above diagram

  • External Components
    • DAML file (for example royal92.daml) [6]
    • Database - MySQL database [7]
    • DOT file - Input file to GraphViz [8]
    • GraphViz - Graph Visualisation Tool [9]
    • SVG file - GraphViz can output as SVG and SVG is the format for the ChartDrawer [10]
  • Internal Components
    • GedLoader - GEDCOM file which is in DAML format.
    • HaskellDB/ODBC - Connector to database.
    • Table View - View person records.
    • Properties - View details for selected person.
    • Tree View - View tree representation of books and chapters.
    • Chart Viewer - View PNG output from GraphViz.
    • Chart Builder - Control generation of chart using GraphViz.
    • Chart Drawer - Read GraphViz SVG files and output 'in the same style'. These files do contain information about the underlying dabase record. Allow user to control colours, text font and line width. Undo/Redo stack. Lines snap to nodes and dragging node will drag lines as well.


1.5 Notes

A background need is to ensure that all of the above is generic and that any other structured data that is graph-like could be 'plugged' in (an immediate example is the data flow diagram above). An example of a 'book' with person details and charts is at [11]. This was generated using PHP. The above application is one that utilises some of the aspects covered in the wiki article Enterprise_Haskell