gramps/doc/gramps-manual/C/gramps-manual.xml

<?xml version="1.0"?>

<!--
	  User Manual for Gramps - a GTK+/GNOME based genealogy program

	  Copyright (C) 2003-2004  Alexander Roitman

	  Permission is granted to copy, distribute and/or modify this
	  document under the terms of the GNU Free Documentation
	  License (GFDL), Version 1.1 or any later version published
	  by the Free Software Foundation with no Invariant Sections,
	  no Front-Cover Texts, and no Back-Cover Texts. 
          A copy of the license is included in the file COPYING-DOCS 
          distributed with this manual.
-->

<!-- $Id$ -->

<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
  <!ENTITY legal SYSTEM "legal.xml">
  <!ENTITY getstart SYSTEM "getstart.xml">
  <!ENTITY mainwin SYSTEM "mainwin.xml">
  <!ENTITY usage SYSTEM "usage.xml">
  <!ENTITY custom SYSTEM "custom.xml">
  <!ENTITY faq SYSTEM "faq.xml">
  <!ENTITY keybind SYSTEM "keybind.xml">
  <!ENTITY filtref SYSTEM "filtref.xml">
  <!ENTITY cmdline SYSTEM "cmdline.xml">
  <!ENTITY appversion "1.0.0">
  <!ENTITY manrevision "2.5">
  <!ENTITY date "January 2003">
  <!ENTITY app "<application>GRAMPS</application>">
  <!-- Information about the entities
       The legal.xml file contains legal information, there is no need to edit the file. 
       Use the appversion entity to specify the version of the application.
       Use the manrevision entity to specify the revision number of this manual.
       Use the date entity to specify the release date of this manual.
       Use the app entity to specify the name of the application. -->
]>
<!-- 
      (Do not remove this comment block.)
  Maintained by the GNOME Documentation Project
  http://developer.gnome.org/projects/gdp
  Template version: 2.0 beta
  Template last modified Apr 11, 2002
-->
<!-- =============Document Header ============================= -->
<article id="index" lang="en">
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->
  <articleinfo> 
    <title>&app; Manual V&manrevision;</title>       

    <copyright> <year>2001</year> <holder>Donald N. Allingham</holder> </copyright>
    <copyright> <year>2003-2004</year> <holder>Alex Roitman</holder> </copyright> 

<!-- translators: uncomment this:

  <copyright>
   <year>2002</year>
   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
  </copyright>

   -->
<!-- An address can be added to the publisher information.  If a role is 
     not specified, the publisher/author is the same for all versions of the 
     document.  -->
    <publisher> <publishername> GRAMPS Project </publishername> </publisher> 

   &legal;
   <!-- This file  contains link to license for the documentation (GNU FDL), and 
        other legal stuff such as "NO WARRANTY" statement. Please do not change 
	any of this. -->

    <authorgroup> 
      <author> 
		<firstname>Alex</firstname> 
		<surname>Roitman</surname> 
		<affiliation> 
	  		<orgname>GRAMPS Project</orgname> 
	  		<address> <email>shura@alex.neuro.umn.edu</email> </address> 
		</affiliation> 
      </author> 
      <author> 
		<firstname>Donald N.</firstname> 
		<surname>Allingham</surname> 
		<affiliation> 
	  		<orgname>GRAMPS Project</orgname> 
	  		<address> <email>dallingham@users.sourceforge.net</email> </address> 
		</affiliation> 
      </author> 
      
<!-- This is appropriate place for other contributors: translators,
     maintainers,  etc. Commented out by default.
     
      <othercredit role="translator">
		<firstname>Latin</firstname> 
		<surname>Translator 1</surname> 
		<affiliation> 
	  		<orgname>Latin Translation Team</orgname> 
	  		<address> <email>translator@gnome.org</email> </address> 
		</affiliation>
		<contrib>Latin translation</contrib>
      </othercredit>
-->
    </authorgroup>

<!-- According to GNU FDL, revision history is mandatory if you are -->
<!-- modifying/reusing someone else's document.  If not, you can omit it. -->
<!-- Remember to remove the &manrevision; entity from the revision entries other
-->
<!-- than the current revision. -->
<!-- The revision numbering system for GNOME manuals is as follows: -->
<!-- * the revision number consists of two components -->
<!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
<!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
<!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
<!-- is written in that desktop time frame is V2.0, the second version of the manual is V2.1, etc. -->
<!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
<!-- to V3.0, and so on. -->  
    <revhistory>
      <revision> 
		<revnumber>GRAMPS Manual V&manrevision;</revnumber> 
		<date>&date;</date> 
		<revdescription> 
	  	<para role="author">Alex Roitman
		    	<email>shura@alex.neuro.umn.edu</email></para>
                <para role="publisher">GRAMPS Project</para>
		</revdescription> 
      </revision> 
      <revision> 
		<revnumber>GRAMPS Manual V2.4</revnumber> 
		<date>December 2003</date> 
		<revdescription> 
	  	<para role="author">Alex Roitman
		    	<email>shura@alex.neuro.umn.edu</email></para>
                <para role="publisher">GRAMPS Project</para>
		</revdescription> 
      </revision> 
      <revision> 
		<revnumber>GRAMPS Manual V2.3</revnumber> 
		<date>September 2003</date> 
		<revdescription> 
	  	<para role="author">Alex Roitman
		    	<email>shura@alex.neuro.umn.edu</email></para>
                <para role="publisher">GRAMPS Project</para>
		</revdescription> 
      </revision> 
      <revision> 
		<revnumber>GRAMPS Manual V2.2</revnumber> 
		<date>July 2003</date> 
		<revdescription> 
	  	<para role="author">Alex Roitman
	    		<email>shura@alex.neuro.umn.edu</email></para>
  		<para role="author">Donald A. Peterson
		    	<email>dpeterson@sigmaxi.org</email></para>
  		<para role="publisher">GRAMPS Project</para>
		</revdescription> 
      </revision> 
      <revision> 
		<revnumber>GRAMPS Manual V2.1</revnumber> 
		<date>May 2003</date> 
		<revdescription> 
	  		<para role="author">Alex Roitman
	    	<email>shura@alex.neuro.umn.edu</email>
	  		</para>
	  		<para role="publisher">GRAMPS Project</para>
		</revdescription> 
      </revision> 
      <revision> 
		<revnumber>GRAMPS Manual V2.0</revnumber> 
		<date>April 2003</date> 
		<revdescription> 
	  		<para role="author">Alex Roitman
	    	<email>shura@alex.neuro.umn.edu</email>
	  		</para>
	  		<para role="publisher">GRAMPS Project</para>
		</revdescription> 
      </revision> 
      <revision> 
		<revnumber>GRAMPS User Manual V1.1</revnumber> 
		<date>2001</date> 
		<revdescription> 
	  		<para role="author">Donald N. Allingham 
	    	<email>dallingham@users.sourceforge.net</email>
	  		</para>
	  		<para role="publisher">GRAMPS Project</para>
		</revdescription> 
      </revision> 
      <revision> 
		<revnumber>gramps User Manual V1.0</revnumber> 
		<date>2001</date> 
		<revdescription> 
	  		<para role="author">Donald N. Allingham 
	    	<email>dallingham@users.sourceforge.net</email>
	  		</para>
	  		<para role="publisher">GRAMPS Project</para>
		</revdescription> 
      </revision> 
    </revhistory> 

    <releaseinfo>This manual describes version &appversion; of GRAMPS.
    </releaseinfo> 
    <legalnotice> 
      <title>Feedback</title> 
      <para>To report a bug or make a suggestion regarding the &app; application or
      this manual, follow the directions in the <ulink url="ghelp:gnome-feedback"
	  type="help">GNOME Feedback Page</ulink>. 
      </para>
<!-- Translators may also add here feedback address for translations -->
    </legalnotice> 
  </articleinfo> 

  <indexterm zone="index"> <primary>GRAMPS</primary> </indexterm> 
  <indexterm zone="index"> <primary>gramps</primary> </indexterm>

<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
  <sect1 id="gramps-intro"> 
    <title>Introduction</title> 
    <para> &app; is a genealogical 
    application. &app; is an acronym for the 
    Genealogical Research and Analysis Management Programming System. To put 
    it shortly, it allows you to store, edit, and research genealogical data 
    using your computer. Its functionality is somewhat common to other 
    genealogical programs. However, &app; offers some unique features. </para> 

    <sect2 id="why-gramps">
      <title>Why &app;?</title>
      <para> &app; was conceived under the concept
      that most genealogy programs were designed to provide the researcher the 
      capability to input information related to a particular family tree.  
      Most of these programs have allowed for the arranging and storing of
      information consistent with the GEDCOM standards. They usually provide
      means for displaying descendant or ancestral relationships by means of
      graphical displays, charts, or reports.  These may be augmented with 
      pictures or other media to enhance the data.  Most provide for inputting 
      data on unconnected individuals/families that may or may not have a 
      relationship to the primary surname being researched.  Various other 
      enhancements may also be provided in the genealogical program that 
      allows for different degrees of importing and exporting data from other 
      programs and printing the data contained in the various reports. </para>
      
      <para> &app;, on the other hand, attempts to
      provide all of the common capabilities of these programs, but, more
      importantly, to provide an additional capability of integration not common
      to these programs.  This is the ability to input any bits and pieces of
      information directly into &app; and
      rearrange/manipulate any/all data events in the entire data base (in any
      order or sequence) to assist the user in doing research, analysis and
      correlation with the potential of filling relationship gaps.  In short, it 
      is a tool that provides a way to input all your research into one place and 
      do your analysis and correlation using the speed, power, and accuracy of 
      your computer instead of pencils and unmanageable reams of paper. </para>
    </sect2>
  </sect1> <!-- ================ End Intro ================================ -->
  
  &getstart;	<!-- Getting Started -->
  &mainwin;		<!-- Main window -->
  &usage;		<!-- Usage -->
  &custom;		<!-- Customization -->
	
  
<!-- ============= Bugs ================================== -->
<!-- This section is optional and is commented out by default. 
     You can use it to describe known bugs and limitations of the 
	  program if there are any - please be frank and list all
     problems you know of. 
-->
  <sect1 id="mayapp-bugs">
  <title>Known Bugs and Limitations</title>
  <para>Currently, &app; loads all data into memory, which tends to bog 
  down the system for large databases (over 15000 people for a typical 
  system). This will be addressed with the 1.2 release by incorporating 
  a database backend. The database backend should dramatically improve 
  both speed and memory usage. </para>
  
  <para>Direct printing is not currently supported. This is planned to be 
  fixed after the stable 1.0 release by using gnome-print architechture.</para>
  
  <para>PS and PDF reports output garbage in place of unicode characters. 
  This should also be solved when we move to gnome-print. In the meantime, 
  a decent workaround is to produce reports in OpenOffice.org format and then 
  export into PDF from withing OpenOffice.org application.</para>
 </sect1>
<!-- ============= About ================================== -->
<!-- This section contains info about the program (not docs), such as
      author's name(s), web page, license, feedback address. This
      section is optional: primary place for this info is "About.." box of
      the program. However, if you do wish to include this info in the
      manual, this is the place to put it. 
      Alternatively, you can put this information in the title page.-->
  <sect1 id="gramps-about"> 
    <title>About &app;</title> 
    <para> &app; was written by Donald N. Allingham
      (<email>dallingham@users.sourceforge.net</email>). 
      To find more information about &app;, please visit the 
      <ulink url="http://gramps.sourceforge.net" type="http">GRAMPS Project 
      Web page</ulink>. </para>
    <para>
      To report a bug or make a suggestion regarding this application or
      this manual, use the help menu in &app;, or follow the directions 
      in this <ulink url="ghelp:gnome-feedback"  type="help">document</ulink>.
    </para>

    <para> This program is distributed 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. A copy of this license can be found at this
      <ulink url="ghelp:gpl" type="help">link</ulink>, or in the file
      COPYING included with the source code of this program. </para>

  </sect1> <!-- ============= End About ============================= -->

<!-- ============= Appendices ================================== -->
  <sect1 id="appendices">
    <title>Appendices</title>
  
      &faq;		    <!-- FAQ -->
      &keybind;		<!-- Keybindings reference -->
      &filtref;		<!-- Filter rule reference -->
      &cmdline;		<!-- Command line reference -->
      
  </sect1>

</article>