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

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

Browse Source 
* doc/gramps-manual/C/preface.xml: update
* doc/gramps-manual/C/usage.xml: update


svn: r5535
This commit is contained in:
Don Allingham
2005-12-11 05:24:19 +00:00
parent da2fe09894
commit 4419567584
5 changed files with 275 additions and 296 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
gramps2/ChangeLog
View File

@@ -1,3 +1,8 @@
2005-12-10 Don Allingham <don@gramps-project.org>
* doc/gramps-manual/C/getstart.xml: update
* doc/gramps-manual/C/preface.xml: update
* doc/gramps-manual/C/usage.xml: update
2005-12-09 J<>r<EFBFBD>me Rapinat <romjerome@yahoo.fr> 2005-12-09 J<>r<EFBFBD>me Rapinat <romjerome@yahoo.fr>
* doc/gramps-manual/fr/cmdplug.xml: Add file with new section. * doc/gramps-manual/fr/cmdplug.xml: Add file with new section.
* doc/gramps-manual/fr/gramps-manual.xml: Define entity for new * doc/gramps-manual/fr/gramps-manual.xml: Define entity for new

BIN
gramps2/doc/gramps-manual/C/figures/first-open.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 17 KiB

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

@@ -25,9 +25,8 @@
<title>Getting Started</title> <title>Getting Started</title>
<para> <para>
This chapter provides the most basic information on starting In this chapter, we'll begin with the basics. We'll show you how
&app; and obtaining help. Please proceed to the following to start &app; and how to get help when you need it.
chapters for more information.
</para> </para>
<!-- ================ Getting Started Subsection ====== --> <!-- ================ Getting Started Subsection ====== -->
@@ -39,29 +38,33 @@
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><guimenu>Applications</guimenu> menu</term> <term>From the <guimenu>Applications</guimenu> menu</term>
<listitem> <listitem>
<para>
The method of starting &app; from the menus may vary <para>Select &app; from the list of programs displayed in
from distribution to distribution. On default GNOME your computer's Applications menu. (The location and
desktop, choose appearance of this menu vary slightly from one distribution
<menuchoice><guisubmenu>Other</guisubmenu> of Linux to another. On the default GNOME desktop, you'll
<guimenuitem>Gramps</guimenuitem></menuchoice>. find &app; in the
</para> <menuchoice><guimenu>Applications</guimenu><guisubmenu>Other</guisubmenu></menuchoice>
menu. </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Command line</term> <term>From the command line</term>
<listitem> <listitem>
<para> <para>
To start &app; from a command line, type If you're adept with Linux and like to work from the command
<command>gramps</command>, then press line, you can start &app; by calling up a terminal window,
<keycap>Enter</keycap>. typing <command>gramps</command>, and then pressing
<keycap>Enter</keycap>.
</para> </para>
<para> <para>
If you would like &app; to open a specific database or to If you would like GRAMPS to open a specific database or to
import a specific file on startup, you can use the import a specific file on startup, you can supply the filename
filename as a command line argument: as a command line argument:
</para> </para>
<para> <para>
<filename>gramps filename.grdb</filename> <filename>gramps filename.grdb</filename>
@@ -84,13 +87,28 @@
<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 the The first time you run the program, GRAMPS will display the
Getting Started dialogs. Follow the directions that guide you through &quot;Getting Started&quot; dialogs. Follow the directions that
<guilabel>Researcher information</guilabel>, <guilabel>Numerical date guide you through <guilabel>Researcher information</guilabel>,
formats</guilabel>, <guilabel>Alternate calendar support</guilabel>, <guilabel>Numerical date formats</guilabel>, <guilabel>Alternate
and <guilabel>the LDS extensions</guilabel> sections. Most of the dialogs calendar support</guilabel>, and <guilabel>the LDS
are self-explanatory and will not be covered here. extensions</guilabel> sections. You should find them to be
self-explanatory.
</para> </para>
<note id="note-dialog">
<title>Dialog boxes</title>
<para>We'll make frequent reference in this manual to
dialogs. A dialog is simply a pop-up window into which you can
enter information.</para>
</note>
<para>We recommend you enter your personal information when GRAMPS
prompts you for it. GRAMPS uses this information strictly so it
can create valid GEDCOM output files (which require information
about the files' creator). If you wish, you can choose not to
supply this information, but be aware that unless and until you
do, any GEDCOM files you export will not be valid.</para>
<!-- ==== Figure: Getting Started Druid Window ==== --> <!-- ==== Figure: Getting Started Druid Window ==== -->
<figure id="druid-fig"> <figure id="druid-fig">
@@ -110,19 +128,12 @@
<!-- ==== End of Figure ==== --> <!-- ==== End of Figure ==== -->
<para> <tip id="preferences-tip">
Enter your personal information in the corresponding text entry <title>Entering personal information</title>
fields. Although &app; requests information about you, this <para>This information can be entered at any time in the
information is used only so that &app; can create valid GEDCOM Preferences dialog, under the Database/Researcher Information
output files. A valid GEDCOM file requires information about the category.</para>
file's creator. If you choose, you may leave the information </tip>
empty, however all the GEDCOM files you export will be invalid.
</para>
<para>
This information can be entered at any time in the
<guilabel>Preferences</guilabel> dialog, under the
<guilabel>Database/Researcher Information</guilabel> category.
</para>
</sect1> </sect1>
<!-- ================ Getting Started Subsection --> <!-- ================ Getting Started Subsection -->
@@ -141,8 +152,7 @@
<screenshot> <screenshot>
<mediaobject> <mediaobject>
<imageobject> <imageobject>
<imagedata fileref="figures/first-open.png" format="PNG" <imagedata fileref="figures/first-open.png" format="PNG" />
width="311" depth="199" scale="80"/>
</imageobject> </imageobject>
<textobject> <textobject>
<phrase>Shows Open Database Window.</phrase> <phrase>Shows Open Database Window.</phrase>
@@ -153,21 +163,26 @@
<!-- ==== End of Figure ==== --> <!-- ==== End of Figure ==== -->
<para>
If you would like to open an existing database, check the top <para>To open a database that you have recently opened, choose the
radio button and click the <guibutton>OK</guibutton> top selection, select your database from the menu and
button. You will then be asked to specify the name of your click <guibutton>OK</guibutton>. &app; will then ask you to specify
existing database. If you would like to immediately create a the name of the database you wish to open. </para>
brand new database from scratch right away, choose new
database. <para>To open an existing database you have not recently opened,
</para> choose the middle selection and click
<guibutton>OK</guibutton>. &app; will then ask you to specify the
name of the database you wish to open. </para>
<para>As you might guess, to create a new database, choose
&quot;Create a new database&quot;</para>
<note id="file-notdir-note"> <note id="file-notdir-note">
<title>Selecting file</title> <title>Selecting file</title>
<para> <para>
This version of &app; does not require selecting a directory If you're familiar with version 1.0.X of GRAMPS, you'll note
for the database. Please select filename, as you would in any that version 2.0 does not require you to select a directory in
other application. which to store the database.
</para> </para>
</note> </note>
@@ -178,17 +193,17 @@
<sect1 id="get-help"> <sect1 id="get-help">
<title>Obtaining Help</title> <title>Obtaining Help</title>
<para> <para>
The following items are available from the GRAMPS has a <menuchoice><guimenu>Help</guimenu></menuchoice> menu
<menuchoice><guimenu>Help</guimenu></menuchoice> to provide that you can consult at any time. It includes the following items:
immediate assistance:
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>User manual</term> <term>User manual</term>
<listitem> <listitem>
<para> <para>
Select this item to access this manual in the help browser. An electronic version of the manual that you can access while you work in GRAMPS.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -196,20 +211,14 @@
<varlistentry> <varlistentry>
<term>FAQ</term> <term>FAQ</term>
<listitem> <listitem>
<para> <para>A list of Frequently Asked Questions about &app;.</para>
Select this item to read the Frequently Asked Questions about
&app; in the browser.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>GRAMPS home page</term> <term>GRAMPS home page</term>
<listitem> <listitem>
<para> <para>A link to the GRAMPS' project web site.</para>
Select this item to open the home page of &app; in your
default web browser.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -217,8 +226,7 @@
<term>GRAMPS mailing lists</term> <term>GRAMPS mailing lists</term>
<listitem> <listitem>
<para> <para>
Select this item to direct your web browser Gives you direct access to GRAMPS' mailing list archives.
to the &app; mailing list archives.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -227,8 +235,10 @@
<term>Report a bug</term> <term>Report a bug</term>
<listitem> <listitem>
<para> <para>
Select this item to file a bug report regarding &app; Choose this item to file a bug report in our bug tracking
with the bug tracking system. system. (Remember, &app; is a living project. We want to
know about any problems you encounter so we can work to
solve them for everyone's benefit.)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -237,7 +247,7 @@
<term>Show plugin status</term> <term>Show plugin status</term>
<listitem> <listitem>
<para> <para>
Select this item to display the status of loaded plugins. Use this item to display the status of any plugins you may have added.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -246,10 +256,10 @@
<term>Open example database</term> <term>Open example database</term>
<listitem> <listitem>
<para> <para>
Select this item to load the example database shipped Select this item to load the example database that is
with &app;. This database is composed of fictitious included in your GRAMPS package. This database is composed
people and serves as a useful example for learning how of fictitious people and serves as a useful example for
to work with &app;. learning how to work with GRAMPS.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>

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

@@ -23,278 +23,242 @@
<!-- $Id$ --> <!-- $Id$ -->
<title>Preface</title> <title>Preface</title>
<para>
&app; is a free software package designed to help you with <para>GRAMPS is a software package designed for genealogical
genealogical research. It allows you to store, edit, and research research. Although similar to other genealogical programs, GRAMPS
genealogical data using your computer. &app; is an open source offers some unique and powerful features, which we'll discuss
software package, which means you are free to run it on any number below. </para>
of computers, examine the code, make changes, and redistribute as
many copies as you like. It is developed and maintained by a
worldwide team of volunteers and is available at no cost from the
project web site and from many software distributions
</para> <para>GRAMPS is a Open Source Software package, which means you
are free to make copies and distribute it to anyone you like.
It's developed and maintained by a worldwide team of volunteers
whose goal is to make GRAMPS powerful, yet easy to use.</para>
<sect1 id="why-gramps"> <sect1 id="why-gramps">
<title>Why use GRAMPS?</title> <title>Why use GRAMPS?</title>
<para> <para>Most genealogy programs allow you to enter information
about your ancestors and descendants. Typically, they can
display family relationships through charts, graphs, or
reports. Some allow you to include pictures or other media. Most
let you include information about people even if those people
are not related to the primary family you happen to be
researching. And they may include features that let you exchange
data with other programs and print different types of
reports. </para>
Most genealogy programs allow the researcher to input <para>GRAMPS has all these capabilities and more. Notably, it
information related to a family tree. They can usually display allows you to integrate bits and pieces of data as they arise
descendant or ancestral relationships through graphical from your research and to put them in one place &mdash; your
displays, charts, or reports. Some allow pictures or other media computer. You can then use your computer to manipulate,
to be inserted to enhance the raw data. Most provide a means to correlate, and analyze your data, rather than messing with reams
include data on individuals or families that may or may not be of paper. </para>
related to the primary family being researched. And they may
include other features such as exporting or importing to and
from other programs and printing data contained in various
reports.
</para><para>
&app; has all these capabilities and more. Notably, it allows
you to integrate bits and pieces of stray data as the arise from
your research and put all this information in one place - your
computer. You can then use the speed, power, and accuracy of
your computer to store, manipulate, correlate, and analyze your
data, rather than messing with reams of paper.
</para><para>
&app; has the power to let you rearrange your data in any order
or sequence and to help you fill gaps in genealogical
relationships.
</para>
</sect1> </sect1>
<sect1 id="whats-new"> <sect1 id="whats-new">
<title>What's new since 1.0.X</title> <title>What's new since 1.0.X</title>
<para>
This section lists most notable changes from the previous <para>If you are new to GRAMPS, it may not be important for you
stable branch of &app;, the 1.0.X. to know how GRAMPS version 2.0.0 (the object of this manual)
differs from previous versions of the software. You may
therefore elect to skip this section.</para>
</para> <para>However, if you are already familiar with GRAMPS and are
interested in the new aspects and features of version 2.0.0,
please read on.</para>
<variablelist> <variablelist>
<varlistentry><term>Berkeley database backend</term> <varlistentry><term>Berkeley database backend</term>
<listitem> <listitem>
<para>
The default format for &app; is now the BSDDB database. <para>We've adopted the Berkeley database format (BSDDB) as
This change allowed us to overcome performance issues and the default for GRAMPS. Berkeley is the most widely used
memory requirements of the 1.0.X branch. With the database open source developer database in the world.</para>
backend, the database sizes of up to a hundred thousand
people do not present a major obstacle any longer.
</para><para> <para>This change allowed us to overcome issues of
performance and memory requirements that beset version
1.0.X. With the new back-end, database sizes of up to a
hundred thousand people no longer present a major
obstacle.</para>
The default extension for &app; BSDDB database files is <para>The default extension for GRAMPS' BSDDB database files
grdb. The new format is open and fully documented in the is grdb. The new format is open and fully documented in the
developer's API reference distributed with the source of developer's API reference distributed with the source code
&app;. of GRAMPS. </para>
</para><para> <note id="default-format">
<title>Preferred format</title>
A consequence of the new database backend is that the <para>The preferred and default format for &app; is the
changes, once approved by the user, are applied new BSDDB format.</para>
immediately. In short, once you click </note>
<guibutton>OK</guibutton> in the Person, Family, Source,
Place, Media object, or Event editor, all the changes made
to this object are recorded in the database. No saving is
necessary (or even possible). The analog of quitting
without saving would be abandoning all changes and
quitting. Also, it is possible to undo recent actions.
</para> <para>A consequence of the new database back-end is that the
&quot;saving&quot; function is no longer necessary (or even
possible). Now, once you approve changes, they are
immediately applied; this means that clicking
<guibutton>OK</guibutton> in the Person, Family, Source,
Place, Media object, or Event editor immediately records
changes in the database. </para>
<para>In previous versions, you could &quot;quit without
saving.&quot; This option no longer exists per se; however,
in version 2.0.0, you can achieve the same effect if you
abandon or &quot;cancel&quot; all changes and then
quit.</para>
<para>Also, it is now possible to undo recent
actions.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry><term>Interface improvements</term> <varlistentry><term>Other database back-ends</term>
<listitem> <listitem>
<para>
There were numerous changes in the interface. Most of them <para>Along with the BSDDB backend, we've incorporated
are subtle and incremental improvements, and all of them &quot;in-memory&quot; database handling for the GRAMPS XML
cannot be listed here. The most noticeable changes are: and GEDCOM formats. This means you can now open files in
those two formats and work with their data without having to
first create a new database and import data into it. Since
this approach requires GRAMPS to hold all the data in
memory, it is only useful for small databases (depending on
available memory size).</para>
<itemizedlist> <warning id="gedcom-editing">
<listitem> <title>GEDCOM Editing</title>
<para>
Removal of alphabetical tabs
</para>
</listitem>
<listitem>
<para>
Ability to add/remove/rearrange columns in list views
</para>
</listitem>
<listitem>
<para>
Removal of Save function and addition of Undo
</para>
</listitem>
<listitem>
<para>
Proper window management and removal of most modal windows
</para>
</listitem>
<listitem>
<para>
Support for Tip of the Day
</para>
</listitem>
<listitem>
<para>
Person-dependent context menus (right-click) in Pedigree View
listing parents, children, spouses, and siblings
</para>
</listitem>
<listitem>
<para>
Export wizard
</para>
</listitem>
<listitem>
<para>
Built-in Find function in list views
</para>
</listitem>
<listitem>
<para>
Date selector dialog
</para>
</listitem>
<listitem>
<para>
Name editor enhancements: patronymic names and non-default
grouping
</para>
</listitem>
<listitem>
<para>
Recent file support (both gramps-specific and gnome-wide)
</para>
</listitem>
</itemizedlist>
</para> <para>Please keep in mind that some information in a
</listitem> GEDCOM file may be lost during import into GRAMPS. Simply
opening and viewing the file will not change it. However,
if any changes were made and they were not abandoned upon
exit, exiting GRAMPS will save the data, with the possible
data loss.</para>
</warning>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>Desktop integration</term>
Other database backends
</term>
<listitem> <listitem>
<para>
Along with the BSDDB backend, the in-memory database handling
for &app; XML and GEDCOM formats has been added. Simply put, it
is now possible to natively open data in those two formats
(although the preferred and default format is grdb) and work with
that data, without necessarily setting up an empty database and
then importing into it. This approach requires holding all data in
memory, so it is only useful for small databases (depending on the
available memory size). In such mode, the data is automatically
saved upon exit, to mimic the functionality of the real database.
<warning id="gedcom-inmem1-warn"> <para>We've improved the way GRAMPS integrates with the GNOME
<title>GEDCOM Editing</title> desktop interface common to many Linux distributions. All file
<para> formats recognized by GRAMPS are now registered as mime types;
Please keep in mind that some information in GEDCOM each has its own icon and has GRAMPS as its default
file may be lost during import into &app;. Simply handler. Thus, if you double-click on any file having one of
opening and viewing the file will not change it. these formats, GRAMPS will launch and open the file.</para>
However, if any changes were made and they were not
abandoned upon exit, exiting &app; will save the data, <para>We've also added support for GNOME's &quot;recent
with the possible data loss. documents&quot; function and have incorporated this function
</para> within GRAMPS itself.</para>
</warning>
</para> </listitem>
</varlistentry>
<varlistentry>
<term>Interface improvements</term>
<listitem>
<para>We've made numerous changes in the interface. Most of
them are subtle and incremental improvements, and all of them
cannot be listed here. The most notable are:</para>
<itemizedlist>
<listitem>
<para>Removal of alphabetical tabs.</para>
</listitem>
<listitem>
<para>Ability to add/remove/rearrange columns in list views.</para>
</listitem>
<listitem>
<para>Removal of the Save function and addition of Undo.</para>
</listitem>
<listitem>
<para>Proper window management and removal of most modal windows.</para>
</listitem>
<listitem>
<para>Support for Tip of the Day.</para>
</listitem>
<listitem>
<para>Person-dependent context menus (right-click) in
Pedigree View, listing parents, children, spouses, and
siblings.</para>
</listitem>
<listitem>
<para>Addition of an Export wizard.</para>
</listitem>
<listitem>
<para>Built-in Find function in list views.</para>
</listitem>
<listitem>
<para>Addition of a Date selector dialog.</para>
</listitem>
<listitem>
<para>Name editor enhancements: patronymic names and
non-default grouping.</para>
</listitem>
<listitem>
<para>&quot;Recent document&quot; support (both within GRAMPS and
GNOME-wide)</para>
</listitem>
</itemizedlist>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Import and Export</term> <term>Import and Export</term>
<listitem> <listitem>
<para> <para>We've added import and export filters for the GeneWeb format.</para>
New import and export filters available for the GeneWeb format.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Reports</term> <term>Reports</term>
<listitem>
<para>
A new report -- Statistics Chart -- has been added to &app;.
</para><para>
An overall change of the whole report framework has been
accomplished. All reports now remember their options. It
is possible to generate reports from the command line,
without launching the interactive &app; session. The
report API is much simpler now, making it easy to write a
custom report. A single code instance may be used for a
standalone report, a book item, and a command-line
report.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Command line</term>
<listitem> <listitem>
<para> <itemizedlist>
The new command line functionality includes opening the <listitem>
filename argument given without any flags, as well as new <para>We've added a new report: Statistics Chart. </para>
flags and options for report generation. Also, the </listitem>
addition of new formats leads to additional available <listitem>
format options. <para>We've changed the overall report framework. All
</para> reports now remember the options you configure for
them.</para>
</listitem>
<listitem>
<para>It is possible to generate reports from the command
line, without launching the interactive GRAMPS
session.</para>
</listitem>
<listitem>
<para>The report API is much simpler now, making it easy to
write custom reports.</para>
</listitem>
<listitem>
<para>A single code instance may be used for a standalone
report, a book item, and a command-line report. </para>
</listitem>
</itemizedlist>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Internationalization</term> <term>Internationalization</term>
<listitem> <listitem>
<para> <para>The approach for entering and displaying dates has
The approach for entering and displaying dates has been been completely reworked. The new framework allows for a
completely re-worked. In particular, the new framework deeper localization of displayed dates than was ever
allows for a deeper localization of displayed dates than possible using the translatable strings.</para>
was ever possible using the translatable strings. <para>The internationalization of names has also been
</para><para> improved. Names can be grouped under a non-default
The internationalization of names have also been improved. string. Patronymic names are supported, and it is easy to
Names can be grouped under a non-default program new ways to display names in the manner customary to
string. Patronymic names are supported, and it is easy to a given culture or language.</para>
program new ways of displaying names, as may be required </listitem>
by various cultures and languages. </varlistentry>
</para> </variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>Desktop integration</term>
<listitem>
<para>
All formats known to &app; are now registered as mime
types, each with its icon and &app; as a default
handler. Double-clicking on a file with any of these
formats will launch &app; and open that file. &app; also
added support for the recent documents
functionality. This is on both the GNOME-wide level
and within the &app;.
</para><para>
The preferences are now properly stored using GConf, with
schemas, partitioning of keys into smaller directories,
error checking, and notification.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1> </sect1>
<sect1 id="typography"> <sect1 id="typography">

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

@@ -4985,7 +4985,7 @@
To insert the code from the internal notes into the web pages, To insert the code from the internal notes into the web pages,
select the appropriate Media Objects from the <guilabel>HTML user select the appropriate Media Objects from the <guilabel>HTML user
header</guilabel> and <guilabel>HTML user footer</guilabel> menus. header</guilabel> and <guilabel>HTML user footer</guilabel> menus.
Two div sections will be added to the pages &mdash; userheader and userfooter. Two div sections will be added to the pages - userheader and userfooter.
The corresponding HTML code is inserted into the HTML page surrounded by div The corresponding HTML code is inserted into the HTML page surrounded by div
markers. You can customize your style sheet to provide additional formatting markers. You can customize your style sheet to provide additional formatting
and positioning information to control these sections.</para> and positioning information to control these sections.</para>