From 6566037cdd104178390e1e07cee601508a358e8a Mon Sep 17 00:00:00 2001 From: Alex Roitman Date: Tue, 15 Feb 2005 02:35:26 +0000 Subject: [PATCH] * doc/gramps-manual/C/authors.xml: Add file. * doc/gramps-manual/C/bugs.xml: Add file. * doc/gramps-manual/C/preface.xml: Add file. * doc/gramps-manual/C/Makefile.am: Ship new files. * doc/gramps-manual/C/cmdline.xml: Convert to book. * doc/gramps-manual/C/custom.xml: Convert to book. * doc/gramps-manual/C/faq.xml: Convert to book. * doc/gramps-manual/C/filtref.xml: Convert to book. * doc/gramps-manual/C/getstart.xml: Convert to book. * doc/gramps-manual/C/gramps-manual.xml: Convert to book. * doc/gramps-manual/C/keybind.xml: Convert to book. * doc/gramps-manual/C/legal.xml: Change license to GPL. * doc/gramps-manual/C/mainwin.xml: Convert to book. * doc/gramps-manual/C/usage.xml: Convert to book. * COPYING-DOCS: Change license to GPL. svn: r4032 --- COPYING-DOCS | 360 +------------------------- ChangeLog | 16 ++ doc/gramps-manual/C/Makefile.am | 5 +- doc/gramps-manual/C/authors.xml | 44 ++++ doc/gramps-manual/C/bugs.xml | 27 ++ doc/gramps-manual/C/cmdline.xml | 40 +-- doc/gramps-manual/C/custom.xml | 85 +++--- doc/gramps-manual/C/faq.xml | 29 ++- doc/gramps-manual/C/filtref.xml | 56 ++-- doc/gramps-manual/C/getstart.xml | 73 ++---- doc/gramps-manual/C/gramps-manual.xml | 187 +++++-------- doc/gramps-manual/C/keybind.xml | 39 +-- doc/gramps-manual/C/legal.xml | 34 +-- doc/gramps-manual/C/mainwin.xml | 68 ++--- doc/gramps-manual/C/preface.xml | 126 +++++++++ doc/gramps-manual/C/usage.xml | 220 ++++++++-------- 16 files changed, 609 insertions(+), 800 deletions(-) create mode 100644 doc/gramps-manual/C/authors.xml create mode 100644 doc/gramps-manual/C/bugs.xml create mode 100644 doc/gramps-manual/C/preface.xml diff --git a/COPYING-DOCS b/COPYING-DOCS index b42936beb..52aa16272 100644 --- a/COPYING-DOCS +++ b/COPYING-DOCS @@ -1,355 +1,13 @@ - GNU Free Documentation License - Version 1.1, March 2000 +The User Manual for Gramps is distributed under the terms of +GNU General Public License (GPL). Yes, it is under GNU GPL and +*NOT* under GNU FDL. - Copyright (C) 2000 Free Software Foundation, Inc. - 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. +As such, this manual meets citeria of Debian Free Software Guidelines +(DFSG) and can be distributed through Debian main (as opposed to non-free). +Please see file named COPYING for exact terms of the license. -0. PREAMBLE +Alex Roitman +February 15, 2005 -The purpose of this License is to make a manual, textbook, or other -written document "free" in the sense of freedom: to assure everyone -the effective freedom to copy and redistribute it, with or without -modifying it, either commercially or noncommercially. Secondarily, -this License preserves for the author and publisher a way to get -credit for their work, while not being considered responsible for -modifications made by others. - -This License is a kind of "copyleft", which means that derivative -works of the document must themselves be free in the same sense. It -complements the GNU General Public License, which is a copyleft -license designed for free software. - -We have designed this License in order to use it for manuals for free -software, because free software needs free documentation: a free -program should come with manuals providing the same freedoms that the -software does. But this License is not limited to software manuals; -it can be used for any textual work, regardless of subject matter or -whether it is published as a printed book. We recommend this License -principally for works whose purpose is instruction or reference. - - -1. APPLICABILITY AND DEFINITIONS - -This License applies to any manual or other work that contains a -notice placed by the copyright holder saying it can be distributed -under the terms of this License. The "Document", below, refers to any -such manual or work. Any member of the public is a licensee, and is -addressed as "you". - -A "Modified Version" of the Document means any work containing the -Document or a portion of it, either copied verbatim, or with -modifications and/or translated into another language. - -A "Secondary Section" is a named appendix or a front-matter section of -the Document that deals exclusively with the relationship of the -publishers or authors of the Document to the Document's overall subject -(or to related matters) and contains nothing that could fall directly -within that overall subject. (For example, if the Document is in part a -textbook of mathematics, a Secondary Section may not explain any -mathematics.) The relationship could be a matter of historical -connection with the subject or with related matters, or of legal, -commercial, philosophical, ethical or political position regarding -them. - -The "Invariant Sections" are certain Secondary Sections whose titles -are designated, as being those of Invariant Sections, in the notice -that says that the Document is released under this License. - -The "Cover Texts" are certain short passages of text that are listed, -as Front-Cover Texts or Back-Cover Texts, in the notice that says that -the Document is released under this License. - -A "Transparent" copy of the Document means a machine-readable copy, -represented in a format whose specification is available to the -general public, whose contents can be viewed and edited directly and -straightforwardly with generic text editors or (for images composed of -pixels) generic paint programs or (for drawings) some widely available -drawing editor, and that is suitable for input to text formatters or -for automatic translation to a variety of formats suitable for input -to text formatters. A copy made in an otherwise Transparent file -format whose markup has been designed to thwart or discourage -subsequent modification by readers is not Transparent. A copy that is -not "Transparent" is called "Opaque". - -Examples of suitable formats for Transparent copies include plain -ASCII without markup, Texinfo input format, LaTeX input format, SGML -or XML using a publicly available DTD, and standard-conforming simple -HTML designed for human modification. Opaque formats include -PostScript, PDF, proprietary formats that can be read and edited only -by proprietary word processors, SGML or XML for which the DTD and/or -processing tools are not generally available, and the -machine-generated HTML produced by some word processors for output -purposes only. - -The "Title Page" means, for a printed book, the title page itself, -plus such following pages as are needed to hold, legibly, the material -this License requires to appear in the title page. For works in -formats which do not have any title page as such, "Title Page" means -the text near the most prominent appearance of the work's title, -preceding the beginning of the body of the text. - - -2. VERBATIM COPYING - -You may copy and distribute the Document in any medium, either -commercially or noncommercially, provided that this License, the -copyright notices, and the license notice saying this License applies -to the Document are reproduced in all copies, and that you add no other -conditions whatsoever to those of this License. You may not use -technical measures to obstruct or control the reading or further -copying of the copies you make or distribute. However, you may accept -compensation in exchange for copies. If you distribute a large enough -number of copies you must also follow the conditions in section 3. - -You may also lend copies, under the same conditions stated above, and -you may publicly display copies. - - -3. COPYING IN QUANTITY - -If you publish printed copies of the Document numbering more than 100, -and the Document's license notice requires Cover Texts, you must enclose -the copies in covers that carry, clearly and legibly, all these Cover -Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -the back cover. Both covers must also clearly and legibly identify -you as the publisher of these copies. The front cover must present -the full title with all words of the title equally prominent and -visible. You may add other material on the covers in addition. -Copying with changes limited to the covers, as long as they preserve -the title of the Document and satisfy these conditions, can be treated -as verbatim copying in other respects. - -If the required texts for either cover are too voluminous to fit -legibly, you should put the first ones listed (as many as fit -reasonably) on the actual cover, and continue the rest onto adjacent -pages. - -If you publish or distribute Opaque copies of the Document numbering -more than 100, you must either include a machine-readable Transparent -copy along with each Opaque copy, or state in or with each Opaque copy -a publicly-accessible computer-network location containing a complete -Transparent copy of the Document, free of added material, which the -general network-using public has access to download anonymously at no -charge using public-standard network protocols. If you use the latter -option, you must take reasonably prudent steps, when you begin -distribution of Opaque copies in quantity, to ensure that this -Transparent copy will remain thus accessible at the stated location -until at least one year after the last time you distribute an Opaque -copy (directly or through your agents or retailers) of that edition to -the public. - -It is requested, but not required, that you contact the authors of the -Document well before redistributing any large number of copies, to give -them a chance to provide you with an updated version of the Document. - - -4. MODIFICATIONS - -You may copy and distribute a Modified Version of the Document under -the conditions of sections 2 and 3 above, provided that you release -the Modified Version under precisely this License, with the Modified -Version filling the role of the Document, thus licensing distribution -and modification of the Modified Version to whoever possesses a copy -of it. In addition, you must do these things in the Modified Version: - -A. Use in the Title Page (and on the covers, if any) a title distinct - from that of the Document, and from those of previous versions - (which should, if there were any, be listed in the History section - of the Document). You may use the same title as a previous version - if the original publisher of that version gives permission. -B. List on the Title Page, as authors, one or more persons or entities - responsible for authorship of the modifications in the Modified - Version, together with at least five of the principal authors of the - Document (all of its principal authors, if it has less than five). -C. State on the Title page the name of the publisher of the - Modified Version, as the publisher. -D. Preserve all the copyright notices of the Document. -E. Add an appropriate copyright notice for your modifications - adjacent to the other copyright notices. -F. Include, immediately after the copyright notices, a license notice - giving the public permission to use the Modified Version under the - terms of this License, in the form shown in the Addendum below. -G. Preserve in that license notice the full lists of Invariant Sections - and required Cover Texts given in the Document's license notice. -H. Include an unaltered copy of this License. -I. Preserve the section entitled "History", and its title, and add to - it an item stating at least the title, year, new authors, and - publisher of the Modified Version as given on the Title Page. If - there is no section entitled "History" in the Document, create one - stating the title, year, authors, and publisher of the Document as - given on its Title Page, then add an item describing the Modified - Version as stated in the previous sentence. -J. Preserve the network location, if any, given in the Document for - public access to a Transparent copy of the Document, and likewise - the network locations given in the Document for previous versions - it was based on. These may be placed in the "History" section. - You may omit a network location for a work that was published at - least four years before the Document itself, or if the original - publisher of the version it refers to gives permission. -K. In any section entitled "Acknowledgements" or "Dedications", - preserve the section's title, and preserve in the section all the - substance and tone of each of the contributor acknowledgements - and/or dedications given therein. -L. Preserve all the Invariant Sections of the Document, - unaltered in their text and in their titles. Section numbers - or the equivalent are not considered part of the section titles. -M. Delete any section entitled "Endorsements". Such a section - may not be included in the Modified Version. -N. Do not retitle any existing section as "Endorsements" - or to conflict in title with any Invariant Section. - -If the Modified Version includes new front-matter sections or -appendices that qualify as Secondary Sections and contain no material -copied from the Document, you may at your option designate some or all -of these sections as invariant. To do this, add their titles to the -list of Invariant Sections in the Modified Version's license notice. -These titles must be distinct from any other section titles. - -You may add a section entitled "Endorsements", provided it contains -nothing but endorsements of your Modified Version by various -parties--for example, statements of peer review or that the text has -been approved by an organization as the authoritative definition of a -standard. - -You may add a passage of up to five words as a Front-Cover Text, and a -passage of up to 25 words as a Back-Cover Text, to the end of the list -of Cover Texts in the Modified Version. Only one passage of -Front-Cover Text and one of Back-Cover Text may be added by (or -through arrangements made by) any one entity. If the Document already -includes a cover text for the same cover, previously added by you or -by arrangement made by the same entity you are acting on behalf of, -you may not add another; but you may replace the old one, on explicit -permission from the previous publisher that added the old one. - -The author(s) and publisher(s) of the Document do not by this License -give permission to use their names for publicity for or to assert or -imply endorsement of any Modified Version. - - -5. COMBINING DOCUMENTS - -You may combine the Document with other documents released under this -License, under the terms defined in section 4 above for modified -versions, provided that you include in the combination all of the -Invariant Sections of all of the original documents, unmodified, and -list them all as Invariant Sections of your combined work in its -license notice. - -The combined work need only contain one copy of this License, and -multiple identical Invariant Sections may be replaced with a single -copy. If there are multiple Invariant Sections with the same name but -different contents, make the title of each such section unique by -adding at the end of it, in parentheses, the name of the original -author or publisher of that section if known, or else a unique number. -Make the same adjustment to the section titles in the list of -Invariant Sections in the license notice of the combined work. - -In the combination, you must combine any sections entitled "History" -in the various original documents, forming one section entitled -"History"; likewise combine any sections entitled "Acknowledgements", -and any sections entitled "Dedications". You must delete all sections -entitled "Endorsements." - - -6. COLLECTIONS OF DOCUMENTS - -You may make a collection consisting of the Document and other documents -released under this License, and replace the individual copies of this -License in the various documents with a single copy that is included in -the collection, provided that you follow the rules of this License for -verbatim copying of each of the documents in all other respects. - -You may extract a single document from such a collection, and distribute -it individually under this License, provided you insert a copy of this -License into the extracted document, and follow this License in all -other respects regarding verbatim copying of that document. - - -7. AGGREGATION WITH INDEPENDENT WORKS - -A compilation of the Document or its derivatives with other separate -and independent documents or works, in or on a volume of a storage or -distribution medium, does not as a whole count as a Modified Version -of the Document, provided no compilation copyright is claimed for the -compilation. Such a compilation is called an "aggregate", and this -License does not apply to the other self-contained works thus compiled -with the Document, on account of their being thus compiled, if they -are not themselves derivative works of the Document. - -If the Cover Text requirement of section 3 is applicable to these -copies of the Document, then if the Document is less than one quarter -of the entire aggregate, the Document's Cover Texts may be placed on -covers that surround only the Document within the aggregate. -Otherwise they must appear on covers around the whole aggregate. - - -8. TRANSLATION - -Translation is considered a kind of modification, so you may -distribute translations of the Document under the terms of section 4. -Replacing Invariant Sections with translations requires special -permission from their copyright holders, but you may include -translations of some or all Invariant Sections in addition to the -original versions of these Invariant Sections. You may include a -translation of this License provided that you also include the -original English version of this License. In case of a disagreement -between the translation and the original English version of this -License, the original English version will prevail. - - -9. TERMINATION - -You may not copy, modify, sublicense, or distribute the Document except -as expressly provided for under this License. Any other attempt to -copy, modify, sublicense or distribute the Document is void, and will -automatically terminate your rights under this License. However, -parties who have received copies, or rights, from you under this -License will not have their licenses terminated so long as such -parties remain in full compliance. - - -10. FUTURE REVISIONS OF THIS LICENSE - -The Free Software Foundation may publish new, revised versions -of the GNU Free Documentation License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. See -http://www.gnu.org/copyleft/. - -Each version of the License is given a distinguishing version number. -If the Document specifies that a particular numbered version of this -License "or any later version" applies to it, you have the option of -following the terms and conditions either of that specified version or -of any later version that has been published (not as a draft) by the -Free Software Foundation. If the Document does not specify a version -number of this License, you may choose any version ever published (not -as a draft) by the Free Software Foundation. - - -ADDENDUM: How to use this License for your documents - -To use this License in a document you have written, include a copy of -the License in the document and put the following copyright and -license notices just after the title page: - - Copyright (c) YEAR YOUR NAME. - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 - or any later version published by the Free Software Foundation; - with the Invariant Sections being LIST THEIR TITLES, with the - Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. - A copy of the license is included in the section entitled "GNU - Free Documentation License". - -If you have no Invariant Sections, write "with no Invariant Sections" -instead of saying which ones are invariant. If you have no -Front-Cover Texts, write "no Front-Cover Texts" instead of -"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. - -If your document contains nontrivial examples of program code, we -recommend releasing these examples in parallel under your choice of -free software license, such as the GNU General Public License, -to permit their use in free software. +$Id$ diff --git a/ChangeLog b/ChangeLog index 025585864..9ab656206 100644 --- a/ChangeLog +++ b/ChangeLog @@ -2,6 +2,22 @@ * src/plugins/DetAncestralReport.py: Typos. * src/plugins/DetDescendantReport.py: Typos. + * doc/gramps-manual/C/authors.xml: Add file. + * doc/gramps-manual/C/bugs.xml: Add file. + * doc/gramps-manual/C/preface.xml: Add file. + * doc/gramps-manual/C/Makefile.am: Ship new files. + * doc/gramps-manual/C/cmdline.xml: Convert to book. + * doc/gramps-manual/C/custom.xml: Convert to book. + * doc/gramps-manual/C/faq.xml: Convert to book. + * doc/gramps-manual/C/filtref.xml: Convert to book. + * doc/gramps-manual/C/getstart.xml: Convert to book. + * doc/gramps-manual/C/gramps-manual.xml: Convert to book. + * doc/gramps-manual/C/keybind.xml: Convert to book. + * doc/gramps-manual/C/legal.xml: Change license to GPL. + * doc/gramps-manual/C/mainwin.xml: Convert to book. + * doc/gramps-manual/C/usage.xml: Convert to book. + * COPYING-DOCS: Change license to GPL. + 2005-02-12 Alex Roitman * src/ReadGrdb.py: Check for overlapping handles prior to modifying data. diff --git a/doc/gramps-manual/C/Makefile.am b/doc/gramps-manual/C/Makefile.am index a79338c36..b50c756a9 100644 --- a/doc/gramps-manual/C/Makefile.am +++ b/doc/gramps-manual/C/Makefile.am @@ -4,12 +4,15 @@ lang = C omffile = gramps-manual-C.omf entities = legal.xml\ getstart.xml\ + preface.xml\ mainwin.xml\ usage.xml\ custom.xml\ faq.xml\ keybind.xml\ filtref.xml\ - cmdline.xml + cmdline.xml\ + bugs.xml\ + authors.xml include $(top_srcdir)/doc/xmldocs.make dist-hook: app-dist-hook diff --git a/doc/gramps-manual/C/authors.xml b/doc/gramps-manual/C/authors.xml new file mode 100644 index 000000000..ecb493ded --- /dev/null +++ b/doc/gramps-manual/C/authors.xml @@ -0,0 +1,44 @@ + + + + + + + About GRAMPS + &app; was written by Donald N. Allingham + (dallingham@users.sourceforge.net). + To find more information about &app;, please visit the + GRAMPS Project + Web page. + + To report a bug or make a suggestion regarding this application or + this manual, use the help menu in &app;, or follow the directions + in this document. + + + This program is distributed under the terms of the GNU + General Public license as published by the Free Software + Foundation; either version 2 of the License, or (at your option) + any later version. A copy of this license can be found at this + link, or in the file + COPYING included with the source code of this program. + + diff --git a/doc/gramps-manual/C/bugs.xml b/doc/gramps-manual/C/bugs.xml new file mode 100644 index 000000000..c642772c1 --- /dev/null +++ b/doc/gramps-manual/C/bugs.xml @@ -0,0 +1,27 @@ + + + + + + + Known Bugs and Limitations + + diff --git a/doc/gramps-manual/C/cmdline.xml b/doc/gramps-manual/C/cmdline.xml index 7ae0c00d5..90bfc6269 100644 --- a/doc/gramps-manual/C/cmdline.xml +++ b/doc/gramps-manual/C/cmdline.xml @@ -1,22 +1,28 @@ - + + - Command line reference This appendix provides the reference to the command line capabilities available when launching &app; from the terminal. @@ -37,7 +43,7 @@ - + Available options Here is the list of the command line options in &app;: @@ -159,10 +165,10 @@ - + - + Operation The order of -i, -o, @@ -185,9 +191,9 @@ or or to stderr (if these are not handled). Use usual shell redirections of stdout and stderr to save messages and errors in files. - + - + Examples To import four databases (whose formats can be determined from their names) and then check the resulting database for errors, one may @@ -242,6 +248,6 @@ Finally, to start normal interactive session type: gramps - + - + diff --git a/doc/gramps-manual/C/custom.xml b/doc/gramps-manual/C/custom.xml index 5c157fb3d..94a4190af 100644 --- a/doc/gramps-manual/C/custom.xml +++ b/doc/gramps-manual/C/custom.xml @@ -1,24 +1,27 @@ - + - - - Settings To configure &app;, choose Edit @@ -33,13 +36,13 @@ - + Usage This category contains preferences relevant to the general usage of &app;. It has the following subcategories: - + Find @@ -55,10 +58,10 @@ - + - + Report Preferences @@ -95,10 +98,10 @@ - + - + Researcher Information @@ -115,10 +118,10 @@ - + - + Data Guessing @@ -144,19 +147,19 @@ - + - + - + Display This category contains preferences relevant to displaying database records and controls in &app;. It has the following subcategories: - + General @@ -188,10 +191,10 @@ - + - + Dates and Calendar @@ -223,10 +226,10 @@ - + - + Toolbar and Statusbar @@ -244,18 +247,18 @@ - + - + - + Database This category contains preferences relevant to the database itself. It has the following subcategories: - + General @@ -288,10 +291,10 @@ - + - + Media Objects Before describing preferences for media objects, let us @@ -346,10 +349,10 @@ - + - + GRAMPS internal IDs @@ -368,10 +371,10 @@ - + - + Revision Control @@ -391,8 +394,8 @@ - + - + - + diff --git a/doc/gramps-manual/C/faq.xml b/doc/gramps-manual/C/faq.xml index dd8cdf321..f4d71dd63 100644 --- a/doc/gramps-manual/C/faq.xml +++ b/doc/gramps-manual/C/faq.xml @@ -1,22 +1,27 @@ - + + - - Frequently Asked Questions This appendix contains the list of questions that frequently come up in mailing list discussions and forums. This list is by no means @@ -380,4 +385,4 @@ potential of your great idea :-) - + diff --git a/doc/gramps-manual/C/filtref.xml b/doc/gramps-manual/C/filtref.xml index 62406d686..fbbc3eef3 100644 --- a/doc/gramps-manual/C/filtref.xml +++ b/doc/gramps-manual/C/filtref.xml @@ -1,23 +1,27 @@ - + - - Filter rules reference This appendix lists of all the filter rules currently defined in &app;. Each of these rules is available for use when creating custom @@ -25,7 +29,7 @@ - + General filters This category includes the following most general rules: @@ -85,10 +89,10 @@ - + - + Event filters This category includes the following rules that match people based on their recorded events: @@ -160,10 +164,10 @@ - + - + Family filters This category includes the following rules that match people based on their family relationships: @@ -204,10 +208,10 @@ - + - + Ancestral filters This category includes the following rules that match people based on their ancestral relations to other people: @@ -270,10 +274,10 @@ - + - + Descendant filters This category includes the following rules that match people based on their descendant relations to other people: @@ -330,10 +334,10 @@ - + - + Relationship filters This category includes the following rules that match people based on their mutual relationship: @@ -356,10 +360,10 @@ - + - + Miscellaneous filters This category includes the following rules which do not naturally fit into any of the above categories: @@ -389,6 +393,6 @@ - + - + diff --git a/doc/gramps-manual/C/getstart.xml b/doc/gramps-manual/C/getstart.xml index 1382ad19d..6d9255fcb 100644 --- a/doc/gramps-manual/C/getstart.xml +++ b/doc/gramps-manual/C/getstart.xml @@ -1,28 +1,32 @@ - + - - Getting Started - + To Start GRAMPS You can start &app; in the following ways: @@ -50,10 +54,10 @@ - + - + Running GRAMPS for the first time The first time you run the program, GRAMPS will display its @@ -87,10 +91,10 @@ Usage category. - + - + Choosing a database on startup If &app; is started without any database to open, the following window will appear prompting you to @@ -128,40 +132,11 @@ created by &app; when you start a new database and is updated each time the database is saved. - + - - + Obtaining Help At any time, the following items are available for immediate aid from the Help menu: @@ -205,6 +180,6 @@ - + - + diff --git a/doc/gramps-manual/C/gramps-manual.xml b/doc/gramps-manual/C/gramps-manual.xml index 1470609e5..b10033294 100644 --- a/doc/gramps-manual/C/gramps-manual.xml +++ b/doc/gramps-manual/C/gramps-manual.xml @@ -3,22 +3,36 @@ - + + + + + + + @@ -27,10 +41,9 @@ - - - - GRAMPS"> + + + -
+ - + GRAMPS Manual V&manrevision; 2001 Donald N. Allingham - 2003-2004 Alex Roitman + 2003-2005 Alex Roitman + @@ -106,7 +118,7 @@ --> - + @@ -129,6 +141,15 @@ GRAMPS Project + + GRAMPS Manual V2.5 + February 2004 + + Alex Roitman + shura@alex.neuro.umn.edu + GRAMPS Project + + GRAMPS Manual V2.4 December 2003 @@ -210,118 +231,28 @@ - + GRAMPS gramps - - - Introduction - &app; is a genealogical - application. &app; is an acronym for the - Genealogical Research and Analysis Management Programming System. To put - it shortly, it allows you to store, edit, and research genealogical data - using your computer. Its functionality is somewhat common to other - genealogical programs. However, &app; offers some unique features. - - Why GRAMPS? - &app; was conceived under the concept - that most genealogy programs were designed to provide the researcher the - capability to input information related to a particular family tree. - Most of these programs have allowed for the arranging and storing of - information consistent with the GEDCOM standards. They usually provide - means for displaying descendant or ancestral relationships by means of - graphical displays, charts, or reports. These may be augmented with - pictures or other media to enhance the data. Most provide for inputting - data on unconnected individuals/families that may or may not have a - relationship to the primary surname being researched. Various other - enhancements may also be provided in the genealogical program that - allows for different degrees of importing and exporting data from other - programs and printing the data contained in the various reports. + + &preface; + + + &getstart; + &mainwin; + &usage; + &custom; + + + &faq; + &keybind; + &filtref; + &cmdline; + &bugs; + &authors; - &app;, on the other hand, attempts to - provide all of the common capabilities of these programs, but, more - importantly, to provide an additional capability of integration not common - to these programs. This is the ability to input any bits and pieces of - information directly into &app; and - rearrange/manipulate any/all data events in the entire data base (in any - order or sequence) to assist the user in doing research, analysis and - correlation with the potential of filling relationship gaps. In short, it - is a tool that provides a way to input all your research into one place and - do your analysis and correlation using the speed, power, and accuracy of - your computer instead of pencils and unmanageable reams of paper. - - - - &getstart; - &mainwin; - &usage; - &custom; - - - - - - Known Bugs and Limitations - Currently, &app; loads all data into memory, which tends to bog - down the system for large databases (over 15000 people for a typical - system). This will be addressed with the 1.2 release by incorporating - a database backend. The database backend should dramatically improve - both speed and memory usage. - - Direct printing is not currently supported. This is planned to be - fixed after the stable 1.0 release by using gnome-print architechture. - - PS and PDF reports output garbage in place of unicode characters. - This should also be solved when we move to gnome-print. In the meantime, - a decent workaround is to produce reports in OpenOffice.org format and then - export into PDF from withing OpenOffice.org application. - - - - - About GRAMPS - &app; was written by Donald N. Allingham - (dallingham@users.sourceforge.net). - To find more information about &app;, please visit the - GRAMPS Project - Web page. - - To report a bug or make a suggestion regarding this application or - this manual, use the help menu in &app;, or follow the directions - in this document. - - - This program is distributed under the terms of the GNU - General Public license as published by the Free Software - Foundation; either version 2 of the License, or (at your option) - any later version. A copy of this license can be found at this - link, or in the file - COPYING included with the source code of this program. - - - - - - Appendices - - &faq; - &keybind; - &filtref; - &cmdline; - - - -
+ diff --git a/doc/gramps-manual/C/keybind.xml b/doc/gramps-manual/C/keybind.xml index 9fc28a059..ec7b4071e 100644 --- a/doc/gramps-manual/C/keybind.xml +++ b/doc/gramps-manual/C/keybind.xml @@ -1,30 +1,33 @@ - + - - Keybindings reference This appendix contains the list of keybindings that are not displayed in menus of &app;. - - + People View The following bindings are available in the People View: @@ -48,11 +51,10 @@ - + - - + Family View The bindings available in the Family View depend on where the focus is. The following tables list the bindings for all focus @@ -258,7 +260,6 @@ - - - + + \ No newline at end of file diff --git a/doc/gramps-manual/C/legal.xml b/doc/gramps-manual/C/legal.xml index ac97e1de4..b6f267cd8 100644 --- a/doc/gramps-manual/C/legal.xml +++ b/doc/gramps-manual/C/legal.xml @@ -1,19 +1,22 @@ - Permission is granted to copy, distribute and/or modify this - document under the terms of the GNU Free Documentation - License (GFDL), Version 1.1 or any later version published - by the Free Software Foundation with no Invariant Sections, - no Front-Cover Texts, and no Back-Cover Texts. You can find - a copy of the GFDL at this link or in the file COPYING-DOCS - distributed with this manual. - - This manual is part of a collection of GNOME manuals - distributed under the GFDL. If you want to distribute this - manual separately from the collection, you can do so by - adding a copy of the license to the manual, as described in - section 6 of the license. + This manual is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + + + This manual is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA @@ -27,7 +30,7 @@ DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED - UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE + UNDER THE TERMS OF THE GNU GENERAL PUBLIC LICENSE WITH THE FURTHER UNDERSTANDING THAT: @@ -73,4 +76,3 @@ - diff --git a/doc/gramps-manual/C/mainwin.xml b/doc/gramps-manual/C/mainwin.xml index 033444f9b..982d2682e 100644 --- a/doc/gramps-manual/C/mainwin.xml +++ b/doc/gramps-manual/C/mainwin.xml @@ -1,23 +1,27 @@ - + - - Main Window When you open a database (either existing or brand new), the following window is displayed. @@ -84,7 +88,7 @@ - + Views Views are the various ways to display different aspects of genealogical information, as described below. Since the relevant @@ -96,7 +100,7 @@ switching between the Views. - + Switching Views and Viewing Modes Depending on the state of the ViewSidebar @@ -139,10 +143,10 @@ Sidebar from the &app; menu. - + - + People View When &app; first opens a database, the View is set to the People View ( @@ -170,7 +174,7 @@ heading. - + Filters Genealogical databases may contain huge numbers of people. Since the long lists are hard for humans to handle, @@ -219,10 +223,10 @@ checking View Filter menu item and check what kind of filtering is currently set. - + - + Alphabetical Tabs &app; offers another way of managing long lists of people -- alphabetical tabs. Upon loading a @@ -234,12 +238,12 @@ characters -- all the entries not assigned to any other tab end up in Other. In particular, people with no family name will appear under this category. - + - + - + Family View Family View displays the family information of a currently selected (or Active) person. Specifically, this view shows the @@ -329,10 +333,10 @@ - + - + Pedigree View @@ -430,10 +434,10 @@ reference. - + - + Sources View @@ -456,10 +460,10 @@ Author of the source. Any column can be used for sorting the list. The usual rules apply: one click for ascending order, another click for descending order. - + - + Places View @@ -481,10 +485,10 @@ City, County, State, and Country. All of these columns can be used for sorting by the usual sorting rules. - + - + Media View @@ -505,7 +509,7 @@ Path to the Media Object. The top part of the GRAMPS window shows a preview (if available) and information about the Media Object. - + - - + + diff --git a/doc/gramps-manual/C/preface.xml b/doc/gramps-manual/C/preface.xml new file mode 100644 index 000000000..88943a9f4 --- /dev/null +++ b/doc/gramps-manual/C/preface.xml @@ -0,0 +1,126 @@ + + + + + + + Preface + &app; is a genealogical + application. &app; is an acronym for the + Genealogical Research and Analysis Management Programming System. To put + it shortly, it allows you to store, edit, and research genealogical data + using your computer. Its functionality is somewhat common to other + genealogical programs. However, &app; offers some unique features. + + + Why GRAMPS? + &app; was conceived under the concept + that most genealogy programs were designed to provide the researcher the + capability to input information related to a particular family tree. + Most of these programs have allowed for the arranging and storing of + information consistent with the GEDCOM standards. They usually provide + means for displaying descendant or ancestral relationships by means of + graphical displays, charts, or reports. These may be augmented with + pictures or other media to enhance the data. Most provide for inputting + data on unconnected individuals/families that may or may not have a + relationship to the primary surname being researched. Various other + enhancements may also be provided in the genealogical program that + allows for different degrees of importing and exporting data from other + programs and printing the data contained in the various reports. + + &app;, on the other hand, attempts to + provide all of the common capabilities of these programs, but, more + importantly, to provide an additional capability of integration not common + to these programs. This is the ability to input any bits and pieces of + information directly into &app; and + rearrange/manipulate any/all data events in the entire data base (in any + order or sequence) to assist the user in doing research, analysis and + correlation with the potential of filling relationship gaps. In short, it + is a tool that provides a way to input all your research into one place and + do your analysis and correlation using the speed, power, and accuracy of + your computer instead of pencils and unmanageable reams of paper. + + + + + + + Typographical conventions + + In this book, we some words are marked with special typography: + + Applications + Commands you type at the command + line + Filenames + Replaceable text + Labels for buttons and other + portions of the graphical interface + + Menu selections look like this: + + Menu + Submenu + Menu Item + + + Buttons you can + click + Anything you type + in + + + + + We also provide assorted bits of additional information in tips + and notes, as follows. + + + Tip + + Tips and bits of extra information will look like + this. + + + + + Note + + Notes will look like this. + + + + + + Finally, we have warnings, in cases where you should be careful: + + + Example Warning + + This is what a warning looks like. If there's a chance + you'll run into trouble, we'll warn you beforehand. + + + + + + + \ No newline at end of file diff --git a/doc/gramps-manual/C/usage.xml b/doc/gramps-manual/C/usage.xml index 22f11ec52..55068a57b 100644 --- a/doc/gramps-manual/C/usage.xml +++ b/doc/gramps-manual/C/usage.xml @@ -1,23 +1,27 @@ - + - - Usage As commonly encountered in everyday life, in &app; there is usually more than one way to @@ -25,7 +29,7 @@ be listed as appropriate. - + Starting a New Database To start a new database, choose File New. You will then be @@ -33,10 +37,10 @@ to specify the name under which the new database will be stored. Choose an empty directory for your new database (create one if necessary). - + - + Opening a Database To open a database, either choose FileOpen @@ -63,10 +67,10 @@ possible copies of media objects. Such a directory is created by &app; when you start a new database and is updated each time the database is saved. - + - + Saving a Database To save changes made to your database, choose File @@ -74,10 +78,10 @@ Save button on the Toolbar. The statusbar will then display the Saving databasename... message, and the progressbar will advance as the saving progresses. - + - + Importing Data Importing allows you to incorporate the data from other databases into your currently open &app; database. Currently, @@ -179,10 +183,10 @@ - + - + Exporting Data Exporting allows you to share any portion of your &app; database @@ -317,10 +321,10 @@ - + - + Editing Data: Quick Start Editing any portion of data allows you to amend and/or modify information stored in the database. The available editing @@ -338,7 +342,7 @@ - + To Add a Person To add a person to the database, switch to the People View () and then click the @@ -355,10 +359,10 @@ and select Add... or Edit... from the invoked context menu. - + - + To Specify a Relationship To specify a relationship, first switch to the Family View (). Then click one of the two top buttons on @@ -387,10 +391,10 @@ menu available upon right-clicking into the spouse box. Also, most of the above function are available from the items of this context menu. - + - + To Specify Parents To specify parents of an active person, first switch to the Family View (). Then click the @@ -415,10 +419,10 @@ the corresponding parents' box and double-click. All these functions can also be performed by right-clicking on the parents' box and selecting an appropriate item from the context menu. - + - + To Specify Children To specify children of an active person, switch to the Family View () and then click either the @@ -442,10 +446,10 @@ into the children box. Also, most of the above function are available from the items of this context menu. - + - + To Add Images You can add images (as well as other media objects) to individual people, events, sources, places, as well as images @@ -498,10 +502,10 @@ delete it from Media View by first selecting it and then clicking the Remove icon on the toolbar. - + - + To Edit Sources and Places To add a source or a place to the database, switch to @@ -519,11 +523,11 @@ may double-click on the entry to edit it. - - + + - + Editing Data: Complete Description This section provides a complete description of all editing options for all pieces of data in the &app; database. It refers mainly @@ -533,7 +537,7 @@ the . - + Edit Personal Information Editing of personal data can be performed in the following ways: @@ -933,10 +937,10 @@ - + - + Edit Dates Anywhere in &app; where the date is entered or edited, the following rules apply: @@ -999,10 +1003,10 @@ - + - + Edit Relationship Data Editing of relationship data is performed in the following Marriage/Relationship Editor dialog which appears @@ -1180,10 +1184,10 @@ - + - + Edit Source Data To edit source data, switch to the Sources View and select the desired entry in the list of sources. Double-click on that entry or @@ -1290,11 +1294,11 @@ - + - + Edit Place Data To edit place data, switch to the Places View and select the desired entry in the list of places. Double-click on that entry or @@ -1450,10 +1454,10 @@ - + - + Edit Media Data To edit media data, switch to the Media View and select the desired entry in the list of sources. Double-click on that entry or @@ -1561,10 +1565,10 @@ - + - + Edit Events Events are edited through the following Event Editor dialog: @@ -1663,10 +1667,10 @@ - + - + Edit Source Information When adding source references to events, places, etc., the following dialog appears: @@ -1701,10 +1705,10 @@ The rest of the details can be typed in the appropriate text entry fields. - + - + Edit Alternate Names Alternate names are edited through the following Alternate Names Editor dialog: @@ -1790,10 +1794,10 @@ - + - + Edit Attributes Attributes are edited through the following Attribute Editor dialog: @@ -1877,10 +1881,10 @@ - + - + Edit Addresses Addresses are edited through the following Address Editor dialog: @@ -1965,10 +1969,10 @@ - + - + Edit Witnesses Witnesses are edited through the following Witness Editor dialog: @@ -2030,10 +2034,10 @@ existing comments simply edit the text in the text area. - + - + Merge People Sometime two people entries in the database turn out to be describing the same person. When this happens, merging people is @@ -2052,10 +2056,10 @@ data if you so choose. If you would like to continue editing data of a newly merged person, click the Merge and edit button. - + - + Merge Places Sometime two place entries in the database turn out to be describing the same place. When this happens, merging places is @@ -2073,12 +2077,12 @@ the new (merged) place. Alternatively, you may type in other data for the new place, if you click Other radio button. - + - + - + Navigation As long as any database is open, &app; is focused on a single person usually referred to as an Active person. This @@ -2092,7 +2096,7 @@ depending what you are doing in &app; at the moment. - + Using the People View The most intuitive way to select an active person is to use the People View (see ). @@ -2100,10 +2104,10 @@ name of the desired person from the list by clicking that list entry. The person you have selected becomes active. The statusbar updates to reflect the change of the active person. - + - + Using the Family View When in the Family View (see ), you can easily navigate between the members of the displayed family @@ -2147,10 +2151,10 @@ navigation options. The detailed reference to the keybindings is found in the . - + - + Using the Pedigree View The Pedigree View (see ) also allows you to move along the family tree. @@ -2186,10 +2190,10 @@ boxes for father and mother. - + - + Setting the Home Person One and only one person in the database can be selected as the Home person. Once the Home person is selected, moving to that @@ -2208,11 +2212,11 @@ right click. - + - + Using history-based tools &app; also features a powerful set of history-based navigation tools. These tools are similar to those commonly used in web browsers. @@ -2227,10 +2231,10 @@ popup menu with corresponding portion of the history. Select any item from the menu to jump directly to it. - + - + Bookmarking People Similar to setting the Home person, you can bookmark other people from the database to simplify further navigation. To bookmark @@ -2259,10 +2263,10 @@ - + - + Finding People To find a person in a database, choose EditFind... @@ -2273,42 +2277,42 @@ If the search is successful, the found person becomes an active person and the display adjusts according to the new active person and the current view. - + - + Finding Sources To find a source in a database, choose EditFind... when in the Sources View. This opens a Find Source dialog which can be used for searching forward and backward. If the search is successful, the found source becomes highlighted. - + - + Finding Places To find a place in a database, choose EditFind... when in the Places View. This opens a Find Place dialog which can be used for searching forward and backward. If the search is successful, the found place becomes highlighted. - + - + Finding Media Objects To find a media object in a database, choose EditFind... when in the Media View. This opens a Find Media Objects dialog which can be used for searching forward and backward. If the search is successful, the found media object becomes highlighted. - + - + - + Generating Reports Reports are the most common form of the output produced by genealogical research. The majority of genealogical software puts a lot @@ -2335,7 +2339,7 @@ - + Graphical Reports Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, @@ -2401,10 +2405,10 @@ Applications dialog). - + - + Text Reports Text reports represent the desired information as formatted text. Most of the options are common among text reports, @@ -2515,10 +2519,10 @@ Applications dialog). - + - + Books Currently, the only available report under this category is the Book Report. @@ -2607,10 +2611,10 @@ - + - + View Reports View reports represent overall summaries of the database information available immediately for on-screen viewing. @@ -2630,10 +2634,10 @@ - + - + Web Page This report generates web pages, either for a selected @@ -2650,12 +2654,12 @@ the optional &app; ID, create a GENDEX index, and specify the extension of the resulting files. - + - + - + Running Tools &app; tools allow you to perform various types of analyses of your genealogical data. Typically, the tools do not produce @@ -2676,7 +2680,7 @@ Tools icon on the toolbar. - + Analysis and Exploration This section contains tools which analyze and explore the database, but do not alter it. The following analysis and exploration @@ -2700,10 +2704,10 @@ - + - + Database Processing This section contains tools which may modify your database. The modifications will only be performed upon your explicit consent. @@ -2769,10 +2773,10 @@ - + - + Utilities @@ -2893,8 +2897,8 @@ - + - + - +