diff --git a/gramps2/ChangeLog b/gramps2/ChangeLog index 3dfb2dde2..126ca3472 100644 --- a/gramps2/ChangeLog +++ b/gramps2/ChangeLog @@ -1,3 +1,8 @@ +2005-12-10 Don Allingham + * 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ôme Rapinat * doc/gramps-manual/fr/cmdplug.xml: Add file with new section. * doc/gramps-manual/fr/gramps-manual.xml: Define entity for new diff --git a/gramps2/doc/gramps-manual/C/figures/first-open.png b/gramps2/doc/gramps-manual/C/figures/first-open.png index 646a443c0..6e24d01d4 100644 Binary files a/gramps2/doc/gramps-manual/C/figures/first-open.png and b/gramps2/doc/gramps-manual/C/figures/first-open.png differ diff --git a/gramps2/doc/gramps-manual/C/getstart.xml b/gramps2/doc/gramps-manual/C/getstart.xml index 02d0ed902..1e0718e82 100644 --- a/gramps2/doc/gramps-manual/C/getstart.xml +++ b/gramps2/doc/gramps-manual/C/getstart.xml @@ -25,9 +25,8 @@ Getting Started - This chapter provides the most basic information on starting - &app; and obtaining help. Please proceed to the following - chapters for more information. + In this chapter, we'll begin with the basics. We'll show you how + to start &app; and how to get help when you need it. @@ -39,29 +38,33 @@ - Applications menu + From the Applications menu - - The method of starting &app; from the menus may vary - from distribution to distribution. On default GNOME - desktop, choose - Other - Gramps. - + + Select &app; from the list of programs displayed in + your computer's Applications menu. (The location and + appearance of this menu vary slightly from one distribution + of Linux to another. On the default GNOME desktop, you'll + find &app; in the + ApplicationsOther + menu. + + - Command line + From the command line - To start &app; from a command line, type - gramps, then press - Enter. + If you're adept with Linux and like to work from the command + line, you can start &app; by calling up a terminal window, + typing gramps, and then pressing + Enter. - 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: + If you would like GRAMPS to open a specific database or to + import a specific file on startup, you can supply the filename + as a command line argument: gramps filename.grdb @@ -83,14 +86,29 @@ Running GRAMPS for the first time - The first time you run the program, GRAMPS will display the - Getting Started dialogs. Follow the directions that guide you through - Researcher information, Numerical date - formats, Alternate calendar support, - and the LDS extensions sections. Most of the dialogs - are self-explanatory and will not be covered here. + The first time you run the program, GRAMPS will display the + "Getting Started" dialogs. Follow the directions that + guide you through Researcher information, + Numerical date formats, Alternate + calendar support, and the LDS + extensions sections. You should find them to be + self-explanatory. + + Dialog boxes + We'll make frequent reference in this manual to + dialogs. A dialog is simply a pop-up window into which you can + enter information. + + + 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. +
@@ -110,19 +128,12 @@ - - Enter your personal information in the corresponding text entry - fields. Although &app; requests information about you, this - 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. - - - This information can be entered at any time in the - Preferences dialog, under the - Database/Researcher Information category. - + + Entering personal information + This information can be entered at any time in the + Preferences dialog, under the Database/Researcher Information + category. + @@ -141,8 +152,7 @@ - + Shows Open Database Window. @@ -153,21 +163,26 @@ - - If you would like to open an existing database, check the top - radio button and click the OK - 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. - + + To open a database that you have recently opened, choose the + top selection, select your database from the menu and + click OK. &app; will then ask you to specify + the name of the database you wish to open. + + To open an existing database you have not recently opened, + choose the middle selection and click + OK. &app; will then ask you to specify the + name of the database you wish to open. + + As you might guess, to create a new database, choose + "Create a new database" Selecting file - This version of &app; does not require selecting a directory - for the database. Please select filename, as you would in any - other application. + If you're familiar with version 1.0.X of GRAMPS, you'll note + that version 2.0 does not require you to select a directory in + which to store the database. @@ -178,17 +193,17 @@ Obtaining Help - The following items are available from the - Help to provide - immediate assistance: + GRAMPS has a Help menu + that you can consult at any time. It includes the following items: + User manual - 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. @@ -196,20 +211,14 @@ FAQ - - Select this item to read the Frequently Asked Questions about - &app; in the browser. - + A list of Frequently Asked Questions about &app;. GRAMPS home page - - Select this item to open the home page of &app; in your - default web browser. - + A link to the GRAMPS' project web site. @@ -217,8 +226,7 @@ GRAMPS mailing lists - Select this item to direct your web browser - to the &app; mailing list archives. + Gives you direct access to GRAMPS' mailing list archives. @@ -227,8 +235,10 @@ Report a bug - Select this item to file a bug report regarding &app; - with the bug tracking system. + Choose this item to file a bug report in our bug tracking + 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.) @@ -237,7 +247,7 @@ Show plugin status - Select this item to display the status of loaded plugins. + Use this item to display the status of any plugins you may have added. @@ -246,10 +256,10 @@ Open example database - 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;. + Select this item to load the example database that is + included in your GRAMPS package. This database is composed + of fictitious people and serves as a useful example for + learning how to work with GRAMPS. diff --git a/gramps2/doc/gramps-manual/C/preface.xml b/gramps2/doc/gramps-manual/C/preface.xml index 6c3bb4767..45881f10b 100644 --- a/gramps2/doc/gramps-manual/C/preface.xml +++ b/gramps2/doc/gramps-manual/C/preface.xml @@ -23,278 +23,242 @@ Preface - - &app; is a free software package designed to help you with - genealogical research. It allows you to store, edit, and research - genealogical data using your computer. &app; is an open source - software package, which means you are free to run it on any number - 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 - - + GRAMPS is a software package designed for genealogical + research. Although similar to other genealogical programs, GRAMPS + offers some unique and powerful features, which we'll discuss + below. + + 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. Why use GRAMPS? - - - Most genealogy programs allow the researcher to input - information related to a family tree. They can usually display - descendant or ancestral relationships through graphical - displays, charts, or reports. Some allow pictures or other media - to be inserted to enhance the raw data. Most provide a means to - include data on individuals or families that may or may not be - 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. + 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. - + GRAMPS has all these capabilities and more. Notably, it + allows you to integrate bits and pieces of data as they arise + from your research and to put them in one place — your + computer. You can then use your computer to manipulate, + correlate, and analyze your data, rather than messing with reams + of paper. - &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. - - - - &app; has the power to let you rearrange your data in any order - or sequence and to help you fill gaps in genealogical - relationships. - - - - What's new since 1.0.X - - - This section lists most notable changes from the previous - stable branch of &app;, the 1.0.X. + What's new since 1.0.X - + If you are new to GRAMPS, it may not be important for you + 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. + + 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. Berkeley database backend - - The default format for &app; is now the BSDDB database. - This change allowed us to overcome performance issues and - memory requirements of the 1.0.X branch. With the database - backend, the database sizes of up to a hundred thousand - people do not present a major obstacle any longer. + We've adopted the Berkeley database format (BSDDB) as + the default for GRAMPS. Berkeley is the most widely used + open source developer database in the world. - + 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. - The default extension for &app; BSDDB database files is - grdb. The new format is open and fully documented in the - developer's API reference distributed with the source of - &app;. + The default extension for GRAMPS' BSDDB database files + is grdb. The new format is open and fully documented in the + developer's API reference distributed with the source code + of GRAMPS. - + + Preferred format - A consequence of the new database backend is that the - changes, once approved by the user, are applied - immediately. In short, once you click - OK 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. - - + The preferred and default format for &app; is the + new BSDDB format. + + + A consequence of the new database back-end is that the + "saving" function is no longer necessary (or even + possible). Now, once you approve changes, they are + immediately applied; this means that clicking + OK in the Person, Family, Source, + Place, Media object, or Event editor immediately records + changes in the database. + + In previous versions, you could "quit without + saving." This option no longer exists per se; however, + in version 2.0.0, you can achieve the same effect if you + abandon or "cancel" all changes and then + quit. + + Also, it is now possible to undo recent + actions. - Interface improvements - - + Other database back-ends + + + Along with the BSDDB backend, we've incorporated + "in-memory" database handling for the GRAMPS XML + 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). - There were numerous changes in the interface. Most of them - are subtle and incremental improvements, and all of them - cannot be listed here. The most noticeable changes are: + + GEDCOM Editing - - - - Removal of alphabetical tabs - - - - - Ability to add/remove/rearrange columns in list views - - - - - Removal of Save function and addition of Undo - - - - - Proper window management and removal of most modal windows - - - - - Support for Tip of the Day - - - - - Person-dependent context menus (right-click) in Pedigree View - listing parents, children, spouses, and siblings - - - - - Export wizard - - - - - Built-in Find function in list views - - - - - Date selector dialog - - - - - Name editor enhancements: patronymic names and non-default - grouping - - - - - Recent file support (both gramps-specific and gnome-wide) - - - + Please keep in mind that some information in a + 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. + - - + - - Other database backends - + Desktop integration - - 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. - - GEDCOM Editing - - Please keep in mind that some information in GEDCOM - file may be lost during import into &app;. Simply - opening and viewing the file will not change it. - However, if any changes were made and they were not - abandoned upon exit, exiting &app; will save the data, - with the possible data loss. - - - + We've improved the way GRAMPS integrates with the GNOME + desktop interface common to many Linux distributions. All file + formats recognized by GRAMPS are now registered as mime types; + each has its own icon and has GRAMPS as its default + handler. Thus, if you double-click on any file having one of + these formats, GRAMPS will launch and open the file. + + We've also added support for GNOME's "recent + documents" function and have incorporated this function + within GRAMPS itself. + + + + + + Interface improvements + + + 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: + + + + Removal of alphabetical tabs. + + + Ability to add/remove/rearrange columns in list views. + + + Removal of the Save function and addition of Undo. + + + Proper window management and removal of most modal windows. + + + Support for Tip of the Day. + + + Person-dependent context menus (right-click) in + Pedigree View, listing parents, children, spouses, and + siblings. + + + Addition of an Export wizard. + + + Built-in Find function in list views. + + + Addition of a Date selector dialog. + + + Name editor enhancements: patronymic names and + non-default grouping. + + + "Recent document" support (both within GRAMPS and + GNOME-wide) + + Import and Export - - New import and export filters available for the GeneWeb format. - + We've added import and export filters for the GeneWeb format. Reports - - - A new report -- Statistics Chart -- has been added to &app;. - - 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. - - - - - - Command line - - - The new command line functionality includes opening the - filename argument given without any flags, as well as new - flags and options for report generation. Also, the - addition of new formats leads to additional available - format options. - - + + + + We've added a new report: Statistics Chart. + + + We've changed the overall report framework. All + reports now remember the options you configure for + them. + + + It is possible to generate reports from the command + line, without launching the interactive GRAMPS + session. + + + The report API is much simpler now, making it easy to + write custom reports. + + + A single code instance may be used for a standalone + report, a book item, and a command-line report. + + + Internationalization - - The approach for entering and displaying dates has been - completely re-worked. In particular, the new framework - allows for a deeper localization of displayed dates than - was ever possible using the translatable strings. - - The internationalization of names have also been improved. - Names can be grouped under a non-default - string. Patronymic names are supported, and it is easy to - program new ways of displaying names, as may be required - by various cultures and languages. - - - - - - Desktop integration - - - 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;. - - The preferences are now properly stored using GConf, with - schemas, partitioning of keys into smaller directories, - error checking, and notification. - - - - + The approach for entering and displaying dates has + been completely reworked. The new framework allows for a + deeper localization of displayed dates than was ever + possible using the translatable strings. + The internationalization of names has also been + improved. Names can be grouped under a non-default + string. Patronymic names are supported, and it is easy to + program new ways to display names in the manner customary to + a given culture or language. + + + diff --git a/gramps2/doc/gramps-manual/C/usage.xml b/gramps2/doc/gramps-manual/C/usage.xml index d6ed44fca..32d82307e 100644 --- a/gramps2/doc/gramps-manual/C/usage.xml +++ b/gramps2/doc/gramps-manual/C/usage.xml @@ -4985,7 +4985,7 @@ To insert the code from the internal notes into the web pages, select the appropriate Media Objects from the HTML user header and HTML user footer menus. - Two div sections will be added to the pages — 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 markers. You can customize your style sheet to provide additional formatting and positioning information to control these sections.