From dbd1697a022f45a6a96790d202cf8ca866fe4dcf Mon Sep 17 00:00:00 2001 From: Alex Roitman Date: Thu, 27 Mar 2003 16:52:40 +0000 Subject: [PATCH] Corrections to properly install GNOME2 docs svn: r1404 --- gramps2/Makefile.am | 8 +- gramps2/configure.in | 52 +- gramps2/doc/Makefile.am | 4 +- gramps2/doc/gramps-manual/C/Makefile.am | 52 +- .../doc/gramps-manual/C/gramps-manual-C.omf | 22 +- gramps2/doc/gramps-manual/C/gramps-manual.xml | 3134 +++++++++++++++++ gramps2/doc/omf.make | 53 + gramps2/doc/xmldocs.make | 95 + gramps2/gramps.spec.in | 13 +- 9 files changed, 3329 insertions(+), 104 deletions(-) create mode 100644 gramps2/doc/gramps-manual/C/gramps-manual.xml create mode 100644 gramps2/doc/omf.make create mode 100644 gramps2/doc/xmldocs.make diff --git a/gramps2/Makefile.am b/gramps2/Makefile.am index c8c30da1d..ed452ebad 100644 --- a/gramps2/Makefile.am +++ b/gramps2/Makefile.am @@ -1,13 +1,12 @@ # copyright (C) 2000 Sun Microsystems, Inc. -SUBDIRS = src doc omf-install +SUBDIRS = src doc -EXTRA_DIST = autogen.sh gramps.spec.in +EXTRA_DIST = autogen.sh gramps.spec.in COPYING-DOCS bin_SCRIPTS = gramps grampsdocdir = $(datadir)/doc/gramps-$(VERSION) -scrollkeeper_localstate_dir = $(localstatedir)/lib/scrollkeeper gramps: gramps.sh cp gramps.sh gramps @@ -17,10 +16,7 @@ dist-hook: gramps.spec # Build/rebuild the catalog install-data-hook: - rm -rf $(DESTDIR)$(scrollkeeper_localstate_dir) - $(mkinstalldirs) $(DESTDIR)$(scrollkeeper_localstate_dir) $(mkinstalldirs) $(DESTDIR)$(localstatedir)/log -# scrollkeeper-rebuilddb -p $(DESTDIR)$(scrollkeeper_localstate_dir) # Remove generated files uninstall-local: diff --git a/gramps2/configure.in b/gramps2/configure.in index 837faaac4..d2cde0e42 100644 --- a/gramps2/configure.in +++ b/gramps2/configure.in @@ -218,40 +218,25 @@ fi AC_MSG_RESULT(ok) -dnl ====================================================== -dnl == Modern documentation tools (scrollkeeper) checks -dnl == We may need a more recent version (GNOME2 will use -dnl == scrollkeeper > 0.3) but basic scrollkeeper instructions -dnl == use 0.1.4 example so we'll just check for that -dnl ====================================================== -SCROLLKEEPER_REQUIRED=0.1.4 -AC_SUBST(SCROLLKEEPER_REQUIRED) - -dnl First see that *some* version of scrollkeeper is installed -dnl AC_PATH_PROG(SCROLLKEEPER_CONFIG, scrollkeeper-config, no) -dnl if test x$SCROLLKEEPER_CONFIG = xno; then -dnl AC_MSG_ERROR(Couldn't find scrollkeeper-config. Please install the scrollkeeper package.) -dnl DISABLE_SCROLLKEEPER=1 -dnl AC_SUBST(DISABLE_SCROLLKEEPER) -dnl fi - -DISABLE_SCROLLKEEPER=1 -AC_SUBST(DISABLE_SCROLLKEEPER) - -dnl ====================================================== -dnl == GNOME modified DTD's need jw, not db2html -dnl ====================================================== -AC_PATH_PROG(JW, jw, no) -if test x$JW = xno; then - HAVE_JW="no" -else - HAVE_JW="yes" +dnl ==================================== +dnl = Begin tests for scrollkeeper +dnl ==================================== +AC_PATH_PROG(SK_CONFIG,scrollkeeper-config,no) +if test x$SK_CONFIG = xno; then + AC_MSG_ERROR(Couldn't find scrollkeeper-config. Please install the scrollkeeper package: http://scrollkeeper.sourceforge.net) fi -AC_SUBST(HAVE_JW) +dnl ==================================== +dnl = End tests for scrollkeeper +dnl ==================================== -dnl ====================================================== -dnl == end of modern doc tests -dnl ====================================================== +dnl =================================== +dnl Set localstatedir to /var/lib -- this is apparently not used +dnl by anything besides scrollkeeper in our setup +dnl ================================== +localstatedir=/var/lib + +SCROLLKEEPER_BUILD_REQUIRED=0.3.5 +AC_SUBST(SCROLLKEEPER_BUILD_REQUIRED) AC_SUBST(BINSH) AC_SUBST(SWIG) @@ -283,8 +268,5 @@ src/po/Makefile doc/Makefile doc/gramps-manual/Makefile doc/gramps-manual/C/Makefile -doc/extending-gramps/Makefile -doc/extending-gramps/C/Makefile -omf-install/Makefile gramps.spec gramps.sh]) diff --git a/gramps2/doc/Makefile.am b/gramps2/doc/Makefile.am index a24f2349f..3ce16727e 100644 --- a/gramps2/doc/Makefile.am +++ b/gramps2/doc/Makefile.am @@ -1,11 +1,11 @@ # Process this file with automake to produce Makefile.in -SUBDIRS = gramps-manual extending-gramps +SUBDIRS = gramps-manual man_IN_FILES = gramps.1.in man_MANS = ${man_IN_FILES:.1.in=.1} -EXTRA_DIST = $(man_MANS) $(man_IN_FILES) sgmldocs.make +EXTRA_DIST = $(man_MANS) $(man_IN_FILES) xmldocs.make omf.make gramps.1: $(top_builddir)/config.status gramps.1.in cd $(top_builddir) && CONFIG_FILES=doc/$@ $(SHELL) ./config.status diff --git a/gramps2/doc/gramps-manual/C/Makefile.am b/gramps2/doc/gramps-manual/C/Makefile.am index dde918710..b8447e160 100644 --- a/gramps2/doc/gramps-manual/C/Makefile.am +++ b/gramps2/doc/gramps-manual/C/Makefile.am @@ -1,53 +1,7 @@ -SGML_FILES = gramps-manual.sgml - -figs = \ - figures/addmedia.png \ - figures/druidpg1.png \ - figures/editbookmarks.png \ - figures/ep-address.png \ - figures/ep-altname.png \ - figures/ep-attributes.png \ - figures/ep-event.png \ - figures/ep-gallery.png \ - figures/ep-general.png \ - figures/ep-internet.png \ - figures/ep-lds.png \ - figures/ep-notes.png \ - figures/familyview.png \ - figures/filter.png \ - figures/globalmedia.png \ - figures/gotobookmark.png \ - figures/localmedia.png \ - figures/mainwin.png \ - figures/mediaview.png \ - figures/opendb.png \ - figures/pedegreesel.png \ - figures/pedegreeview.png \ - figures/peoplelist.png \ - figures/placelist.png \ - figures/prefs-bars.png \ - figures/prefs-colors.png \ - figures/prefs-dates.png \ - figures/prefs-disp.png \ - figures/prefs-find.png \ - figures/prefs-gen.png \ - figures/prefs-guess.png \ - figures/prefs-ids.png \ - figures/prefs-main.png \ - figures/prefs-media.png \ - figures/prefs-report.png \ - figures/prefs-research.png \ - figures/prefs-revision.png \ - figures/reportsel.png \ - figures/revcontrol.png \ - figures/savecomment.png \ - figures/sourcelist.png \ - figures/sourcerefsel.png \ - figures/toolsel.png - +figdir = figures docname = gramps-manual lang = C omffile = gramps-manual-C.omf -sgml_ents = -include $(top_srcdir)/doc/sgmldocs.make +entities = legal.xml +include $(top_srcdir)/doc/xmldocs.make dist-hook: app-dist-hook diff --git a/gramps2/doc/gramps-manual/C/gramps-manual-C.omf b/gramps2/doc/gramps-manual/C/gramps-manual-C.omf index 057a9f63d..d3e6959d9 100644 --- a/gramps2/doc/gramps-manual/C/gramps-manual-C.omf +++ b/gramps2/doc/gramps-manual/C/gramps-manual-C.omf @@ -1,14 +1,18 @@ - + - - GRAMPS User Manual - - - GNOME|Applications - - - + Alex Roitman shura@alex.neuro.umn.edu + GRAMPS Manual + 2003-03-25 + + + User Manual for GRAMPS. + User Manual + + + + + \ No newline at end of file diff --git a/gramps2/doc/gramps-manual/C/gramps-manual.xml b/gramps2/doc/gramps-manual/C/gramps-manual.xml new file mode 100644 index 000000000..9cc116aad --- /dev/null +++ b/gramps2/doc/gramps-manual/C/gramps-manual.xml @@ -0,0 +1,3134 @@ + + + + + + GRAMPS"> + +]> + + +
+ + + + &app; Manual V&manrevision; + + 2003 Alex Roitman + 2001 Donald N. Allingham + + + + GRAMPS Project + + &legal; + + + + + Alex + Roitman + + GRAMPS Project +
shura@alex.neuro.umn.edu
+ + + + Donald N. + Allingham + + GRAMPS Project +
dallingham@users.sourceforge.net
+ + + + + + + + + + + + + + + + + + + + + GRAMPS Manual V&manrevision; + &date; + + Alex Roitman + shura@alex.neuro.umn.edu + + GRAMPS Project + + + + GRAMPS User Manual V1.1 + 2001 + + Donald N. Allingham + dallingham@users.sourceforge.net + + GRAMPS Project + + + + gramps User Manual V1.0 + 2001 + + Donald N. Allingham + dallingham@users.sourceforge.net + + GRAMPS Project + + + + + This manual describes version &appversion; of GRAMPS. + + + Feedback + To report a bug or make a suggestion regarding the &app; application or + this manual, follow the directions in the GNOME Feedback Page. + + + + + + GRAMPS + gramps + + + + + Introduction + The &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 &app;? + &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, 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. + + + + + + + Getting Started + + + + To Start &app; + You can start &app; in the + following ways: + + + Applications menu + Choose Other + Gramps. + + + Command line + To start &app; + from a command line, type gramps, then + press Return. + + If you would like &app; 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.ged + + + where filename.ged is the name + of the file you want to open/import. + + + + + + + Running &app; for the first time + + [ FIXME: NEED TO RUN Getting Started DRUID to document this section ] + + The first time you run the program, GRAMPS will display its + Getting Started screens. + + +
+ &app; Getting Started Window + + + Shows Getting Started Window. +
+ + + + + + Choosing a database on startup + If &app; is started without any + database to open, the following window will appear prompting you to + choose what database to open. + + +
+ Open Database Window + + + Shows Open Database Window. +
+ + + If you would like to open an existing database, check the top radio + button and click OK. You will then be asked to + specify the name of your existing database. If you would like to start + creating your brand new database from scratch right away, choose new XML + database. + + + + + Optional ZODB support + + If either StandaloneZODB or Zope is installed on your system, + &app; will give you the third option of + creating a new ZODB database. You can choose to start your new database + in either XML or ZODB format. Both formats have their strong and weak + points. + + XML stands for eXtensible Markup Language, and is a human readable + structured description of data. It could be easily parsed by other + programs should the need occur. It stores only the data itself. Its weak + point is the relatively low speed of processing large data files. + + ZODB stands for Zope Object Database and provides the full-fledged + database support. ZODB files are not human readable. They contain a + certain overhead to assist working with large data structures. However, + ZODB provides a significant speed-up when the database size is large (over + few thousand people). + + Its is hard to tell which format is better, since this is a typical + tradeoff situation. If you are starting your research then you are likely + to be fine with the regular XML database. If you have tons of data to + import describing thousands upon thousands of people, then you are + probably better of with ZODB. + + + + + + + + Main Window + When you open a database (either existing or brand new), + the following window is displayed. + + +
+ &app; Main Window + + + Shows &app; main window. Contains titlebar, menubar, + toolbar, sidebar, display area, statusbar, progress bar, and + scrollbars. Menubar contains File, Edit, View, Bookmarks, + Reports, Tools, Settings, and Help menus. +
+ + + The &app; window contains the following elements: + + Menubar + The menubar provides access to all features of + &app; through its menus. + + Toolbar + The toolbar provides access to the most frequently + used functions of &app;. The appearance of + the toolbar can be adjusted in Preferences + dialog. + + Progress bar + The progress bar is located in the lower left corner + of the &app; window. It displays the + progress of time consuming operations, such as opening and saving + large data bases, importing and exporting to other formats, generating + web sites, etc. + + Statusbar + The statusbar is located to the right of the progress + bar, on the very bottom of the &app; window. + It displays information about current &app; + activity and contextual information about the menu items. + The behavior of the Status line can be adjusted in + Preferences dialog. + + Display area + The largest area in the center of the + &app; window is the display area. + It shows certain aspects of genealogical information, depending on the + currently selected View. The following six Views are available + in &app;: + + People View + Family View + Pedigree View + Sources View + Places View + Media View + + + + + + + + + Views + Views are the various ways to display different aspects of + genealogical information, as described below. Since the relevant + information is very broad and non-uniform in both context and modality, + it is best to split it's display into smaller categories, uniform in + context and modality. Each View represents such a split and displays a + certain portion of overall available information. Before the detailed + description of available Views, let us guide you through the ways of + switching between the Views. + + + + Switching Views and Viewing Modes + Depending on the state of the + ViewSidebar + menu item, the View could be switched either in the + sidebar or in the notebook tabs in the top part of the window. + + + + To switch the View while in a Sidebar mode, + click on the desired sidebar icon. + + +
+ Sidebar Viewing Mode + + + Shows sidebar viewing mode. +
+ + + + To switch the View while in a Notebook mode, + click on the desired notebook tab. + + +
+ Tabbed Viewing Mode + + + Shows tabbed viewing mode. +
+ + + + + To switch between sidebar and notebook viewing modes, + choose View + Sidebar + from the &app; menu. + + + + + + People View + When &app; opens a database, + the View is set to the People View ( + and ). People View lists individuals + whose data is stored in the database. People View displays people's + Names, &app; ID numbers, + Gender, and + their Birth and Death dates. + The list can be ordered by any field. + + Example: to order list by the Birth date, click on the + Birth date column heading. To order list in + reverse (descending) order, click one more time on the desired column + heading. + + + + Filters + Genealogical databases may contain huge numbers of people. + Since the long lists are hard for humans to handle, + &app; provides a convenient way to limit + the scope of browsing by using the Filter. To save screen space, + Filter controls may be hidden, depending on the state of + View + Filter menu item. + + +
+ Filter Controls Displayed + + + Shows filter controls. +
+ + + When &app; opens a database, the + Filter is set to the trivial filter called All + people, i.e. no filtering is in effect. To choose a + filter, use a pop-up Filter menu above the + people's list. Once the Filter is chosen, click + Apply in the upper right corner of the + window. The filtering will take effect upon clicking + Apply. To invert the filtering rule, check + the Invert box on the left + of Apply button. + + Example: To show people without children, choose + People with children filter, then check + Invert box, and then click + Apply. To cancel any filtering, set + the filter to All people + and then click Apply. + + Note: even if the Filter controls are not displayed + ( View + Filter menu item is + unchecked), the filtering might still be in place. In other words, + the visibility of the Filter controls is not related to the actual + filtering imposed on the list. This may be a cause of confusion, when + you enable the filtering and then remove the controls from the + display. If in doubt, enable the display of Filter controls by + checking 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 + database, &app; checks for the stored + Family names and breaks the people list into sublists based on the + first letter of their name. The alphabetical tabs are displayed in + the bottom part of the &app; window. + The last tab, Other, stands for unidentified + 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 + relationships (e.g marriages, partnerships, etc.) of the active + person, his/her parents (or step parents, or guardians, etc), and + his/her children (could be step children, adopted children, etc.). + + + +
+ Family View + + + Shows Family View. +
+ + + The Active person's data is in the list-box in the upper left + corner of the window. Directly below it, another box lists the Spouse's + data, for each relationship of Active person (can be more than one). + The double-arrow button to the right of the Active person list-box + allows to exchange the currently selected spouse (Current spouse) + with the Active person. Double-clicking on the Active person allows + to edit Active person's data. Double-clicking on the Current spouse + allows to edit their relationship information. To add a spouse, + click + to the right of the spouse box. + To remove Current spouse, click - to the + right of the spouse box. + + The parents of both the Active person and the Current spouse + are listed in the corresponding list-boxes in the right-hand part of + the window (Active person's parents on top, Current spouse parents + on the bottom). Both list-boxes have a set of three buttons on their + right side. The + and - + buttons allow to add and remove parents of the Active person and the + Current spouse, respectively. Clicking -> + makes the family in the corresponding list-box and active family. + That is, it makes the selected Father the Active person, and the + selected Mother the Current spouse. + + The bottom list-box displays children of the Active person and + the Current Spouse. Children's list can be order by the Birth date, + by usual way of clicking on the Birth date column + header. In addition to the Name, + ID, Gender, and + Birth date columns, the list includes + Status column. The pair of status words reflect the + relationship between the child and his Father/Mother (such as Birth, Adoption, + etc.) The three buttons are available on the right side of the + children list-box. The + + and + buttons allow to add and remove + children, respectively. Clicking left arrow button makes + the selected child the Active person. + + + + + Pedigree View + + +
+ Pedigree View + + + Shows Pedigree View. +
+ + + Pedigree View helps to visualize the place of the Active + person in the tree of its ancestors. Pedigree View shows four + generations, going back in time from the Active person + 1 to his/her parents 1, + to grandparents 1, to great-grandparents + 1. + Each person is denoted by a white box bearing the person's name. + The two lines that converge on the box represent ties with the + person's Father (top line) and mother (bottom line). Solid lines + represent birth relations, while dashed lines represent non-birth + relations (such as adoption, step-parenthood, guardianship, etc.). + When the mouse moves over the white box, it expands to display the + corresponding person's dates of birth and death. When the mouse is + placed over the family line, the line changes color to indicate an + active link: double-clicking on the line makes the corresponding + ancestor the Active person. The display in that case is re-adjusted + to show four generations, starting from a newly selected Active + person. + + The left-hand side of the window shows the left arrow button. + Upon clicking, the button expands to the menu listing the children + of the Active person. Selecting the menu item makes the corresponding + child the Active person. + + The right-hand side of the window shows two right arrow buttons. + When the top button is clicked, the Father of the Active person + becomes Active person. Clicking the bottom button makes the Mother of + the Active person the Active person. Again, the display is re-adjusted + to show four generations, starting from a newly selected Active + person. + + + + + Sources View + + +
+ Sources View + + + Shows Sources View. +
+ + + Sources View lists the sources of information stored in the + database. This can include various documents (birth, death, and + marriage certificates, etc.), books, films, journals, private diaries, + i.e. virtually anything that can be classified as a source of + information. The sources can be used as the reference for any event + stored in the database. The Source View lists the + Title, ID, and the + Author of the source. All the columns can be + used for sorting the list. The usual rules apply: one click for + ascending order, another click for descending order. + + + + + Places View + + +
+ Places View + + + Shows Places View. +
+ + + Places View lists the geographical places in which the events + of the database took place. These could be places of birth, death, + marriages of people, as well as their home, employment, education + addresses, or any other conceivable reference to the geographical + location. The Places View lists places' Name, + ID, Church Parish, + City, County, + State, and Country. All of + these can be used for sorting by the usual sorting rules. + + + + + Media View + + +
+ Media View + + + Shows Media View. +
+ + + Media View is a list of Media Objects used in the database. + Media Objects are any files that relate somehow to the stored + genealogical data. Technically, any file can be stored as a Media + Object. Most frequently, these are images, audio files, animation + files, etc. The list-box on the bottom lists the Name, ID, Type, and + Path to the Media Object. The top part of the GRAMPS window shows + the preview (if available) and the information about the Media + Object. + + + + + + + + + Usage + As commonly encountered in everyday life, in + &app; there is usually more than one way to + accomplish something. The alternatives to some actions will therefore + be listed as appropriate. + + + + Opening Database + To open a database, either choose + FileOpen + or click Open button on the Toolbar. + The Open Database dialog will appear. + Either type the full path into the Database text + entry field, or click Browse... to get the + Open File dialog in which you can select the file + that you want to open. After you have selected the file, click + OK to open it. + + If you have previously opened files with + &app; you can retrieve your past selections + from the drop-down menu by clicking the down arrow button. Finally, if + the Revision Control System (RCS) is enabled in the + Preferences dialog, the check-box + Revert to an older version from RCS + will be available. Check it to revert your database to an older RCS + version. + + Note: the name you type or select should be the directory + (folder) which has your data (data.gramps or data.zodb files) as well as + any possible copies of Media Objects. + + + + + Starting New Database + To start a new database, choose File + New. You will then be + prompted with the Save Database dialog asking + to specify the name under which the new database will be stored. + Choose an empty directory for your new database (create one if + necessary). + + + + + Saving Database + To save changes made to your database, choose + File + Save or click + Save on the Toolbar. The Status line will then + display Saving filename... + message, and the progress bar will advance as the saving progresses. + + + + + Importing GEDCOM Data + Importing GEDCOM data allows you to incorporate the data created in + other genealogical programs into your currently open &app; database. + &app; can import GEDCOM data files from a + number of software packages, as long as they comply with GEDCOM + standards. To import GEDCOM file, choose File + ImportImport from + GEDCOM. You will then be prompted with the + Open File dialog asking to specify the GEDCOM file + name. + + Upon starting the import, &app; will + display the following GEDCOM import dialog with the summary of the + information about the data. The information is updated as the import + progresses. + + +
+ GEDCOM Import + + + Shows GEDCOM Import Window. +
+ + + + + Exporting GEDCOM Data + Exporting GEDCOM data allows you to share any portion of your + &app; database with other researchers + by way of standard GEDCOM files. To export into GEDCOM file, + choose File + Export + Export to GEDCOM. The following + Export GEDCOM file dialog will appear. + + +
+ Export GEDCOM File dialog + + + Shows Export GEDCOM File dialog +
+ + + Type the desired GEDCOM filename into the text entry box or + click Browse... to evoke + Save File dialog. Use Filter + pop-up menu to limit the scope of export according to the stated rule. + Choose the desired Encoding of the exported file. + Use Target to select the desired GEDCOM + dialect. Select you copyright statement from the + Copyright menu. Check Do not include + records marked private to disable the output of private + records. Check Restrict data on living people + to limit living people's data to family ties. With this option, + information concerning birth, death, addresses, various events, + etc. will be omitted in the exported GEDCOM file. + + + Upon starting the export, &app; will + display the following GEDCOM export progress window with the progress + bars reflecting the current state of exporting. + + +
+ Export GEDCOM progress dialog + + + Shows Export GEDCOM progress dialog. +
+ + + + + + Importing and Exporting &app; Packages + &app; provides a way to make your + &app; database completely portable. This might + prove useful, for instance, when you need to move your database to + another machine or to share it with somebody, while retaining all the + features provided by &app;. To accomplish + this, choose File + Export + Export to GRAMPS Package. The + GRAMPS Package Export window will appear. Type + the desired package name into the text entry area or click + Browse... to select the file using the + Save File dialog. The resulting package is + gzip-compressed tar archive (also known as tarball) which contains + gramps database, all local media objects, and copies of all external + media objects. + + To import data from such a package into your &app; database, choose + FileImport + Import from GRAMPS, then select + a package to be imported from the Import from GRAMPS + dialog. + + + + + Editing Data: Quick Start + Editing any portion of data allows you to amend and/or + modify information stored in the database. The available editing + options include editing personal data, relationship data, data about + children and parents, information about sources, places, and media + objects used in the database. In short, any data stored in the + database can be edited! Adding new pieces of information is in fact + creating an appropriate empty data structure and subsequent + editing of that empty structure. + + + + To Add a Person + To add a person to the database, switch to the People View + () and then click + Add on the toolbar. + Enter any data you know about this person into the Edit + Person Dialog (see + for details). To edit information about a person already present + in the database, select an entry you would like to view/modify, + and then click Edit on the toolbar. + + + + + To Specify a Relationship + To specify a relationship, first switch to the Family View + (). Then click + + button on the right of the spouse box. Select a spouse/partner from the + list and specify their relationship using the menu at the bottom. If + necessary, you can add a person to the list by clicking + Add... button. To edit information about + relationship already present in the database, move the mouse over + Spouse box and double-click. + + + + + + To Specify Parents + To specify parents of an active person, first switch to the + Family View (). Then click + + button on the right of the active person's + parents list-box. Select the parents from two lists and specify the + parents' relationships to the active person using menus at the bottom. + You can also specify parents' relationship to each other. + If necessary, you can add a person to the list by clicking + Add... button. + + The top and bottom lists contain males and females, + respectively. By default, &app; will + limit both lists to people who could possibly be the parents (judged + by the date of birth) of the active person. To override this, check + the Show all box for each list. + + + To specify parents of the active person's spouse, switch to the + Family View and then click + button on the + right of the spouse's parents list-box. To edit information about + parents already present in the database, move the mouse over + the corresponding parents' box and double-click. + + + + + To Specify Children + To specify children of an active person, switch to the + Family View () and then + click + button on the + right of the children list-box. Select a child from the list and + specify child's relationship with father and mother using menus + at the bottom. If necessary, you can add a person to the list by + clicking Add... button. + + By default, &app; will + limit the list lists to people who could possibly be the child (judged + by the date of birth) of the active person. To override this, check + the Show all box. + + + + + + To Add Images + You can add images (as well as other media objects) to + individual people, events, sources, places, as well as images + generally related to the database (e.g. group family photos). + + To add images related to a single person, switch to the + People View (), select a person, and + then click Edit on the toolbar to invoke + the Edit Person Dialog + (). Then, select the + Gallery tab, and click + Add... to invoke Select a media + object dialog. Type filename or select a file with the + image, then provide a title for that image. To prevent the file from + being copied into your database directory, check the Do not + make a local copy box. Keep adding images until you are + done. + + To add images related to a relationship (e.g. marriage), + switch to the Family View () and then + double click on the Spouse box invoke Marriage/Relationship + editor dialog. Select the Gallery + tab and click Add... to add an image. + + To add images related to a source or a place, first switch to + the Sources View () or Places + View (), respectively. Then select the + appropriate source or place and then either double click on it + or click Edit on the toolbar to invoke + Source Editor (or Place + Editor) dialog. Select the Gallery + tab and click Add... to add an image. + + Finally, to add images that are generally related to the + database but not limited to any person, relationship, source, or place + in particular, switch to the Media View (). + Then click Add on the toolbar to add an image. + If you have already added any images to any individual galleries, + you will also find the listed in the Media View. + + In any gallery, you can also use Edit... + and Remove buttons to edit image information + and to remove the image reference from that gallery. Note that in all + galleries removing the reference to the image does not remove the image + from the database. To completely remove the image from the database, + delete it from Media View by first selecting it and then + clicking Remove on the toolbar. + + + + + + To Edit Sources and Places + + To add a source or a place to the database, switch to + the appropriate Sources View () or + Places View (). + Then click Add on the toolbar to add a + source/place. Enter the information into the Source + Editor (or Place Editor) dialog. + + + To edit information about sources and places already present + in the database, switch to the appropriate view, select an entry + you would like to view/modify, and then click + Edit on the toolbar. + + + + + + + + Editing Data: Complete Description + This section provides a complete description of all editing + options for all pieces of data in the &app; database. + + + + Edit Personal Information + Editing of personal data can be performed in the + following ways. + + From People View: + Double-click the name of the person whose data you would like + to edit, or select the name by single click and then click + Edit on the toolbar. + + From Family View: + Move the mouse into the Active person box, + then double-click. + + + + With either method, the following Edit + Person dialog will appear: + + +
+ Edit Person dialog + + + Shows Edit Person dialog. +
+ + + The top of the window shows the name of the person whose + data is being edited. The main part of the window displays nine + notebook tabs containing different categories of available + information. You can bring any tab to the top for viewing + or editing by clicking on the appropriate tab heading. + The bottom part has OK and + Cancel buttons. Clicking OK + at any time will apply all the changes made in all tabs and close the + dialog window. Clicking Cancel at any time will + close the window without applying any changes. If any of the data + in any tab was modified, the alert window will appear with the + choices of closing the dialog without saving changes, canceling the + initial cancel request, or saving the changes. + + + + The tabs provide the following information categories of + personal data: + + + + General + + General tab allows editing of + the most general information about the person. This includes text + entry fields of Given name, + Family name, Family prefix + (such as de or van), Suffix (e.g. Jr. or III), + Title (e.g. Dr. or Rev.), + Nickname (Bob for Robert), + Type of the name (birth name, married name, etc.) + and Date and Place of birth + and death. Some of these (Family name, + Type, and both Place fields), + in addition to typing the data in, allow to choose the corresponding + contents from the drop-down menus by clicking on a down-arrow button + located immediately to the right of the text entry field. The + available menu choices are formed from the information already stored + in the database. Also, when you start to type within these fields, + &app; will try to guess the remainder of + the text by using the same choices that are available from the + corresponding menu. To accept the highlighted guess and move to + the next field, press Tab. + + + The Gender radio buttons offers + the choice of person's gender between male, + female, and unknown. + The buttons Source... and + Note... allow to add or modify the data about + the sources of the name information and any notes relevant to it. + Similarly, clicking Edit.. buttons located by the + birth and death Date fields allows to edit the + corresponding events of birth and death. + The field ID displays internal + &app; ID number which identifies user in the + database. Finally, the Image area shows the first + image available in the Gallery of this person. + + + + + + Names + + + +
+ Edit Person dialog - Names + + + Shows Names Tab of Edit Person dialog. +
+ + + Names tab displays information concerning + alternate names of the person and the controls allowing its + modification. The bottom part displays the list of all alternate names + of the person stored in the database. The top part shows the details + of the currently selected name in the list (if any). The buttons + Add..., Edit..., + and Delete allow to correspondingly add, + modify, and remove an alternate name record from the database. + Note that Edit... and + Delete buttons become available only when + an alternate name is selected from the list. + + + + + + Events + + + +
+ Edit Person dialog - Events + + + Shows Events Tab of Edit Person dialog. +
+ + + Events tab displays information about + the events relevant to the person and the controls allowing its + modification. The bottom part displays the list of all such events + stored in the database. The top part shows the details + of the currently selected event in the list (if any). The buttons + Add..., Edit..., + and Delete allow to correspondingly add, + modify, and remove an event record from the database. + Note that Edit... and + Delete buttons become available only when + an event is selected from the list. + + + + + + Attributes + + + +
+ Edit Person dialog - Attributes + + + Shows Attributes Tab of Edit Person dialog. +
+ + + Attributes tab displays information about + the attributes of the person and the controls allowing its + modification. These could be any personal attributes of a person whose + description naturally fits into Parameter-Value pairs (e.g. enormous + generosity can be stored as the parameter "Generosity" with the + value "Enormous", etc.). The bottom part displays the list of all + attributes stored in the database. The top part shows the details + of the currently selected attribute in the list (if any). The buttons + Add..., Edit..., + and Delete allow to correspondingly add, + modify, and remove an attribute record from the database. + Note that Edit... and + Delete buttons become available only when + an attribute is selected from the list. + + + + + + Addresses + + + +
+ Edit Person dialog - Addresses + + + Shows Addresses Tab of Edit Person dialog. +
+ + + Addresses tab displays information about + the addresses of the person and the controls allowing its + modification. The bottom part displays the list of all + addresses stored in the database. The top part shows the details + of the currently selected address in the list (if any). The buttons + Add..., Edit..., + and Delete allow to correspondingly add, + modify, and remove an address record from the database. + Note that Edit... and + Delete buttons become available only when + an address is selected from the list. + + + + + + Notes + + + +
+ Edit Person dialog - Notes + + + Shows Notes Tab of Edit Person dialog. +
+ + + Notes tab displays information about + the notes concerning the person. These could be any notes which do not + naturally fit into the Parameter-Value pairs available to Attributes. + To add a note or modify existing notes simply edit the text in the + text entry field. + + + + + + Gallery + + + + + + + Gallery tab displays information about + media objects associated with the person and the controls allowing its + modification. The central part shows the list of all such media objects. + For media object which are valid image files previews of images are + displayed. For other objects such as audio files, movie files, etc. + generic &app; icon is displayed instead. Note that the first available + image in the gallery will be also displayed in the + Image area in the General + tab. The buttons Add..., + Edit..., and Remove allow + to correspondingly add, modify, and remove a media object reference + to this person. Note that Edit... and + Remove buttons become available only when + a media object is selected from the list. + + + + + + Internet + + + +
+ Edit Person dialog - Internet + + + Shows Internet Tab of Edit Person dialog. +
+ + + Internet tab displays information about + Internet addresses relevant to the person and the controls + allowing its modification. The bottom part displays the list of all + such Internet addresses stored in the database. The top part shows the + details of the currently selected addresses in the list (if any). + The buttons Add..., + Edit..., and Delete + allow to correspondingly add, modify, and remove an Internet address + record from the database. The button Go allows + to open a web-page with the corresponding address with your default + browser. Note that Edit..., + Delete, and Go buttons + become available only when an address is selected from the list. + + + + + + LDS + + + +
+ Edit Person dialog - LDS + + + Shows LDS Tab of Edit Person dialog. +
+ + + LDS tab displays information + about LDS ordinances of the person and the controls allowing its + modification. These are LDS baptism, + Endowment, and Sealed to + parents ordinances, as labeled inside the tab. + Each ordinance is described by its date, LDS temple, and Place where + it happened. An additional pop-up menu Parents is + available for the Sealed to parents ordinance. + Each ordinance can further be described by its status through the + selections available in the Status pop-up + menu and can also be referenced by sources and notes via corresponding + Sources... and Note + buttons. + + + + + + + + + Edit Relationship Data + Editing of relationship data is performed in the following + Marriage/Relationship Editor dialog which appears + after double-clicking on the spouse box in the Family View. + + +
+ Marriage/Relationship Editor dialog + + + Shows Marriage/Relationship Editor dialog. +
+ + + The top of the window shows the names of the people whose + relationship is being edited. The main part of the window displays + six notebook tabs containing different categories of available + information. You can bring any tab to the top for viewing + or editing by clicking on the appropriate tab heading. + The bottom part has OK and + Cancel buttons. Clicking OK + at any time will apply all the changes made in all tabs and close the + dialog window. Clicking Cancel at any time will + close the window without applying any changes. If any of the data + in any tab was modified, the alert window will appear with the + choices of closing the dialog without saving changes, canceling the + initial cancel request, or saving the changes. + + + The tabs provide the following information categories of + relationship data: + + + + General + + General tab allows editing of the most general + information about the relationship: the relationship type. + The available types (such as married, partners, etc.) can be chosen + from the drop-down Relationship type menu. + The non-editable field ID displays internal &app; + ID number which identifies this relationship in the database. + + + + + + Events + + Events tab displays information about + the events relevant to the relationship and the controls allowing + its modification. The bottom part displays the list of all such events + stored in the database. The top part shows the details + of the currently selected event in the list (if any). The buttons + Add..., Edit..., + and Delete allow to correspondingly add, + modify, and remove an event record from the database. + Note that Edit... and + Delete buttons become available only when + an event is selected from the list. + + + + + + Attributes + + Attributes tab displays information about + the attributes of the relationship and the controls allowing its + modification. The bottom part displays the list of all such + attributes stored in the database. The top part shows the details + of the currently selected attribute in the list (if any). The buttons + Add..., Edit..., + and Delete allow to correspondingly add, + modify, and remove an attribute record from the database. + Note that Edit... and + Delete buttons become available only when + an attribute is selected from the list. + + + + + + Notes + + Notes tab displays information about the + notes concerning the relationship. These could be any notes which do + not naturally fit into the Parameter-Value pairs available to + Attributes. To add a note or modify existing notes simply edit the + text in the text entry field. + + + + + + Gallery + + Gallery tab displays information about + media objects associated with the person and the controls allowing its + modification. The central part shows the list of all such media objects. + For media object which are valid image files previews of images are + displayed. For other objects such as audio files, movie files, etc. + generic &app; icon is displayed instead. The buttons + Add..., Edit..., + and Remove allow to correspondingly add, modify, + and remove a media object reference to this relationship. + Note that Edit... and + Remove buttons become available only when + a media object is selected from the list. + + + + + + LDS + + LDS tab displays information + about LDS Sealed to spouse ordinance + of the person and the controls allowing its + modification. The data can include date, LDS temple, and Place where + it happened. The ordinance can further be described by its status + through the selections available in the Status + pop-up menu and can also be referenced by sources and notes via + corresponding Sources... and + Note buttons. + + + + + + + + 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 + click Edit on the toolbar to invoke the + following Source Editor dialog: + + +
+ Source Editor dialog + + + Shows Source Editor dialog. +
+ + + The top of the window shows the Source Editor + title of the dialog. The main part of the window displays four notebook + tabs containing different categories of available information. You can + bring any tab to the top for viewing or editing by clicking on the + appropriate tab heading. The bottom part has OK + and Cancel buttons. Clicking + OK at any time will apply all the changes made + in all tabs and close the dialog window. Clicking + Cancel at any time will close the window without + applying any changes. If any of the data in any tab was modified, + the alert window will appear with the choices of closing the dialog + without saving changes, canceling the initial cancel request, or saving + the changes. + + + The tabs provide the following information categories of + source data: + + + + General + + General tab allows editing of the most general + information about the source: its title, author, and publication + information. This information can be typed in the appropriate + text entry fields. + + + + + + Note + + Note tab displays any notes concerning + the source. To add a note or modify existing notes simply edit the + text in the text entry field. + + + + + + Gallery + + Gallery tab displays information about + media objects associated with the given source and the controls + allowing its modification. The central part shows the list of all + such media objects. For media object which are valid image files + previews of images are displayed. For other objects such as audio + files, movie files, etc., generic &app; icon is displayed instead. + The buttons Add..., + Edit..., and Remove allow + to correspondingly add, modify, and remove a media object reference + to this source. Note that Edit... and + Remove buttons become available only when + a media object is selected from the list. + + + + + + References + + References tab displays information about + database records that refer to this source. If the source is not + referenced from any database record, the tab shows empty list. + If the source is referenced from many records, the tab will list + all of them. The list can be ordered by any of its column headers: + Source type, Object, or + Value. This information cannot be modified from + the Source Editor dialog. Instead, the + corresponding database record (e.g. birth event) has to be brought + up and its source reference edited. + + + + + + + + + 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 + click Edit on the toolbar to invoke the + following Place Editor dialog: + + +
+ Place Editor dialog + + + Shows Place Editor dialog. +
+ + + The top of the window shows the Place Editor + title of the dialog. The main part of the window displays seven + notebook tabs containing different categories of available information. + You can bring any tab to the top for viewing or editing by clicking on + the appropriate tab heading. The bottom part has + OK and Cancel buttons. + Clicking OK at any time will apply all the + changes made in all tabs and close the dialog window. Clicking + Cancel at any time will close the window without + applying any changes. If any of the data in any tab was modified, + the alert window will appear with the choices of closing the dialog + without saving changes, canceling the initial cancel request, or saving + the changes. + + + The tabs provide the following information categories of + place data: + + + + General + + General tab allows editing of the most general + information about the place: title which labels it in the database, + city, church parish, county, state, country, longitude, and latitude. + This information can be typed in the appropriate text entry fields. + + + + + + Other names + + Other names tab displays information concerning + other names by which the place might be known and the controls + allowing its modification. The bottom part displays the list of all + other names of the place stored in the database. The top part shows + the details of the currently selected name in the list (if any). + The buttons Add..., + Edit..., and Delete allow + to correspondingly add, modify, and remove a name record + from the database. Note that Edit... and + Delete buttons become available only when + a name is selected from the list. + + + + + Note + + Note tab displays any notes concerning + the place. To add a note or modify existing notes simply edit the + text in the text entry field. + + + + + + Sources + + Sources tab displays information about sources + relevant to this place and the controls allowing its modification. + The central part displays the list of all such sources references + stored in the database. The buttons Add..., + Edit..., and Delete allow + to correspondingly add, modify, and remove a source reference + to this place. Note that Edit... and + Delete buttons become available only when + a source reference is selected from the list. + + + + + Gallery + + Gallery tab displays information about + media objects associated with the given place and the controls + allowing its modification. The central part shows the list of all + such media objects. For media object which are valid image files + previews of images are displayed. For other objects such as audio + files, movie files, etc., generic &app; icon is displayed instead. + The buttons Add..., + Edit..., and Remove allow + to correspondingly add, modify, and remove a media object reference + to this source. Note that Edit... and + Remove buttons become available only when + a media object is selected from the list. + + + + + + Internet + + Internet tab displays information about + Internet addresses relevant to the place and the controls + allowing its modification. The bottom part displays the list of all + such Internet addresses stored in the database. The top part shows the + details of the currently selected addresses in the list (if any). + The buttons Add..., + Edit..., and Delete + allow to correspondingly add, modify, and remove an Internet address + record from the database. The button Go allows + to open a web-page with the corresponding address with your default + browser. Note that Edit..., + Delete, and Go buttons + become available only when an address is selected from the list. + + + + + + References + + References tab displays information about + database records that refer to this place. If the place is not + referenced from any database record, the tab shows empty list. + If the place is referenced from many records, the tab will list + all of them. This information cannot be modified from + the Place Editor dialog. Instead, the + corresponding database record (e.g. birth event) has to be brought + up and its place reference edited. + + + + + + + + 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 + click Edit on the toolbar to invoke the + following Edit Media Properties dialog: + + +
+ Edit Media Properties dialog + + + Shows Edit Media Properties dialog. +
+ + + The top of the window shows the dialog title. Below the title + is the preview of an object and the summary of its properties (ID, + path, and object type). The central part of the window displays four + notebook tabs containing different categories of available information. + You can bring any tab to the top for viewing or editing by clicking on + the appropriate tab heading. The bottom part has + OK and Cancel buttons. + Clicking OK at any time will apply all the + changes made in all tabs and close the dialog window. Clicking + Cancel at any time will close the window without + applying any changes. If any of the data in any tab was modified, + the alert window will appear with the choices of closing the dialog + without saving changes, canceling the initial cancel request, or saving + the changes. + + + The tabs provide the following information categories of + media object data: + + + + General + + General tab allows to edit the title which labels + this object in the database. The title can be typed in the appropriate + text entry field. If the object is not local (i.e. the corresponding + file does not reside under &app; database directory), the + Make a local copy button is available. + Click it to copy the media into &app; database directory. This will + increase the amount of disk space consumed by &app; database. However, + if the external file is deleted or removed, &app; will still be able + to use the local copy. + + + + + Attributes + + Attributes tab displays information about + the attributes of the media object and the controls allowing its + modification. The bottom part displays the list of all such + attributes stored in the database. The top part shows the details + of the currently selected attribute in the list (if any). The buttons + Add..., Edit..., + and Delete allow to correspondingly add, + modify, and remove an attribute record from the database. + Note that Edit... and + Delete buttons become available only when + an attribute is selected from the list. + + + + + Notes + + Notes tab displays information about the + notes concerning the media object. These could be any notes which do + not naturally fit into the Parameter-Value pairs available to + Attributes. To add a note or modify existing notes simply edit the + text in the text entry field. + + + + + References + + References tab displays information about + database records that refer to this media object. If the object is not + referenced from any database record, the tab shows empty list. + If the object is referenced from many records, the tab will list + all of them. The list can be ordered by any of its column headers: + Type, Object, or + Value. This information cannot be modified from + the Media Object Properties Editor dialog. + Instead, the corresponding database record (e.g. birth event) has to + be brought up and its media object reference edited in the gallery + tab. + + + + + + + + Edit Events + Events are edited through the following Event + Editor dialog: + + +
+ Event Editor dialog + + + Shows Event Editor dialog. +
+ + + The top of the window shows the dialog title including the name + of the person whose event is being edited. The central part of the + window displays four notebook tabs containing different categories of + available information. You can bring any tab to the top for viewing or + editing by clicking on the appropriate tab heading. The bottom part has + OK and Cancel buttons. + Clicking OK at any time will apply all the + changes made in all tabs and close the dialog window. Clicking + Cancel at any time will close the window without + applying any changes. If any of the data in any tab was modified, + the alert window will appear with the choices of closing the dialog + without saving changes, canceling the initial cancel request, or saving + the changes. + + The tabs provide the following information categories of + the event data: + + + General + + General tab allows editing of the most general + information about the event: its type, date, place, cause, and + description. The type can be selected from available types listed + in the Event type drop-down menu. The rest + of the information can be typed in the appropriate text entry fields. + Check the Private record box to mark this event + record as private. This will give you a chance to omit this event from + being included in the reports, if you choose so among the report + generation options. + + + + + Sources + + Sources tab displays information about sources + relevant to this event and the controls allowing its modification. + The central part displays the list of all such sources references + stored in the database. The buttons Add..., + Edit..., and Delete + allow to correspondingly add, modify, and remove a source reference + to this event. Note that Edit... and + Delete buttons become available only when + a source reference is selected from the list. + + + + + Note + + Note tab displays any notes concerning + the event. To add a note or modify existing notes simply edit the + text in the text entry field. + + + + + + Witnesses + + Witnesses tab displays information about witnesses + relevant to this event and the controls allowing its modification. + The central part displays the list of all such witnesses + stored in the database. The buttons Add..., + Edit..., and Delete + allow to correspondingly add, modify, and remove a witness reference + to this event. Note that Edit... and + Delete buttons become available only when + a witness reference is selected from the list. + + + + + + + + Edit Source Information + When adding source references to events, places, etc., + the following dialog appears: + + +
+ Source Information dialog + + + Shows Source Information dialog. +
+ + + The top of the window shows the dialog title. The central part + displays the source information. The bottom part has + OK and Cancel buttons. + Clicking OK at any time will apply all the + changes made and close the dialog window. Clicking + Cancel at any time will close the window without + applying any changes. If any of the data was modified, + the alert window will appear with the choices of closing the dialog + without saving changes, canceling the initial cancel request, or saving + the changes. + + The source can be selected from available sources listed in the + Title drop-down menu. If the source you are + referencing is not present in the database yet, you can enter it into + the database. To do this, click New... button + and enter source information into the invoked Source + Editor dialog. You can also set the details specific for + this particular reference: confidence, volume/file/page. date, text, + and comments. Choose the confidence + level from the Confidence drop-down menu. + 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: + + +
+ Alternate Names Editor dialog + + + Shows Alternate Names Editor dialog. +
+ + + The top of the window shows the dialog title including the name + of the person whose alternate name is being edited. The central part + of the window displays three notebook tabs containing different + categories of available information. You can bring any tab to the + top for viewing or editing by clicking on the appropriate tab heading. + The bottom part has OK and + Cancel buttons. Clicking + OK at any time will apply all the + changes made in all tabs and close the dialog window. Clicking + Cancel at any time will close the window without + applying any changes. If any of the data in any tab was modified, + the alert window will appear with the choices of closing the dialog + without saving changes, canceling the initial cancel request, or saving + the changes. + + The tabs provide the following information categories of + the alternate name data: + + + General + + General tab allows editing of the most general + information about the alternate name: given name, family name, family + prefix, suffix, title, and type of the name. The information can be + typed in the appropriate text entry fields. The family name and the + type can be also selected from available choices listed in the + appropriate drop-down menus. + Check the Private record box to mark this name + record as private. This will give you a chance to omit this name from + being included in the reports, if you choose so among the report + generation options. + + + + + Sources + + Sources tab displays information about sources + relevant to this name and the controls allowing its modification. + The central part displays the list of all such sources references + stored in the database. The buttons Add..., + Edit..., and Delete + allow to correspondingly add, modify, and remove a source reference + to this name. Note that Edit... and + Delete buttons become available only when + a source reference is selected from the list. + + + + + Note + + Note tab displays any notes concerning + the name. To add a note or modify existing notes simply edit the + text in the text entry field. + + + + + + + + + Edit Attributes + Attributes are edited through the following + Attribute Editor dialog: + + +
+ Attribute Editor dialog + + + Shows Attribute Editor dialog. +
+ + + The top of the window shows the dialog title including the name + of the person whose attribute is being edited. The central part + of the window displays three notebook tabs containing different + categories of available information. You can bring any tab to the + top for viewing or editing by clicking on the appropriate tab heading. + The bottom part has OK and + Cancel buttons. Clicking + OK at any time will apply all the + changes made in all tabs and close the dialog window. Clicking + Cancel at any time will close the window without + applying any changes. If any of the data in any tab was modified, + the alert window will appear with the choices of closing the dialog + without saving changes, canceling the initial cancel request, or saving + the changes. + + The tabs provide the following information categories of + the attribute data: + + + General + + General tab allows editing of the most general + information about the attribute: name of the attribute and its value. + The information can be typed in the appropriate text entry fields. + The attribute name can also be selected from available choices (if any) + listed in the Attribute drop-down menu. + Check the Private record box to mark this + attribute record as private. This will give you a chance to omit + this attribute from being included in the reports, if you choose + so among the report generation options. + + + + + Sources + + Sources tab displays information about sources + relevant to this attribute and the controls allowing its modification. + The central part displays the list of all such sources references + stored in the database. The buttons Add..., + Edit..., and Delete + allow to correspondingly add, modify, and remove a source reference + to this attribute . Note that Edit... and + Delete buttons become available only when + a source reference is selected from the list. + + + + + Note + + Note tab displays any notes concerning + the attribute . To add a note or modify existing notes simply edit the + text in the text entry field. + + + + + + + + Edit Addresses + Addresses are edited through the following + Address Editor dialog: + + +
+ Address Editor dialog + + + Shows Address Editor dialog. +
+ + + The top of the window shows the dialog title including the name + of the person whose address is being edited. The central part + of the window displays three notebook tabs containing different + categories of available information. You can bring any tab to the + top for viewing or editing by clicking on the appropriate tab heading. + The bottom part has OK and + Cancel buttons. Clicking + OK at any time will apply all the + changes made in all tabs and close the dialog window. Clicking + Cancel at any time will close the window without + applying any changes. If any of the data in any tab was modified, + the alert window will appear with the choices of closing the dialog + without saving changes, canceling the initial cancel request, or saving + the changes. + + The tabs provide the following information categories of + the address data: + + + General + + General tab allows editing of the most general + information about the address: date, street address, city or county, + state or province, country, and the postal code. The information can + be typed in the appropriate text entry fields. + Check the Private record box to mark this address + record as private. This will give you a chance to omit this address + from being included in the reports, if you choose so among the report + generation options. + + + + + Sources + + Sources tab displays information about sources + relevant to this address and the controls allowing its modification. + The central part displays the list of all such sources references + stored in the database. The buttons Add..., + Edit..., and Delete + allow to correspondingly add, modify, and remove a source reference + to this address. Note that Edit... and + Delete buttons become available only when + a source reference is selected from the list. + + + + + Note + + Note tab displays any notes concerning + the address. To add a note or modify existing notes simply edit the + text in the text entry field. + + + + + + + + + Edit Witnesses + Witnesses are edited through the following + Witness Editor dialog: + + +
+ Witness Editor dialog + + + Shows Witness Editor dialog. +
+ + + The top of the window shows the dialog title. The central part + of the window displays information about the witness. The bottom part + has OK and Cancel buttons. + Clicking OK at any time will apply all the + changes made and close the dialog window. Clicking + Cancel at any time will close the window + without applying any changes. If any of the data was + modified, the alert window will appear with the choices of closing + the dialog without saving changes, canceling the initial cancel + request, or saving the changes. + + The witness name can be entered in two ways, depending on + whether the witness is a person already stored in the database or + not (unrelated person). + + + Person from the database + + If the person's data are stored in a database, click Person + is in the database box. Then ... + +[ FIXME: Need Don to decide which way this will eventually be implemented. ] + + + + + + + Unrelated person + + If the person is not in the database, make sure that + Person is in the database box is unchecked. + Then enter the name or any description of a person into the + Person text entry field. This information + is stored as entered, and this is the only place it is stored in. + In other words, there is no reference to that person in the entire + database except for this witness reference. If the person is in fact + a member of the database, it is advised to user the former method. + + + + + The Comment text area allows to enter + any comments concerning the witness. To add a comment or to modify + existing comments simply edit the text in the text area. + + + + + + + + + Navigation + As long as any database is open, + &app; is focused on a + single person usually referred to as an Active person. This + allows you to view or modify the data concerning this person, + his or her immediate family, etc. Navigating in the database (i.e. + moving from person to person) is in fact nothing else but changing + the Active person. This section describes many alternative ways + to navigate through the database using complex and convenient + interface &app; provides. All these ways + eventually accomplish the same thing, but some are more convenient + than others, depending what you are doing in + &app; at the moment. + + + + Using People View + The most intuitive way to select an active person is + to use the People View. When in the People View, just select the + 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 Family View + When in the Family View, you can easily navigate between the + members of the displayed family as follows: + + + To make currently selected spouse the active person, + click double-arrow button to the right of the active person box. + + + To make currently selected parents the active family + (thereby making father the active person and mother the selected + spouse), click right-arrow button to the right of the active person's + parents box. + + To make currently selected spouse's parents + the active family (thereby making father the active person and mother + the selected spouse), click right-arrow button to the right of the + spouse's parents box. + + To make currently selected child the active person, + click left-arrow button to the right of the children box. + + + + + + + + Using Pedigree View + Pedigree View also allows you to move along the family tree. + The benefits of this method is that you can see more than one + generation of the family tree. Also, you can jump directly from a + great-grandson to a great-grandfather without going through the + intermediate generations. + + Note that after changing the active person in the Pedigree + View, the display is re-adjusted to show four generations, starting + from a newly selected Active person. When in the Pedigree View, you + can easily navigate between the members of the displayed family tree + as follows: + + + To make any displayed person the active person, + double click the line that connects to the left side of the + corresponding box. + + To make a child of currently active person (if any) + the active person, click the left arrow button to the left of the + corresponding box. If there is more than one child, the button expands + to the menu listing the children to choose from. + + To move the whole family tree one generation back, + click on the corresponding right arrow button on the right-hand side + of the display area. Clicking the upper button will move the tree + along the paternal line. Clicking the lower button will move the + tree along the maternal line. + + Clicking either of these buttons is completely equivalent to + double-clicking the lines connecting to the left of the corresponding + boxes for father and mother. + + + + + + + Setting Default Person + One and only one person in the database can be selected as the + default person. Once the default person is selected, moving to that + person becomes a matter of a single click, regardless of which view + you are using at the moment. + + To set the default person, first navigate to that person using + any method you like. Then choose + Settings + Default Person. Once this is + done, you can move to the default person from anywhere in the + database by simply clicking Home on the + toolbar. + + + + + + Bookmarking People + Similarly to the default person, you can bookmark other people + from the database to simplify further navigation. To bookmark a person, + first navigate to that person, then choose + Bookmarks + Add bookmark. To move to that + person from anywhere in the database, choose + Bookmarks + Go to bookmark + Person's name + . + + You can manage your bookmarks by choosing + Bookmarks + Edit bookmarks. This opens + the followingEdit Bookmarks dialog with the + list of bookmarks and the controls to modify this list. + + +
+ Edit Bookmarks dialog + + + Shows Edit Bookmarks dialog. +
+ + + + + + + + + Generating Reports + Reports are the most common form of the output produced by + genealogical research. Majority of genealogical software puts a lot + of emphasis on developing nicely looking reports. &app; is no + exception in this regard: it offers a variety of reports to choose + from. &app; can generate reports in a multitude of open formats, both + text based and graphical. &app; can also produce screen based reports + that are convenient for viewing the summary of your database. + Finally, &app; can generate a web-site suitable for immediate + posting on the Internet. All these are almost infinitely flexible: + you get to design and choose the style for your reports. + + All reports can be accessed through the menu by choosing + Reports + Report Type + Particular + Report. Alternatively, + you can browse the complete selection of available reports along + with their brief descriptions in a Report + Selection dialog evoked by clicking + Reports on the toolbar. + + + + + Graphical Reports + Graphical reports represent information in forms of charts + and graphs. Most of the options are common among graphical reports, + therefore they will be described only once, at the end of this + section. Few options specific to the given report will be + described directly in that report's entry. + + The following graphical reports are currently + available in &app;: + + + + Timeline Graph + This report outputs the list of people with their + lifetimes represented by intervals on a common chronological scale. + Specific options include filter, sorting method, and the title of + the report. + + + Relationship Graph + This report creates complex relationship graph in + GraphViz format. The GraphViz dot tool can + transform the graph into postscript, jpeg, png, vrml, svg, and many + other formats. GraphViz tools are freely available from + GraphViz + site. Specific options include filter for this report + include filter and number of generations considered, as well as + several GraphViz specific options related to pagination, color, + and details of the graph. + + + Descendant Graph + This report generates the graph of people who are + descendants of a currently active person. Specific options include + the format of the displayed entries. + + + Ancestor Chart + This report generates the chart of people who are + ancestors of a currently active person. Specific options include + the number of generations considered and the format of the displayed + entries. + + + + + Common options for graphical reports are the filename of the + output, the format of the output, selected style, and page size and + orientation. + + + + + + Text Reports + Text reports represent the desired information as formatted + text. Most of the options are common among text reports, + therefore they will be described only once, at the end of this + section. Few options specific to the given report will be + described directly in that report's entry. + + The following text reports are currently + available in &app;: + + + + Individual Summary + This report produces a detailed summary on the + active person. The report includes all the facts known to the + database about that person. + + + Family Group Report + This creates a family group report, showing + information on a set of parents and their children. Specific + options: the spouse (available only if the active person has more + than one spouse). + + + Detailed Descendant Report + This report covers in detail the descendants of the + active person. It includes vital (birth and death) as well as + marriages. Specific options: number of forward generations + to consider. + + + Detailed Ancestral Report + This report covers in detail the ancestors of the + active person. It includes vital data (birth and death) as well as + marriages. Specific options: number of backward generations + to consider, as well as a variety of options on what exactly + contents to include. + + + Descendant Report + This report produces brief description + of descendants of the active person. Specific options: number + of forward generations to consider. + + + Complete Individual Report + This report provides individual summaries similar to + that of the Individual Summary report. The advantage of this report + is the specific filter option. Depending on the filter choice (active + person only, his or her descendants, his or her ancestors, or entire + database), the report may contain from one to many individual + summaries. Another option for this report is the inclusion of + source information when listing events. + + + Ahnentafel Report + This report lists the active person and his or her + ancestors along with their vital data. The people are numbered in a + special way which is an established standard called Ahnentafel. + The active person is given number 1. His or her father and mother + have numbers 2 and 3, respectively. This rule holds for every person + while going back in generations: father's parents are numbered 4 and 5, + and mother's parents are numbered 6 and 7, fathers always numbered + with even and mothers with odd numbers. Therefore, for any person + having number N in this tree, the numbers of father and mother + are 2N and 2N+1, respectively. + + + + + + Common options for text reports are the filename of the + output, the format of the output, selected style, and page size and + orientation. For HTML reports, there is no page information. + Instead, HTML options include the choice of the HTML template, + either available in &app; or a custom template defined by you. + + + + + + View + View reports represent overall summaries of the database + information available immediately for on-screen viewing. + The following view reports are currently available in &app;: + + + + Number of ancestors + This report displays the number of ancestors of the + active person. + + + Summary of the database + This report displays the overall statistics concerning + number of individuals of each gender, various incomplete entries + statistics, as well as family and media statistics. + + + + + + + + Web Page + + This report generates web pages, either for a selected + individual (active person) or a set of individuals. The options + for this report are broken down into contents, privacy, and advanced + options. The contents options include the filter (determine the + scope of the database to consider), number of generations to consider, + destination directory for the images, and a link to the index page. + Privacy options allow you to omit private records, restrict + information on living people, to skip images (either all or those of + living people), and to omit comments and text in source information. + Finally, the advanced options allow to include 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 + output in form of printouts or files. Instead, they produce screen + output immediately available for the researcher. However, when + appropriate, you can save the result of running a tool into a file. + Tools present one of the major strengths of &app; compared to the most + genealogical software. + + The tools can be accessed through the menu by choosing + Tools + Tool Section + Particular + Tool. Alternatively, + you can browse the complete selection of available tools along + with their brief descriptions in a Tool + Selection dialog evoked by clicking + Tools 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 + tools are currently available in &app;: + + + + Compare individual events + This tool compares events across the selected group of + people. The people for this comparison are chosen with the use of + custom filters. The custom filters can be created in the Custom Filter + Editor (see ). The resulting table produced + by this tool can be saved as a spreadsheet. + + + Interactive descendant browser + This tool builds a tree with the active person being + the root. Children branch from their parents in a usual manner. + Use this tool for a quick glance on a person's descendants. + + + + + + + + + Database Processing + This section contains tools which may modify your database. + The modifications will only be performed upon your explicit consent. + The tools from this section are used most for finding and correcting + errors in the data. The following database processing tools are + currently available in &app;: + + + + Check and repair database + This tool checks the database for integrity problems, + fixing the problems it can. + + + + Extract information from names + This tool searches the entire database and attempts + to extract titles and nicknames that may be embedded in a person's + given name field. + + + + Find possible duplicate people + This tool searches the entire database, looking + for the entries that may represent the same person. + + + + Rename personal event types + This tool allows all the events of a certain name + to be renamed to a new name. + + + + Reorder &app; IDs + This tool reorders the &app; IDs according to the + defaults of &app;. + + + + + + + + + + Utilities + + + This section contains tools allowing to perform a simple + operation on a portion of data. The results can be saved in your + database, but they will not modify your existing data. + The following utilities are currently available in &app;: + + + + Custom Filter Editor + The Custom Filter Editor builds custom filters + that can be used to select people included in reports, exports, + and other tools and utilities. This is in fact a very powerful tool + in genealogical analysis. + + When you launch it, the User defined filters + dialog appears that lists all the filters (if any) previously defined + by you. Click Add... to define a new filter. + Once you have designed your filters, you can edit, test, and delete + selected filters using Edit..., + Test..., and Delete... + buttons, respectively. All the filters displayed in the list will be + automatically saved along with your database and will be available + upon the future runs of &app;. + + Clicking Add... invokes the + following Define filter dialog: + + +
+ Define filter dialog + + + Shows Define filter dialog. +
+ + + Type the name for your + new filter into the Name field. Enter any + comment that would help you identify this filter in the future + into the Comment field. Add as many rules as you + would like to your filter using Add... button. + Check Invert box to negate the filter rule + (e.g. inverting "has a common ancestor with I1" rule will match + everyone who does not have a common ancestor with that person). + If the filter has more than one rule, choose whether all of them + must apply, only one (either) rule must apply, or exactly one (either) + rule must apply, in order for the filter to generate a match. + + Note that the filters you already designed may be used as a rule + for another filter. This gives you nearly infinite flexibility in + custom-tailoring your selection criteria that can be later used in + most of the exports, reports and some of the tools (such as comparing + individual events). + + + Generate SoundEx codes + This utility generates SoundEx codes for the names of + people in the database. + + + + Relationship calculator + This utility calculates the relationship between + two people from the database. + + + + Verify the database + This utility allows you to verify the database based + on the set of criteria specified by you. + + + + + + + + + + + + + + + Settings + To configure &app;, choose + Settings + Preferences. + The Preferences dialog contains the following + categories: + + + + + + + + + + Usage + This category contains preferences relevant to the + general usage of &app;. It has the following subcategories: + + + + Find + + + + Enable autocompletion + If this box is checked, &app; will attempt to complete + the text as you type it into text entry fields such as family name, + place of birth, etc. Completion is attempted based on the match + between the beginning of the text being typed and the corresponding + data already stored in the database. + + + + + + + + + + Report Preferences + + + + Preferred text format + Select the preferred format for text reports + from the available formats listed in this menu. + + + + Preferred graphical format + Select the preferred format for graphical reports + from the available formats listed in this menu. + + + + Preferred paper size + Select the preferred paper size used for reports + from the available sizes listed in this menu. + + + + Default report directory + Choose the default directory for the reports using + Browse... button or type it in the text entry + field. + + + Default web site directory + Choose the default directory for the web site using + Browse... button or type it in the text entry + field. + + + + + + + + + Researcher Information + + + + Researcher information + Enter your personal information in the corresponding + text entry fields. Although GRAMPS requests information about you, + this information is used only so that it can create valid GEDCOM + output files. A valid GEDCOM file requires information about the files + creator. If you choose, you may leave the information empty, however + all the GEDCOM files you export will not be valid. + + + + + + + + + + Data Guessing + + + + Surname guessing + This option is not currently implemented. + + + + + + + + + + + + Display + This category contains preferences relevant to + displaying database records and controls in &app;. + It has the following subcategories: + + + + General + + + + Always display the LDS ordinance tabs + Check this box to have LDS ordinance tabs displayed. + If you do not know what LDS is then you probably should not check it. + + + + Show index numbers in child list + + This option is not currently implemented. + + + + + + + + + Dates and Calendar + + + + Display: Date format + Select the display format for the dates + from the available formats listed in this menu. + + + + Name format + Select the display format for the names + from the available formats listed in this menu. + + + + Entry: Date format + Select the entry format for the dates + from the available formats listed in this menu. + + + + Show calendar format selection menu + Check this box to enable calendar format selection + menu when you are entering dates in the Event + Editor dialog. + + + + + + + + + Tool and Status Bars + + + Toolbar + Select the desired appearance of the toolbar icons + using the radio buttons. + + + + Status bar + Select the desired contents displayed in the + statusbar using the radio buttons. + + + + + + + + + + + Database + This category contains preferences relevant to the + database itself. It has the following subcategories: + + + + General + + + + Automatically load last database + Check this box to automatically load the last open + database on startup. + + + Do not compress XML data file + Check this box to disable compression of the XML + data file. Compression significantly reduces the file size. + + + + Capitalize surnames + Check this box to capitalize surnames entered into the + database. + + + Autosave interval + Set the interval (in minutes) after which &app; will + automatically save your database. Zero interval completely disables + autosave. + + + Default database directory + Choose the default directory in which &app; starts + looking when saving the database using Browse.. + or type its path into the text entry field. + + + + + + + + Media Objects + + + + Drag and drop from an external source + Choose between a reference and a local copy made when + the object is dropped into the gallery. The reference saves disk + space as it does not copy the object. The local copy makes your + database portable as it does not depend on an external file. Consult + your need to make best choice. + + Check Display global properties editor when object is + dropped box to invoke global properties editor after you + drop an external object into the gallery. + + + + Drag and drop from an internal source + Check Display local properties editor when + object is dropped box to invoke local properties editor + after you drop an internal object into the gallery. + + + + + + + + + &app; internal IDs + + + + GRAMPS ID prefixes + Enter ID prefixes for various kinds of database + entries into the corresponding text entry fields. + + + + Allow internal GRAMPS ID numbers to be + edited + Check this box to enable editing of the internal &app; + ID numbers. Unless you know what you are doing, leave it unchecked. + + + + + + + + + Revision Control + + + + Use revision control + Check this box to enable &app; to use revision control + system for your database. If you choose this option, select the + particular revision control system from the menu. + + + + Prompt for comment on save + Check this box to instruct &app; to prompt you to enter + the comment when you save the database. + + + + + + + + + + + + + + + + + About &app; + &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, 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/gramps2/doc/omf.make b/gramps2/doc/omf.make new file mode 100644 index 000000000..d6dfa82be --- /dev/null +++ b/gramps2/doc/omf.make @@ -0,0 +1,53 @@ +# +# No modifications of this Makefile should be necessary. +# +# This file contains the build instructions for installing OMF files. It is +# generally called from the makefiles for particular formats of documentation. +# +# Note that you must configure your package with --localstatedir=/var/lib +# so that the scrollkeeper-update command below will update the database +# in the standard scrollkeeper directory. +# +# If it is impossible to configure with --localstatedir=/var/lib, then +# modify the definition of scrollkeeper_localstate_dir so that +# it points to the correct location. Note that you must still use +# $(localstatedir) in this or when people build RPMs it will update +# the real database on their system instead of the one under RPM_BUILD_ROOT. +# +# Note: This make file is not incorporated into xmldocs.make because, in +# general, there will be other documents install besides XML documents +# and the makefiles for these formats should also include this file. +# +# About this file: +# This file was taken from scrollkeeper_example2, a package illustrating +# how to install documentation and OMF files for use with ScrollKeeper +# 0.3.x and 0.4.x. For more information, see: +# http://scrollkeeper.sourceforge.net/ +# Version: 0.1.2 (last updated: March 20, 2002) +# + +omf_dest_dir=$(datadir)/omf/@PACKAGE@ +scrollkeeper_localstate_dir = $(localstatedir)/scrollkeeper + +omf: omf_timestamp + +omf_timestamp: $(omffile) + -for file in $(omffile); do \ + scrollkeeper-preinstall $(docdir)/$(docname).xml $(srcdir)/$$file $(srcdir)/$$file.out; \ + done + touch omf_timestamp + +install-data-hook-omf: + $(mkinstalldirs) $(DESTDIR)$(omf_dest_dir) + for file in $(omffile); do \ + $(INSTALL_DATA) $(srcdir)/$$file.out $(DESTDIR)$(omf_dest_dir)/$$file; \ + done + -scrollkeeper-update -p $(scrollkeeper_localstate_dir) -o $(DESTDIR)$(omf_dest_dir) + +uninstall-local-omf: + -for file in $(srcdir)/*.omf; do \ + basefile=`basename $$file`; \ + rm -f $(omf_dest_dir)/$$basefile; \ + done + -rmdir $(omf_dest_dir) + -scrollkeeper-update -p $(scrollkeeper_localstate_dir) diff --git a/gramps2/doc/xmldocs.make b/gramps2/doc/xmldocs.make new file mode 100644 index 000000000..12b044567 --- /dev/null +++ b/gramps2/doc/xmldocs.make @@ -0,0 +1,95 @@ +# +# No modifications of this Makefile should be necessary. +# +# To use this template: +# 1) Define: figdir, docname, lang, omffile, and entities in +# your Makefile.am file for each document directory, +# although figdir, omffile, and entities may be empty +# 2) Make sure the Makefile in (1) also includes +# "include $(top_srcdir)/doc/xmldocs.make" and +# "dist-hook: app-dist-hook". +# 3) Optionally define 'entities' to hold xml entities which +# you would also like installed +# 4) Figures must go under $(figdir)/ and be in PNG format +# 5) You should only have one document per directory +# 6) Note that the figure directory, $(figdir)/, should not have its +# own Makefile since this Makefile installs those figures. +# +# example Makefile.am: +# figdir = figures +# docname = scrollkeeper-manual +# lang = C +# omffile=scrollkeeper-manual-C.omf +# entities = fdl.xml +# include $(top_srcdir)/help/xmldocs.make +# dist-hook: app-dist-hook +# +# About this file: +# This file was taken from scrollkeeper_example2, a package illustrating +# how to install documentation and OMF files for use with ScrollKeeper +# 0.3.x and 0.4.x. For more information, see: +# http://scrollkeeper.sourceforge.net/ +# Version: 0.1.2 (last updated: March 20, 2002) +# + + +# ************* Begin of section some packagers may need to modify ************** +# This variable (docdir) specifies where the documents should be installed. +# This default value should work for most packages. +docdir = $(datadir)/@PACKAGE@/doc/$(docname)/$(lang) + +# ************** You should not have to edit below this line ******************* +xml_files = $(entities) $(docname).xml +omf_dir=$(top_srcdir)/omf-install + +EXTRA_DIST = $(xml_files) $(omffile) +CLEANFILES = omf_timestamp + +include $(top_srcdir)/doc/omf.make + +all: omf + +$(docname).xml: $(entities) + -ourdir=`pwd`; \ + cd $(srcdir); \ + cp $(entities) $$ourdir + +app-dist-hook: + if test "$(figdir)"; then \ + $(mkinstalldirs) $(distdir)/$(figdir); \ + for file in $(srcdir)/$(figdir)/*.png; do \ + basefile=`echo $$file | sed -e 's,^.*/,,'`; \ + $(INSTALL_DATA) $$file $(distdir)/$(figdir)/$$basefile; \ + done \ + fi + +install-data-local: omf + $(mkinstalldirs) $(DESTDIR)$(docdir) + for file in $(xml_files); do \ + cp $(srcdir)/$$file $(DESTDIR)$(docdir); \ + done + if test "$(figdir)"; then \ + $(mkinstalldirs) $(DESTDIR)$(docdir)/$(figdir); \ + for file in $(srcdir)/$(figdir)/*.png; do \ + basefile=`echo $$file | sed -e 's,^.*/,,'`; \ + $(INSTALL_DATA) $$file $(DESTDIR)$(docdir)/$(figdir)/$$basefile; \ + done \ + fi + +install-data-hook: install-data-hook-omf + +uninstall-local: uninstall-local-doc uninstall-local-omf + +uninstall-local-doc: + -if test "$(figdir)"; then \ + for file in $(srcdir)/$(figdir)/*.png; do \ + basefile=`echo $$file | sed -e 's,^.*/,,'`; \ + rm -f $(docdir)/$(figdir)/$$basefile; \ + done; \ + rmdir $(DESTDIR)$(docdir)/$(figdir); \ + fi + -for file in $(xml_files); do \ + rm -f $(DESTDIR)$(docdir)/$$file; \ + done + -rmdir $(DESTDIR)$(docdir) + diff --git a/gramps2/gramps.spec.in b/gramps2/gramps.spec.in index df7385201..8e952601d 100644 --- a/gramps2/gramps.spec.in +++ b/gramps2/gramps.spec.in @@ -20,7 +20,7 @@ Requires: gnome-python2-canvas >= 1.99 Requires: pygtk2 >= 1.99 Requires: pygtk2-libglade >= 1.99 -BuildRequires: scrollkeeper >= 0.1.4 +BuildRequires: scrollkeeper >= @SCROLLKEEPER_BUILD_REQUIRED@ BuildRequires: automake >= 1.6 BuildRequires: autoconf >= 2.52 @@ -53,12 +53,11 @@ rm -rf $RPM_BUILD_ROOT %files %defattr(-, root, root) -%doc README COPYING TODO INSTALL +%doc README COPYING TODO INSTALL COPYING-DOCS %{prefix}/bin/gramps %{_datadir}/gnome/help/gramps-manual/C/* -%{_datadir}/gnome/help/extending-gramps/C/* %{_datadir}/gnome/apps/Applications/gramps.desktop %{_datadir}/pixmaps/gramps.png @@ -86,7 +85,15 @@ rm -rf $RPM_BUILD_ROOT %{prefix}/man/man1/gramps.1* %{_datadir}/omf/gramps + +%post +if which scrollkeeper-update>/dev/null 2>&1; then scrollkeeper-update -q -o %{_datadir}/omf/gramps; fi + +%postun +if which scrollkeeper-update>/dev/null 2>&1; then scrollkeeper-update -q; fi %changelog +* Mon Mar 24 2003 Alex Roitman +- update scrollkeeper dependencies and add post and postun to enable install on a machine without scrollkeeper * Fri Jun 14 2002 Donald Peterson - add scrollkeeper dependencies and some file cleanup