Gramps 4.2 Wiki Manual

From Gramps
Revision as of 09:22, 3 September 2015 by Sam888 (talk | contribs) (Table of Contents: add missing merge citations)
Jump to: navigation, search

This is the wiki manual for Gramps version 4.2. All users are encouraged to edit this manual to help improve its readability and usability.

Gnome-important.png Special copyright notice: All edits to this page need to be under two different copyright licenses:

These licenses allow the Gramps project to maximally use this wiki manual as free content in future Gramps versions. If you do not agree with this dual license, then do not edit this page. You may only link to other pages within the wiki which fall only under the GFDL license via external links (using the syntax: [https://www.gramps-project.org/...]), not via internal links.
Also, only use the known Typographical conventions


Previous Index Next


Gramps-notes.png This page's factual accuracy may be compromised due to out-of-date information. Please help improve the Gramps Wiki as a useful resource by updating it.

Abstract

The Gramps Manual details all aspects of the Gramps software application.

Table of Contents

Preface
Why use Gramps?
Typographical conventions

  1. What's new?
    1. Before you upgrade
    2. Visible changes to the core
      1. Data Model
      2. GUI
      3. Place
      4. Reports, Tools, Gramplets
    3. Under the hood changes
      1. Dependencies
    4. Further information
      1. Miscellaneous
      2. Localization
      3. Roadmap
      4. Changelog
  2. Getting started
    1. Overview
      1. Connections
      2. Privacy
      3. GEDCOM
      4. Summary
    2. Start Gramps
    3. Languages
      1. Linux
      2. MS Windows
      3. Mac OS X
    4. Choosing a Family Tree
    5. Tell me how to start right now!
    6. Obtaining Help
  3. Main Window
    1. Main Window
    2. Window Title Bar
      1. Menubar
      2. Toolbar
      3. Navigator
      4. Display area
      5. Status Bar and Progress Bar
      6. Bottombar and Sidebar
    3. Switching Navigator modes
    4. Switching Categories
    5. Switching Views
    6. Column Editor
      1. Sorting columns
    7. Filters
  4. Categories
    1. Categories of the Navigator
    2. Dashboard Category
    3. People Category
      1. Tree View - Grouped People
      2. Tree View - People List View
    4. Relationships Category
      1. Active Person
      2. Parents
        1. Siblings
      3. Family
        1. Children
      4. Configuration
    5. Families Category
    6. Charts Category
      1. Pedigree View
      2. Fan Chart View
      3. Descendant Fan View
    7. Events Category
    8. Places Category
      1. Place List View
      2. Place Tree View
      3. Map Service
    9. Geography Category
      1. The different views
        1. All known places for one person
          1. All known places for one person with graphical information (KML files)
        2. All known places for one family
        3. Have they been able to meet ?
        4. Have these two families been able to meet ?
        5. All displacements for one person and their descendants
        6. All places related to events
        7. All known places
      2. Usage
        1. The configuration
          1. All views
          2. Specific views
        2. How to zoom and move around the map ?
          1. Zoom in and Zoom out the map
          2. Move around the map
        3. The mouse actions on the map
          1. button 1 ( left button )
          2. button 2 ( middle button )
          3. button 3 ( right button )
          4. The mouse over a marker
        4. The menu popup
        5. Click on a marker
        6. Adding or Linking to a place
        7. Adding places from KML files
        8. How to change the map provider ?
        9. Can we change the marker's color ?
        10. How to get/remove the crosshair ?
        11. How to lock/unlock the map ?
      3. Prerequisites to see the geography view
      4. Possible problems
    10. Sources Category
      1. Citation Tree - View
      2. List View
    11. Citations Category
    12. Repositories Category
    13. Media Category
    14. Notes Category
  5. Manage Family Trees
    1. Starting a new Family Tree
    2. Opening a Family Tree
    3. Opening a GEDCOM or XML database
    4. Deleting a Family Tree
    5. Renaming a Family Tree
    6. Backing up a Family Tree
      1. Backup dialog
      2. Advanced settings
    7. Archiving a Family Tree
    8. Extracting a Family Tree Archive
    9. Unlocking a Family Tree
    10. Repairing a damaged Family Tree
    11. Saving changes to your Family Tree
    12. Importing data
      1. Import Family Tree dialog
      2. GRAMPS V2.x database import
      3. Gramps XML and XML Package import
      4. Gramps CSV import
      5. GEDCOM import
        1. HEADer, SUBMitter and SUBmissioN
        2. INDIvidual
        3. FAM_RECORD
        4. SOURCE_RECORD
        5. REPOSITORY_RECORD
        6. MULTIMEDIA_RECORD
        7. NOTE_RECORD
    13. Exporting data
      1. Export Assistant dialog
      2. Filters and privacy
      3. Export into Gramps formats
      4. Exporting into the GEDCOM format
      5. Export into other formats
    14. Moving a Gramps 2.2 databases to Gramps 3.x
  6. CSV Import and Export
    1. Gramps Spreadsheet Import/Export
    2. Export
    3. Import
      1. People
      2. Marriage
      3. Family
      4. Place
    4. Details
      1. Example CSV with multiple areas
      2. Real world example
  7. Probably Alive
    1. How does Gramps know if someone is alive?
    2. Probably Alive Proxy
    3. Age On Date Gramplet
    4. Calendar Gramplet
    5. Probably Alive Filter
    6. Calculated Estimated Dates Tool
  8. Entering and editing data: brief
    1. To add or edit a person
    2. To specify a relationship
      1. Specifying a relationship using the Relationship View
      2. Specifying a relationship using the Family List View
    3. To specify parents
    4. To specify children
    5. Adding photos and other media objects
    6. To edit events, sources, places, and repositories
  9. Entering and editing data: detailed
    1. Entering and editing data: detailed - part 1
      1. Editing information about people
        1. Edit Person dialog
        2. Preferred name section
        3. General section
        4. Preferred image
        5. Edit Person tab pages
          1. Events
          2. Names
          3. Source Citations
          4. Attributes
          5. Addresses
          6. Notes
          7. Gallery
          8. Internet
          9. Associations
          10. LDS
          11. References
      2. Editing information about relationships
        1. Family Editor dialog
        2. Family Editor tab pages
          1. Children
          2. Events
          3. Source Citations
          4. Attributes
          5. Notes
          6. Gallery
          7. LDS
      3. Editing dates
        1. Date selection dialog
        2. Date validity indicators
        3. Date Quality
        4. Date formats and parsing rules
        5. Calendars
          1. Swedish calendar
        6. Dual-dated dates
          1. Alternate new year day
    2. Entering and editing data: detailed - part 2
      1. Editing information about events
        1. New Event dialog
        2. New Event tab pages
          1. Source Citations
          2. Notes
          3. Gallery
          4. Attributes
          5. References
      2. Editing event references
        1. Event Reference Editor dialog
          1. Reference Information
            1. Reference Information tab pages
              1. General
              2. Notes
              3. Attributes
          2. Shared Information
      3. Editing information about media objects
        1. New Media dialog
        2. New Media tab pages
          1. Source Citations
          2. Attributes
          3. Notes
          4. References
      4. Editing media object references
        1. Select a media object selector
        2. Media Reference Editor dialog
          1. Top section
            1. Top section tab pages
              1. General
              2. Source Citations
              3. Attributes
              4. Notes
          2. Shared Information
            1. Shared Information tab pages
              1. General
              2. References
              3. Source Citations
              4. Attributes
              5. Notes
      5. Editing information about places
        1. Place Editor dialog
        2. Place editor tab pages
          1. Enclosed By
          2. Alternative Names
          3. Source Citations
          4. Notes
          5. Gallery
          6. Internet
          7. References
        3. Supported longitude/latitude formats
      6. Editing information about sources
        1. New Source dialog
        2. New Source tab pages
          1. Notes
          2. Gallery
          3. Attributes
          4. Repositories
          5. References
      7. Editing source citations
        1. Select Source or Citation selector
        2. New Citation dialog
          1. Citation information
            1. Citation information section tab pages
          2. Shared source information
      8. Editing information about repositories
        1. New Repositories dialog
        2. New Repositories tab pages
          1. Addresses
          2. Internet]
          3. Notes
          4. References
      9. Editing information about notes
        1. Note tab
        2. Note editor
          1. References tab
          2. References tab
        3. Note markup and preformat in reports
    3. Entering and editing data: detailed - part 3
      1. Name Editor
        1. Name Editor dialog
          1. Type
          2. Given Name(s) Section
          3. Family Names Section
        2. Name Editor tab pages
          1. General
          2. Source Citations
          3. Notes
      2. Attributes
        1. Attribute Editor dialog
        2. Attribute Editor tab pages
          1. Source Citations
          2. Notes
      3. Addresses
        1. Address Editor dialog
        2. Address Editor tab pages
          1. Source Citations
          2. Notes
      4. Merging records
        1. Merge People
        2. Merge Families
        3. Merge Events
        4. Merge Sources
        5. Merge Citations
        6. Merge Places
        7. Merge Media Objects
        8. Merge Repositories
        9. Merge Notes
  10. Navigation
    1. Using the People Category
    2. Using the Relationships Category
    3. Using the Families Category
    4. Using the Charts Category
    5. Using Gramplets
    6. Setting the Home Person
    7. Using history-based tools
    8. Bookmarks
    9. Finding records
    10. Using the Clipboard
    11. Main Menus
      1. Family Trees
      2. Edit
      3. View
      4. Go
      5. Bookmarks
      6. Reports
      7. Tools
      8. Windows
      9. Help
  11. Plugin Manager
    1. Plugin types
    2. Registration and loading
    3. Hide/Unhide
    4. Actions
      1. Registered Plugins
      2. Loaded Plugins
      3. Install Addons
  12. Gramplets
    1. What is a Gramplet
      1. General Usage and Configuration
      2. Summary of Gramplets
    2. Gramplets
      1. Age on Date
      2. Age Stats
      3. Ancestors
      4. Attributes
      5. Calendar
      6. Children
      7. Citations
      8. Descendant Fan
      9. Descendants
      10. Details
      11. Events
      12. Fan Chart
      13. FAQ
      14. Filter
      15. Gallery
      16. Given Name Cloud
      17. Image Metadata
        1. The interface
          1. Data Fields
          2. Buttons
        2. Prerequisites
        3. Usage scenario
      18. Locations
      19. Notes
      20. Pedigree
      21. Preview
      22. Quick View
      23. Records
      24. References
      25. Relatives
      26. Residence
      27. Session Log
      28. SoundEx
        1. Soundex what is this?
      29. Statistics
      30. Surname Cloud
      31. To Do
      32. Top Surnames
      33. Welcome
      34. What's Next
  13. Reports - Index and Summary.
    1. Generating Reports
      1. Report Settings
      2. Report Format Style
    2. Substitution Values
      1. The Substitution Keys
        1. Other Substitution Keys
        2. Default displayed formats
        3. Deprecated variables
      2. Format Strings
        1. Formatting names
        2. Formatting Dates
        3. Formatting Places
        4. Rules for format strings
      3. Control Variables
      4. Grouping
        1. Rules for groups
        2. Examples
      5. Attributes
      6. Events
        1. Event format strings
        2. Notes for attributes and events
      7. Separators
    3. Books
      1. Book main dialog
        1. Book name
          1. Book name toolbar
        2. Available items
        3. Available items selections
          1. Alphabetical Index
          2. Custom Text
          3. Table of contents
          4. Title Page
        4. Current book
          1. Current book toolbar
      2. Book second dialog
        1. Paper Options
        2. Document Options
    4. Graphical Reports
      1. Common options
        1. Paper Options
        2. Document Options
      2. Ancestor Tree
        1. Tree Options
        2. Display
        3. Size
        4. Include
      3. Calendar
        1. Report Options
        2. Content Options
        3. Text Options
      4. Descendant Tree
        1. Tree Options
        2. Display
        3. Replace
        4. Size
        5. Include
      5. Family Descendant Tree
        1. Tree Options
        2. Display
        3. Replace
        4. Size
        5. Include
      6. Fan Chart
        1. Report Options
      7. Statistics Chart
        1. Report Options
        2. Charts 1
        3. Charts 2
      8. Timeline Chart
        1. Report Options
      9. Scale and Resize options
        1. Scale tree to fit:
        2. Resize Page to Fit Tree size
        3. inter-box Y scale factor
        4. box shadow scale factor
        5. Know what you want to print on
    5. Graphs
      1. Common Options
        1. Graphviz Layout
        2. Graphviz Options
        3. Note
      2. Family Lines Graph
        1. People of Interest
        2. Family Colours
        3. Individuals
        4. Include
      3. Hourglass Graph
        1. Report Options
        2. Graph Style
      4. Relationship Graph
        1. Report Options
        2. Include
        3. Graph Style
        4. Example
    6. Text Reports
      1. Common options
        1. Paper Options
        2. Document Options
      2. Ahnentafel Report
        1. Report Options
      3. Birthday and Anniversary Report
        1. Report Options
        2. Text Options
      4. Complete Individual Report
        1. Report Options
        2. Include
        3. Sections
      5. Database Summary Report
        1. Report Options
      6. Descendant Report
        1. Report Options
      7. Detailed Ancestral Report
        1. Report Options
        2. Content
        3. Include
        4. Missing information
      8. Detailed Descendant Report
        1. Report Options
        2. Content
        3. Include
        4. Missing information
      9. End of Line Report
        1. Report Options
      10. Family Group Report
        1. Report Options
        2. Include
        3. Missing information
      11. Kinship Report
        1. Report Options
      12. Note Link Report
      13. Number of Ancestors
        1. Report Options
      14. Place Report
        1. Report Options
      15. Records Report
        1. Report Options
        2. Person Records
        3. Family Records
      16. Tag Report
        1. Report Options
    7. Web Pages
      1. Narrated Web Site
        1. Dialog tabs
          1. Report Options
          2. Page Generation
          3. Privacy
          4. Download
          5. Advanced Options
          6. Place Map Options
        2. Example Web Site output
          1. Home
          2. Introduction
          3. Individuals
          4. Surnames
          5. Families
          6. Events
          7. Places
          8. Sources
          9. Repositories
          10. Media
          11. Thumbnails
          12. Download
          13. Address Book
          14. Contact
      2. Web Calendar
        1. Dialog tabs
          1. Report Options
          2. Content Options
          3. Jan - Jun Notes
          4. Jul - Dec Notes
          5. Advanced Options
        2. Example Web Site output
    8. Quick Views
      1. Making your own Quick view
  14. Tools
    1. Analysis and Exploration
      1. Compare Individual Events
    2. Family Tree Processing
      1. Database Owner Information
      2. Extract Event Description
      3. Extract Information from Names
      4. Extract Place Data from a Place Title
      5. Find Possible Duplicate People...
      6. Fix Capitalization of Family Names...
      7. Merge citations...
      8. Rename Event Types
      9. Reorder Gramps ID
      10. Sort Events
    3. Family Tree Repair
      1. Check and Repair Database
      2. Rebuild Gender Statistics
      3. Rebuild Reference Maps
      4. Rebuild Secondary Indices
      5. Remove Unused Objects...
    4. Utilities
      1. Media Manager...
      2. Not Related
      3. Relationship Calculator
      4. Verify the Data
        1. Verify the Data tab pages
          1. General
          2. Women
          3. Men
          4. Families
        2. Data Verification Results window
        3. Examples
  15. Settings
    1. Preferences
      1. General
      2. Family Tree
      3. Display
      4. Places
      5. Text
      6. ID Formats
      7. Dates
      8. Researcher
      9. Warnings
      10. Colors
    2. Other settings
      1. Column Editor
      2. Setting Home person
      3. Adjusting viewing controls
      4. Export View...
      5. Modularity and plugins
      6. Style editor
    3. Customizing
      1. Preferences
      2. Language
      3. Advanced manipulation of settings
  16. Filters
    1. Filter vs. Search
    2. Regular Expressions
      1. Groups and Sets
      2. Examples
        1. Common variations of a surname
        2. testing regular expressions
    3. Custom Filter Editor
    4. Which filters in which Category?
    5. Ancestral filters
    6. Child filters
    7. Citation/sources filters
      1. Persons-, and Relationship Category
      2. Families Category
      3. Events Category
      4. Places Category
      5. Media Category
    8. Descendant filters
    9. Event filters
      1. Persons-, and Relationship Category
      2. Families Category
    10. Family filters
    11. Father filters
    12. General filters
      1. Persons-, and Relationship Category
      2. Families Category
      3. Events Category
      4. Places Category
      5. Sources Category
      6. Citations Category
      7. Repositories Category
      8. Media Category
      9. Notes Category
    13. Mother filters
    14. Position filters
    15. Source filters
    16. Relationship filters
    17. Tagging
      1. Concept
      2. Differences with markers
      3. Tags and Filters
      4. Operations with tags
        1. Filtering
        2. Tagging a selection of objects
      5. Tags Column

Appendix A: Frequently Asked Questions
Appendix B: Keybindings reference
List Views
Common bindings
All List Views bindings
People View bindings
Editor Tab bindings
Handy Shortcuts
Appendix C: Command line reference
Available options
Format options
Opening options
Import options
Export options
Action options
List options
Operation
Examples
Environment variables
GRAMPSHOME
LANG
GRAMPSI18N
GRAMPSDIR
Appendix D: User Directory
Appendix E: Error and Warning Reference
When something goes wrong
Alerts
Warnings
Errors
Appendix F: About Gramps
Previous Index Next