Cyclone-Team/gramps
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

* doc/gramps-manual/C/mainwin.xml: wording fixes.

Browse Source 
svn: r5172
This commit is contained in:
Don Allingham 2005-09-03 05:19:26 +00:00
parent 973f550d94
commit ca7a190a80
5 changed files with 769 additions and 529 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
gramps2/ChangeLog
View File

@ -1,6 +1,7 @@
2005-09-02 Don Allingham <don@gramps-project.org> 2005-09-02 Don Allingham <don@gramps-project.org>
* src/GrampsBSDDB.py: fixed unicode/str problem * src/GrampsBSDDB.py: fixed unicode/str problem
* doc/gramps-manual/C/preface.xml: wording fixes. * doc/gramps-manual/C/preface.xml: wording fixes.
* doc/gramps-manual/C/mainwin.xml: wording fixes.
2005-09-01 Don Allingham <don@gramps-project.org> 2005-09-01 Don Allingham <don@gramps-project.org>
* src/docgen/OpenOfficeDoc.py: fix font point size handling * src/docgen/OpenOfficeDoc.py: fix font point size handling

244
gramps2/doc/gramps-manual/C/getstart.xml
View File

@ -22,163 +22,235 @@
<!-- $Id$ --> <!-- $Id$ -->
<title>Getting Started</title> <title>Getting Started</title>
<para>This chapter provides the most basic information on starting &app; <para>
and obtaining help. Please proceed to the following chapters for more This chapter provides the most basic information on starting
information.</para> &app; and obtaining help. Please proceed to the following
chapters for more information.
</para>
<!-- ================ Getting Started Subsection ====== -->
<!-- ================ Getting Started Subsection ====== -->
<sect1 id="gramps-start"> <sect1 id="gramps-start">
<title>To Start GRAMPS</title> <title>To Start GRAMPS</title>
<para>You can start &app; in the following ways:</para> <para>
You can start &app; in the following ways:
</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><guimenu>Applications</guimenu> menu</term> <term><guimenu>Applications</guimenu> menu</term>
<listitem><para>The method of starting &app; from the menus may vary from <listitem>
distribution to distribution. On default GNOME desktop, <para>
choose <menuchoice><guisubmenu>Other</guisubmenu> The method of starting &app; from the menus may vary
<guimenuitem>Gramps</guimenuitem></menuchoice>. </para></listitem> from distribution to distribution. On default GNOME
desktop, choose
<menuchoice><guisubmenu>Other</guisubmenu>
<guimenuitem>Gramps</guimenuitem></menuchoice>.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Command line</term> <term>Command line</term>
<listitem><para>To start &app; from a command line, type <listitem>
<command>gramps</command>, then press <keycap>Enter</keycap>.</para> <para>
To start &app; from a command line, type
<para>If you would like &app; to open a specific database or to <command>gramps</command>, then press
import a specific file on startup, you can supply the filename <keycap>Enter</keycap>.
as a command line argument:</para> </para>
<para>
If you would like &app; to open a specific database or to
import a specific file on startup, you can use the
filename as a command line argument:
</para>
<para> <para>
<command>gramps</command> <filename>filename.grdb</filename> <command>gramps</command> <filename>filename.grdb</filename>
</para> </para>
<para>
<para>where <filename>filename.grdb</filename> is the name where <filename>filename.grdb</filename> is the name of
of the file you want to open. The command line provides many more ways the file you want to open. The command line provides many
to start &app; and perform different tasks. The detailed reference to the more ways to start &app; and perform different tasks. The
command line options is found in the <xref linkend="append-cmdline"/>. detailed reference to the command line options is found
</para></listitem> in <xref linkend="append-cmdline"/>.
</para>
</listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</sect1> </sect1>
<!-- ================ Getting Started Subsection ==== --> <!-- ================ Getting Started Subsection ==== -->
<sect1 id="run-1st-time"> <sect1 id="run-1st-time">
<title>Running GRAMPS for the first time</title> <title>Running GRAMPS for the first time</title>
<para> <para>
The first time you run the program, GRAMPS will display its The first time you run the program, GRAMPS will display its
Getting Started dialogs. Follow the directions guiding you through Getting Started dialogs. Follow the directions that guide you through
<guilabel>Researcher information</guilabel>, <guilabel>Numerical date <guilabel>Researcher information</guilabel>, <guilabel>Numerical date
formats</guilabel>, <guilabel>Alternate calendar support</guilabel>, formats</guilabel>, <guilabel>Alternate calendar support</guilabel>,
and <guilabel>LDS extensions</guilabel> sections. Most of the dialogs and <guilabel>the LDS extensions</guilabel> sections. Most of the dialogs
are self-explanatory and will not be covered here. are self-explanatory and will not be covered here.
</para> </para>
<!-- ==== Figure: Getting Started Druid Window ==== --> <!-- ==== Figure: Getting Started Druid Window ==== -->
<figure id="druid-fig"> <figure id="druid-fig">
<title>GRAMPS Getting Started Window: Researcher Information</title> <title>GRAMPS Getting Started Window: Researcher Information</title>
<screenshot><mediaobject><imageobject><imagedata <screenshot>
fileref="figures/researcher.png" format="PNG"/></imageobject> <mediaobject>
<imageobject>
<imagedata fileref="figures/researcher.png" format="PNG"/>
</imageobject>
<textobject> <textobject>
<phrase>Shows Researcher Information Window. </phrase> <phrase>Shows Researcher Information Window. </phrase>
</textobject></mediaobject></screenshot></figure> </textobject>
<!-- ==== End of Figure ==== --> </mediaobject>
</screenshot>
</figure>
<para>Enter your personal information in the corresponding <!-- ==== End of Figure ==== -->
text entry fields. Although &app; requests information about you,
this information is used only so that &app; can create valid GEDCOM <para>
output files. A valid GEDCOM file requires information about the file's Enter your personal information in the corresponding text entry
creator. If you choose, you may leave the information empty, however fields. Although &app; requests information about you, this
all the GEDCOM files you export will not be valid. information is used only so that &app; can create valid GEDCOM
output files. A valid GEDCOM file requires information about the
file's creator. If you choose, you may leave the information
empty, however all the GEDCOM files you export will be invalid.
</para> </para>
<para>
<para>This information can be entered at any time in the This information can be entered at any time in the
<guilabel>Preferences</guilabel> dialog, under the <guilabel>Preferences</guilabel> dialog, under the
<guilabel>Database/Researcher Information</guilabel> category. <guilabel>Database/Researcher Information</guilabel> category.
</para> </para>
</sect1> </sect1>
<!-- ================ Getting Started Subsection --> <!-- ================ Getting Started Subsection -->
<sect1 id="choose-db-start"> <sect1 id="choose-db-start">
<title>Choosing a database on startup</title> <title>Choosing a database on startup</title>
<para>If &app; is started without any <para>
database to open, the following window will appear prompting you to If &app; is started without a database selected, the following
choose what database to open. </para> window will appear prompting you to choose one to open.
</para>
<!-- ==== Figure: Open existing/new database window ==== -->
<!-- ==== Figure: Open existing/new database window ==== -->
<figure id="first-open"> <figure id="first-open">
<title>Open Database Window</title> <title>Open Database Window</title>
<screenshot><mediaobject><imageobject><imagedata <screenshot>
fileref="figures/first-open.png" format="PNG"/></imageobject> <mediaobject>
<imageobject>
<imagedata fileref="figures/first-open.png" format="PNG"/>
</imageobject>
<textobject> <textobject>
<phrase>Shows Open Database Window. </phrase> <phrase>Shows Open Database Window.</phrase>
</textobject></mediaobject></screenshot></figure> </textobject>
<!-- ==== End of Figure ==== --> </mediaobject>
</screenshot>
</figure>
<para>If you would like to open an existing database, check the top radio <!-- ==== End of Figure ==== -->
button and click the <guibutton>OK</guibutton> button. You will then be asked to
specify the name of your existing database. If you would like to start <para>
creating your brand new database from scratch right away, choose new If you would like to open an existing database, check the top
database. </para> radio button and click the <guibutton>OK</guibutton>
button. You will then be asked to specify the name of your
existing database. If you would like to immediately create a
brand new database from scratch right away, choose new
database.
</para>
<note id="file-notdir-note"> <note id="file-notdir-note">
<title>Selecting file</title> <title>Selecting file</title>
<para> <para>
Unlike the version 1.0.X of &app;, this version does not require selecting directory This version of &app; does not require selecting a directory
for the database. Please select filename, as you would in any other application. for the database. Please select filename, as you would in any
other application.
</para> </para>
</note> </note>
</sect1> </sect1>
<!-- ================ Getting Started Subsection ==== -->
<!-- ================ Getting Started Subsection ==== -->
<sect1 id="get-help"> <sect1 id="get-help">
<title>Obtaining Help</title> <title>Obtaining Help</title>
<para> At any time, the following items are available for immediate aid <para>
from the <menuchoice><guimenu>Help</guimenu></menuchoice> menu: </para> The following items are available from the
<menuchoice><guimenu>Help</guimenu></menuchoice> to provide
immediate assistance:
</para>
<variablelist> <variablelist>
<varlistentry><term>User manual</term> <varlistentry>
<listitem><para> Choose this item to read the text of this manual <term>User manual</term>
in the help browser. </para></listitem> <listitem>
<para>
Select this item to access this manual in the help browser.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry><term>FAQ</term> <varlistentry>
<listitem><para> Use this item to read Frequently Asked Questions <term>FAQ</term>
about &app; in the browser. </para></listitem> <listitem>
<para>
Select this item to read the Frequently Asked Questions about
&app; in the browser.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry><term>GRAMPS home page</term> <varlistentry>
<listitem><para> Select this item to open home page of &app; in your <term>GRAMPS home page</term>
default web browser. </para></listitem> <listitem>
<para>
Select this item to open the home page of &app; in your
default web browser.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry><term>GRAMPS mailing lists</term> <varlistentry>
<listitem><para> Choose this item to direct your web browser <term>GRAMPS mailing lists</term>
to the &app; mailing list archives. </para></listitem> <listitem>
<para>
Select this item to direct your web browser
to the &app; mailing list archives.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry><term>Report a bug</term> <varlistentry>
<listitem><para> Use this item to file a bug report against &app; <term>Report a bug</term>
with the bug tracking system. </para></listitem> <listitem>
<para>
Select this item to file a bug report regarding &app;
with the bug tracking system.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry><term>Show plugin status</term> <varlistentry>
<listitem><para> Use this item to display the status of loaded <term>Show plugin status</term>
plugins. </para></listitem> <listitem>
<para>
Select this item to display the status of loaded plugins.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry><term>Open example database</term> <varlistentry>
<listitem><para> Select this item to load the example database shipped <term>Open example database</term>
with &app;. This database is composed of fictitious people and serves as <listitem>
a useful example for learning how to work with &app;. </para></listitem> <para>
Select this item to load the example database shipped
with &app;. This database is composed of fictitious
people and serves as a useful example for learning how
to work with &app;.
</para>
</listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</sect1> </sect1>
</chapter>
</chapter>

42
gramps2/doc/gramps-manual/C/gramps-manual.xml
View File

@ -1,4 +1,4 @@
<?xml version="1.0"?> <?xml version="1.0" encoding="UTF-8"?>
<?yelp:chunk-depth 3?> <?yelp:chunk-depth 3?>
<!-- <!--
User Manual for Gramps - a GTK+/GNOME based genealogy program User Manual for Gramps - a GTK+/GNOME based genealogy program
@ -36,7 +36,7 @@
<!ENTITY appversion "2.0.0"> <!ENTITY appversion "2.0.0">
<!ENTITY manrevision "2.6"> <!ENTITY manrevision "2.6">
<!ENTITY date "May 2005"> <!ENTITY date "Aug 2005">
<!ENTITY app "GRAMPS"> <!ENTITY app "GRAMPS">
<!-- The rest of the entities is simply the chapters of the manual.. --> <!-- The rest of the entities is simply the chapters of the manual.. -->
@ -77,10 +77,13 @@
<holder>ME-THE-TRANSLATOR (Latin translation)</holder> <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
</copyright> </copyright>
--> -->
<!-- An address can be added to the publisher information. If a role is
<!--
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 not specified, the publisher/author is the same for all versions of the
document. --> document.
-->
<publisher> <publishername> GRAMPS Project </publishername> </publisher> <publisher> <publishername> GRAMPS Project </publishername> </publisher>
&legal; &legal;
@ -93,7 +96,9 @@
<surname>Roitman</surname> <surname>Roitman</surname>
<affiliation> <affiliation>
<orgname>GRAMPS Project</orgname> <orgname>GRAMPS Project</orgname>
<address> <email>shura@gramps-project.org</email> </address> <address>
<email>shura@gramps-project.org</email>
</address>
</affiliation> </affiliation>
</author> </author>
<author> <author>
@ -101,7 +106,9 @@
<surname>Allingham</surname> <surname>Allingham</surname>
<affiliation> <affiliation>
<orgname>GRAMPS Project</orgname> <orgname>GRAMPS Project</orgname>
<address> <email>don@gramps-project.org</email> </address> <address>
<email>don@gramps-project.org</email>
</address>
</affiliation> </affiliation>
</author> </author>
@ -139,7 +146,8 @@
<date>&date;</date> <date>&date;</date>
<revdescription> <revdescription>
<para role="author">Alex Roitman <para role="author">Alex Roitman
<email>shura@gramps-project.org</email></para> <email>shura@gramps-project.org</email>
</para>
<para role="publisher">GRAMPS Project</para> <para role="publisher">GRAMPS Project</para>
</revdescription> </revdescription>
</revision> </revision>
@ -148,7 +156,8 @@
<date>February 2004</date> <date>February 2004</date>
<revdescription> <revdescription>
<para role="author">Alex Roitman <para role="author">Alex Roitman
<email>shura@gramps-project.org</email></para> <email>shura@gramps-project.org</email>
</para>
<para role="publisher">GRAMPS Project</para> <para role="publisher">GRAMPS Project</para>
</revdescription> </revdescription>
</revision> </revision>
@ -157,7 +166,8 @@
<date>December 2003</date> <date>December 2003</date>
<revdescription> <revdescription>
<para role="author">Alex Roitman <para role="author">Alex Roitman
<email>shura@gramps-project.org</email></para> <email>shura@gramps-project.org</email>
</para>
<para role="publisher">GRAMPS Project</para> <para role="publisher">GRAMPS Project</para>
</revdescription> </revdescription>
</revision> </revision>
@ -166,7 +176,8 @@
<date>September 2003</date> <date>September 2003</date>
<revdescription> <revdescription>
<para role="author">Alex Roitman <para role="author">Alex Roitman
<email>shura@gramps-project.org</email></para> <email>shura@gramps-project.org</email>
</para>
<para role="publisher">GRAMPS Project</para> <para role="publisher">GRAMPS Project</para>
</revdescription> </revdescription>
</revision> </revision>
@ -175,9 +186,11 @@
<date>July 2003</date> <date>July 2003</date>
<revdescription> <revdescription>
<para role="author">Alex Roitman <para role="author">Alex Roitman
<email>shura@gramps-project.org</email></para> <email>shura@gramps-project.org</email>
</para>
<para role="author">Donald A. Peterson <para role="author">Donald A. Peterson
<email>dpeterson@sigmaxi.org</email></para> <email>dpeterson@sigmaxi.org</email>
</para>
<para role="publisher">GRAMPS Project</para> <para role="publisher">GRAMPS Project</para>
</revdescription> </revdescription>
</revision> </revision>
@ -223,7 +236,8 @@
</revision> </revision>
</revhistory> </revhistory>
<releaseinfo>This manual describes version &appversion; of GRAMPS. <releaseinfo>
This manual describes version &appversion; of GRAMPS.
</releaseinfo> </releaseinfo>
</bookinfo> </bookinfo>

617
gramps2/doc/gramps-manual/C/mainwin.xml
View File

@ -23,57 +23,99 @@
<!-- $Id$ --> <!-- $Id$ -->
<title>Main Window</title> <title>Main Window</title>
<para>When you open a database (either existing or brand new),
the following window is displayed.</para>
<!-- ==== Figure: Main Window ==== --> <para>
<figure id="mainwin-fig"> When you open a database (either existing or brand new), the
following window is displayed.
</para>
<!-- ==== Figure: Main Window ==== -->
<figure id="mainwin-fig" pgwide="1">
<title>GRAMPS Main Window</title> <title>GRAMPS Main Window</title>
<screenshot><mediaobject><imageobject><imagedata <screenshot>
fileref="figures/mainwin.png" format="PNG"/></imageobject> <mediaobject>
<imageobject>
<imagedata fileref="figures/mainwin.png" format="PNG"/>
</imageobject>
<textobject> <textobject>
<phrase>Shows GRAMPS main window. Contains titlebar, menubar, <phrase>
Shows GRAMPS main window. Contains titlebar, menubar,
toolbar, sidebar, display area, statusbar, progressbar, and toolbar, sidebar, display area, statusbar, progressbar, and
scrollbars. Menubar contains File, Edit, View, Go, Bookmarks, scrollbars. Menubar contains File, Edit, View, Go, Bookmarks,
Reports, Tools, Settings, and Help menus. </phrase> Reports, Tools, Settings, and Help menus.
</textobject></mediaobject></screenshot></figure> </phrase>
<!-- ==== End of Figure ==== --> </textobject>
</mediaobject>
</screenshot>
</figure>
<!-- ==== End of Figure ==== -->
<para>
The &app; window contains the following elements:
</para>
<para>The &app; window contains the following elements: </para>
<variablelist> <variablelist>
<varlistentry><term>Menubar</term>
<listitem><para>The menubar is located at the very top of the window <varlistentry>
(right below the window title) and provides access to all features of <term>Menubar</term>
&app; through its menus.</para></listitem> <listitem>
<para>
The menubar is located at the very top of the window (right
below the window title) and provides access to all features
of &app; through its menus.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry><term>Toolbar</term>
<listitem><para> The toolbar is located immediately below the menubar. <varlistentry>
The toolbar provides access to the most frequently used functions <term>Toolbar</term>
of &app;. The appearance of the toolbar <listitem>
can be adjusted in the <guilabel>Preferences</guilabel> <para>
dialog. </para></listitem> The toolbar is located immediately below the menubar. The
toolbar provides access to the most frequently used
functions of &app;. The appearance of the toolbar can be
adjusted in the <guilabel>Preferences</guilabel> dialog.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry><term>Progressbar</term>
<listitem><para>The progressbar is located in the lower left corner <varlistentry>
of the &app; window. It displays the <term>Progressbar</term>
progress of time consuming operations, such as opening and saving <listitem>
large data bases, importing and exporting to other formats, generating <para>
web sites, etc. </para></listitem> The progressbar is located in the lower left corner of the
&app; window. It displays the progress of time consuming
operations, such as opening and saving large data bases,
importing and exporting to other formats, generating web
sites, etc.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry><term>Statusbar</term>
<listitem><para>The statusbar is located to the right of the <varlistentry>
progressbar, on the very bottom of the &app; window. <term>Statusbar</term>
It displays information about current &app; <listitem>
activity and contextual information about the menu items. <para>
The behavior of the statusbar can be adjusted in The statusbar is located to the right of the progressbar, on
<guilabel>Preferences</guilabel> dialog. </para></listitem> the very bottom of the &app; window. It displays
information about current &app; activity and contextual
information about the menu items. The behavior of the
statusbar can be adjusted in
<guilabel>Preferences</guilabel> dialog.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry><term>Display area</term>
<listitem><para>The largest area in the center of the <varlistentry>
&app; window is the display area. <term>Display area</term>
It shows certain aspects of genealogical information, depending on the <listitem>
currently selected View. The following six Views are available <para>
in &app;: The largest area in the center of the &app; window is the
display area. It shows certain aspects of genealogical
information, depending on the currently selected View. The
following six Views are available in &app;:
<itemizedlist> <itemizedlist>
<listitem><para>People View</para></listitem> <listitem><para>People View</para></listitem>
<listitem><para>Family View</para></listitem> <listitem><para>Family View</para></listitem>
@ -81,265 +123,368 @@
<listitem><para>Sources View</para></listitem> <listitem><para>Sources View</para></listitem>
<listitem><para>Places View</para></listitem> <listitem><para>Places View</para></listitem>
<listitem><para>Media View</para></listitem> <listitem><para>Media View</para></listitem>
</itemizedlist> </itemizedlist>
</para></listitem> </para>
</listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<!-- ================ Main Window Subsection --> <!-- ================ Main Window Subsection -->
<sect1 id="gramps-views"> <sect1 id="gramps-views">
<title>Views</title> <title>Views</title>
<para>Views are the various ways to display different aspects of <para>
Views are the various ways to display different aspects of
genealogical information, as described below. Since the relevant genealogical information, as described below. Since the relevant
information is very broad and non-uniform in both context and modality, information is very broad and non-uniform in both context and
it is best to split its display into smaller categories, uniform in modality, it is best to split its display into smaller
context and modality. Each View represents such a split and displays a categories, uniform in context and modality. Each View
certain portion of overall available information. Before the detailed represents such a split and displays a certain portion of
description of available Views, let us guide you through the ways of overall available information. Before the detailed description
switching between the Views.</para> of available Views, let us guide you through the ways of
switching between the Views.
</para>
<!-- ================ Main Window Sub-subsection -->
<!-- ================ Main Window Sub-subsection -->
<sect2 id="view-modes"> <sect2 id="view-modes">
<title>Switching Views and Viewing Modes</title> <title>Switching Views and Viewing Modes</title>
<para>Depending on the state of the <menuchoice> <para>
Depending on the state of the <menuchoice>
<guimenu>View</guimenu><guimenuitem>Sidebar</guimenuitem> <guimenu>View</guimenu><guimenuitem>Sidebar</guimenuitem>
</menuchoice> menu item, the View could be switched either in the </menuchoice> menu item, the View could be switched either in
sidebar or in the notebook tabs in the top part of the window. the sidebar or in the notebook tabs in the top part of the
window.
</para> </para>
<variablelist> <variablelist>
<varlistentry><term>To switch the View while in a Sidebar mode, <varlistentry>
click on the desired sidebar icon.</term> <term>
To switch the View while in a Sidebar mode,
click on the desired sidebar icon.
</term>
<listitem> <listitem>
<!-- ==== Figure: Sidebar Mode ==== -->
<!-- ==== Figure: Sidebar Mode ==== -->
<figure id="side-nofilt-fig"> <figure id="side-nofilt-fig">
<title>Sidebar Viewing Mode</title> <title>Sidebar Viewing Mode</title>
<screenshot><mediaobject><imageobject><imagedata <screenshot>
fileref="figures/mainwin.png" format="PNG"/></imageobject> <mediaobject>
<imageobject>
<imagedata fileref="figures/mainwin.png" format="PNG"/>
</imageobject>
<textobject> <textobject>
<phrase>Shows sidebar viewing mode. </phrase> <phrase>Shows sidebar viewing mode.</phrase>
</textobject></mediaobject></screenshot></figure> </textobject>
<!-- ==== End of Figure ==== --> </mediaobject>
</listitem></varlistentry> </screenshot>
</figure>
<varlistentry><term>To switch the View while in a Tabbed mode, <!-- ==== End of Figure ==== -->
click on the desired notebook tab.</term>
</listitem>
</varlistentry>
<varlistentry>
<term>
To switch the View while in a Tabbed mode,
click on the desired notebook tab.
</term>
<listitem> <listitem>
<!-- ==== Figure: Tabbed Notebook Mode ==== --> <!-- ==== Figure: Tabbed Notebook Mode ==== -->
<figure id="noside-nofilt-fig"> <figure id="noside-nofilt-fig">
<title>Tabbed Viewing Mode</title> <title>Tabbed Viewing Mode</title>
<screenshot><mediaobject><imageobject><imagedata <screenshot>
fileref="figures/noside-nofilt.png" format="PNG"/></imageobject> <mediaobject>
<imageobject>
<imagedata fileref="figures/noside-nofilt.png" format="PNG"/>
</imageobject>
<textobject> <textobject>
<phrase>Shows tabbed viewing mode. </phrase> <phrase>Shows tabbed viewing mode.</phrase>
</textobject></mediaobject></screenshot></figure> </textobject>
<!-- ==== End of Figure ==== --> </mediaobject>
</listitem></varlistentry> </screenshot>
</figure>
<!-- ==== End of Figure ==== -->
</listitem>
</varlistentry>
</variablelist> </variablelist>
<para>To switch between sidebar and tabbed viewing modes, <para>
choose <menuchoice> <guimenu>View</guimenu> To switch between sidebar and tabbed viewing modes, choose
<guimenuitem>Sidebar</guimenuitem> <menuchoice> <guimenu>View</guimenu>
</menuchoice> from the &app; menu.</para> <guimenuitem>Sidebar</guimenuitem> </menuchoice> from the
&app; menu.
</para>
</sect2> </sect2>
<!-- ================ Main Window Sub-subsection --> <!-- ================ Main Window Sub-subsection -->
<sect2 id="people-view"> <sect2 id="people-view">
<title>People View</title> <title>People View</title>
<para>When &app; first opens a database, <para>
the View is set to the People View (<xref linkend="side-nofilt-fig"/> When &app; first opens a database, the View is set to the
and <xref linkend="noside-nofilt-fig"/>). The People View lists People View (<xref linkend="side-nofilt-fig"/> and <xref
individuals whose data is stored in the database.</para> linkend="noside-nofilt-fig"/>). The People View lists
individuals whose data is stored in the database.
<para> The individuals are arranged in a tree-like structure, </para>
according to their family names. Every family name is a node of the <para>
tree. Clicking the arrow on the left of the node will toggle its The individuals are arranged in a tree-like structure,
expansion state. When expanded, the node's content is listed in the according to their family names. Every family name is a node
window. When collapsed, the contents is rolled up and not visible. of the tree. Clicking the arrow on the left of the node will
However, all the data is still intact, it is just not being displayed. toggle its expansion state. When expanded, the node's content
is listed in the window. When collapsed, the contents is
rolled up and not visible. However, all the data is still
intact, it is just not being displayed.
</para>
<para>
The People View in its default state displays people's
<guilabel>Names</guilabel>, &app; <guilabel>ID</guilabel>
numbers, <guilabel>Gender</guilabel>, and their
<guilabel>Birth</guilabel> and <guilabel>Death
dates</guilabel>. The list can be ordered by any field.
</para> </para>
<para>The People View in its default state <tip id="columns-tip">
displays people's <guilabel>Names</guilabel>, <title>Order list by selected column</title>
&app; <guilabel>ID</guilabel> numbers, <para>
<guilabel>Gender</guilabel>, and To order list by the Birth date, click on the
their <guilabel>Birth</guilabel> and <guilabel>Death dates</guilabel>. <guilabel>Birth date</guilabel> column heading. To order
The list can be ordered by any field. </para> list in reverse (descending) order, click one more time on
the desired column heading.
</para>
</tip>
<tip id="columns-tip"><title>Order list by selected column</title> <para>
<para>To order list by the Birth date, click on the The columns of the view may be added, removed, or reordered in
<guilabel>Birth date</guilabel> column heading. To order list in a <guilabel>Column Editor Dialog</guilabel>, see <xref
reverse (descending) order, click one more time on the desired column linkend="column-editor-fig"/>. Only checked columns will be
heading. </para> </tip> shown in the view. To change their order, drag any column to
its desired place inside the editor. Clicking
<para>The columns of the view may be <guibutton>OK</guibutton> will reflect the changes in the
added, removed, or reordered in a <guilabel>Column Editor Dialog</guilabel>, People View. To invoke <guilabel>Column Editor
see <xref linkend="column-editor-fig"/>. Only checked columns will be shown Dialog</guilabel>, choose
in the view. To change their order, drag any column to its desired place inside <menuchoice><guimenu>Edit</guimenu><guimenuitem>Column
the editor. Clicking <guibutton>OK</guibutton> will reflect the changes
in the People View. To invoke <guilabel>Column Editor Dialog</guilabel>,
choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Column
Editor</guimenuitem></menuchoice>. Editor</guimenuitem></menuchoice>.
</para> </para>
<tip id="columns-tip2"><title>Other Views</title> <tip id="columns-tip2">
<para>The <guilabel>Column Editor</guilabel> is available <title>Other Views</title>
and works in the same way for all list views, not only People View.</para> </tip> <para>
The <guilabel>Column Editor</guilabel> is available and
works in the same way for all list views, not only People
View.
</para>
</tip>
<!-- ==== Figure: Enabled Filter ==== -->
<!-- ==== Figure: Enabled Filter ==== -->
<figure id="column-editor-fig"> <figure id="column-editor-fig">
<title>Column Editor Dialog</title> <title>Column Editor Dialog</title>
<screenshot><mediaobject><imageobject><imagedata <screenshot>
fileref="figures/column-editor.png" format="PNG"/></imageobject> <mediaobject>
<imageobject>
<imagedata fileref="figures/column-editor.png" format="PNG"/>
</imageobject>
<textobject> <textobject>
<phrase>Shows column editor dialog. </phrase> <phrase>Shows column editor dialog. </phrase>
</textobject></mediaobject></screenshot></figure> </textobject>
</mediaobject>
</screenshot>
</figure>
<!-- ================ Main Window Sub-sub-subsection -->
<!-- ================ Main Window Sub-sub-subsection -->
<sect3 id="filters"> <sect3 id="filters">
<title>Filters</title> <title>Filters</title>
<para>Genealogical databases may contain huge numbers of people. <para>
Since the long lists are hard for humans to handle, Genealogical databases may contain huge numbers of people.
&app; provides a convenient way to limit Since the long lists are hard for humans to handle, &app;
the scope of browsing by using the filter. To save screen space, provides a convenient way to limit the scope of browsing by
filter controls may be hidden, depending on the state of using the filter. To save screen space, filter controls may
<menuchoice> <guimenu>View</guimenu> be hidden, depending on the state of <menuchoice>
<guimenuitem>Filter</guimenuitem> </menuchoice> menu item.</para> <guimenu>View</guimenu> <guimenuitem>Filter</guimenuitem>
</menuchoice> menu item.
</para>
<!-- ==== Figure: Enabled Filter ==== -->
<!-- ==== Figure: Enabled Filter ==== -->
<figure id="side-filt-fig"> <figure id="side-filt-fig">
<title>Filter Controls Displayed</title> <title>Filter Controls Displayed</title>
<screenshot><mediaobject><imageobject><imagedata <screenshot>
fileref="figures/side-filt.png" format="PNG"/></imageobject> <mediaobject>
<imageobject>
<imagedata fileref="figures/side-filt.png" format="PNG"/>
</imageobject>
<textobject> <textobject>
<phrase>Shows filter controls. </phrase> <phrase>Shows filter controls.</phrase>
</textobject></mediaobject></screenshot></figure> </textobject>
<!-- ==== End of Figure ==== --> </mediaobject>
</screenshot>
</figure>
<para>When &app; opens a database, the <!-- ==== End of Figure ==== -->
filter is set to the trivial filter called <guilabel>All
people</guilabel>, i.e. no filtering is in effect. To choose a
filter, use the pop-up <guilabel>Filter</guilabel> menu above the
people's list. Once the filter is chosen, click the
<guibutton>Apply</guibutton> button in the upper right corner of the
window. The filtering will take effect upon clicking the
<guibutton>Apply</guibutton> button. </para>
<tip id="filt-tip"><title>Example filter use</title> <para>
<para>To show males only, choose When &app; opens a database, the filter is set to the
<guilabel>Males</guilabel> filter, then click the trivial filter called <guilabel>All people</guilabel>,
<guibutton>Apply</guibutton> button. To cancel any filtering, set i.e. no filtering is in effect. To choose a filter, use the
the filter to <guilabel>Entire Database</guilabel> pop-up <guilabel>Filter</guilabel> menu above the people's
and then click the <guibutton>Apply</guibutton> button.</para> list. Once the filter is chosen, click the
<guibutton>Apply</guibutton> button in the upper right
corner of the window. The filtering will take effect upon
clicking the <guibutton>Apply</guibutton> button.
</para>
<tip id="filt-tip">
<title>Example filter use</title>
<para>
To show males only, choose <guilabel>Males</guilabel>
filter, then click the <guibutton>Apply</guibutton>
button. To cancel any filtering, set the filter to
<guilabel>Entire Database</guilabel> and then click the
<guibutton>Apply</guibutton> button.
</para>
</tip> </tip>
<note id="filt-note"> <note id="filt-note">
<title>Filtering is persistent</title> <title>Filtering is persistent</title>
<para> Even if the filter controls are not displayed <para>
Even if the filter controls are not displayed
(<menuchoice> <guimenu>View</guimenu> (<menuchoice> <guimenu>View</guimenu>
<guimenuitem>Filter</guimenuitem> </menuchoice> menu item is <guimenuitem>Filter</guimenuitem> </menuchoice> menu
unchecked), the filtering might still be in place. In other words, item is unchecked), the filtering might still be in
the visibility of the filter controls is not related to the actual place. In other words, the visibility of the filter
filtering imposed on the list.</para> controls is not related to the actual filtering imposed
on the list.
<para>This may be a cause of confusion, when </para>
you enable the filtering and then remove the controls from the <para>
display. If in doubt, enable the display of filter controls by This may be a cause of confusion, when you enable the
checking <menuchoice> <guimenu>View</guimenu> filtering and then remove the controls from the
<guimenuitem>Filter</guimenuitem> </menuchoice> menu item and check display. If in doubt, enable the display of filter
what kind of filtering is currently set.</para> controls by checking <menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Filter</guimenuitem> </menuchoice> menu
item and check what kind of filtering is currently set.
</para>
</note> </note>
</sect3> </sect3>
</sect2> </sect2>
<!-- ================ Main Window Sub-subsection --> <!-- ================ Main Window Sub-subsection -->
<sect2 id="family-view"> <sect2 id="family-view">
<title>Family View</title> <title>Family View</title>
<para>Family View displays the family information of a currently <para>
selected (or Active) person. Specifically, this view shows the Family View displays the family information of a currently
relationships (e.g marriages, partnerships, etc.) of the active selected (or Active) person. Specifically, this view shows
person, his/her parents (or step parents, or guardians, etc), and the relationships (e.g marriages, partnerships, etc.) of the
his/her children (could be step children, adopted children, etc.). active person, his/her parents (or step parents, or
guardians, etc), and his/her children (could be step
children, adopted children, etc.).
</para> </para>
<!-- ==== Figure: Family View ==== --> <!-- ==== Figure: Family View ==== -->
<figure id="family-fig"> <figure id="family-fig">
<title>Family View</title> <title>Family View</title>
<screenshot><mediaobject><imageobject><imagedata <screenshot>
fileref="figures/family.png" format="PNG"/></imageobject> <mediaobject>
<imageobject>
<imagedata fileref="figures/family.png" format="PNG"/>
</imageobject>
<textobject> <textobject>
<phrase>Shows Family View. </phrase> <phrase>Shows Family View.</phrase>
</textobject></mediaobject></screenshot></figure> </textobject>
</mediaobject>
</screenshot>
</figure>
<!-- ==== End of Figure ==== --> <!-- ==== End of Figure ==== -->
<para>The Active person's data is in the list box in the upper left <para>
corner of the window. Directly below it, another box lists the Spouse's The Active person's data is in the list box in the upper
data, for each relationship of Active person (can be more than one). left corner of the window. Directly below it, another box
The double-arrow button to the right of the Active person list box lists the Spouse's data, for each relationship of Active
allows you to exchange the currently selected spouse (Current spouse) person (can be more than one). The double-arrow button to
with the Active person. Double-clicking on the Active person allows the the right of the Active person list box allows you to
editing of Active person's data. Double-clicking on the Current spouse exchange the currently selected spouse (Current spouse) with
allows you to edit their relationship information. Shift-clicking on the Active person. Double-clicking on the Active person
the Current spouse allows the editing of the Current spouse's data.</para> allows the editing of Active person's data. Double-clicking
on the Current spouse allows you to edit their relationship
<para> To add a new relationship, use one of the two upper buttons to the information. Shift-clicking on the Current spouse allows the
right of the spouse box. Click the top one to add a new person to a editing of the Current spouse's data.
database and to the new relationship. Click the middle one to add a </para>
person already existing in the database to the new relationship. <para>
To remove Current spouse, click the lowest button To add a new relationship, use one of the two upper buttons
(<guibutton>-</guibutton>) to the to the right of the spouse box. Click the top one to add a
right of the spouse box. Note that removing a spouse from the new person to a database and to the new relationship. Click
relationship does not remove the person from the database. Most of these the middle one to add a person already existing in the
functions are also available by right-clicking into the spouse box and database to the new relationship. To remove Current spouse,
selecting an appropriate item from the context menu. </para> click the lowest button (<guibutton>-</guibutton>) to the
right of the spouse box. Note that removing a spouse from
<para>The parents of both the Active person and the Current spouse the relationship does not remove the person from the
are listed in the corresponding list boxes in the right-hand part of database. Most of these functions are also available by
the window (Active person's parents on top, Current spouse parents right-clicking into the spouse box and selecting an
on the bottom). Both list boxes have a set of three buttons on their appropriate item from the context menu.
right side. The <guibutton>+</guibutton> and <guibutton>-</guibutton> </para>
buttons allow you to add and remove parents of the Active person and the <para>
Current spouse, respectively. Clicking the right arrow button The parents of both the Active person and the Current spouse
makes the family in the corresponding list box an active family. are listed in the corresponding list boxes in the right-hand
That is, it makes the selected Father the Active person, and the part of the window (Active person's parents on top, Current
selected Mother the Current spouse. Most of these spouse parents on the bottom). Both list boxes have a set of
functions are also available by right-clicking into the parent box and three buttons on their right side. The
selecting an appropriate item from the context menu. </para> <guibutton>+</guibutton> and <guibutton>-</guibutton>
buttons allow you to add and remove parents of the Active
<para>The bottom list box displays children of the Active person and person and the Current spouse, respectively. Clicking the
the Current Spouse. The Children's list can be ordered by the Birth date right arrow button makes the family in the corresponding
in the usual way of clicking on the <guilabel>Birth date</guilabel> column list box an active family. That is, it makes the selected
header. In addition to the <guilabel>Name</guilabel>, Father the Active person, and the selected Mother the
<guilabel>ID</guilabel>, <guilabel>Gender</guilabel>, and Current spouse. Most of these functions are also available
<guilabel>Birth date</guilabel> columns, the list includes a by right-clicking into the parent box and selecting an
<guilabel>Status</guilabel> column. The pair of status words reflect the appropriate item from the context menu.
relationship between the child and his Father/Mother (such as Birth, Adoption, </para>
etc.). <guilabel>Column Editor Dialog</guilabel> can be used to change <para>
column arrangement. The bottom list box displays children of the Active person
Four buttons are available on the right side of the and the Current Spouse. The Children's list can be ordered
children list box. The top (left arrow) button makes by the Birth date in the usual way of clicking on the
the selected child the Active person. The next two buttons add a new <guilabel>Birth date</guilabel> column header. In addition
child to the family: the upper one adds a new person to the database to the <guilabel>Name</guilabel>, <guilabel>ID</guilabel>,
and to the family, the lower one just adds a person existing in the <guilabel>Gender</guilabel>, and <guilabel>Birth
database to the family. Finally, the lowest <guibutton>-</guibutton> date</guilabel> columns, the list includes a
button removes the selected child from the family. Note that removing <guilabel>Status</guilabel> column. The pair of status words
a child from the family does not remove the person from the reflect the relationship between the child and his
database. Most of these functions are also available by right-clicking Father/Mother (such as Birth, Adoption,
into the children box and selecting an appropriate item from the etc.). <guilabel>Column Editor Dialog</guilabel> can be used
context menu.</para> to change column arrangement. Four buttons are available on
the right side of the children list box. The top (left
<para>The layout of the Family View can be switched from the arrow) button makes the selected child the Active
person. The next two buttons add a new child to the family:
the upper one adds a new person to the database and to the
family, the lower one just adds a person existing in the
database to the family. Finally, the lowest
<guibutton>-</guibutton> button removes the selected child
from the family. Note that removing a child from the family
does not remove the person from the database. Most of these
functions are also available by right-clicking into the
children box and selecting an appropriate item from the
context menu.
</para>
<para>
The layout of the Family View can be switched from the
left-to-right arrangement (shown above) to the top-to-bottom left-to-right arrangement (shown above) to the top-to-bottom
arrangement (shown below). This can be done in the arrangement (shown below). This can be done in the
<guilabel>Display</guilabel> section of the <guilabel>Display</guilabel> section of the
<guilabel>Preferences</guilabel> dialog. The top-to-bottom view <guilabel>Preferences</guilabel> dialog. The top-to-bottom
has the same functionality as the left-to-right view. </para> view has the same functionality as the left-to-right view.
</para>
<!-- ==== Figure: Family View ==== -->
<!-- ==== Figure: Family View ==== -->
<figure id="family-alt-fig"> <figure id="family-alt-fig">
<title>Alternative Family View</title> <title>Alternative Family View</title>
<screenshot><mediaobject><imageobject><imagedata <screenshot><mediaobject><imageobject><imagedata
@ -351,19 +496,27 @@
</sect2> </sect2>
<!-- ================ Main Window Sub-subsection --> <!-- ================ Main Window Sub-subsection -->
<sect2 id="pedigree-view"> <sect2 id="pedigree-view">
<title>Pedigree View</title> <title>Pedigree View</title>
<!-- ==== Figure: Pedigree View ==== --> <!-- ==== Figure: Pedigree View ==== -->
<figure id="pedigree-fig"> <figure id="pedigree-fig">
<title>Pedigree View</title> <title>Pedigree View</title>
<screenshot><mediaobject><imageobject><imagedata <screenshot>
fileref="figures/pedigree.png" format="PNG"/></imageobject> <mediaobject>
<imageobject>
<imagedata fileref="figures/pedigree.png" format="PNG"/>
</imageobject>
<textobject> <textobject>
<phrase>Shows Pedigree View. </phrase> <phrase>Shows Pedigree View.</phrase>
</textobject></mediaobject></screenshot></figure> </textobject>
<!-- ==== End of Figure ==== --> </mediaobject>
</screenshot>
</figure>
<!-- ==== End of Figure ==== -->
<para>The Pedigree View helps to visualize the place of the Active <para>The Pedigree View helps to visualize the place of the Active
person in the tree of his/her ancestors. The Pedigree View shows four person in the tree of his/her ancestors. The Pedigree View shows four

10
gramps2/doc/gramps-manual/C/preface.xml
View File

@ -235,10 +235,10 @@
A new report -- Statistics Chart -- has been added to &app;. A new report -- Statistics Chart -- has been added to &app;.
</para><para> </para><para>
An overall change of the whole report framework has been An overall change of the whole report framework has been
acomplished. All reports now remember their options. It accomplished. All reports now remember their options. It
is possible to generate reports from the command line, is possible to generate reports from the command line,
without launching the interactive &app; session. The without launching the interactive &app; session. The
report API is much simpler now, making it easy to write report API is much simpler now, making it easy to write a
custom report. A single code instance may be used for a custom report. A single code instance may be used for a
standalone report, a book item, and a command-line standalone report, a book item, and a command-line
report. report.
@ -253,7 +253,7 @@
The new command line functionality includes opening the The new command line functionality includes opening the
filename argument given without any flags, as well as new filename argument given without any flags, as well as new
flags and options for report generation. Also, the flags and options for report generation. Also, the
addition of new formats leads to addition of available addition of new formats leads to additional available
format options. format options.
</para> </para>
</listitem> </listitem>
@ -271,7 +271,7 @@
The internationalization of names have also been improved. The internationalization of names have also been improved.
Names can be grouped under a non-default Names can be grouped under a non-default
string. Patronymic names are supported, and it is easy to string. Patronymic names are supported, and it is easy to
program new ways on displaying names, as may be required program new ways of displaying names, as may be required
by various cultures and languages. by various cultures and languages.
</para> </para>
</listitem> </listitem>
@ -286,7 +286,7 @@
handler. Double-clicking on a file with any of these handler. Double-clicking on a file with any of these
formats will launch &app; and open that file. &app; also formats will launch &app; and open that file. &app; also
added support for the recent documents added support for the recent documents
functionailty. This is on both the GNOME-wide level functionality. This is on both the GNOME-wide level
and within the &app;. and within the &app;.
</para><para> </para><para>
The preferences are now properly stored using GConf, with The preferences are now properly stored using GConf, with