* doc/gramps-manual/C/keybind.xml: Update.

* doc/gramps-manual/C/usage.xml: Update.
* doc/gramps-manual/C/custom.xml: Update.
* NEWS: typo.

* doc/gramps-manual/C/keybind.xml: Update.


svn: r2414
This commit is contained in:
Alex Roitman 2003-12-01 14:22:11 +00:00
parent 871de6a5ac
commit 172cd77ac1
5 changed files with 205 additions and 53 deletions

View File

@ -1,3 +1,9 @@
2003-12-01 Alex Roitman <shura@alex.neuro.umn.edu>
* doc/gramps-manual/C/keybind.xml: Update.
* doc/gramps-manual/C/usage.xml: Update.
* doc/gramps-manual/C/custom.xml: Update.
* NEWS: typo.
2003-12-01 Tim Waugh <twaugh@redhat.com>
* doc/xmldocs.make: Clean copied XML files. Now 'make distcheck' works
again.
@ -8,8 +14,8 @@
callback on Shift+click; (sp_key_press, child_key_press): Replace
Ctrl+Insert with Shift+Insert for adding new people.
* src/PedView.py (on_show_child_menu): Markup children with children.
* doc/gramps-manual/C/keybind.xml: Update.
* doc/gramps-manual/C/faq.xml: Update.
* doc/gramps-manual/C/keybind.xml: Update.
* doc/gramps-manual/C/filtref.xml: Update.
2003-11-29 Don Allingham <dallingham@users.sourceforge.net>

View File

@ -15,7 +15,7 @@ Version 0.98.0 -- the "Round me off" release
within the session.
* Substantial speedups in updating display in tree views.
* Children are enumerated in Family View.
* ZODB backend is removed. Reald database backend is being worked on and will
* ZODB backend is removed. Real database backend is being worked on and will
appear in post-1.0 releases.
* Tab labels in tabbed dialogs reflect the presence of data (bold).
* Help button available in most dialogs.

View File

@ -1,11 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Id$ -->
<!-- ================ Customization ================================ -->
<sect1 id="gramps-prefs">
<title>Settings</title>
<para>To configure &app;, choose
<menuchoice><guimenu>Settings</guimenu>
<menuchoice><guimenu>Edit</guimenu>
<guimenuitem>Preferences...</guimenuitem></menuchoice>.
The <guilabel>Preferences</guilabel> dialog contains the following
categories: </para>

View File

@ -3,7 +3,7 @@
<!-- $Id$ -->
<!-- =============== Appendices Subsection ================ -->
<sect2 id="keybind">
<sect2 id="append-keybind">
<title>Keybindings reference</title>
<para>This appendix contains the list of keybindings that are not
displayed in menus of &app;.
@ -26,7 +26,7 @@
</thead>
<tbody>
<row valign="top">
<entry><para><guilabel>Enter</guilabel></para></entry>
<entry><para><keycap>Enter</keycap></para></entry>
<entry><para>Invoke <guilabel>Edit Person</guilabel> dialog
with the selected person.</para></entry>
</row>
@ -61,16 +61,16 @@
</thead>
<tbody>
<row valign="top">
<entry><para><guilabel>Enter</guilabel></para></entry>
<entry><para><keycap>Enter</keycap></para></entry>
<entry><para>Invoke <guilabel>Edit Person</guilabel> dialog with
the active person.</para></entry>
</row>
<row valign="top">
<entry><para><guilabel>Ctrl+Down</guilabel>
or <guilabel>Ctrl+Right</guilabel></para></entry>
<entry><para><keycap>Ctrl</keycap>+<keycap>Down</keycap>
or <keycap>Ctrl</keycap>+<keycap>Right</keycap></para></entry>
<entry><para>Swap the Active Person and the selected spouse.
Use <guilabel>Ctrl+Down</guilabel> in standard Family View and
<guilabel>Ctrl+Right</guilabel> in alternative Family
Use <keycap>Ctrl+Down</keycap> in standard Family View and
<keycap>Ctrl+Right</keycap> in alternative Family
View.</para></entry>
</row>
</tbody>
@ -96,36 +96,36 @@
</thead>
<tbody>
<row valign="top">
<entry><para><guilabel>Enter</guilabel></para></entry>
<entry><para><keycap>Enter</keycap></para></entry>
<entry><para>Edit relationship between the Active Person and
the selected spouse.</para></entry>
</row>
<row valign="top">
<entry><para><guilabel>Shift+Enter</guilabel></para></entry>
<entry><para><keycap>Shift+Enter</keycap></para></entry>
<entry><para>Edit the personal information for the selected
spouse.</para></entry>
</row>
<row valign="top">
<entry><para><guilabel>Insert</guilabel></para></entry>
<entry><para><keycap>Insert</keycap></para></entry>
<entry><para>Add a person from the database to the spouse
list.</para></entry>
</row>
<row valign="top">
<entry><para><guilabel>Shift+Insert</guilabel></para></entry>
<entry><para><keycap>Shift+Insert</keycap></para></entry>
<entry><para>Add a new person to the database and to the spouse
list.</para></entry>
</row>
<row valign="top">
<entry><para><guilabel>Delete</guilabel></para></entry>
<entry><para><keycap>Delete</keycap></para></entry>
<entry><para>Delete the selected spouse from the spouse
list. The spouse is not deleted from the database.</para></entry>
</row>
<row valign="top">
<entry><para><guilabel>Ctrl+Up</guilabel>
or <guilabel>Ctrl+Left</guilabel></para></entry>
<entry><para><keycap>Ctrl+Up</keycap>
or <keycap>Ctrl+Left</keycap></para></entry>
<entry><para>Swap the selected spouse and the Active Person.
Use <guilabel>Ctrl+Down</guilabel> in standard Family View and
<guilabel>Ctrl+Right</guilabel> in alternative Family
Use <keycap>Ctrl+Down</keycap> in standard Family View and
<keycap>Ctrl+Right</keycap> in alternative Family
View.</para></entry>
</row>
</tbody>
@ -151,32 +151,32 @@
</thead>
<tbody>
<row valign="top">
<entry><para><guilabel>Enter</guilabel></para></entry>
<entry><para><keycap>Enter</keycap></para></entry>
<entry><para>Edit relationship between the parents and their
child (either the Active Person or the selected spouse, depending
which parents box the focus is in).</para></entry>
</row>
<row valign="top">
<entry><para><guilabel>Insert</guilabel></para></entry>
<entry><para><keycap>Insert</keycap></para></entry>
<entry><para>Add a new set of parents from the database to the
list.</para></entry>
</row>
<row valign="top">
<entry><para><guilabel>Shift+Insert</guilabel></para></entry>
<entry><para><keycap>Shift+Insert</keycap></para></entry>
<entry><para>Add a new set of parents to the database and to the
list.</para></entry>
</row>
<row valign="top">
<entry><para><guilabel>Delete</guilabel></para></entry>
<entry><para><keycap>Delete</keycap></para></entry>
<entry><para>Delete the selected parents from the list.
The parents are not deleted from the database.</para></entry>
</row>
<row valign="top">
<entry><para><guilabel>Ctrl+Right</guilabel>
or <guilabel>Ctrl+Down</guilabel></para></entry>
<entry><para><keycap>Ctrl+Right</keycap>
or <keycap>Ctrl+Down</keycap></para></entry>
<entry><para>Make the selected parents the active family.
Use <guilabel>Ctrl+Right</guilabel> in standard Family View and
<guilabel>Ctrl+Down</guilabel> in alternative Family
Use <keycap>Ctrl+Right</keycap> in standard Family View and
<keycap>Ctrl+Down</keycap> in alternative Family
View.</para></entry>
</row>
</tbody>
@ -202,37 +202,37 @@
</thead>
<tbody>
<row valign="top">
<entry><para><guilabel>Enter</guilabel></para></entry>
<entry><para><keycap>Enter</keycap></para></entry>
<entry><para>Edit relationship between the child and his/her
parents (the Active Person and the selected
spouse).</para></entry>
</row>
<row valign="top">
<entry><para><guilabel>Shift+Enter</guilabel></para></entry>
<entry><para><keycap>Shift+Enter</keycap></para></entry>
<entry><para>Edit the personal information for the selected
child.</para></entry>
</row>
<row valign="top">
<entry><para><guilabel>Insert</guilabel></para></entry>
<entry><para><keycap>Insert</keycap></para></entry>
<entry><para>Add a new person from the database to the children
list.</para></entry>
</row>
<row valign="top">
<entry><para><guilabel>Shift+Insert</guilabel></para></entry>
<entry><para><keycap>Shift+Insert</keycap></para></entry>
<entry><para>Add a new person to the database and to the children
list.</para></entry>
</row>
<row valign="top">
<entry><para><guilabel>Delete</guilabel></para></entry>
<entry><para><keycap>Delete</keycap></para></entry>
<entry><para>Delete the selected child from the list.
The child is not deleted from the database.</para></entry>
</row>
<row valign="top">
<entry><para><guilabel>Ctrl+Left</guilabel>
or <guilabel>Ctrl+Up</guilabel></para></entry>
<entry><para><keycap>Ctrl+Left</keycap>
or <keycap>Ctrl+Up</keycap></para></entry>
<entry><para>Make the selected child the Active Person.
Use <guilabel>Ctrl+Left</guilabel> in standard Family View and
<guilabel>Ctrl+Up</guilabel> in alternative Family
Use <keycap>Ctrl+Left</keycap> in standard Family View and
<keycap>Ctrl+Up</keycap> in alternative Family
View.</para></entry>
</row>
</tbody>

View File

@ -1,4 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Id$ -->
<!-- ================ Usage ================================ -->
<sect1 id="gramps-usage">
<title>Usage</title>
@ -292,6 +295,12 @@
database can be edited! Adding a new piece of information is in fact
creating an appropriate empty data structure and subsequent
editing of that empty structure. </para>
<para>This section refers mainly to the menu items and buttons as the main
way of interacting with &app;. In addition to this, &app; provides an
extensive set of keybindings. The detailed reference to the keybindings
is found in the <xref linkend="append-keybind"/>.
</para>
<!-- ================ Usage Sub-subsection ================ -->
<sect3 id="gramps-add-pers">
@ -304,6 +313,13 @@
for details). To edit information about a person already present
in the database, select an entry you would like to view/modify,
and then click the <guibutton>Edit</guibutton> icon on the toolbar. </para>
<para>You can also use <guilabel>Add...</guilabel> and
<guilabel>Edit...</guilabel> menu items available under
the <guimenu>Edit</guimenu>. Or you can right-click on the person
and select <guilabel>Add...</guilabel> or <guilabel>Edit...</guilabel>
from the invoked context menu.
</para>
</sect3>
<!-- ================ Usage Sub-subsection ================ -->
@ -474,7 +490,11 @@
<sect2 id="gramps-edit-complete">
<title>Editing Data: Complete Description</title>
<para> This section provides a complete description of all editing
options for all pieces of data in the &app; database. </para>
options for all pieces of data in the &app; database. It refers mainly
to the menu items and buttons as the main way of interacting with &app;.
In addition to this, &app; provides an extensive set of keybindings.
The detailed reference to the keybindings is found in
the <xref linkend="append-keybind"/>.</para>
<!-- ================ Usage Sub-subsection ================ -->
<sect3 id="adv-pers">
@ -485,11 +505,15 @@
<varlistentry><term>From the People View:</term><listitem><para>
Double-click the name of the person whose data you would like
to edit, or select the name by single click and then click the
<guibutton>Edit</guibutton> icon on the toolbar.
<guibutton>Edit</guibutton> icon on the toolbar. You may also select
the name and then press <keycap>Return</keycap>. Finally, you may select
<guimenuitem>Edit...</guimenuitem> from the <guisubmenu>Edit</guisubmenu>
menu of &app; or choose <guimenuitem>Edit</guimenuitem> from the context
menu that appears upon right-click on the name.
</para></listitem></varlistentry>
<varlistentry><term>From the Family View:</term><listitem><para>
Move the mouse into the <guilabel>Active person</guilabel> box,
then double-click.
then double-click, or use any of the menu items described above.
</para></listitem></varlistentry>
</variablelist>
@ -507,7 +531,7 @@
<!-- ==== End of Figure ==== -->
<para> The top of the window shows the name of the person whose
data is being edited. The main part of the window displays nine
data is being edited. The main part of the window displays ten
notebook tabs containing different categories of available
information. You can bring any tab to the top for viewing
or editing by clicking on the appropriate tab heading.
@ -523,6 +547,9 @@
</para>
<para>
The tab labels reflect the presence of corresponding information: if the
tab contains any data, its label appears boldface; if the tab has no data
then its label appears regular (not bold).
The tabs provide the following information categories of
personal data:
</para>
@ -716,6 +743,43 @@
</listitem></varlistentry>
</variablelist>
<variablelist>
<varlistentry><term><guilabel>Sources</guilabel></term>
<listitem>
<!-- ==== Figure: Edit Person dialog - Sources ==== -->
<figure id="edit-pers-sources-fig">
<title>Edit Person dialog - Sources</title>
<screenshot><mediaobject><imageobject><imagedata
fileref="figures/edit-person-sources.png" format="PNG"/></imageobject>
<textobject>
<phrase>Shows Sources Tab of Edit Person dialog. </phrase>
</textobject></mediaobject></screenshot></figure>
<!-- ==== End of Figure ==== -->
<para>The <guilabel>Sources</guilabel> tab displays information about
the sources related to the person and controls allowing its modification.
These could be any general sources which refer to the person but do not
describe specifically any event.
For example, Aunt Martha's memoirs may mention her great grandson Paul,
so the researcher may assume that this person (Paul) existed and cite
the memoirs as the source for this assumption. NOTE: sources documenting
specific events are better filed in relation to those events, under the
<guilabel>Events</guilabel> tab.
</para>
<para>The central part displays the list of all source references stored
in the database in relation to the person. The
buttons <guibutton>Add...</guibutton>,
<guibutton>Edit...</guibutton>, and <guibutton>Delete</guibutton>
allow you to correspondingly add, modify, and remove a source reference
to this person. Note that the <guibutton>Edit...</guibutton> and
<guibutton>Delete</guibutton> buttons become available only when
a source reference is selected from the list. </para>
</listitem></varlistentry>
</variablelist>
<variablelist>
<varlistentry><term><guilabel>Gallery</guilabel></term>
<listitem>
@ -902,7 +966,7 @@
<para> The top of the window shows the names of the people whose
relationship is being edited. The main part of the window displays
six notebook tabs containing different categories of available
seven notebook tabs containing different categories of available
information. You can bring any tab to the top for viewing
or editing by clicking on the appropriate tab heading.
The bottom part has <guibutton>OK</guibutton> and
@ -916,6 +980,9 @@
initial cancel request, or saving the changes. </para>
<para>
The tab labels reflect the presence of corresponding information: if the
tab contains any data, its label appears boldface; if the tab has no data
then its label appears regular (not bold).
The tabs provide the following information categories of
relationship data:
</para>
@ -981,11 +1048,37 @@
</listitem></varlistentry>
</variablelist>
<variablelist>
<varlistentry><term><guilabel>Sources</guilabel></term>
<listitem>
<para>The <guilabel>Sources</guilabel> tab displays information about
the sources related to the relationship and controls allowing its
modification. These could be any general sources which refer to the
relationship but do not describe specifically any event.
For example, Aunt Martha's memoirs may mention that her great grandson Paul
was married, so the researcher may assume that this relationship (between
Paul and his wife) existed and cite the memoirs as the source for this
assumption. NOTE: sources documenting specific events such as marriages
or divorces are better filed in relation to those events, under the
<guilabel>Events</guilabel> tab.
</para>
<para>The central part displays the list of all source references stored
in the database for this relationship. The
buttons <guibutton>Add...</guibutton>,
<guibutton>Edit...</guibutton>, and <guibutton>Delete</guibutton>
allow you to correspondingly add, modify, and remove a source reference
to this relationship. Note that the <guibutton>Edit...</guibutton> and
<guibutton>Delete</guibutton> buttons become available only when
a source reference is selected from the list. </para>
</listitem></varlistentry>
</variablelist>
<variablelist>
<varlistentry><term><guilabel>Gallery</guilabel></term>
<listitem>
<para>The <guilabel>Gallery</guilabel> tab displays information about
media objects associated with the person and the controls allowing
media objects associated with the relationship and the controls allowing
modification of such. The central part shows the list of all such media objects.
For media object which are valid image files previews of images are
displayed. For other objects such as audio files, movie files, etc., a
@ -1051,6 +1144,9 @@
the changes. </para>
<para>
The tab labels reflect the presence of corresponding information: if the
tab contains any data, its label appears boldface; if the tab has no data
then its label appears regular (not bold).
The tabs provide the following information categories of
source data:
</para>
@ -1147,6 +1243,9 @@
the changes. </para>
<para>
The tab labels reflect the presence of corresponding information: if the
tab contains any data, its label appears boldface; if the tab has no data
then its label appears regular (not bold).
The tabs provide the following information categories of
place data:
</para>
@ -1293,6 +1392,9 @@
the changes. </para>
<para>
The tab labels reflect the presence of corresponding information: if the
tab contains any data, its label appears boldface; if the tab has no data
then its label appears regular (not bold).
The tabs provide the following information categories of
media object data:
</para>
@ -1389,7 +1491,11 @@
without saving changes, canceling the initial cancel request, or saving
the changes. </para>
<para>The tabs provide the following information categories of
<para>
The tab labels reflect the presence of corresponding information: if the
tab contains any data, its label appears boldface; if the tab has no data
then its label appears regular (not bold).
The tabs provide the following information categories of
the event data: </para>
<variablelist>
@ -1521,7 +1627,11 @@
without saving changes, canceling the initial cancel request, or saving
the changes. </para>
<para>The tabs provide the following information categories of
<para>
The tab labels reflect the presence of corresponding information: if the
tab contains any data, its label appears boldface; if the tab has no data
then its label appears regular (not bold).
The tabs provide the following information categories of
the alternate name data: </para>
<variablelist>
@ -1598,7 +1708,11 @@
without saving changes, canceling the initial cancel request, or saving
the changes. </para>
<para>The tabs provide the following information categories of
<para>
The tab labels reflect the presence of corresponding information: if the
tab contains any data, its label appears boldface; if the tab has no data
then its label appears regular (not bold).
The tabs provide the following information categories of
the attribute data: </para>
<variablelist>
@ -1673,7 +1787,11 @@
without saving changes, canceling the initial cancel request, or saving
the changes. </para>
<para>The tabs provide the following information categories of
<para>
The tab labels reflect the presence of corresponding information: if the
tab contains any data, its label appears boldface; if the tab has no data
then its label appears regular (not bold).
The tabs provide the following information categories of
the address data: </para>
<variablelist>
@ -1790,7 +1908,7 @@
<title>Merge People</title>
<para> Sometime two people entries in the database turn out to be
describing the same person. When this happens, merging people is
a useful useful way of correcting the situation. </para>
a useful way of correcting the situation. </para>
<para> To make a merge, exactly two people have to be selected in the
People View. This is accomplished by selecting one person and then
@ -1799,7 +1917,7 @@
<para> When exactly two people are selected, choose
<menuchoice><guimenu>Edit</guimenu><guimenuitem>Merge...</guimenuitem></menuchoice>
to evoke <guilabel>Merge</guilabel> dialog. The dialog allows you to
to evoke <guilabel>Merge People</guilabel> dialog. The dialog allows you to
retain the data from either person as the primary data for the new
(merged) person. The data from the other person can be kept as alternate
data if you so choose. If you would like to continue editing data of
@ -1807,6 +1925,27 @@
button. </para>
</sect3>
<!-- ================ Usage Sub-subsection ================ -->
<sect3 id="adv-merge-places">
<title>Merge Places</title>
<para> Sometime two place entries in the database turn out to be
describing the same place. When this happens, merging places is
a useful way of correcting the situation. </para>
<para> To make a merge, exactly two places have to be selected in the
Places View. This is accomplished by selecting one place and then
selecting another place while holding down <keycap>Ctrl</keycap> key.
</para>
<para> When exactly two places are selected, choose
<menuchoice><guimenu>Edit</guimenu><guimenuitem>Merge...</guimenuitem></menuchoice>
to evoke <guilabel>Merge Places</guilabel> dialog. The dialog allows
you to retain the data from either place as the primary data for
the new (merged) place. Alternatively, you may type in other data
for the new place, if you click <guilabel>Other</guilabel> radio
button.</para>
</sect3>
</sect2>
<!-- ================ Usage Subsection ================================ -->
@ -1874,6 +2013,11 @@
</para></listitem>
</itemizedlist>
<para>In addition to this, &app; provides an extensive set of keyboard
navigation options. The detailed reference to the keybindings
is found in the <xref linkend="append-keybind"/>.</para>
</sect3>
<!-- ================ Usage Sub-subsection ================ -->
@ -1925,8 +2069,8 @@
<para> To set the Home person, first navigate to that person using
any method you like. Then choose
<menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Home Person</guimenuitem></menuchoice>. Once this is
<menuchoice><guimenu>Edit</guimenu>
<guimenuitem>Set Home person</guimenuitem></menuchoice>. Once this is
done, you can move to the Home person from anywhere in the
database by simply clicking the <guibutton>Home</guibutton> icon
on the toolbar. You can also choose <menuchoice><guimenu>Go</guimenu>
@ -1946,9 +2090,9 @@
They include <guilabel>Back</guilabel> and <guilabel>Forward</guilabel>
items available from the <menuchoice><guimenu>Go</guimenu></menuchoice>
menu, context menus, and the toolbar buttons. They also include the
<menuchoice><guimenu>Go</guimenu>
<guimenuitem>History</guimenuitem></menuchoice> menu which lists
the recent selections and allows to jump directly to any of them.
list of the recent selections available under the
<menuchoice><guimenu>Go</guimenu></menuchoice> menu that allows you to jump
directly to any of the recent selections.
Finally, right-clicking on the <guibutton>Back</guibutton>
and <guibutton>Forward</guibutton> toolbar buttons invokes the
popup menu with corresponding portion of the history. Select any item