* doc/gramps-manual/C/getstart.xml: updates

* doc/gramps-manual/C/mainwin.xml: updates


svn: r5552
This commit is contained in:
Don Allingham 2005-12-15 04:51:09 +00:00
parent 8c0ad73c2e
commit 37bfa319a7
3 changed files with 168 additions and 152 deletions

View File

@ -1,3 +1,7 @@
2005-12-14 Don Allingham <don@gramps-project.org>
* doc/gramps-manual/C/getstart.xml: updates
* doc/gramps-manual/C/mainwin.xml: updates
2005-12-14 Alex Roitman <shura@gramps-project.org>
* src/plugins/PatchNames.py: Fix title/name mixup, only detect new
title, keep old title, keep old prefix.

View File

@ -47,7 +47,7 @@
of Linux to another. On the default GNOME desktop, you'll
find &app; in the
<menuchoice><guimenu>Applications</guimenu><guisubmenu>Other</guisubmenu></menuchoice>
menu. </para>
menu.</para>
</listitem>
</varlistentry>

View File

@ -25,7 +25,7 @@
<title>Main Window</title>
<para>
When you open a database (either existing or brand new), the
When you open a database (either existing or new), the
following window is displayed:
</para>
@ -38,14 +38,6 @@
<imageobject>
<imagedata fileref="figures/mainwin.png" format="PNG" width="500" depth="352" scale="70"/>
</imageobject>
<textobject>
<phrase>
Shows GRAMPS main window. Contains titlebar, menubar,
toolbar, sidebar, display area, statusbar, progressbar, and
scrollbars. Menubar contains File, Edit, View, Go, Bookmarks,
Reports, Tools, Settings, and Help menus.
</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
@ -53,7 +45,7 @@
<!-- ==== End of Figure ==== -->
<para>
The &app; window contains the following elements:
The main &app; window contains the following elements:
</para>
<variablelist>
@ -63,8 +55,8 @@
<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.
below the window title) and provides access to all the features
of &app;.
</para>
</listitem>
</varlistentry>
@ -73,37 +65,39 @@
<term>Toolbar</term>
<listitem>
<para>
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.
The toolbar is located right below the menubar. It gives you
access to the most frequently used
functions of &app;. You can set options that control how it
appears by going to
<menuchoice><guimenu>Edit</guimenu><guisubmenu>Preferences</guisubmenu></menuchoice>. You can also hide it entirely by going to <menuchoice><guimenu>View</guimenu><guisubmenu>Toolbar</guisubmenu></menuchoice>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Progressbar</term>
<term>Progress Bar</term>
<listitem>
<para>
The progressbar is located in the lower left corner of the
The Progress Bar 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.
sites, etc. Whey you are not doing these types of operations,
the Progress Bar is blank.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Statusbar</term>
<term>Status Bar</term>
<listitem>
<para>
The statusbar is located to the right of the progressbar, on
The Status Bar is located to the right of the Progress Bar, on
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.
information about the selected items. The behavior of the
Status Bar can be adjusted in Preferences dialog, which can
be found by selecting <menuchoice><guimenu>Edit</guimenu><guisubmenu>Preferences</guisubmenu></menuchoice>.
</para>
</listitem>
</varlistentry>
@ -113,17 +107,8 @@
<listitem>
<para>
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>
<listitem><para>People View</para></listitem>
<listitem><para>Family View</para></listitem>
<listitem><para>Pedigree View</para></listitem>
<listitem><para>Sources View</para></listitem>
<listitem><para>Places View</para></listitem>
<listitem><para>Media View</para></listitem>
</itemizedlist>
display area. What it displays depends on the currently
selected View. We'll discuss Views in detail below.
</para>
</listitem>
</varlistentry>
@ -133,92 +118,81 @@
<sect1 id="gramps-views">
<title>Views</title>
<para>
Views are the various ways to display different aspects of
genealogical information. It is best to split the relevant
information display into smaller categories, uniform in context
and modality; since it is very broad and non-uniform in both
context and modality. Each View represents such a split and
displays a certain portion of overall available
information. Before reviewing the detailed description of
available Views, you will be guided through the ways of
switching between the Views.
</para>
<para>Genealogical information is very broad and can be extremely
detailed. Displaying it poses a challenge that GRAMPS takes on by
dividing and organizing the information into a series of
Views. Each View displays a portion of the total information,
selected according to a particular category. This will become
clearer as we explore the six different Views, listed
below:</para>
<itemizedlist>
<listitem><para>People View</para></listitem>
<listitem><para>Family View</para></listitem>
<listitem><para>Pedigree View</para></listitem>
<listitem><para>Sources View</para></listitem>
<listitem><para>Places View</para></listitem>
<listitem><para>Media View</para></listitem>
</itemizedlist>
<para>Before we launch into a description of each View,
let's first explain how to switch between Views.</para>
<!-- ================ Main Window Sub-subsection -->
<sect2 id="view-modes">
<title>Switching Views and Viewing Modes</title>
<para>
Depending on the state of the <menuchoice>
<guimenu>View</guimenu><guimenuitem>Sidebar</guimenuitem>
</menuchoice> menu item, the View could be switched either in
the sidebar or in the notebook tabs in the top part of the
window.
</para>
<variablelist>
<varlistentry>
<term>
To switch the View while in a Sidebar mode,
click on the desired sidebar icon.
</term>
<listitem>
<para>As mentioned above there are 6 different Views. In
addition, there are two different Viewing Modes. You can tell at
a glance which Viewing Mode you are in: If you see icons listed
vertically in a sidebar at the left of the window, you are in
the Sidebar Viewing Mode. If instead you see a series of
&quot;notebook tabs&quot; (labeled People, Family, Pedigree, Sources,
Places, Media) that run horizontally across the window, then you
are in the Tabbed Viewing Mode. You can switch from one Viewing
Mode to another by selecting <menuchoice><guimenu>View</guimenu><guimenuitem>Sidebar</guimenuitem></menuchoice> from the Sidebar menu item.</para>
<para>If you're in the Sidebar Viewing Mode, you can select the View
you want by clicking one of the sidebar icons.</para>
<!-- ==== Figure: Sidebar Mode ==== -->
<figure id="side-nofilt-fig">
<title>Sidebar Viewing Mode</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/mainwin.png" format="PNG" width="500" depth="352" scale="75"/>
</imageobject>
<textobject>
<phrase>Shows sidebar viewing mode.</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<figure id="side-nofilt-fig">
<title>Sidebar Viewing Mode</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/mainwin.png" format="PNG" width="500" depth="352" scale="75"/>
</imageobject>
<textobject>
<phrase>Shows sidebar viewing mode.</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<!-- ==== End of Figure ==== -->
</listitem>
</varlistentry>
<varlistentry>
<term>
To switch the View while in a Tabbed mode,
click on the desired notebook tab.
</term>
<listitem>
<para>If you're in the Tabbed Viewing Mode, you can select the
View you want by clicking the corresponding notebook tab.</para>
<!-- ==== Figure: Tabbed Notebook Mode ==== -->
<figure id="noside-nofilt-fig">
<title>Tabbed Viewing Mode</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/noside-nofilt.png" format="PNG" width="500" depth="393" scale="75"/>
</imageobject>
<textobject>
<phrase>Shows tabbed viewing mode.</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<figure id="noside-nofilt-fig">
<title>Tabbed Viewing Mode</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/noside-nofilt.png" format="PNG" width="500" depth="393" scale="75"/>
</imageobject>
<textobject>
<phrase>Shows tabbed viewing mode.</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<!-- ==== End of Figure ==== -->
</listitem>
</varlistentry>
</variablelist>
<para>
To switch between sidebar and tabbed viewing modes, choose
<menuchoice> <guimenu>View</guimenu>
<guimenuitem>Sidebar</guimenuitem> </menuchoice> from the
&app; menu.
</para>
</sect2>
@ -227,59 +201,47 @@
<sect2 id="people-view">
<title>People View</title>
<para>
When &app; first opens a database, the View is set to the
When &app; first opens a database, it displays the
People View (<xref linkend="side-nofilt-fig"/> and <xref
linkend="noside-nofilt-fig"/>). The People View lists
individuals whose data is stored in the database.
linkend="noside-nofilt-fig"/>). This view lists
all the people stored in the database.
</para>
<para>
The individuals are arranged in a tree-like structure,
according to their family names. Every family name is a node
of the tree. Clicking the arrow on the left of the node will
toggle its expansion state. When expanded, the node's content
is listed in the window. When collapsed, the content is
rolled up and not visible. All the data is still
intact. It is just not being displayed.
You'll note that people are grouped according to their family
names. To the left of each family name is an arrow. Clicking it
once will reveal the entire list of people sharing that
name. Clicking the arrow again will &quot;roll up&quot; the list
and show only the family name.
</para>
<para>
The People View, in its default state, displays people's
By default, the People View, displays the following columns:
<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.
dates</guilabel>. You can add or remove columns to and from
the display by calling up the <guilabel>Column
Editor</guilabel> dialog
(<menuchoice><guimenu>Edit</guimenu><guimenuitem>Column
Editor</guimenuitem></menuchoice>) and checking or unchecking
the boxes listed. You can also change the position of a column
in People View by clicking and dragging it to a new position
in the Editor. Once you have made the changes you want, click
<guibutton>OK</guibutton>to exit the Editor and see your
changes in the People View.
</para>
<tip id="columns-tip">
<title>Order list by selected column</title>
<note id="columns-tip">
<title>Column Editor</title>
<para>
To order list by the Birth date, click on the
<guilabel>Birth date</guilabel> column heading. To order
list in reverse (descending) order, click one more time on
the desired column heading.
The Column Editor is available in all Views and works the
same way in each.
</para>
</tip>
</note>
<para>
The columns of the view may be added, removed, or reordered in
a <guilabel>Column Editor Dialog</guilabel>, see <xref
linkend="column-editor-fig"/>. Only checked columns will be
shown in the view. To change their order, drag any column to
its desired location inside 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>.
</para>
<tip id="columns-tip2">
<title>Other Views</title>
<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 ==== -->
@ -380,12 +342,9 @@
<sect2 id="family-view">
<title>Family View</title>
<para>
Family View displays the family information of a currently
selected (or Active) person. Specifically, this view shows
the relationships (e.g. marriages, partnerships, etc.) of the
active person, his/her parents (or step parents, or
guardians, etc), and his/her children (could be step
children, adopted children, etc.).
The Family View displays the family information of a
selected person that we call the Active person. Specifically,
it shows his or her closest relationships.
</para>
<!-- ==== Figure: Family View ==== -->
@ -406,6 +365,59 @@
<!-- ==== End of Figure ==== -->
<para>
The Family View displays the following series of list boxes:
</para>
<variablelist>
<varlistentry>
<term>Active person</term>
<listitem>
<para>
Shows birth and death data for the individual you have
selected. Double-click inside the box to edit the Active
person's information. Click on the double arrow to the
right and the currently selected Spouse will become the
new Active person.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Relationship</term>
<listitem>
<para>
Displays birth and death data for the Active person's
Spouse(s).
</para>
<note id="spouse-info">
<title>Terminology</title>
<para>
In the Family View, we use the term &quot;spouse&quot;
for sake of simplicity. However, please note that
&quot;spouse&quot; may in fact be a domestic partner, a
partner in a civil union, etc.
</para>
</note>
<para>
Double-click a Spouse to edit his or her
relationship to the Active person. Shift-click (that is,
hold down the Shift key while you click) a Spouse to edit
his or her personal information. Click the icon to the
top right of the Relationship box to add a new person to
the database and to create a relationship between this
person and the Active person. Click the middle icon to
create a relationship between the Active person and
another person already stored in the database. Click the
minus (-) button to remove the relationship between the
currently selected Spouse and the Active person. (Note
that this does not remove the Spouse from the database.)
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The Active person's data is in the list box in the upper
left corner of the window. Directly below it, another box