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

* src/gramps-manual/C/usuage.xml: updates

Browse Source 
svn: r5566
This commit is contained in:
Don Allingham 2005-12-17 04:52:17 +00:00
parent 751a7911fb
commit f1de6cc347
3 changed files with 215 additions and 230 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
gramps2/ChangeLog
View File

@ -1,4 +1,5 @@
2005-12-16 Don Allingham <don@gramps-project.org> 2005-12-16 Don Allingham <don@gramps-project.org>
* src/gramps-manual/C/usuage.xml: updates
* src/gramps-manual/C/mainwin.xml: updates * src/gramps-manual/C/mainwin.xml: updates
2005-12-14 Don Allingham <don@gramps-project.org> 2005-12-14 Don Allingham <don@gramps-project.org>

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

@ -250,7 +250,7 @@
<screenshot> <screenshot>
<mediaobject> <mediaobject>
<imageobject> <imageobject>
<imagedata fileref="figures/column-editor.png" format="PNG" width="444" depth="437" scale="75"/> <imagedata fileref="figures/column-editor.png" format="PNG" width="444" depth="437"/>
</imageobject> </imageobject>
<textobject> <textobject>
<phrase>Shows column editor dialog. </phrase> <phrase>Shows column editor dialog. </phrase>
@ -263,16 +263,18 @@
<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 manage, &app;
provides a convenient way to limit the scope of browsing by Genealogical databases can contain information on many people,
using the filter. To save screen space, filter controls may families, places, and objects. It's therefore possible for a
be hidden, depending on the state of <menuchoice> View to can contain a long list of data that's difficult to
<guimenu>View</guimenu> <guimenuitem>Filter</guimenuitem> work with. &app; gives you a means for controlling this
</menuchoice> menu item. condition by allowing you to filter a list to a more
</para> manageable size.
</para>
<!-- ==== Figure: Enabled Filter ==== --> <!-- ==== Figure: Enabled Filter ==== -->
<figure id="side-filt-fig"> <figure id="side-filt-fig">
@ -292,15 +294,37 @@
<!-- ==== End of Figure ==== --> <!-- ==== End of Figure ==== -->
<para> <para>
When &app; opens a database, the filter is set to the
trivial filter called <guilabel>All people</guilabel>, When &app; opens a database, no filtering is in effect. In
i.e. no filtering is in effect. To choose a filter, use the People View, for example, all people in the database are
pop-up <guilabel>Filter</guilabel> menu above the people's listed by default. To filter the list, go to <menuchoice>
list. Once the filter is chosen, click the <guimenu>View</guimenu> <guimenuitem>Filter</guimenuitem>
<guibutton>Apply</guibutton> button in the upper right </menuchoice>. This will place a new menu just above the list
corner of the window. The filtering will take effect upon of People. Click on the double arrows of this menu to get a
clicking the <guibutton>Apply</guibutton> button. pop-up list of all the criteria by which you can filter the
</para> People listed. Choose a filter (for example, &quot;Males&quot;
or &quot;People with children&quot;) and click
<guibutton>Apply</guibutton>.
</para>
<note id="filter-note">
<title>Displaying the filter</title>
<para>
To reduce screen clutter, the filter menu is hidden by
default. To display it, go to the <menuchoice>
<guimenu>View</guimenu> <guimenuitem>Filter</guimenuitem>
</menuchoice> menu. Please understand that even if the
filter menu is not displayed, filtering may still be in
effect. (Thus, we say that filtering is persistent.) If you
are unsure if your list is filtered, bring up the filter
menu (by going to <menuchoice> <guimenu>View</guimenu>
<guimenuitem>Filter</guimenuitem> </menuchoice>) and check
if any filtering is set.
</para>
</note>
<tip id="filt-tip"> <tip id="filt-tip">
<title>Example filter use</title> <title>Example filter use</title>
@ -313,27 +337,6 @@
</para> </para>
</tip> </tip>
<note id="filt-note">
<title>Filtering is persistent</title>
<para>
Even if the filter controls are not displayed
(<menuchoice> <guimenu>View</guimenu>
<guimenuitem>Filter</guimenuitem> </menuchoice> menu
item is unchecked), the filtering might still be in
place. In other words, the visibility of the filter
controls is not related to the actual filtering imposed
on the list.
</para>
<para>
This may be a cause of confusion, when you enable the
filtering and then remove the controls from the
display. If in doubt, enable the display of filter
controls by checking <menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Filter</guimenuitem> </menuchoice> menu
item and check what kind of filtering is currently set.
</para>
</note>
</sect3> </sect3>
</sect2> </sect2>
@ -772,42 +775,43 @@
<sect2 id="places-view"> <sect2 id="places-view">
<title>Places View</title> <title>Places View</title>
<para> <para>
The Places View lists the geographical places in which the The Places View lists the geographical places in which the
events of the database took place. These could be places of events of the database took place. These could be places of
birth, death, and marriages of people, as well as their birth, death, and marriages of people, as well as their
home, employment, education addresses, or any other home, employment, education addresses, or any other
conceivable reference to the geographical location. The conceivable reference to the geographical location. The
Places View lists the places' <guilabel>Name</guilabel>, Places View lists the places' <guilabel>Name</guilabel>,
<guilabel>ID</guilabel>, <guilabel>Church Parish</guilabel>, <guilabel>ID</guilabel>, <guilabel>Church Parish</guilabel>,
<guilabel>City</guilabel>, <guilabel>County</guilabel>, <guilabel>City</guilabel>, <guilabel>County</guilabel>,
<guilabel>State</guilabel>, and <guilabel>State</guilabel>, and
<guilabel>Country</guilabel>. All of these columns can be <guilabel>Country</guilabel>. All of these columns can be
used for sorting by the usual sorting rules. The used for sorting by the usual sorting rules. The
<guilabel>Column Editor<guilabel> dialog may be used to <guilabel>Column Editor</guilabel> dialog may be used to
add, remove and rearrange the displayed columns. add, remove and rearrange the displayed columns.
</para> </para>
<!-- ==== Figure: Places View ==== --> <!-- ==== Figure: Places View ==== -->
<figure id="places-fig"> <figure id="places-fig">
<title>Places View</title> <title>Places View</title>
<screenshot> <screenshot>
<mediaobject> <mediaobject>
<imageobject> <imageobject>
<imagedata fileref="figures/places.png" format="PNG" width="500" depth="353" scale="75"/> <imagedata fileref="figures/places.png" format="PNG" width="500" depth="353" scale="75"/>
</imageobject> </imageobject>
<textobject> <textobject>
<phrase>Shows Places View.</phrase> <phrase>Shows Places View.</phrase>
</textobject> </textobject>
</mediaobject> </mediaobject>
</screenshot> </screenshot>
</figure> </figure>
<!-- ==== End of Figure ==== --> <!-- ==== End of Figure ==== -->
</sect2>
<!-- ================ Main Window Sub-subsection --> <!-- ================ Main Window Sub-subsection -->
@ -849,6 +853,5 @@
</para> </para>
</sect2> </sect2>
</sect1> </sect1>
</chapter> </chapter>

301
gramps2/doc/gramps-manual/C/usage.xml
View File

@ -23,9 +23,10 @@
<title>Usage</title> <title>Usage</title>
<para> <para>
As commonly encountered in everyday life, there is usually more Now we turn to a detailed exploration of the day-to-day use of
than one way to accomplish something in &app;. The alternatives to GRAMPS. First, we should point out that GRAMPS often offers more
some actions will therefore be listed as appropriate. than one way to do the same task. We'll try to point out some of
these alternatives where appropriate.
</para> </para>
@ -42,20 +43,17 @@
<guimenuitem>New</guimenuitem> <guimenuitem>New</guimenuitem>
</menuchoice>. </menuchoice>.
You will then be prompted with the <guilabel>Create GRAMPS You will then be asked to give the new database a name.
database</guilabel> dialog asking to specify the name under
which the new database will be stored. The new database will be
created in the BSDDB format, with <filename>.grdb</filename> as
the default extension.
</para> </para>
<note id="new-db-notdir-note"> <note id="new-db-notdir-note">
<title>Selecting file</title> <title>&app; databases</title>
<para> <para>
This version does not require selecting a directory for the &app; stores your data in Berkeley database, sometimes
database. Please select filename, as you would in any other known as BSDDB. These files have &quot;.grdb&quot; as
application. their default extension. The extension is automatically
added to your filename.
</para> </para>
</note> </note>
@ -75,59 +73,50 @@
</menuchoice> </menuchoice>
or click the <guibutton>Open</guibutton> button on the Toolbar. or click the <guibutton>Open</guibutton> button on the Toolbar.
The <guilabel>Open database</guilabel> dialog will appear. The <guilabel>Open database</guilabel> dialog will appear and
you'll see a list of files. If you don't see the file you're
looking for, make sure the All files filter is selected. (This
dialog has a &quot;filetype&quot; filter, meaning it may only be
showing files that have a certain extension.)
</para> </para>
<para> <para>
The filetype filter in the <guilabel>Open database</guilabel> To open a recently accessed database, choose <menuchoice>
dialog allows you to display files of a certain type. If the <guimenu>File</guimenu> <guimenuitem>Open Recent</guimenuitem>
<guilabel>All files</guilabel> filter is selected (the default), </menuchoice> and select the filename from the list.
all the files will be shown. The type will be determined by the
extension of the selected filename.
</para> </para>
<note id="open-db-note">
<title>Selecting file</title>
<para>
Unlike the version 1.0.X of &app;, this version does not
require selecting directory for the database. Please select
filename, as you would in any other application.
</para>
</note>
<para> <para>
If you do not have write permissions for the selected database, If you do not have &quot;write permissions&quot; for the selected database,
it will be opened in a Read Only mode. In this mode, the data it will be opened in a Read Only mode. In this mode, the data
may be viewed, but no changes will be made to the database. To may be viewed, but no changes will be made to the database. To
indicate this mode, the title of the main window will be indicate this mode, the title of the main window will be
appended with <guilabel>(Read Only)</guilabel> text. appended with <guilabel>(Read Only)</guilabel> text.
</para><para>
GRAMPS allows you to open certain databases that have not been
saved in GRAMPS' own file format. These include XML and GEDCOM
databases. But you should be aware that if the XML or GEDCOM
database is relatively large, you may encounter some performance
problems. These can be avoided by creating a new GRAMPS database
and importing your XML/GEDCOM data into it.
</para> </para>
<note id="open-db-note2"> <note id="open-db-note2">
<title>Opening XML and GEDCOM databases</title> <title>Opening XML and GEDCOM databases</title>
<para> <para>
This version allows direct opening and editing of &app; XML XML and GEDCOM databases require all data to be held in
and GEDCOM databases. Please keep in mind that, unlike using memory. GRAMPS' native grdb format does not. Thus, a database
the native grdb format, these formats require holding all data with a grdb format can access data quicker and more efficiently.
in memory. This leads to performance and memory consumption
problems which grdb was designed to solve.
</para>
<para>
While direct opening of a &app; XML or GEDCOM file is
convenient for a small database, it may prove burdensome for
large databases. If you experience this, please consider
creating a new native (grdb) database and importing your XML
or GEDCOM data into it. This will make accessing your data
much more efficient and quick.
</para> </para>
</note> </note>
<warning id="open-db-warn"> <warning id="open-db-warn">
<title>GEDCOM Editing</title> <title>GEDCOM Editing</title>
<para> <para>
@ -140,23 +129,6 @@
</para> </para>
</warning> </warning>
<para>
To open a recently opened database, choose
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Open Recent</guimenuitem>
</menuchoice>
and select the filename from the list. You can also use
<menuchoice>
<guimenu>Actions</guimenu>
<guimenuitem>Recent Documents</guimenuitem>
</menuchoice>
from the GNOME <guilabel>Actions</guilabel> menu.
</para>
</sect1> </sect1>
<!-- ================ Usage Subsection ================================ --> <!-- ================ Usage Subsection ================================ -->
@ -165,56 +137,41 @@
<title>Saving a Database</title> <title>Saving a Database</title>
<para> <para>
A consequence of the new database backend is that the changes, GRAMPS saves your changes as soon as you apply them. This
once approved by the user, are applied immediately. Once you means, for example, that any time you click
click <guibutton>OK</guibutton> in the Person, Family, Source, <guibutton>OK</guibutton> when using GRAMPS, your changes are
Place, Media object, or Event editor, all the changes made to immediately recorded and saved. There is no separate
this object are recorded in the database. No saving is &quot;save&quot; command (although there is a &quot;save
necessary, or even possible. as&quot; command that we'll discuss below.)
</para> </para>
<para> <para>
Choosing You can undo changes you've made by selecting
<menuchoice> <menuchoice><guimenu>Edit</guimenu>
<guimenu>Edit</guimenu> <guimenuitem>Undo</guimenuitem> </menuchoice>. If you select
<guimenuitem>Undo</guimenuitem> this command repeatedly, your most recent changes will be undone
</menuchoice> one at a time. </para>
allows you to undo the changes you made, one step at a time.
If you have made changes to your data, and would like to return
your database to the way it was when you opened it, select
<menuchoice><guimenu>File</guimenu><guimenuitem>Abandon changes
and quit</guimenuitem></menuchoice>. This just like quitting
without saving in other programs.
</para> </para>
<tip id="save-tip">
<title>Reverting the whole session</title>
<para>
If you would like to revert the whole editing session, choose
<menuchoice><guimenu>File</guimenu><guimenuitem>Abandon
changes and quit</guimenuitem></menuchoice>. This will be
analogous to quitting without saving any changes in other
applications.
</para>
</tip>
<para> <para>
If you would like to save your database under a different name, If you would like to save your database under a different name,
you can do so by choosing you can do so by choosing <menuchoice><guimenu>File</guimenu>
<menuchoice> <guimenuitem>Save as...</guimenuitem></menuchoice> and
<guimenu>File</guimenu> specifying the name (and, optionally, format) of your new
<guimenuitem>Save as...</guimenuitem> database. Note that &quot;Save as&quot; will allow you to
</menuchoice> continuing editing the newly saved database. If this is not what
and specifying the name (and, optionally, format) of your new you want to do, you may wish to use the &quot;Export&quot;
database. command instead.
</para> </para>
<note id="save-as-note">
<title>"Save as" continues editing</title>
<para>
If you use the <guilabel>Save as...</guilabel> function, the
editing in the main window is performed on the newly made
copy. If this is not what you want to do, please consider
using <guilabel>Export...</guilabel> instead.
</para>
</note>
</sect1> </sect1>
<!-- ================ Usage Subsection ================================ --> <!-- ================ Usage Subsection ================================ -->
@ -223,40 +180,83 @@
<title>Importing Data</title> <title>Importing Data</title>
<para> <para>
Importing allows you to incorporate the data from other Importing allows you to bring data from other
databases into your currently open &app; database. Currently, genealogy programs into a &app; database Currently,
&app; can import data from the following formats: &app; database &app; can import data from the following formats:
(grdb), GEDCOM, &app; XML, &app; package, and GeneWeb. All of
these are available by choosing
<menuchoice>
<guimenu>File</guimenu>
<guisubmenu>Import</guisubmenu>
</menuchoice>
and selecting an appropriate file.
</para> </para>
<itemizedlist>
<listitem>
<para>
Another &app; database (having the &quot;grdb&quot; file
extension),
</para>
</listitem>
<listitem>
<para>GEDCOM</para>
</listitem>
<listitem>
<para>&app; XML</para>
</listitem>
<listitem>
<para>&app; package</para>
</listitem>
<listitem>
<para>GeneWeb</para>
</listitem>
</itemizedlist>
<note id="import-note">
<title>Importing vs. opening</title>
<para>
Please recognize that importing a database is different from
opening a database. When you import, you are actually bringing
data from one database into a GRAMPS database. When you open a
file, you editing your original file.
<para>
</note>
<para> <para>
&app; database (grdb), &app; XML, and &app; package are all To import data, select <menuchoice> <guimenu>File</guimenu>
native &app; formats in that there is no information loss <guisubmenu>Import</guisubmenu> </menuchoice>. The
resulting from reading from and writing into these formats. <guilabel>Import database</guilabel> dialog will open, asking you
to specify the file you wish to import.
<variablelist> </para>
<varlistentry>
<term>&app; database (grdb)</term> <warn id="import-dataloss">
<listitem> <title>Data loss with some formats</title>
<para> <para>
The native &app; database format is a specific form of It is important to note that the importing process is not
Berkeley database (BSDDB) with special structure of data perfect for GEDCOM and GeneWeb databases. There is a chance
tables. This format is binary and that some of the data in these databases will not be imported
architecture-dependent. It is very quick and efficient, into &app;.
but not generally portable across computers with </para>
different binary architecture (e.g. i386 vs alpha). </warn>
</para>
</listitem>
</varlistentry> <para>
<varlistentry> The &app; database (grdb), &app; XML, and &app; package are all
native &app; formats. There is no risk of information loss
when import or exporting to these formats.
</para>
<variablelist>
<varlistentry>
<term>&app; database (grdb)</term>
<listitem>
<para>
The native &app; database format is a specific form of
Berkeley database (BSDDB) with special structure of data
tables. This format is binary and
architecture-dependent. It is very quick and efficient,
but not generally portable across computers with
different binary architecture (e.g. i386 vs alpha).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>&app; XML</term> <term>&app; XML</term>
<listitem> <listitem>
<para> <para>
@ -300,37 +300,18 @@
</variablelist> </variablelist>
</para> </para>
<tip id="import-tip">
<title>Opening vs importing</title>
<para>
The difference between opening &app; database (in any format)
and importing from &app; or GEDCOM database is that importing
incorporates all the data into your currently open database,
if any. In contrast, opening the database will switch from
editing your current data to editing another file.
</para>
</tip>
<para> <para>
After choosing an import format, you will be prompted with the
<guilabel>Import database</guilabel> dialog asking you to
specify the file name from which to import.
</para>
<note id="import-note"> If you import information from another GRAMPS database, you will
<title>Selecting file</title> see the progress of the operation in the progress bar of GRAMPS'
<para> main window.
This version does not require selecting a directory for the
database. Please select filename, as you would in any other </para><para>
application.
</para> If you import a GEDCOM database, you will see the import dialog
</note> shown in <xref linkend="gedcom-import-fig"/>. The information in
the dialog is updated as the import progresses.
<para>
Upon starting the GEDCOM import, &app; will display the
following GEDCOM import dialog with the summary of the
information about the data. The information is updated as the
import progresses.
</para> </para>
<!-- ==== Figure: GEDCOM Import ==== --> <!-- ==== Figure: GEDCOM Import ==== -->