Documentation changes, DTD changes

svn: r404

doc/gramps-manual/C/gramps-manual.sgml

@@ -842,7 +842,45 @@
       </screenshot>
     </figure>
     <para>
-    FIXME: This section should describe the pedegree view.
+    Moving the mouse over a displayed name will display additional
+    information about a person, including their date of birth and date
+    of death. Double-clicking the box will display the <interface>Edit
+    Person</interface> dialog box for the person. Holding down the
+    Shift key while double-clicking will will make that person the
+    active person.
+    </para>
+    <para>
+    Navigation around the tree can be accomplished several
+    ways. Clicking on the arrow next to the active person will display
+    a menu listing the children of the active person. Selecting a
+    person from this list will change the active person to the
+    selected child, effectively shifting the pedegree view to the
+    left, or down one generation. Clicking one of the arrow buttons on
+    the left side of the screen will make the select either the active
+    person's father (top button) or mother (bottom button),
+    effectively shifting the pedegree view to the right, or up one
+    generation. If the active person does not have any children, then
+    the button on the left hand side of the screen will not
+    appear. Similarly, if the active person does have a father or
+    mother, the corresponding button on the right hand side of the
+    screen will not appear.
+    </para>
+    <figure id="navfigure-fig">
+      <title>Navigation</title>
+      <screenshot>
+	<screeninfo>Navigation</screeninfo>
+	<graphic fileref="pedegreesel" format="png" srccredit="Don Allingham">
+        </graphic>
+      </screenshot>
+    </figure>
+    <para>
+    As a quick short cut, double clicking on a line between two people
+    will make the person on the right hand side of the line the active
+    person. <xref linkend="navfigure-fig"> shows navigation using this
+    method. When the mouse is over one of the lines connecting
+    individuals, the line widens and becomes highlighted. In this
+    case, double-clcking on the line would make Hjalmar Smith the
+    active person.
     </para>
   </sect1>
 
@@ -868,7 +906,9 @@
       </screenshot>
     </figure>
     <para>
-    From this screen you are able to Add, Edit, and Delete sources.
+    From this screen you are able to Add and Edit sources. Currently,
+    deleting of sources is not available. This will be implemented in
+    a future version.
     </para>
   </sect1>
 
@@ -928,6 +968,16 @@
       allow you to quickly jump to a person, making that person the
       active person. This allows you to avoid searching for them
       everytime you want to add/change something in their information.
+      </para>
+      <figure id="gotobookmark">
+        <title>Using Bookmarks</title>
+        <screenshot>
+	  <screeninfo>Using Bookmarks</screeninfo>
+  	  <graphic fileref="gotobookmark" format="png" srccredit="Don Allingham">
+          </graphic>
+        </screenshot>
+      </figure>
+      <para>
       Choosing
         <menuchoice>
 	  <guimenu>Bookmarks</guimenu>
@@ -938,6 +988,16 @@
       select the person.
       </para>
       <para>
+      Choosing
+        <menuchoice>
+	  <guimenu>Bookmarks</guimenu>
+	  <guimenuitem>Go to Bookmark</guimenuitem>
+        </menuchoice>
+      displays a submenu which allows you to choose a person who was
+      previously bookmarked. Selecting a person from this menu will
+      make that person the active person.
+      </para>
+      <para>
       Choosing
         <menuchoice>
 	  <guimenu>Bookmarks</guimenu>
@@ -946,6 +1006,14 @@
       displays a dialog box that allows you to reorder or delete
       bookmarks in the list.
       </para>
+      <figure id="editbookmark">
+        <title>Editing Bookmarks</title>
+        <screenshot>
+	  <screeninfo>Editing Bookmarks</screeninfo>
+  	  <graphic fileref="editbookmarks" format="png" srccredit="Don Allingham">
+          </graphic>
+        </screenshot>
+      </figure>
     </sect2>
   </sect1>
 
@@ -1181,7 +1249,7 @@
         </screenshot>
       </figure>
       <para>
-      This allows you to set the default directory for your database,
+      This allows you to set the default directories for your databases,
       reports, and Web Sites.
       </para>
     </sect2>
@@ -1335,82 +1403,94 @@ appear in every gramps generated file.
         </graphic>
       </screenshot>
     </figure>
-    <sect2 id="analysis">
+    <variablelist>
       <title>Analysis and Exploration</title>
-      <itemizedlist>
+      <varlistentry>
+        <term>Compare individual events</term>
         <listitem>
 	  <para>
-	  <guilabel>Compare individual events</guilabel> &mdash; Aids
-	  in the analysis of data by allowing the development of
+	  Aids in the analysis of data by allowing the development of
 	  custom filters that can be applied to the database to find
 	  similar events.
           </para>
         </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Interactive descendant browser</term>
 	<listitem>
 	  <para>
-	  <guilabel>Interactive descendant browser</guilabel> &mdash;
 	  Provides a browsable hierarchy based on the active person.
 	  </para>
 	</listitem>
-      </itemizedlist>
-    </sect2>
-    <sect2 id="dataprocessing">
+      </varlistentry>
+    </variablelist>
+    <variablelist>
       <title>Data Processing</title>
-      <itemizedlist>
+      <varlistentry>
+        <term>Check and repair database</term>
         <listitem>
 	  <para>
-	  <guilabel>Check and repair database</guilabel> &mdash;
 	  Checks the database for integrity problems, fixing the
 	  problems that it can.
 	  </para>
 	</listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Extract information from names</term>
 	<listitem>
 	  <para>
-	  <guilabel>Extract information from names</guilabel> &mdash;
 	  Searches the entire database and attempts to extract titles
 	  and nicknames that may be embedded in a person's given name
 	  field.
 	  </para>
 	</listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Merge people</term>
 	<listitem>
 	  <para>
-	  <guilabel>Merge people</guilabel> &mdash; Searches the
-	  entire database, looking for individual entries that may
-	  represent the same person.
+	  Searches the entire database, looking for individual entries
+	  that may represent the same person.
 	  </para>
 	</listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Rename personal event types</term>
 	<listitem>
 	  <para>
-	  <guilabel>Rename personal event types</guilabel> &mdash;
 	  Allows all the events of a certain name to be renamed to a
 	  new name.
 	  </para>
 	</listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Reorder gramps ID's</term>
 	<listitem>
 	  <para>
-	  <guilabel>Reorder gramps ID's</guilabel> &mdash; Reorders the
-	  gramps ID's according to gramps' default rules.
+	  Reorders the gramps ID's according to gramps' default rules.
 	  </para>
 	</listitem>
-      </itemizedlist>
-    </sect2>
-    <sect2 id="reports_utilities">
+      </varlistentry>
+    </variablelist>
+    <variablelist>
       <title>Utilities</title>
-      <itemizedlist>
+      <varlistentry>
+        <term>Generate SoundEx codes</term>
         <listitem>
 	  <para>
-	  <guilabel>Generate SoundEx codes</guilabel> &mdash;
 	  Generates SoundEx codes for names.
 	  </para>
 	</listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Relationship calculator</term>
 	<listitem>
 	  <para>
-	  <guilabel>Relationship calculator</guilabel> &mdash;
 	  Calulates the relationship between two people.
 	  </para>
 	</listitem>
-      </itemizedlist>
-    </sect2>
+      </varlistentry>
+    </variablelist>
   </sect1>
 
  <!-- ============= Bugs ================================== 
@@ -1436,7 +1516,7 @@ appear in every gramps generated file.
     </para>
     <para>
     This manual was written by Don Allingham
-    (<email>donaldallingham@home.com</email>), Larry Allingham
+    (<email>dallingham@users.sourceforge.net</email>), Larry Allingham
     (<email>llkla@erinet.com</email>), and Shawn Ann Griffith
     (<email>shawnann1@home.com</email>).
     </para>

doc/gramps-manual/C/gramps-manual/bookmarks.html

@@ -122,7 +122,22 @@ NAME="BKMARKS"
       allow you to quickly jump to a person, making that person the
       active person. This allows you to avoid searching for them
       everytime you want to add/change something in their information.
-      Choosing
+      </P
+><DIV
+CLASS="FIGURE"
+><A
+NAME="GOTOBOOKMARK"
+></A
+><P
+><IMG
+SRC="gotobookmark.png"></P
+><P
+><B
+>Figure 18. Using Bookmarks</B
+></P
+></DIV
+><P
+>      Choosing
         <B
 CLASS="GUIMENU"
 >Bookmarks</B
@@ -141,11 +156,37 @@ CLASS="GUIMENU"
 >Bookmarks</B
 >-&gt;<B
 CLASS="GUIMENUITEM"
+>Go to Bookmark</B
+>
+      displays a submenu which allows you to choose a person who was
+      previously bookmarked. Selecting a person from this menu will
+      make that person the active person.
+      </P
+><P
+>      Choosing
+        <B
+CLASS="GUIMENU"
+>Bookmarks</B
+>-&gt;<B
+CLASS="GUIMENUITEM"
 >Edit Bookmarks</B
 >
       displays a dialog box that allows you to reorder or delete
       bookmarks in the list.
       </P
+><DIV
+CLASS="FIGURE"
+><A
+NAME="EDITBOOKMARK"
+></A
+><P
+><IMG
+SRC="editbookmarks.png"></P
+><P
+><B
+>Figure 19. Editing Bookmarks</B
+></P
+></DIV
 ></DIV
 ></DIV
 ><DIV

doc/gramps-manual/C/gramps-manual/bugs.html

@@ -1,133 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
-<HTML
-><HEAD
-><TITLE
->Known Bugs and Limitations</TITLE
-><META
-NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.59"><LINK
-REL="HOME"
-TITLE="gramps User Manual"
-HREF="index.html"><LINK
-REL="PREVIOUS"
-TITLE="Running Tools"
-HREF="runtools.html"><LINK
-REL="NEXT"
-TITLE="Authors"
-HREF="authors.html"></HEAD
-><BODY
-CLASS="SECT1"
-BGCOLOR="#FFFFFF"
-TEXT="#000000"
-LINK="#0000FF"
-VLINK="#840084"
-ALINK="#0000FF"
-><DIV
-CLASS="NAVHEADER"
-><TABLE
-WIDTH="100%"
-BORDER="0"
-CELLPADDING="0"
-CELLSPACING="0"
-><TR
-><TH
-COLSPAN="3"
-ALIGN="center"
->gramps User Manual</TH
-></TR
-><TR
-><TD
-WIDTH="10%"
-ALIGN="left"
-VALIGN="bottom"
-><A
-HREF="runtools.html"
->&#60;&#60;&#60; Previous</A
-></TD
-><TD
-WIDTH="80%"
-ALIGN="center"
-VALIGN="bottom"
-></TD
-><TD
-WIDTH="10%"
-ALIGN="right"
-VALIGN="bottom"
-><A
-HREF="authors.html"
->Next &#62;&#62;&#62;</A
-></TD
-></TR
-></TABLE
-><HR
-ALIGN="LEFT"
-WIDTH="100%"></DIV
-><DIV
-CLASS="SECT1"
-><H1
-CLASS="SECT1"
-><A
-NAME="BUGS"
->Known Bugs and Limitations</A
-></H1
-><P
->   This application has no known bugs.
-  </P
-></DIV
-><DIV
-CLASS="NAVFOOTER"
-><HR
-ALIGN="LEFT"
-WIDTH="100%"><TABLE
-WIDTH="100%"
-BORDER="0"
-CELLPADDING="0"
-CELLSPACING="0"
-><TR
-><TD
-WIDTH="33%"
-ALIGN="left"
-VALIGN="top"
-><A
-HREF="runtools.html"
->&#60;&#60;&#60; Previous</A
-></TD
-><TD
-WIDTH="34%"
-ALIGN="center"
-VALIGN="top"
-><A
-HREF="index.html"
->Home</A
-></TD
-><TD
-WIDTH="33%"
-ALIGN="right"
-VALIGN="top"
-><A
-HREF="authors.html"
->Next &#62;&#62;&#62;</A
-></TD
-></TR
-><TR
-><TD
-WIDTH="33%"
-ALIGN="left"
-VALIGN="top"
->Running Tools</TD
-><TD
-WIDTH="34%"
-ALIGN="center"
-VALIGN="top"
->&nbsp;</TD
-><TD
-WIDTH="33%"
-ALIGN="right"
-VALIGN="top"
->Authors</TD
-></TR
-></TABLE
-></DIV
-></BODY
-></HTML
->

doc/gramps-manual/C/gramps-manual/genreports.html

@@ -89,7 +89,7 @@ NAME="REPORT-FIG"
 SRC="reportsel.png"></P
 ><P
 ><B
->Figure 23. Report Generation Dialog</B
+>Figure 26. Report Generation Dialog</B
 ></P
 ></DIV
 ><P
@@ -270,7 +270,7 @@ appear in every gramps generated file.
 ></TABLE
 ><P
 ><B
->Figure 24. Sample HTML Template Example</B
+>Figure 27. Sample HTML Template Example</B
 ></P
 ></DIV
 ></DIV

doc/gramps-manual/C/gramps-manual/pedegreeview.html

@@ -99,7 +99,56 @@ SRC="pedegreeview.png"></P
 ></P
 ></DIV
 ><P
->    FIXME: This section should describe the pedegree view.
+>    Moving the mouse over a displayed name will display additional
+    information about a person, including their date of birth and date
+    of death. Double-clicking the box will display the <SPAN
+CLASS="INTERFACE"
+>Edit
+    Person</SPAN
+> dialog box for the person. Holding down the
+    Shift key while double-clicking will will make that person the
+    active person.
+    </P
+><P
+>    Navigation around the tree can be accomplished several
+    ways. Clicking on the arrow next to the active person will display
+    a menu listing the children of the active person. Selecting a
+    person from this list will change the active person to the
+    selected child, effectively shifting the pedegree view to the
+    left, or down one generation. Clicking one of the arrow buttons on
+    the left side of the screen will make the select either the active
+    person's father (top button) or mother (bottom button),
+    effectively shifting the pedegree view to the right, or up one
+    generation. If the active person does not have any children, then
+    the button on the left hand side of the screen will not
+    appear. Similarly, if the active person does have a father or
+    mother, the corresponding button on the right hand side of the
+    screen will not appear.
+    </P
+><DIV
+CLASS="FIGURE"
+><A
+NAME="NAVFIGURE-FIG"
+></A
+><P
+><IMG
+SRC="pedegreesel.png"></P
+><P
+><B
+>Figure 15. Navigation</B
+></P
+></DIV
+><P
+>    As a quick short cut, double clicking on a line between two people
+    will make the person on the right hand side of the line the active
+    person. <A
+HREF="pedegreeview.html#NAVFIGURE-FIG"
+>Figure 15</A
+> shows navigation using this
+    method. When the mouse is over one of the lines connecting
+    individuals, the line widens and becomes highlighted. In this
+    case, double-clcking on the line would make Hjalmar Smith the
+    active person.
     </P
 ></DIV
 ><DIV

doc/gramps-manual/C/gramps-manual/placelist.html

@@ -97,7 +97,7 @@ NAME="PLACEVIEW-FIG"
 SRC="placelist.png"></P
 ><P
 ><B
->Figure 16. Place View</B
+>Figure 17. Place View</B
 ></P
 ></DIV
 ><P

doc/gramps-manual/C/gramps-manual/prefs.html

@@ -84,7 +84,7 @@ CLASS="INTERFACE"
 >Preferences</SPAN
 > dialog, shown in <A
 HREF="prefs.html#PREFS_GEN"
->Figure 17 in the section called <I
+>Figure 20 in the section called <I
 >General Preferences</I
 ></A
 >.
@@ -107,7 +107,7 @@ NAME="PREFS_GEN"
 SRC="prefs_gen.png"></P
 ><P
 ><B
->Figure 17. Preferences Dialog</B
+>Figure 20. Preferences Dialog</B
 ></P
 ></DIV
 ><P
@@ -224,7 +224,7 @@ NAME="PREFS_FMT"
 SRC="prefs_fmt.png"></P
 ><P
 ><B
->Figure 18. Formats</B
+>Figure 21. Formats</B
 ></P
 ></DIV
 ><P
@@ -301,7 +301,7 @@ NAME="PREFS_APPEAR"
 SRC="prefs_appear.png"></P
 ><P
 ><B
->Figure 19. Preferences Dialog</B
+>Figure 22. Preferences Dialog</B
 ></P
 ></DIV
 ><P
@@ -389,7 +389,7 @@ NAME="PREFS_RESEARCH"
 SRC="prefs_research.png"></P
 ><P
 ><B
->Figure 20. Researcher Information Dialog</B
+>Figure 23. Researcher Information Dialog</B
 ></P
 ></DIV
 ><P
@@ -417,7 +417,7 @@ NAME="PREFS_REPORT"
 SRC="prefs_report.png"></P
 ><P
 ><B
->Figure 21. Report Preferences Dialog</B
+>Figure 24. Report Preferences Dialog</B
 ></P
 ></DIV
 ><P
@@ -461,11 +461,11 @@ NAME="PREFS_DIR"
 SRC="prefs_dir.png"></P
 ><P
 ><B
->Figure 22. Directory Preferences Dialog</B
+>Figure 25. Directory Preferences Dialog</B
 ></P
 ></DIV
 ><P
->      This allows you to set the default directory for your database,
+>      This allows you to set the default directories for your databases,
       reports, and Web Sites.
       </P
 ></DIV

doc/gramps-manual/C/gramps-manual/runtools.html

@@ -88,153 +88,111 @@ NAME="TOOLS-FIG"
 SRC="toolsel.png"></P
 ><P
 ><B
->Figure 25. Tool Selection Dialog</B
+>Figure 28. Tool Selection Dialog</B
 ></P
 ></DIV
-><DIV
-CLASS="SECT2"
-><H2
-CLASS="SECT2"
-><A
-NAME="ANALYSIS"
->Analysis and Exploration</A
-></H2
 ><P
 ></P
-><UL
-><LI
+><DIV
+CLASS="VARIABLELIST"
 ><P
->	  <TT
-CLASS="GUILABEL"
 ><B
->Compare individual events</B
-></TT
-> &#8212; Aids
-	  in the analysis of data by allowing the development of
+>Analysis and Exploration</B
+></P
+><DL
+><DT
+>Compare individual events</DT
+><DD
+><P
+>	  Aids in the analysis of data by allowing the development of
 	  custom filters that can be applied to the database to find
 	  similar events.
           </P
-></LI
-><LI
+></DD
+><DT
+>Interactive descendant browser</DT
+><DD
 ><P
->	  <TT
-CLASS="GUILABEL"
-><B
->Interactive descendant browser</B
-></TT
-> &#8212;
-	  Provides a browsable hierarchy based on the active person.
+>	  Provides a browsable hierarchy based on the active person.
 	  </P
-></LI
-></UL
+></DD
+></DL
 ></DIV
-><DIV
-CLASS="SECT2"
-><H2
-CLASS="SECT2"
-><A
-NAME="DATAPROCESSING"
->Data Processing</A
-></H2
 ><P
 ></P
-><UL
-><LI
+><DIV
+CLASS="VARIABLELIST"
 ><P
->	  <TT
-CLASS="GUILABEL"
 ><B
->Check and repair database</B
-></TT
-> &#8212;
-	  Checks the database for integrity problems, fixing the
+>Data Processing</B
+></P
+><DL
+><DT
+>Check and repair database</DT
+><DD
+><P
+>	  Checks the database for integrity problems, fixing the
 	  problems that it can.
 	  </P
-></LI
-><LI
+></DD
+><DT
+>Extract information from names</DT
+><DD
 ><P
->	  <TT
-CLASS="GUILABEL"
-><B
->Extract information from names</B
-></TT
-> &#8212;
-	  Searches the entire database and attempts to extract titles
+>	  Searches the entire database and attempts to extract titles
 	  and nicknames that may be embedded in a person's given name
 	  field.
 	  </P
-></LI
-><LI
+></DD
+><DT
+>Merge people</DT
+><DD
 ><P
->	  <TT
-CLASS="GUILABEL"
-><B
->Merge people</B
-></TT
-> &#8212; Searches the
-	  entire database, looking for individual entries that may
-	  represent the same person.
+>	  Searches the entire database, looking for individual entries
+	  that may represent the same person.
 	  </P
-></LI
-><LI
+></DD
+><DT
+>Rename personal event types</DT
+><DD
 ><P
->	  <TT
-CLASS="GUILABEL"
-><B
->Rename personal event types</B
-></TT
-> &#8212;
-	  Allows all the events of a certain name to be renamed to a
+>	  Allows all the events of a certain name to be renamed to a
 	  new name.
 	  </P
-></LI
-><LI
+></DD
+><DT
+>Reorder gramps ID's</DT
+><DD
 ><P
->	  <TT
-CLASS="GUILABEL"
-><B
->Reorder gramps ID's</B
-></TT
-> &#8212; Reorders the
-	  gramps ID's according to gramps' default rules.
+>	  Reorders the gramps ID's according to gramps' default rules.
 	  </P
-></LI
-></UL
+></DD
+></DL
 ></DIV
-><DIV
-CLASS="SECT2"
-><H2
-CLASS="SECT2"
-><A
-NAME="REPORTS_UTILITIES"
->Utilities</A
-></H2
 ><P
 ></P
-><UL
-><LI
+><DIV
+CLASS="VARIABLELIST"
 ><P
->	  <TT
-CLASS="GUILABEL"
 ><B
->Generate SoundEx codes</B
-></TT
-> &#8212;
-	  Generates SoundEx codes for names.
-	  </P
-></LI
-><LI
+>Utilities</B
+></P
+><DL
+><DT
+>Generate SoundEx codes</DT
+><DD
 ><P
->	  <TT
-CLASS="GUILABEL"
-><B
->Relationship calculator</B
-></TT
-> &#8212;
-	  Calulates the relationship between two people.
+>	  Generates SoundEx codes for names.
 	  </P
-></LI
-></UL
+></DD
+><DT
+>Relationship calculator</DT
+><DD
+><P
+>	  Calulates the relationship between two people.
+	  </P
+></DD
+></DL
 ></DIV
 ></DIV
 ><DIV

doc/gramps-manual/C/gramps-manual/sourcelist.html

@@ -97,11 +97,13 @@ NAME="SOURCEVIEW-FIG"
 SRC="sourcelist.png"></P
 ><P
 ><B
->Figure 15. Source list</B
+>Figure 16. Source list</B
 ></P
 ></DIV
 ><P
->    From this screen you are able to Add, Edit, and Delete sources.
+>    From this screen you are able to Add and Edit sources. Currently,
+    deleting of sources is not available. This will be implemented in
+    a future version.
     </P
 ></DIV
 ><DIV