Gramps - User contributions [en]

Gramps 5.1 Wiki Manual - Command Line

2020-12-24T05:16:44Z

Eponymous: /* Mac OS X */ terminology and detail

{{man index|Gramps 5.1 Wiki Manual - Keybindings|Gramps 5.1 Wiki Manual - User Directory|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Command_Line}}
{{#vardefine:chapter|C}}
{{#vardefine:figure|0}}
This appendix provides the reference to the command line capabilities available when launching Gramps from the terminal.

== Start Gramps through the Command Line ==

Normally Gramps is started through the graphical user interface (GUI) on [[Gramps_5.1_Wiki_Manual_-_Getting_started#Start_Gramps|your platform]].

It is also possible to start Gramps using a command line interface (CLI). CLI use can
* produce reports that are not available via the GUI,
* create reports, do conversions etc. without opening a window and
* can provide [[Gramps_5.1_Wiki_Manual_-_Main_Window#Seeing_all_the_error_messages|extra information]] in the event of problems.

This section of the user manual describes how to start Gramps through the CLI, and the features that are available.

The way you start Gramps through the CLI depends on the operating system you are using.

For simplicity of description, the examples of use below are written from the point of view of running Gramps on Linux. The examples would need to be changed for other platforms.

=== Linux ===

Only the Linux platform is officially supported as Gramps developers use and test the source code on that platform, fixing any problems that arise due to upgrades.

Assuming you have used the standard Package Manager (either through a CLI or a GUI) for your Linux distribution, you start Gramps through the CLI by typing
gramps

=== MS Windows ===

{{stub}}
{{man warn|Outdated need to add info for new AIO installer CLI usage|See example usage https://github.com/gramps-project/addons-source/pull/121}}

MS Windows is a [[Download|community supported]] platform. If you install the [[All_In_One_Gramps_Software_Bundle_for_Windows|Windows AIO]] GrampsAIO32 or GrampsAIO64 executable, then this will place an icon on the desktop as well as a menu iten in the 'Start' menu.

What is the best way of knowing what command to type?

Starting Gramps from the command line (cmd.exe) depends on where you have chosen to install Gramps.
* Right click on the ??terminal Gramps application, or the corresponding item in the Start menu.
* Note down the starting directory.
* Select the whole of the command and copy (ctrl-C) it.
* From the Start menu, start cmd.exe.
* Change directory to the starting directory you noted down.
* Right click and select Paste.
* Press {{man key press|Enter}}.

For example, this might be:
cd "\Program Files\GrampsAIO64"
gramps

When the instructions below tell you to type something after the start command, you just type this after the last line, for example:
cd "\Program Files\GrampsAIO64"
gramps -L

There are other ways to install Gramps for MS Windows, but these are much more complicated and are not covered here.

=== MacOS ===

MacOS is a [[Download|community supported]] platform. If you download the MacOS disk image (.dmg), then you simply drag the application to your application folder (or anywhere else you want to store it) and start Gramps by double clicking on the application in the normal way. The Homebrew package manager[https://github.com/Homebrew] also allows for installation of the application in the usual Applications folder.

To run from the command line, you'll need to start Terminal, found in the Utilities folder of the main Applications folder (/Applications/Utilities). Once you have a terminal window open, at the prompt type
/path/to/Gramps.app/Contents/MacOS/Gramps
If you installed Gramps in Applications along with most of your other apps, as suggested above, that would be
/Applications/Gramps.app/Contents/MacOS/Gramps
You may use any of the command-line options along with this. For example, to get a detailed listing of all of the Family Tree databases in your default Family Tree folder, you would use
/Applications/Gramps.app/Content/MacOS/Gramps -L

There are other ways to install Gramps for MacOS, but these are much more complicated and are not covered here.

== Python options ==

In the examples of different platforms above, and also in commands in various files you may see some options after the 'python' command, for example '-EO' in
"python3 -EO ..\share\gramps\gramps.py -L

It is important to distinguish between the '''python options''' in this case:
-EO
and the '''Gramps options''', in this case
-L

The '''python options''' that you may come across are:
* <code>-E</code> Ignore all PYTHON* environment variables, e.g. <code>PYTHONPATH</code> and <code>PYTHONHOME</code>, that might be set.
* <code>-O</code> Turn on basic optimizations. This changes the filename extension for compiled (bytecode) files from <code>.pyc</code> to <code>.pyo</code>. See also PYTHONOPTIMIZE.

The <code>-O</code> optimise flag has a number of effects in Gramps:
* If it is not turned on, an additional {{man menu|[[Gramps_5.1_Wiki_Manual_-_Tools#Debug|Debug]]}} entry appears in the {{man menu|[[Gramps_5.1_Wiki_Manual_-_Tools|Tools]]}} menu.
* If it is not turned on, [[Logging_system#So_how_logging_works_in_Gramps_after_all.3F|info logging messages are output]].
* If it is not turned on, [[Debugging_Gramps#Add_debug_statements|debug statements]] may be activated.
* If it is not turned on, additional features are available in the [[Gramps_5.1_Wiki_Manual_-_Plugin_Manager|Plugin Manager]].

The '''Gramps options''' are described below.

== Available Gramps options ==

This section provides the reference list of all command line options available in Gramps. If you want to know more than just a list of options, see next sections: [[#Operation|Operation]] and [[#Examples| Examples]]. The summary below is printed by
gramps -h
or
gramps --help

<pre>
Usage: gramps.py [OPTION...]
--load-modules=MODULE1,MODULE2,... Dynamic modules to load

Help options
-?, --help Show this help message
--usage Display brief usage message

Application options
-O, --open=FAMILY_TREE Open Family Tree
-U, --username=USERNAME Database username
-P, --password=PASSWORD Database password
-C, --create=FAMILY_TREE Create on open if new Family Tree
-i, --import=FILENAME Import file
-e, --export=FILENAME Export file
-r, --remove=FAMILY_TREE_PATTERN Remove matching Family Tree(s) (use regular expressions)
-f, --format=FORMAT Specify Family Tree format
-a, --action=ACTION Specify action
-p, --options=OPTIONS_STRING Specify options
-d, --debug=LOGGER_NAME Enable debug logs
-l [FAMILY_TREE_PATTERN...] List Family Trees
-L [FAMILY_TREE_PATTERN...] List Family Trees in Detail
-t [FAMILY_TREE_PATTERN...] List Family Trees, tab delimited
-u, --force-unlock Force unlock of Family Tree
-s, --show Show config settings
-c, --config=[config.setting[:value]] Set config setting(s) and start Gramps
-y, --yes Don't ask to confirm dangerous actions (non-GUI mode only)
-q, --quiet Suppress progress indication output (non-GUI mode only)
-v, --version Show versions
-S, --safe Start Gramps in 'Safe mode'
(temporarily use default settings)
-D, --default=[APXFE] Reset settings to default;
A - addons are cleared
P - Preferences to default
X - Books are cleared, reports and tool settings to default
F - filters are cleared
E - Everything is set to default or cleared
</pre>

The usage message is as follows:

gramps --usage

<pre>
Example of usage of Gramps command line interface

1. To import four databases (whose formats can be determined from their names)
and then check the resulting database for errors, one may type:
gramps -i file1.ged -i file2.gpkg -i ~/db3.gramps -i file4.wft -a tool -p name=check.

2. To explicitly specify the formats in the above example, append filenames with appropriate -f options:
gramps -i file1.ged -f gedcom -i file2.gpkg -f gramps-pkg -i ~/db3.gramps -f gramps-xml -i file4.wft -f wft -a tool -p name=check.

3. To record the database resulting from all imports, supply -e flag
(use -f if the filename does not allow Gramps to guess the format):
gramps -i file1.ged -i file2.gpkg -e ~/new-package -f gramps-pkg

4. To save any error messages of the above example into files outfile and errfile, run:
gramps -i file1.ged -i file2.dpkg -e ~/new-package -f gramps-pkg >outfile 2>errfile

5. To import three databases and start interactive Gramps session with the result:
gramps -i file1.ged -i file2.gpkg -i ~/db3.gramps

6. To open a database and, based on that data, generate timeline report in PDF format
putting the output into the my_timeline.pdf file:
gramps -O 'Family Tree 1' -a report -p name=timeline,off=pdf,of=my_timeline.pdf

7. To generate a summary of a database:
gramps -O 'Family Tree 1' -a report -p name=summary

8. Listing report options
Use the name=timeline,show=all to find out about all available options for the timeline report.
To find out details of a particular option, use show=option_name , e.g. name=timeline,show=off string.
To learn about available report names, use name=show string.

9. To convert a Family Tree on the fly to a .gramps xml file:
gramps -O 'Family Tree 1' -e output.gramps -f gramps-xml

10. To generate a web site into an other locale (in german):
LANGUAGE=de_DE; LANG=de_DE.UTF-8 gramps -O 'Family Tree 1' -a report -p name=navwebpage,target=/../de

11. Finally, to start normal interactive session type:
gramps

Note: These examples are for bash shell.
Syntax may be different for other shells and for Windows.

</pre>

=== List options ===
Print a list of known family trees:

;Sparse
-l, List Family Trees

gramps -l

<pre>
List of known Family Trees in your database path

/home/<~username>/.gramps/grampsdb/5a46c1c3 with name "Example Family Tree"
</pre>
{{-}}

;Detailed
-L, List Family Trees in Detail

gramps -L

<pre>
Gramps Family Trees:
Family Tree "Example Family Tree":
Database: SQLite
Database module location: /usr/lib/python3.5/sqlite3/__init__.py
Database module version: 2.6.0
Database version: 3.11.0
Last accessed: 30/12/17 09:29:37
Locked?: False
Number of citations: 2854
Number of events: 3432
Number of families: 762
Number of media: 7
Number of notes: 19
Number of people: 2157
Number of places: 1294
Number of repositories: 3
Number of sources: 4
Number of tags: 2
Path: /home/<~username>/.gramps/grampsdb/5a46c1c3
Schema version: 18.0.0
</pre>

{{man note|Note that dates are shown in the default LOCALE format.|You change that at the system level. For example, on [[Gramps_Glossary#posix|POSIX]]-based systems you could use: <pre>LC_TIME=en_AU.UTF-8 gramps -L</pre>}}
{{-}}

=== Version options ===

-v or --version prints version of Gramps and dependencies,
information about environment settings and python and system paths

gramps -v

<pre>
Gramps Settings:
----------------
python : 3.7.5
gramps : 5.1.1
gtk++ : 3.24.12
pygobject : 3.34.0
pango : 1.42.3
cairo : 1.16.0
pycairo : 1.16.2
osmgpsmap : 1.0
GExiv2 : 0.10
ICU : 63.1
PyICU : 2.2
o.s. : linux
kernel : 5.3.0-24-generic

Environment settings:
---------------------
LANG : en_GB.UTF-8
LANGUAGE : en_GB:en
GRAMPSI18N: not set
GRAMPSHOME: not set
GRAMPSDIR : not set
PYTHONPATH:
/usr/lib/python3/dist-packages/gramps
/usr/bin
/usr/lib/python37.zip
/usr/lib/python3.7
/usr/lib/python3.7/lib-dynload
/usr/local/lib/python3.7/dist-packages
/usr/lib/python3/dist-packages

Non-python dependencies:
------------------------
Graphviz : 2.40
Ghostscr. : 9.27

System PATH env variable:
-------------------------
/usr/local/sbin
/usr/local/bin
/usr/sbin
/usr/bin
/sbin
/bin
/usr/games
/usr/local/games
/snap/bin

Databases:
-------------------------
bsddb :
version : 6.2.6
db version : 5.3.28
location : /usr/lib/python3/dist-packages/bsddb3/__init__.py
sqlite3 :
version : 3.29.0
py version : 2.6.0
location : /usr/lib/python3.7/sqlite3/__init__.py
</pre>

{{-}}

=== Format options ===

The format of any file destined for opening, importing, or exporting can be specified with the <pre>-f format</pre> option. The acceptable <tt>''format''</tt> values are listed below.

==== Full family tree support ====
These formats contain all your data that is present in a family tree.

* '''gramps''' - Gramps XML format: This format is available for import, and export. When not specified, it can be guessed if the filename ends with .gramps
* '''gpkg''' - Gramps package XML format: This format is available for import and export. When not specified, it can be guessed if the filename ends with .gpkg. This creates a zip package with your data as xml, and all your media files included
* '''grdb''' - pre Gramps 3.x database: This format is available for import to support the old file format of Gramps. Everything in the grdb file is imported. When not specified, it can be guessed if the filename ends with .grdb
* '''burn''' - GNOME iso burning: export, only available on GNOME where burn protocol exists

==== Reduced family tree support ====
These formats contain most, but not all data that can be created in Gramps

*'''ged''' - GEDCOM format: This format is available for import, and export. When not specified, it can be guessed if the filename ends with .ged
*'''gw''' - GeneWeb file: This format is available for import and export. When not specified, it can be guessed if the filename ends with .gw

==== Subset of your data ====
These formats contain a specific subset of your data

* '''csv''' - Comma Separated Value: This format is available for import and export. Be careful however, import must be as values created by the export function. Only a part of your data is contained in the output.
* '''vcf''' - VCard format: import and export
* '''vcs''' - VCalandar format: export
* '''def''' - old Pro-Gen format: import
* '''wft''' - Web Family Tree: This format is available for export only. When not specified, it can be guessed if the filename ends with .wft

=== Opening options ===

You can open a family tree, or you can ''open'' a file by importing it in an empty family tree.

To let Gramps handle this automatically, just supply the familytree or filename you want to open:

python gramps.py 'My Fam Tree'
python gramps.py JohnDoe.ged

The first opens a family tree, the second imports a GEDCOM into an empty family tree.

Additionally, you can pass Gramps the name of the family tree to be opened:

* use this option : <code>-O famtree</code> or <code>--open=famtree</code>

<code>-O</code>, Open of a family tree. This can be done also by just typing the name (name or database dir)

Examples:
python gramps.py 'Family Tree 1'
python gramps.py /home/cristina/.gramps/grampsdb/47320f3d
python gramps.py -O 'Family Tree 1'
python gramps.py -O /home/cristina/.gramps/grampsdb/47320f3d

{{Man tip| Tip |If no option is given, just a name, Gramps will ignore the rest of the command line arguments. Use the <code>-O</code> flag to open, <code>-i</code> to import, and do something with the data.}}

{{Man tip| Tip |Only family trees can be opened directly. For other formats, you will need to use the import option which will set up the empty database and then import data into it.}}

{{Man tip| Tip |Only a single family tree can be opened. If you need to combine data from several sources, you will need to use the import option.}}

=== Import options ===

The files destined for import can be specified with the <code>-i filename</code> or <code>--import=filename</code> option. The format can be specified with the <code>-f format</code> or <code>--format=format</code> option, immediately following the ''filename'' . If not specified, the guess will be attempted based on the ''filename''.

Example:
python gramps.py -i 'Family Tree 1' -i 'Family Tree 2'
python gramps.py -i test.grdb -i data.gramps

{{man tip | Tip |More than one file can be imported in one command. If this is the case, Gramps will incorporate the data from the next file into the database available at the moment.}}

When more than one input file is given, each has to be preceded by <code>-i</code> flag. The files are imported in the specified order, i.e. <code> -i file1 -i file2 </code> and <code> -i file2 -i file1 </code> might produce different Gramps IDs in the resulting database.

=== Export options ===

The files destined for export can be specified with the <code>-e filename</code> or <code>--export=filename</code> option. The format can be specified with the <code>-f</code> option immediately following the ''filename'' . If not specified, the guess will be attempted based on the ''filename'' . For iso format, the ''filename'' is actually the name of directory the Gramps database will be written into. For gramps-xml, gpkg, gedcom, wft, geneweb, and gramps-pkg, the ''filename'' is the name of the resulting file.

-e, export a family tree in required format. It is not possible to export to a family tree.

Example:
python gramps.py -i 'Family Tree 1' -i test.grdb -f grdb -e mergedDB.gramps
Note that above does not change 'Family Tree 1' as everything happens via a temporary database, whereas:
python gramps.py -O 'Family Tree 1' -i test.grdb -f grdb -e mergedDB.gramps
will import test.grdb into Family Tree 1, and then export to a file !

{{man tip| Exporting more files |More than one file can be exported in one command. If this is the case, Gramps will attempt to write several files using the data from the database available at the moment.}}

When more than one output file is given, each has to be preceded by <code>-e</code> flag. The files are written one by one, in the specified order.

=== Action options ===

The action to perform on the imported data can be specified with the <code>-a action</code> or <code>--action=action</code> option. This is done after all imports are successfully completed.

The following actions remain the same:

*''report'': This action allows producing reports from the command line.

*''tool'': This action allows to run a tool from the command line.

Reports and tools generally have many options of their own, so these actions should be followed by the report/tool option string. The string is given using the <code>-p option_string</code> or <code>--options=option_string</code> option.

The actions available in older versions of Gramps which were relocated in Gramps 3.3 are:

*''summary'': This action was the same as {{man menu|Reports ->View ->Summary}}. In Gramps 3.3 it was replaced by (or renamed to) '''-a report -p name=summary'''.

*''check'': This action was the same as {{man menu|Tools ->Database Processing ->Check and Repair}}. In Gramps 3.3 it was replaced by (or renamed to) '''-a tool -p name=check'''.

==== report action option ====
You can generate most reports from the command line using the report action.

An example:
gramps -O "Family Tree 1" -a report -p "name=family_group,style=default,off=html,of=test.html"

You can provide the css style to use here with the css option:
gramps -O "Family Tree 1" -a report -p "name=family_group,style=default,off=html,of=test.html,css=Web_Nebraska.css"
or without css in the html output:
gramps -O "Family Tree 1" -a report -p "name=family_group,style=default,off=html,of=test.html,css="

{{man tip| Report option string |The report option string should satisfy the following conditions: It must not contain any spaces (due to the general nature of the command line interface). If some arguments need to include spaces, the string should be enclosed with quotation marks. Option string must list pairs of option names and values. Within a pair, option name and value must be separated by the equal sign. Different pairs must be separated by commas.}}

Most of the report options are specific for every report. However, there are some common options.

*<code>name=report_name</code>: This mandatory option determines which report will be generated.
{{man note|Report names|If the supplied report_name does not correspond to any available report, an error message will be printed followed by this list of available reports. 
<pre>
Available names are:
ancestor_chart - Ancestor Tree
ancestor_report - Ahnentafel Report
birthday_report - Birthday and Anniversary Report
calendar - Calendar
descend_chart - Descendant Tree
descend_report - Descendant Report
det_ancestor_report - Detailed Ancestral Report
det_descendant_report - Detailed Descendant Report
endofline_report - End of Line Report
family_descend_chart - Family Descendant Tree
family_group - Family Group Report
familylines_graph - Family Lines Graph
fan_chart - Fan Chart
hourglass_graph - Hourglass Graph
indiv_complete - Complete Individual Report
kinship_report - Kinship Report
navwebpage - Narrated Web Site
notelinkreport - Note Link Report
number_of_ancestors - Number of Ancestors Report
place_report - Place Report
records - Records Report
rel_graph - Relationship Graph
statistics_chart - Statistics Charts
summary - Database Summary Report
tag_report - Tag Report
timeline - Timeline Chart
WebCal - Web Calendar
</pre>}}
*<code>of=</code>: output filename and optional destination folder/directory eg: <code>of="C:\Users\<username>\Desktop\FamilyTree.odt"</code>
*<code>off=</code>: output format. These are the extension an output format makes available, eg, pdf, html, doc, ...
*<code>style=</code>: for text reports, the stylesheet to use. Defaults to 'default'.
*<code>show=all</code>: This will produce the list of names for all options available for a given report.
*<code>show=option_name</code>: This will print the description of the functionality supplied by the option_name, as well as what are the acceptable types and values for this option.

So, to learn to use a report, do for example:
gramps -O "Family Tree 1" -a report -p "name=family_group,show=all"

{{man tip| Tip |If an option is not supplied, the last used value will be used. If this report has never been generated before, then the value from last generated report will be used when applicable. Otherwise, the default value will be used.}}

When more than one output action is given, each has to be preceded by <code>-a</code> flag. The actions are performed one by one, in the specified order.

{{man tip| lists |Some reports have options or arguments which are interpreted (by the report) to be on multiple lines. For instance some reports allow you to format how the information will be shown, perhaps with a name on one line and the person's birth date on the next line. Such multiple-line options or arguments are called "lists" by Gramps.}}

On the command line such lists must always start with a left square bracket <code>[</code> and must always end with a right square bracket <code>]</code> but since such square brackets are usually "special" to the "shell" (they mean something to the command interpreter
you are typing the command to), you must "escape" them so that they are ignored by your shell.

The details vary with each shell but (in linux/UNIX) usually you can precede such a square bracket with a backslash <code>\</code> or put quotation marks around the square bracket, usually either "single" or "double" ones.

The Hourglass Graph report allows you to put a "note" at the top of the report and such a "note" is an example of a "list" option. Here is an example:
gramps -O "Family Tree 1" -a report -p name=hourglass_graph,note='[line one,line two]'
which shows that inside such a list different lines are separated by commas, and that spaces are acceptable since the quotation marks are already there for the square brackets.

But if you want to have a comma inside your report you have to somehow tell Gramps that comma is not one which separates lines. You do that by enclosing the line with the comma in quotation marks (either single or double).

But if you are already using a set of quotation marks (to enclose your square brackets) you have to use the other type to enclose
the line with your comma. Here is an example:
gramps -O "Family Tree 1" -a report -p name=hourglass_graph,note="['line one, also line one','line two, also line two']"

It is possible to include any character in a list but the details are beyond the scope of this command-line introduction to Gramps.

You will need to know the precise methods available in your particular command shell interpreter to include a character which is "special" to your shell or "special" to Gramps (like the comma in the example above) but in general you will have to "escape" it twice, once to your shell and once again to Gramps, since you don't want your shell to think it is some instruction it should pay attention to and you don't want Gramps to think that either.

==== tool action option ====
You can run most tools from the command line using the 'tool' action.
To see which ones, say:
gramps -O "Family Tree 1" -a tool -p show=all
To see a tool's available options, for instance the "verify" tool:
gramps -O "Family Tree 1" -a tool -p name=verify,show=all
To run a tool, for instance the "verify" tool:
gramps -O "Family Tree 1" -a tool -p name=verify

{{man note|Tool names|If the supplied tool_name does not correspond to any available tool, an error message will be printed followed by this list of available tools. 
<pre>
Available names are:
check - Check and Repair Database
chtype - Rename Event Types
dgenstats - Dump Gender Statistics
evname - Extract Event Description
rebuild - Rebuild Secondary Indexes
rebuild_genstats - Rebuild Gender Statistics
rebuild_refmap - Rebuild Reference Maps
reorder_ids - Reorder Gramps IDs
test_for_date_parser_and_displayer - Check Localized Date Displayer and Parser
testcasegenerator - Generate Testcases for Persons and Families
verify - Verify the Data
</pre>}}

==== book action option ====
{{man note|New feature|Added in Gramps 5.0}}
You can run books from the command line using the 'book' action.
To see which ones, say:
gramps -O "Family Tree 1" -a book
To see a book's available options, for instance a book called "mybook":
gramps -O "Family Tree 1" -a book -p name=mybook,show=all
To run a book, for instance a book called "mybook":
gramps -O "Family Tree 1" -a book -p name=mybook

{{man note|Book names|If the supplied book_name does not correspond to any available Book, an error message will be printed followed by this list of available Books. eg: Example listing only as the Books will be whatever you have named them. 
<pre>
Available names are:
Granny Jones
Grampa John
Smith Family History
</pre>}}

=== Force unlock option ===

*<code>-u</code>: you can extend the <code>-O</code> flag with <code>-u</code> to force a locked family to be unlocked. This allows you to recover from a crash that leaves the family tree (database) locked, from the command line.

An example (to unlock the "Family Tree 1" database):
:<code>gramps -O "Family Tree 1" -a report -u > /dev/null</code>

{{man note|Note|It is not possible to open family trees that need repair from the command line.}}

See also:
* [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Unlocking_a_Family_Tree|Manage Family Trees:Unlocking a Family Tree]]

=== Configuration (config) option ===
When all configuration variable(s) are set Gramps will start with these new values.

These options can takes three forms:
{{man note|Note|Except for examples <tt>1</tt> and <tt>3.2</tt>, All the following examples, use <code>behavior.database-path</code> as the configuration variable to change.}}

;1) See all config values: <code>-s</code> or <code>--show</code>
 For example:
gramps --show
<pre>
Gramps config settings from /home/<~username>/.gramps/gramps50/gramps.ini:
export.proxy-order=[['privacy', 0], ['living', 0], ['person', 0], ['note', 0], ['reference', 0]]

database.compress-backup=True
database.backend='bsddb'
database.backup-path='/home/<~username>'
database.port=''
database.autobackup=0
database.path='/home/<~username>/.gramps/grampsdb'
database.host=''
database.backup-on-exit=True

geography.lock=False
....
</pre>

{{-}}

;2) See a single config value: <code>--config=database.path</code> or <code>-c database.path</code>
 For example:
gramps --config=database.path
<pre>
Current Gramps config setting: database.path:'/home/<~username>/.gramps/grampsdb'
</pre>

3) Set a value: <code>--config=behavior.database-path:'/media/mydb'</code> or <code>-c behavior.database-path:'/media/mydb'</code>
 For example:

3.1) Set a value to its default: <code>--config=behavior.database-path:DEFAULT</code> or <code>-c behavior.database-path:DEFAULT</code>
 For example:

3.2) Set more than one value: <code>--config=behavior.use-tips:False --config=behavior.autoload:True</code> or <code>-c behavior.use-tips:False -c behavior.autoload:True</code>
 For example:
=== Safe mode ===
<code>gramps -S</code> or <code>gramps --safe</code>

This CLI command starts Gramps as if it had never been installed before. In this mode, any previous family trees can still be loaded, as long as they were stored in the default folder. All other settings, filters, books, addons etc. are either cleared or returned to their default values. Other CLI commands can be used, or, if none, Gramps will start the GUI. Nothing except the actual family tree data is saved.

Note that this is typically used to see if Gramps behaves better when it is running as if with a totally 'clean' install. It is NOT permanent (if you want that see [[#Defaults|Defaults]] below), if you start Gramps normally after using this command all of your previous settings etc. are still there.

This actually works by setting the folder that Gramps uses to store its user data (except for family trees) to a temporary directory, which is deleted when Gramps closes.
=== Defaults ===
<code>gramps -D E</code> or <code>gramps --default=E</code>

This CLI command causes Gramps to clear out or return to defaults the desired settings.
The family tree databases are NOT cleared out or removed.
The sub-commands (replace the 'E' from the example command line above with one or more of
the subcommand characters) are:

*<code>A</code> Addons are cleared. Any installed addons are removed, along with their settings.
*<code>F</code> Filters are cleared. Any custom filters are removed.
*<code>P</code> Preferences are returned to their default values.
*<code>X</code> Books are cleared, Reports and Tools settings are returned to their default values.
*<code>Z</code> Old '.zip' files from family tree version upgrades are deleted.
*<code>E</code> Everything except the actual family tree data is returned to default settings. This does all of the above as well as a few more items; deletes thumbnails, maps, and the user CSS (used in web reports).

For example:
gramps -D AP
will cause Gramps to remove all the Addons and to reset Preferences to their default values.
== Operation ==

If the first argument on the command line does not start with a dash (i.e. no flag), Gramps will attempt to open the file with the name given by the first argument and start an interactive session, ignoring the rest of the command line arguments.

If the <code>-O</code> flag is given, then Gramps will try opening the supplied file name and then work with that data, as instructed by the further command line parameters.

{{man note|1=Note |2=Only one file can be opened in a single invocation of Gramps. If you need to get data from multiple sources, use the importing options by using <code>-i</code> flag.}}

With or without the <code>-O</code> flag, there could be multiple imports, exports, and actions specified further on the command line by using <code>-i</code> , <code>-e</code> , and <code>-a</code> flags.

The order of <code>-i</code> , <code>-e</code> , or <code>-a</code> options with respect to each does not matter. The actual execution order always is: all imports (if any) -> all exports (if any) -> all actions (if any).

{{man note| Note |But opening must always be first!}}

If no <code>-O</code> or <code>-i</code> option is given, Gramps will launch its main window and start the usual interactive session with the empty database, since there is no data to process, anyway. (Unless you have already expressed a "preference" that it start with the last database it used.)

If no <code>-e</code> or <code>-a</code> options are given, Gramps will launch its main window and start the usual interactive session with the database resulted from opening and all imports (if any). This database resides in a directory under the ''<code>~/.gramps/grampsdb/</code>'' directory.

Any errors encountered during import, export, or action, will be either dumped to stdout (if these are exceptions handled by Gramps) or to stderr (if these are not handled). Use usual shell redirections of stdout and stderr to save messages and errors in files.

== Examples ==

*To import four databases (whose formats can be determined from their names) and then check the resulting database for errors, one may type:

:<code>gramps -i file1.ged -i file2.gpkg -i ~/db3.gramps -i file4.wft -a check</code>

*To explicitly specify the formats in the above example, append filenames with appropriate -f options:

:<code>gramps -i file1.ged -f gedcom -i file2.gpkg -f gramps-pkg -i ~/db3.gramps -f gramps-xml -i file4.wft -f wft -a check</code>

*To record the database resulting from all imports, supply -e flag (use -f if the filename does not allow Gramps to guess the format):

:<code>gramps -i file1.ged -i file2.gpkg -e ~/new-package -f gramps-pkg</code>

*To save any error messages of the above example into files outfile and errfile, run:

:<code>gramps -i file1.ged -i file2.dpkg -e ~/new-package -f gramps-pkg >outfile 2>errfile </code>

*To import three databases and start interactive Gramps session with the result:

:<code>gramps -i file1.ged -i file2.gpkg -i ~/db3.gramps </code>

*To open a database and, based on that data, generate timeline report in PDF format putting the output into the my_timeline.pdf file:

:<code>gramps -O 'Family Tree 1' -a report -p name=timeline,off=pdf,of=my_timeline.pdf </code>

{{man tip|1=Listing report options |2=Use the <code>''name=timeline,show=all''</code> to find out about all available options for the timeline report. To find out details of a particular option, use <code>''show=option_name''</code> , e.g. <code>''name=timeline,show=off''</code> string. To learn about available report names, use <code>''name=show''</code> string.}}

*To convert the bsddb database on the fly to a .gramps xml file:

:<code>gramps -O 'Family Tree 1' -e output.gramps -f gramps-xml</code>

* To generate a web site into an other locale (in german):

:<code>LANGUAGE=de_DE; LANG=de_DE.UTF-8 gramps -O 'Family Tree 1' -a report -p name=navwebpage,target=/../de </code>

*Finally, to start normal interactive session type:

:<code>gramps</code>

== Environment variables==

{{man warn|Warning|Gramps can take advantage of the following [[Gramps_and_Windows#Environmental_Variables|environment variables]] ('''Only change them if you know what are you doing.''')}}

===GRAMPSHOME===
* '''GRAMPSHOME''' - if set, [[Gramps_and_Windows#Setting_the_configuration_path|override default path]] to profile allowing user to use an external network drive to store data and all settings. For technically advanced users who run multiple versions of Gramps, setting a different $GRAMPSHOME is a way to avoid interference between the different versions in the Gramps user directory. It can also be used to configure Gramps to [[Run_Gramps_from_a_portable_drive|run from a portable drive]] or to prepare for a [[Installation|manual installation]]. The path can also be used to configure the path to a [[Gramps_for_Windows_with_MSYS2#Keep_your_GRAMPSHOME_separate|separate test Tree]] or [[Getting_started_with_Gramps_development|development Tree]].

For example <pre>GRAMPSHOME=$HOME/familytrees/paternal</pre>

===LANG, LANGUAGE, LC_MESSAGE, LC_TIME ===
* '''LANG''', '''LANGUAGE''', '''LC_MESSAGES''', and '''LC_TIME''' - are used by Gramps to determine which language file(s) should be loaded. See locale(1) for a general discussion of '''LANG''', '''LC_MESSAGES''', and '''LC_TIME'''. Note that in addition to setting date formats (which are overridden in Gramps with Preferences settings) '''LC_TIME''' also sets the language used for words in dates like month and day names and ''in the context of dates'' words like ''about'', ''between'', and ''before''. '''LANGUAGE''' is a comma-separated list of language codes (''not locales'', though certain languages like pt_BR or cn_TW are regional variants) that sets a preference-ordered list of desired translations. It will override '''LANG''' but not '''LC_MESSAGES''' or '''LC_TIME'''.

{{man note|MacOSX|Because of the way launching with Finder works, the environment variables for the Gramps.app bundle are hard-coded in <code>Gramps.app/Contents/MacOS/Gramps</code>. If for some reason you need to change them, edit that file with TextEdit; be sure to save it back as plain text. See as well [[Run_GRAMPS_in_another_locale#Change_Mac_OS_X_application_defaults|setting locale]] for an alternative to using the '''LANG''' and '''LANGUAGE''' environment variables.}}

===GRAMPSI18N===
* [[Translating_Gramps#.24GRAMPSI18N_.28for_your_locale.29| $GRAMPSI18N (for your locale) ]] - The LANG assumes the Gramps translations are installed globally. If this is not the case, you need to [[Translating_Gramps#.24GRAMPSI18N_.28for_your_locale.29|give Gramps the directory]] where the translations will be found. This can be used to temporarily [[Howto:Change_the_language_of_reports|change the language for Reports]] being generated.

A translation is called <code>gramps.mo</code>, you can find it in Linux with the locate command. For example, if you have Swedish in directory <code>/home/me/gramps/mo/sv/gramps.mo</code>, you can direct Gramps there using:
GRAMPSI18N=/home/me/gramps/mo LC_ALL=C.UTF-8 LANG="sv" python3 gramps

===GRAMPSDIR===
* The environment variable GRAMPSDIR is the path to your [[Translating_Gramps#gramps.sh|Gramps directory]].

===GRAMPS_RESOURCES===
* The environment variable GRAMPS_RESOURCES is the path to Gramps builtin resources files. You should only change this if you are using Gramps from source code or a custom environment. An indicator that you need to set this variable is if you receive one of the following errors:
** ''Encoding error while parsing resource path''
** ''Failed to open resource file''
** ''Resource Path {invalid/path/to/resources} is invalid''
** ''Unable to determine resource path''

Example [[Linux:Build_from_source#Running_from_a_tarball_release|usage]]:
GRAMPS_RESOURCES=/home/username/gramps/branches/maintenance/gramps51/build/lib.linux-x86_64-2.7/ PYTHONPATH=$GRAMPS_RESOURCES:$PYTHONPATH ./gramps

{{-}}
{{man index|Gramps 5.1 Wiki Manual - Keybindings|Gramps 5.1 Wiki Manual - User Directory|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Command_Line}}
{{grampsmanualcopyright}}

[[Category:Documentation]]

Download

2020-10-15T15:27:10Z

Eponymous: Improving mac section, adding homebrew.

{{languages|Download}}
[[File:Gramp-Small-background-wiki-2020.jpg|120px|left]]
'''Research, organize and share your family tree with Gramps.'''

Gramps is a free software project and community. We strive to produce a genealogy program that is both intuitive for hobbyists and feature-complete for professional genealogists. It is a community project, created, developed and governed by genealogists.

{{man note|{{Man menu|Gramps '''Current version: '''{{version}}''' Released: '''2020-08-13'''}}|''Different data format to the GRAMPS 3.4 series. Full Python 3 support only as [https://www.python.org/doc/sunset-python-2/ Python 2 support dropped]. Uses GTK+ 3 GUI. Default database is now SQlite. Lot of updates see: ''[[Gramps 5.1 Wiki Manual - What's new?|What's new?]]{{-}}
[[File:Linux_220x261.png|128px|link=Download#Linux]] [[File:windows_180x160.png|128px|link=Download#MS_Windows]] [[File:macos_200x200.png|128px|link=Download#macOS]] [[File:Bsd daemon.png|128px|link=Download#BSD]]}}

== Linux ==

[[File:Linux_220x261.png|128px|left|link=Download#Linux]]

Before upgrading your distribution: Use your '''old version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees [[#1|[1]]].

<big>
[[Download#Linux distributions|via Distributions]]
    
[[Download#Linux:_Install_latest_version|Latest version ({{version}}) (advanced users only)]]</big>
{{-}}

== MS Windows ==
[[File:windows_180x160.png|128px|left|link=Download#MS_Windows]]

Before downloading the [[All_In_One_Gramps_Software_Bundle_for_Windows|All-In-One software installer bundle for Windows]]: Use your '''earlier version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees to the hardy and portable [[#1|XML format1]].

This installer supports Microsoft Windows in all versions [http://windows.microsoft.com/en-au/windows/lifecycle Vista/7] and later.

(''Please note: Gramps prefers the Python-3.5 and Gtk-3.18 libraries and newer. Those libraries have dropped support for Windows XP. But Gramps can still be run on Windows XP with earlier library versions, i.e., Python3.4.4 and Gtk-3.16'')

<big>
*[{{github_url}}/releases/download/v{{version_windows_AIO32}}/{{filename_windows_AIO32}}.exe Windows Installer (32-bit) {{version_windows_AIO32}}]
*[{{github_url}}/releases/download/v{{version_windows_AIO64}}/{{filename_windows_AIO64}}.exe Windows Installer (64-bit) {{version_windows_AIO64}}]</big>

After download: '''double-click to install Gramps'''. By default: new releases will be added in a new directory and earlier installations of Gramps will ''not'' be overwritten; the language will be a [[#Missing_other_languages|mix of British and US English]].

{{man tip|Shortcuts|During installation, one shortcut is placed on the desktop and two shortcuts are added the Start menu. ''Please only use the 'console' secondary shortcut when performing diagnostics requested by a developer.'' 1) ''GrampsAIO'''XX''' ''{{version}}'' {{man menu| ← for normal use of Gramps}} 2) ''GrampsAIO'''XX''' ''{{version}}''-console}}

Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. Should this fail for any reason, '''Create''' a new Family Tree and [[How_to_restore_a_backup|'''Import''' the back-up]] into this new Tree.

Use the Windows AIO (All-In-One) version, please use the download links above. For more information about individual versions, console and debug modes, release notes, etc., look at [[GrampsAIO cx freeze-based|this page]] (English only).

If necessary, there is an alternative independent '''Legacy''' MS Windows [[#2|portable version2]].

You may also install using the alternative independent Gramps [[#3|Chocolatey NuGet Package3]].

{{-}}
=== Missing other languages ===
[[File:Microsoft Window Gramps AIO Installer Choose Components-Selection-51.png|right|thumb|450px|Microsoft Window Gramps AIO Installer Choose Components-Selection window.]]
The default Gramps AIO installer will embed the US dialect of English for the interface with the British spellcheck dictionary.

If you prefer a different language (or spell with the US or Australian dialects of English), please ensure that you pay special attention to the Choose Components phase of the installation.

To install a language other than English, select from both the '''Translations''' ''and'' '''Dictionaries''' during the Choose Components phase of the installation.

Even your primary language is installed by default, you might anticipate the need to spellcheck Notes in other than the British dialect of English. Be certain to select the appropriate languages from '''Dictionaries'''. Gramps will not access your Operating System's native dictionary.

There is no simple facility for adding interface or dictionary languages after installation.
{{-}}



== macOS ==

[[File:macos_200x200.png|128px|left|link=Download#Mac_OS_X]]

Before download: Use your '''old version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees [[#1|[1]]]. Read the [[Mac OS X:Application package|before installation]] instructions.

Supports Apple macOS/Mac OS X versions 10.5 ([https://wikipedia.org/wiki/Mac_OS_X_Leopard Leopard]) and later. (Help determining your Operating System version can be found in the [https://support.apple.com/en-us/HT201260 HT201260 Apple Support article.])

<big>
* [{{github_url}}/releases/download/v{{version_Mac}}/{{Filename_mac_intel}}.dmg Intel {{version_Mac}}]
</big>

After download: Double-click the .dmg file to mount the disk (note: your browser may do this for you automatically). Next drag the Gramps application to your application folder and double-click to launch it [[#4|[4]]].

Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. However if this fails for any reason, '''Create''' a new Family Tree and '''Import''' the back-up into this new Tree.

Gramps can also be installed on MacOS using the MacPorts[[#5|[5]]] framework or Homebrew package manager[[#6|[6]]].

{{man tip|Spell Checking:|Gramps uses a different spell checker than the one provided by Mac OS X, with different spelling dictionary requirements. We can't easily provide dictionaries for all of the supported languages in the bundle, but they're easily downloaded from [https://extensions.openoffice.org/ OpenOffice.org's website]. Download the language you want and save it, then navigate to the download in Finder. Most browsers have a downloads window that offers "Show in Finder" in its context menu. Change the file extension from <tt>oxt</tt> to <tt>zip</tt>, then from the context menu select '''Open with... Archive Utility''' to decompress it. In the decompressed folder or perhaps in a subfolder you'll find the dictionary files in pairs, <tt>foo.aff</tt> and <tt>foo.dic</tt>. Some languages have more than one pair with a README file to explain why. Select a pair and copy it to /Library/Dictionaries (you'll have to authenticate with an administrator id and password), and if 'foo' isn't already a language or locale code, make it one. For example, the French package includes several pairs with names like <tt>fr-moderne.aff</tt> and <tt>fr-moderne.dic</tt>. The spell checker doesn't recognize those names, so when you copy them to /Library/Dictionaries you must rename them to <tt>fr.aff</tt> and <tt>fr.dic</tt> or <tt>fr_FR.aff</tt> and <tt>fr_FR.dic</tt>. You can have more than one dictionary pair installed if you use several languages, but one '''must''' match the language you use for Gramps or spell checking won't be enabled at all.}}

{{-}}

== Linux and BSD distributions ==
{{man note|These packages are built and supported by the [https://en.wikipedia.org/wiki/Linux_distribution distros].|If your distribution is not listed you may possibly find it listed on [https://repology.org/metapackage/gramps/versions ''Repology''] Please report any problems with them to the package maintainer.}}
Most Linux distributions come bundled with a version of Gramps, though it's not always the most recent version and it may not have been installed by default. Still it is recommended to use the Gramps version that comes with your distribution.

Below are ways to install Gramps on some of the more popular distributions:

{| {{prettytable}}
!style="width: 85pt;" | Distribution
!GUI Package manager
!Current versions
!Notes
|-
|[[File:Debianopenlogo-32.png|link=https://packages.debian.org/search?keywords=gramps]]''' [[Debian]] '''
|Add/Remove Software
|
* Debian 8 ("jessie")(old old stable): Gramps 4.1.1
* Debian 9 ("stretch") (old stable): Gramps 4.2.5
* Debian 9 ("stretch")([https://packages.debian.org/stretch-backports/gramps backports]): Gramps 5.0.1
* Debian 10 ("buster") (stable): Gramps 5.0.1
* Debian 10 ("buster")([https://packages.debian.org/buster-backports/gramps backports]) (stable): Gramps 5.1.2
* bullseye (testing): Gramps 5.1.3
* [http://packages.debian.org/sid/gramps sid (unstable)]: Gramps 5.1.3
|[http://packages.debian.org/search?keywords=gramps available versions]
|-
|[[File:Ubuntu_32x32.png]]''' Ubuntu '''
|Software Centre
|
* Xenial (16.04 LTS): Gramps: 4.2.2
* Xenial (16.04 LTS): Gramps: 4.2.6 ([https://launchpad.net/~rosco2/+archive/ubuntu/backports Backport])
* Bionic Beaver (18.04 LTS): Gramps: 5.0.0
* Eoan (19.10): Gramps: 5.0.1
* Focal (20.04 LTS): Gramps: 5.1.2
* Groovy Gorilla (Development: 20.10): Gramps: 5.1.3
|[http://packages.ubuntu.com/search?keywords=gramps&searchon=names available versions]/ (Also see: [https://launchpad.net/~rosco2/+archive/ubuntu/backports Backports])
|-
|[[File:Farm-Fresh linux mint.png]]''' [https://www.linuxmint.com/ Linux Mint]'''
|Software Manager
|
* 18.x(Gramps 4.2.2~dfsg-1)
* 19.x(Gramps 4.2.8)
* 20.x(Gramps 5.1.2)
|
* Use the "Software Manager" to install a recent version.
* Manually install the most current version of Gramps using the following [https://forums.linuxmint.com/viewtopic.php?t=220159 instructions] from the ''Linux Mint Forums''
* [http://community.linuxmint.com/software/view/gramps Old versions available from Linuxmint]
|-
|[[File:Fedora_32x32.png]]''' Fedora '''
|Add/Remove Software (Gnome) or Software Management (KDE)
|
* Rawhide (Gramps 5.1.3)
* Fedora 31 (Gramps 5.1.3)
* Fedora 32 (Gramps 5.1.3)
* Fedora 32 (Gramps 5.1.3)
|[https://koji.fedoraproject.org/koji/packageinfo?packageID=1969 available versions]
|-
|'''[https://www.mageia.org/en/ Mageia]'''
||[https://wiki.mageia.org/en/Installing_and_removing_software drakrpm (or rpmdrake)]
|
* Mageia [https://madb.mageia.org/package/show/name/gramps/release/cauldron/ Caulron]: Gramps 5.1.2
* Mageia 7.1: Gramps 5.0.1
|[http://mageia.madb.org/package/show/name/gramps Mageia App Db - gramps]
|-
|[[File:OpenSUSE-distribution-icon.png|32px]]''' openSUSE '''
|[https://en.opensuse.org/YaST_Software_Management YaST]
|
* openSUSE Tumbleweed: Gramps 5.1.2
* openSUSE Leap 15.2: Gramps 4.2.8
* openSUSE Leap 15.1: Gramps 4.2.8
* openSUSE Leap 15.0: Gramps 4.2.8
|[https://software.opensuse.org/package/gramps available versions] The most recent version can usually be installed from the 'openSUSE BuildService - GNOME:Apps' repository
|-
|[[File:Slackware-distribution-icon.jpg|32px]]'''Slackware'''
|
|
* 14.2: Gramps 4.2.6
* 14.2: Gramps 5.1.2 - [https://slackbuilds.org/repository/14.2/misc/gramps/?search=gramps slackbuilds.org]
* 14.1: Gramps 4.0.3
|[http://pkgs.org/search/?keyword=gramps available versions]
|-
|[[File:archlinux-icon-crystal-32.svg]]'''[https://www.archlinux.org/ Arch Linux]'''
|
|
* Gramps 5.1.2
|[https://www.archlinux.org/packages/community/any/gramps/ available versions]
|-
|[[File:Gentoo-distribution-icon.png|32px]]'''[https://gentoo.org Gentoo Linux]'''
|
|
* Gramps 5.1.3
|[https://packages.gentoo.org/packages/app-misc/gramps available versions]
|-
|'''[https://www.netbsd.org/ NetBSD]'''
|
|
* NetBSD: [http://pkgsrc.se/databases/gramps3 Gramps 3.4.9]
* NetBSD: [http://pkgsrc.se/databases/gramps5 Gramps 5.1.2]
|
|-
|'''[https://www.freebsd.org/ FreeBSD]'''
|
|
* FreeBSD: Gramps 4.2.8
* [https://www.freshports.org/science/gramps/ FreshPorts: Gramps 5.1.1]
|[http://portsmon.freebsd.org/portoverview.py?category=science&portname=gramps available versions]
|-
|'''[https://www.openbsd.org/ OpenBSD]'''
|
|
* OpenBSD: Gramps 5.1.1
|[http://openports.se/misc/gramps available versions]
|-
|
|
|
|
|}

{{-}}

== Linux: Install latest version ==

If your distribution doesn't ship with Gramps or you wish to install a different version than it ships with, you could try to install the latest version of Gramps manually.

{{man warn|1=Warning before attempting this use your existing installation to [[How to make a backup|make a Gramps XML backup]]|2=This should only be attempted by experienced users, and after you have backed up your Family Tree.

The version of Gramps that has been included in your distribution will have been tested to work with the components in that distribution. If you try to install a different version of Gramps there is a possibility that the components needed for the new version of Gramps are not available for your distribution, or they are available, but don't work properly. You might not discover that there is a problem till you have already done some work with the new version of Gramps.

If you already have Gramps installed, and you are only making a 'point' upgrade (i.e. from Gramps x.y.z to x.y.z+1, e.g. from 3.4.3 to 3.4.4), then it is likely but not certain that Gramps will continue to work. However, if the change is much greater, especially if it is a major version change (e.g. from 2.y.z to 3.y.z), then the danger that it does not work properly is much greater.}}

=== Debian-based ===
For [[File:Debianopenlogo-32.png|link=Download#Debian-based]]'''[[Debian|Debian-based linux distributions]]''' (Which includes [[File:Ubuntu_32x32.png|link=Download#Debian-based]]''' Ubuntu ''') [{{github_url}}/releases/v{{version}} Download the .deb file]. Double-click on the downloaded .deb file or (for some distributions, e.g. Mint Debian) run the following command from the directory where the file was saved ({{man menu|change the filename to match the one you downloaded}}).

sudo dpkg -i gramps_{{version}}-1_all.deb

If you have an error about having unmet dependencies run:

sudo apt-get -f install

to install the dependencies.

If you see an error about language support when starting Gramps, run

sudo apt install language-pack-gnome-en

to install the proper language pack. You may need to replace 'en' with your own language code, like 'nl' for Dutch.

==== Useful command lines ====
Before upgrading you can[https://sourceforge.net/p/gramps/mailman/message/35460486/]:

* Find out what version you are running, by using this:

dpkg-query -s gramps

that queries the package and gives you info about it.

* If you are committed to an upgrade then make sure you have backed up you Family Trees to Gramps XML then run :

sudo dpkg -r gramps

this will remove the current gramps package (assuming its a python3 version older versions could be python-gramps )

* To stop Ubuntu updating gramps (to possibly an older version from Ubuntu!) you may need to run:

sudo apt-mark hold gramps

'''Upgrade is then complete.'''

=== For other distributions ===
For other distributions, [[File:Download_link.png|150px|link={{github_url}}/releases/v{{version}}]] the source and follow the instructions for [[Linux:Build from source]]

== BSD ==

[[File:Bsd daemon.png|128px|left|link=Download#BSD]]

Before upgrading your distribution: Use your '''old version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees [[#1|[1]]].

<big>
[[Download#Linux and BSD distributions|via Distributions]]
    
[[Download#Linux:_Install_latest_version|Latest version (advanced users only)]]</big>

See also:
* [[BSD platforms]]
{{-}}

== Live CD ==

{{man warn|Note that both Live CD demonstrations use an old version of Gramps and it is not recommended for general use}}

[[File:Download_link.png|150px|left|link=https://sourceforge.net/projects/gramps/files/gramps-cdrom/lgenealogy-6.1-desktop-i386.iso/download]]
'''Linux live CD Demonstration''' includes Gramps {{Version Linux Live CD}} pre-installed to trial, without touching anything on the hard drive. To start this boot the Computer with this Live Linux Desktop on a CD in the CD/DVD-ROM Drive. (Requires that you write this image to a CD-ROM using CD-Burner software eg:Nero, Imgburn..). [[Linux_Genealogy_CD#Download_the_CD|Download the CD]] (727 MB). The [[Linux Genealogy CD|Linux Genealogy CD is based on Ubuntu 10.10 (Maverick Meerkat)]]. If you are interested in Gramps, but are afraid to actually install it or unable to install it (not your PC, windows, no internet at home, work laptop, ...), then try out our [[Linux Genealogy CD]]. It runs without installing on the hard disk and contains a collection of open source, free, genealogy programs. You can then install latest [http://www.ubuntulinux.org/ Ubuntu] and Gramps from the CD anytime you like.
{{-}}

=== Online Demonstration ===
You can also try an online demonstration of Gramps on rollApp:
* https://www.rollapp.com/app/gramps
Select '''Launch Online''' then '''Test Drive(Opening/saving files will not be available)'''

{{man note|Note|This is a commercial limited trial and not endorsed by the Gramps-project. Beware of third parties having your genealogical data.}}
{{-}}

== Notes ==

[1]
Backup to Gramps XML. You will find backup in the Family Tree menu of recent Gramps versions, otherwise use export in the same menu but '''uncheck privacy options''' in the Exporter Assistant in order to export all data. See : [[How to make a backup]]

[2]
{{man menu|Note that PortableApps.com use an old version of Gramps and it is not recommended for general use}} An alternative independent '''Legacy''' version is [http://sourceforge.net/projects/portableapps/files/Gramps%20Portable/ GrampsPortable_{{version_windows_portable}}.paf.exe] (29.0 MB)
[http://portableapps.com/apps/education/gramps_portable Portable Gramps from PortableApps.com] includes all dependencies required for Windows. ''Note:You can install it on C: then to run Gramps type C:\PortableApps\GrampsPortable\GrampsPortable.exe (Or the path you installed it to) or make a shortcut to that file on your desktop or start-menu.'' By Bart.S - '''[http://portableapps.com/blog/84601 Please report packaging issues to the author.]''' (2012-09-07)

[3]
Chocolatey NuGet is a Machine Package Manager, somewhat like apt-get, but built with Windows in mind. [https://chocolatey.org/packages/gramps/ Gramps Chocolatey Package]

[4]
For Apple Mac OS X, alternatively, you can click and hold on the disk icon at the top of the window of the mounted disk, and then option-drag to the Applications folder. This will create a new folder containing all the files, including the README and NEWS.

[5]
The MacPorts Project is an open-source community initiative to design an easy-to-use system for compiling, installing, and upgrading open-source software on the Mac operating system. https://www.macports.org/ In order to do that run the following command: <code>port install gramps</code> see: [[Mac OS X:Build from source:MacPorts]]

[6]
Homebrew is an open-source package manager for macOS (and Linux). See https://github.com/homebrew/.

== See also ==
* [[Previous releases of Gramps]]

[[Category:Documentation]]

Gramps 5.1 Wiki Manual - Manage Family Trees

2020-08-12T16:22:54Z

Eponymous: /* GEDCOM import report dialog */ Language clean-up

{{man index|Gramps 5.1 Wiki Manual - Categories|Gramps 5.1 Wiki Manual - Manage Family Trees: CSV Import and Export|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees}}
{{#vardefine:chapter|5}}
{{#vardefine:figure|0}}
A detailed exploration of the day-to-day use of Gramps. In this Chapter we give a detailed overview of how you can manage your family trees, as well as share your data with other genealogists.

== Starting a new Family Tree ==

[[File:Menubar-FamilyTrees-overview-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menubar - "Family Trees" - overview example]]

To start a new Family Tree, choose the menu {{man menu|Family Trees ->Manage Family Trees...}} or select the toolbar {{icon|ance}}{{man button|Family Trees}} button or use the [[Gramps_5.1_Wiki_Manual_-_Keybindings|keybinding]] {{man key press|CTRL|O}}. This will open the {{man label|[[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Family_Trees_manager_window|Family Trees]]}} manager window.

Select the {{man button|New}} button and to add a new Family Tree entry to the list of Family Trees. To change its name from the default ''<code>Family Tree 1</code>'', select the name and press the {{man button|Rename}} button then type in a new name.

To open the new, empty Family Tree select the Family Tree and either double click or press the {{man button|Load Family Tree}} button to load.
{{-}}
=== Family Trees manager window ===

[[File:ManageFamilyTrees-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Family Trees" manager window]]

Clicking the {{man button|Family Tree Manager}} button brings up the {{man label|Family Tree}} manager windows this allows you to work with and manage your Family Trees.

The Family Tree Manager window allows the you to create a new Family tree, rename an existing Family tree, delete a Family tree, or load a Family tree or check info(mation) about the Family tree. All the names of your Family trees appear in the list. If a Family tree is open, an icon will appear next to the name in the status column. The Database Type as well an indication of the date and time your family tree was ''Last accessed''' is shown.

* {{man button|New}} creates a new Family tree.
* {{man button|Info}} shows infomation about the selected Family tree.
* {{man button|Delete}} the selected Family tree, this will show a warning with a final confirmation for you to select.
* {{man button|Rename}} the selected existing Family tree.
* {{man button|Close}} the selected existing Family tree.
* {{man button|Convert}} the selected family tree only available for legacy BSDDB databases. See: [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Converting_a_BSDDB_Family_Tree_to_SQlite|Converting a BSDDB Family Tree to SQlite]]
* {{man button|Repair}} the selected existing Family tree, only available if Gramps detects an issue. 
* {{man button|Archive}} option is only present if [http://www.gnu.org/software/rcs/ GNU Revision Control System] (RCS) is installed.
* {{man button|Extract}} used with the {{man button|Archive}} button and the option is only present if [http://www.gnu.org/software/rcs/ GNU Revision Control System] (RCS) is installed.
* {{man button|Help}} - from this section.
* {{man button|Close Window}} - dismisses the {{man label|Family Tree}} manager windows
* {{man button|Load Family Tree}} the selected existing Family tree.
{{-}}

== Opening a Family Tree ==

To open a Family Tree, either choose the menu {{man menu|Family Trees ->Manage Family Trees...}} or click the Toolbar {{man button|Family Trees}} button. The {{man label|Family Tree Manager}} will appear and you will see a list of all the Family Trees known to Gramps. In the {{man label|Status}} column an icon (looks like an open folder) will display beside any Family Tree that is currently open. Select the tree you want to open, and open it by selecting the {{man button|Load Family Tree}} button. Alternatively you can double-click on the desired Family Tree.

To open a recently accessed Family Tree, choose either the menu {{man menu|Family Trees ->Open Recent}} or the down arrow next to the Toolbar {{man button|Family Trees}} button and select the Family Tree from the list.

=== Read Only Mode ===

{{man warn| Read Only Mode |If you do not have "write permissions" for the selected Family Tree, it will be opened in a Read Only mode. In this mode, the data may be viewed, but no changes will be made to the Family Tree. To indicate this mode, the title of the main window will be appended with {{man label|(Read Only)}} text.}}

== Saving changes to your Family Tree ==

Gramps saves your changes as soon as you apply them. This means, for example, that any time you click {{man button|OK}} when using Gramps, your changes are immediately recorded and saved. There is no separate "save" command.

You can undo changes you have made by selecting the menu {{man menu|Edit ->Undo}}. If you select this command repeatedly, your most recent changes will be undone one at a time. To roll back multiple commands at a time, you can use the menu {{man menu|Edit|Undo History...}} dialog.

If you want to return your Family Tree to the way it was when you opened it, select the menu {{man menu|Family Trees ->Abandon Changes and Quit}}. (This is just like quitting without saving in other programs.) 

If you would like to save a copy of your Family Tree under a different name, you will need to export it and then import it into a new Family Tree. The ''Gramps XML'' database format is recommended for this purpose.

== Opening a GEDCOM or XML database ==

Gramps allows you to open certain databases that have not been saved in Gramps own file format from the command line, see [[Gramps_5.1_Wiki_Manual_-_Command_Line#Opening_options|Command line references]]. These include XML and GEDCOM databases. But you should be aware that if the XML or GEDCOM database is relatively large, you will encounter performance problems, and in the event of a crash your data can be corrupted. Hence, it is normally better to create a new Gramps family tree (database) and import your XML/GEDCOM data into it.

{{man note| Opening databases |XML and GEDCOM databases require all data to be held in memory and don't contain indexes. Gramps native format is a database that only reads the data needed. Thus, for a large family tree the data can be accessed quicker and more efficiently by not using XML or GEDCOM.}}

{{man warn| GEDCOM Editing |Please keep in mind that some information in a GEDCOM file may be lost during import into Gramps as well as export back to GEDCOM. Simply opening and viewing the file will not change it. However, if any changes were made and they were not abandoned upon exit, exiting Gramps will save the data, with possible data loss.}}

== Deleting a Family Tree ==

Select the family tree you want removed, and click the {{man button|Delete}} button.

This will '''completely''' remove the tree, with no possibility to retrieve the data. Consider taking a backup of your data by exporting to the GRAMPS XML format, and storing that file.

== Renaming a Family Tree ==

You can rename a Family Tree (or an archive of it) by selecting the tree you want to rename and clicking {{man button|Rename}}. You can also click on the name in the list of trees.

In either case, you just type in the new name to have it take effect.

== Backing up a Family Tree ==

The safest way to backup your Gramps Family Tree is to export without privacy options and filters to '''Gramps XML''' format (or '''Gramps XML Package''' to include items from your Gallery) and copy the resultant file to a safe place, preferably in a different building.

=== Backup dialog ===

[[File:MakeBackup-GrampsXMLBackup-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Making a backup]]

From the menu select {{man menu|Family Trees > Make Backup..."}}

The {{man label|Gramps XML Backup}} window will appear.

You can enter the path where the backup should be stored manually or using the path selector button.

You can enter a file name manually or use the automatically generated file name.

You can either choose to ''Include'' or '''Exclude'''(default) the {{man label|Media:}}.

{{man note|Note|This is just a regular XML export, except that no data is filtered out. You can import these as usual with any exported file.}}
{{-}}
*You can use the Archive feature (see next section) to store snapshots of your Family Tree. These snapshots can be used as simple backups, very useful if you want to try something that you might later want to undo. However this method should not be used for standard backups, as it will not survive a hard disk crash or most of the other disasters that can befall a computer.

*''For advanced users:'' each database is stored in its own subdirectory under ~/.gramps. Although a manual backup can be made by backing up this directory, it is not recommended. It is strongly recommended that you please use a Gramps XML backup instead.

See also:
* [[Gramps_5.1_Wiki_Manual_-_Settings#Advanced_backup_filename_setting|Advanced backup filename setting]] - Where you can also define the naming pattern for the backup filename.

== Archiving a Family Tree ==

{{man tip|Note|The {{man button|Archive}} option is only present if [http://www.gnu.org/software/rcs/ GNU Revision Control System] (RCS) is installed so that Gramps can use it. You normally need to install this on your computer separately from Gramps.}}

You can {{man button|Archive}} your family trees with Gramps to retain a copy before any major changes and be able to return to a known version.

To make an archive :

[[File:ManageFamilyTrees-Archive-RevisionComment-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Archive a Family Tree example]]

# load your Family Tree.
# click on the Toolbar {{icon|ance}}{{man button|Family Trees}} button (it displays {{man label|Connect to a recent database}} when you hover over it).
# click on the family tree you have just loaded: the {{man button|Archive}} button should appear.
# click on {{man button|Archive}} and you will be able to enter in the {{man label|Revision comment}} dialog a ''Version description'' for your archive.

After archiving, the list of family trees will now show your original family tree with a right-pointing triangle on its left.
* Click on the triangle to display the archive name.(Click again to collapse the archive list).

Archives can be {{man button|Deleted}}, {{man button|Rename(d)}} and {{man button|Extract(ed)}}.

{{-}}

== Extracting a Family Tree Archive ==

[[File:ManageFamilyTrees-Archive-Selected-to-Extract-example-50.png|thumb|right|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} (Manage)"Family Trees" dialog - Archive selected ready to "Extract" - example]]

To retrieve a version of a previously archived family tree in the "Family Tree" manager highlight the archive you want to restore, and select the {{man button|Extract}} button.

{{-}}
[[File:ManageFamilyTrees-Archive-Extracted-version-highlighted-example-50.png|thumb|right|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} (Manage)"Family Trees" dialog - Archived version extracted and selected - example]]

The archive will then be restored into a new Family Tree and be listed in the family tree manager.

The Family Tree name is based on the original name and the archive name eg: ''<code><name of original tree>:<name of archive></code>''.(see also [[#Archiving a Family Tree|Archiving a Family Tree]])

This can be a useful way of preserving an archive, because archives disappear if the originating tree is deleted; and '''they are not incorporated into a Gramps XML export of the family tree''.
{{-}}

== Unlocking a Family Tree ==

[[File:FamilyTreesManager-Dialog-ShowingLocked-Sample-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Family Trees (Manager) - Dialog - Showing Locked "Sample" Family Tree]]

When Gramps opens a tree, it locks the tree, preventing you or anyone else opening it at the same time. A second copy of Gramps will be able to open another family tree, but the tree already open will appear with the lock icon, indicating you cannot open it. Closing the tree in the first copy of Gramps will make it available to be opened in the second copy.

If you could open the same Family Tree in two Gramps at once, it is likely your data would be damaged.

See also:
* [[Gramps_5.1_Wiki_Manual_-_Command_Line#Force_unlock_option|Command Line:Force unlock option]]
{{-}}
=== Break the lock on the "Family Tree name" database? dialog ===

In the unlikely event that Gramps crashes, the family tree will be left in a locked state (indicated by a lock icon in the {{man label|Status}} colum next to the Family Trees name)

To unlock the Family Tree
{{-}}
* If Gramps has been set to open a tree automatically on startup, then you will see the 'Database is locked' dialogue. Click on the {{man button|Close}} button

[[File:ErrorParsingArguments-dialog-DatabaseIsLocked-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Database is locked - Error parsing arguments - dialog - example]]
{{-}}
* Otherwise the {{man label|Family Tree Manager}} will appear. Choose the locked family tree and then click the {{man button|Load Family Tree}} button. The {{man label|Break the lock on the "[Family Tree name]" database?}} dialog will be shown.

[[File:Break-the-lock-on-the-database-Dialog-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Break the lock on the "Sample" database? - Dialog - example ]]

{{-}}
* {{man menu|Only do this if you are sure no other copy of Gramps is using the selected Family Tree.}} Click the {{man button|Break lock}} button and the {{man label|Family Trees (Manager)}} window should show that the lock icon has gone.
* Choose the previously locked family tree and then click the {{man button|Load Family Tree}} button to continue your work.
{{-}}

== Repairing a damaged Family Tree ==

[[File:FamilyTreesManager-Dialog-ShowingRedErrorStatusIcon-Sample-50.png|right|450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Family Trees (Manager) - Dialog - Showing Red Error Status Icon for "Sample" Family Tree]]

Should your Family Tree become damaged or corrupted in some way, Gramps Family Tree Manager will display a red Error icon in the {{man label|Status}} column.

To have Gramps attempt to repair the damage, select the Family Tree and then click the {{man button|Repair}} button.

This will attempt to rebuild your Family Tree from the backup files that are automatically created on exit.

See also:
* [[Recover corrupted family tree]]
{{-}}

== Converting a BSDDB Family Tree to SQlite ==

{{man warn|From Gramps 5.1.x the default database is SQlite.|Before following the advice in this section take the time to [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Backing_up_a_Family_Tree|backup your family trees]]}}

[[File:ManageFamilyTrees-Convert-the-database-dialog-example-51.png|right|450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} '''Convert the 'Family Tree Name' database?''' dialog with ''Family Trees (Manager)'' - Dialog shown in background]]

If you have an older legacy BSDDB format '''Database Type''' shown for any of your family tree's in the ''Family Trees (Manager)'' - Dialog, then selecting a family tree in the''Family Trees (Manager)'' - Dialog will shown the {{man button|Convert}} button as available.

{{man menu|It is highly recommended that before doing the following you [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Backing_up_a_Family_Tree|back up the family trees]] to be converted.}}

When ready select the {{man button|Convert}} button and the {{man label|Convert the 'Family Tree Name' database?}} dialog will be shown with the message '''Do you wish to convert this family tree into a SQlite database?''' you can select {{man button|Cancel}} to stop or {{man button|Convert}} to start the process, once completed the ''Family Trees (Manager)'' - Dialog will show a new entry for the converted copy of your Family tree but with the ''Database Type'' of SQlite, you should then open and backup the converted family tree.

You may then rename the original BSDDB family tree with the word '''OLD''' or you can Delete it to avoid confusion, then you can rename the new SQlite database.

{{stub}}

{{-}}
== Importing data ==

{{man note| Importing vs. opening |Please recognize that importing a Family Tree is different from opening a Family Tree. When you import, you are actually bringing data from another Family Tree into a Gramps Family Tree. When you open a file, you are editing your original file.}}

Importing allows you to transfer data from other genealogy programs into a Gramps Family Tree. Gramps can import data from the following formats:
* [[#Gramps_XML_and_XML_Package_import|Gramps XML]] (<code>.gramps</code> file extension)
* [[#Gramps_XML_and_XML_Package_import|Gramps XML Package]] (<code>.gpkg</code> file extension)
* [[#Gramps_CSV_import|Gramps CSV Spreadsheet]] - comma separated values (<code>.csv</code> file extension)
* [[#GRAMPS_V2.x_database_import|GRAMPS V2.x database]] (<code>.grdb</code> file extension)
* [[#GEDCOM_import|GEDCOM]] (<code>.ged</code> file extension)
* GeneWeb (<code>.gw</code> file extension) - [https://en.wikipedia.org/wiki/GeneWeb GeneWeb] is genealogy software with a web interface.
* Pro-Gen (<code>.def</code> file extension) - [https://www.pro-gen.nl/gbhome.htm Pro-Gen] is very popular in the Netherlands and North-West Germany, often used by people who started decades before today collecting data and storing; this in a DOS based program (which is still today, patched up to Win 10).

===Import Family Tree dialog===

{{man note|Note that data can only be imported into an existing Family Tree (database)|So, if migrating from another program, it is best to start by creating a new empty Family Tree and then import the data into it. Then clean up any corruptions or incompatibilities.
If the intent is to merge into an existing Gramps Tree by importing, it is less risky to import data from a cleaned and validated Tree already in Gramps format. Importing is a risky task, always make a backup of your Tree before importing.}}

[[File:Importfamilytree-dialog-50.png|thumb|right|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Import Family Tree - dialog example]]

First create a [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Starting_a_new_Family_Tree|new empty Family Tree]]. Then select the menu {{man menu|Family Trees ->Import}} or the [[Gramps_5.1_Wiki_Manual_-_Keybindings#2|keybinding]] {{Man key press|CTRL|I}} to import data or restore a previously saved Gramps Family Tree (from an older version of Gramps or the current version) the '''{{man label|Import Family Tree}}''' dialog will open, asking you to specify the file you wish to import.

If you attempt to import into an existing Family Tree the {{man label|Undo history warning}} dialog will open giving you the opportunity to stop the import and create a new Family Tree, unless you are deliberately attempting to merge data.

{{man warn|Data loss with some formats |It is important to note that there is no direct one-to-one correspondence between all the features of Gramps and those of GEDCOM or GeneWeb or Pro-Gen. Therefore, when importing from any of these formats data may be lost. Details of data that may be lost from GEDCOM is given [[#GEDCOM_import|below]].}}

{{man note|Reorder {{man label|Event}}s generated by other programs|Some programs from which you have imported data may not order the events as you expect. Gramps provides help for reordering events according to your preference. See the [[Gramps_5.1_Wiki_Manual_-_Tools#Sort_Events|Sort Events]] tool.}}

=== GRAMPS V2.x database import ===

GRAMPS V2.x database (.grdb): Prior to Gramps Version 3.0, this native Gramps database format was a specific form of the Berkeley database (BSDDB) with a special structure of data tables. This format was binary and architecture-dependent. It was very quick and efficient, but not generally portable across computers with different binary architecture (e.g. i386 vs. alpha).

Import from the GRAMPS V2.x database format is only supported by Gramps version 3.0.x. Import of V2.x into Gramps V3.0.x will not loose any data.

{{man warn|Import from the Gramps V2.x format is not supported by Gramps 5.1.|If you have an old V2.x database, then you must import it into Gramps V3.0.x, export it from there to Gramps XML (or Gramps XML Package), and then import it into Gramps 5.1.}}

==== Moving a Gramps 2.2 databases to Gramps 3.x ====

To move your Gramps data from version 2.x to version 5.1.x you must import the v2.x database into an earlier Gramps v3.0.x program and then either save the database and import it into Gramps 5.1.x, or export the database in [[XML]] format from the earlier Gramps version and import it into Gramps 5.1.x.

Please refer to the [[User_manual|User Manual]] for earlier versions of Gramps for instructions on the import of v2.x databases into Gramps v3.x.

{{-}}

=== Gramps XML and XML Package import ===

The Gramps [[XML]] and Gramps [[XML]] Package database are the native Gramps formats. There is no risk of information loss when importing (restore) from or exporting to these formats.

*Gramps [[XML]] (.gramps): The Gramps [[XML]] file is the standard Gramps data-exchange and backups format, and was also the default working-database format for older (pre 2.x) versions of Gramps. Unlike the GRAMPS V2.x grdb format, it is architecture independent and human-readable. The database may also have references to non-local (external) media objects, therefore it is not guaranteed to be completely portable (for full portability including media objects in the Gramps [[XML]] package (.gpkg) should be used). The Gramps [[XML]] database is created by exporting (Menu {{man menu|Family Trees ->Export...}}) to that format.

*Gramps [[XML]] package (.gpkg): The Gramps [[XML]] package is a '''compressed''' archive containing the Gramps [[XML]] file and all [[Gramps_Glossary#media|media]] objects (images, sound files, etc.) to which the database refers. Because it contains all the media objects, this format is completely portable. The Gramps [[XML]] package is created by exporting ( Menu {{man menu|Family Trees ->Export...}} ) data in that format.

If you import information from another Gramps database or Gramps [[XML]] database, you will see the progress of the operation in the progress bar of Gramps main window. When the import finishes, a feedback window shows the number of imported objects. If the imported data originates from the very family tree in which you import the data, the import feedback gives suggestions about what could be merged; the merge is '''not''' done automatically for you. If you want to merge basic genealogy data automatically, consider CSV Spreadsheet Export/Import.

=== Gramps CSV import ===

*The Gramps CSV Spreadsheet format allows importing and exporting of a subset of your Gramps data in a simple spreadsheet format. See [[Gramps 5.1 Wiki Manual - Manage Family Trees: CSV Import and Export|CSV Import and Export]] for more information.

=== GEDCOM import ===

First create a [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Starting_a_new_Family_Tree|new empty Family Tree]]. Then select the menu {{man menu|Family Trees ->Import}} or the [[Gramps_5.1_Wiki_Manual_-_Keybindings#2|keybinding]] {{Man key press|CTRL|I}} then use the {{man label|[[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Import_Family_Tree_dialog|Import Family Tree]]}} dialog to select the GEDCOM file you want to import, depending on the the type of GEDCOM you may then see the {{man label|[[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#GEDCOM_Encoding_dialog|GEDCOM Encoding]]}} dialog.

When you import information from GEDCOM, Gramps main window will show you a [[Gramps_5.1_Wiki_Manual_-_Main_Window#Status_Bar_and_Progress_Bar|progress bar]]. When the GEDCOM import finishes, the {{man label|[[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Import_Statistics_dialog|Import Statistics]]}} window and the '''{{man label|[[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#GEDCOM_import_report_dialog|GEDCOM import report:]]}}''' windows show any results or warnings.

{{-}}
==== GEDCOM Encoding dialog ====

[[File:GEDCOM-Encoding-dialog-50.png|right|200px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} GEDCOM Encoding - dialog]]

The {{man label|GEDCOM Encoding}} dialog will be shown when the GEDCOM file you are importing has identified itself as using the ANSEL encoding format. Sometimes, this is in error. If after the GEDCOM is imported you notice that your data contains unusual characters, undo the import, and override the character set by selecting a different encoding from the available list.

{{man label|Encoding:}}
* '''default'''
* ANSEL
* ANSI (iso-8859-1)
* ASCII
* UTF8

{{-}}

==== Import Statistics dialog ====
{{stub}}
[[File:GEDCOM-ImportStatistics-dialog-50.png|right|200px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Import Statistics - dialog]]
{{-}}

==== GEDCOM import report dialog ====
{{stub}}
[[File:GEDCOM-import-report-result-example-50.png|right|450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} GEDCOM import report - example results.]]

The '''{{man label|GEDCOM import report}}''' details most of the GEDCOM lines that were either ignored or could not be understood. These are most likely because they are not part of the GEDCOM 5.5.1 standard. (See [[GEDCOM Extensions]].) The contents of the GEDCOM line (or lines where there are continuation lines) are also shown. In some cases, the lines may not be exactly what is contained in the input GEDCOM file, because the line is reconstructed following some processing.
{{-}}

===== Reading the report =====

[[File:Source-Note-GEDCOMImportNote-example-50.png|right|450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} GEDCOM import note indicating omitted data attached to "Source>Note"(data from "GEDitCOM" - "GEDCOM 5.5 Torture Test Files"]]

Gramps uses a more advanced 'data model' than GEDCOM, therefore some data in GEDCOM cannot be imported into Gramps. (See [[Gramps and GEDCOM]].) The main exceptions are:
* Some GEDCOM attribute structures are treated as Gramps {{man label|[[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Attributes|Attributes]]}} and therefore many of the GEDCOM Primitive Elements cannot be stored.
* The DATA elements of a SOURCE_RECORD (indicating the events recorded and responsible agency) are ignored.
* Any source citations on notes are ignored.
* Many GEDCOM Primitive Elements do not have exactly corresponding data elements in Gramps, and they are therefore stored as {{man label|Attributes}} with appropriate names, normally the GEDCOM tag. This applies particularly to the header, submitter and submission GEDCOM records and particular fields like REFN, RFN, RIN and AFN.

Where data is listed as 'ignored', its omission is reported in the feedback at the end of import, and it is included in a {{man label|Note}} attached to a relevant object with a custom type of {{man label|GEDCOM import}}. See, for example, the Source object in the example screenshot.

Where data is listed as 'silently ignored', it is not reported and not included in a note. At present this may be regarded as something that has been missed by Gramps and should be raised as an issue.
{{-}}

==== GEDCOM import limitations ====

This section describes any GEDCOM data that cannot be directly represented in Gramps, and how it is handled. For additional information on the limits of GEDCOM imports (and exports), please read the section on [[Gramps and GEDCOM]].

===== HEADer, SUBMitter and SUBmissioN =====

Gramps has no direct representation of this data, and hence all information there has to be stored in other objects. Depending on a [[Gramps_5.1_Wiki_Manual_-_Settings#General|General preferences]] setting, a 'default source' object may be created. If this is created, then much of the data is stored in that {{man label|Source}}, or in {{man label|Repositories}} attached to that source.

HEADER:=
n HEAD {1:1}
+1 SOUR <APPROVED_SYSTEM_ID> {1:1} (Data item of the 'default source')
+2 VERS <VERSION_NUMBER> {0:1} (Data item of the 'default source')
+2 NAME <NAME_OF_PRODUCT> {0:1} (Data item of the 'default source')
+2 CORP <NAME_OF_BUSINESS> {0:1} (Repository of the 'default source')
+3 <<ADDRESS_STRUCTURE>> {0:1} (Repository of the 'default source')
+2 DATA <NAME_OF_SOURCE_DATA> {0:1} (Data item of the 'default source')
+3 DATE <PUBLICATION_DATE> {0:1} (Data item of the 'default source')
+3 COPR <COPYRIGHT_SOURCE_DATA> {0:1} (Data item of the 'default source')
+1 DEST <RECEIVING_SYSTEM_NAME> {0:1*} (Data item of the 'default source')
+1 DATE <TRANSMISSION_DATE> {0:1} (Data item of the 'default source')
+2 TIME <TIME_VALUE> {0:1} (Data item of the 'default source')
+1 SUBM @<XREF:SUBM>@ {1:1} (Data item of the 'default source')
(Also used to determine the SUBMITTER_RECORD)
(that should be stored as the database owner)
+1 SUBN @<XREF:SUBN>@ {0:1} (ignored)
+1 FILE <FILE_NAME> {0:1} (Data item of the 'default source')
+1 COPR <COPYRIGHT_GEDCOM_FILE> {0:1} (stored as the Publication information of the 'default source')
+1 GEDC {1:1}
+2 VERS <VERSION_NUMBER> {1:1} (Data item of the 'default source')
+2 FORM <GEDCOM_FORM> {1:1} (Data item of the 'default source')
+1 CHAR <CHARACTER_SET> {1:1} (Data item of the 'default source')
+2 VERS <VERSION_NUMBER> {0:1} (Data item of the 'default source')
+1 LANG <LANGUAGE_OF_TEXT> {0:1} (Data item of the 'default source')
+1 PLAC {0:1}
+2 FORM <PLACE_HIERARCHY> {1:1} (see below)
+1 NOTE <GEDCOM_CONTENT_DESCRIPTION> {0:1} (note attached to the 'default source')
+2 [CONT|CONC] <GEDCOM_CONTENT_DESCRIPTION> {0:M}

* NOTE: Submissions to the Family History Department for Ancestral
File submission or for clearing temple ordinances must use a
DESTination of ANSTFILE or TempleReady.

The PLAC FORM is stored internally and used to govern the interpretation of places (in accordance with the GEDCOM specification).

The SUBMISSION_RECORD (there should be only one, but this is not checked) is stored as a {{man label|Data}} item of the 'default source'

SUBMISSION_RECORD:=
n @<XREF:SUBN>@ SUBN {1:1]
+1 SUBM @<XREF:SUBM>@ {0:1}
+1 FAMF <NAME_OF_FAMILY_FILE> {0:1}
+1 TEMP <TEMPLE_CODE> {0:1}
+1 ANCE <GENERATIONS_OF_ANCESTORS> {0:1}
+1 DESC <GENERATIONS_OF_DESCENDANTS> {0:1}
+1 ORDI <ORDINANCE_PROCESS_FLAG> {0:1}
+1 RIN <AUTOMATED_RECORD_ID> {0:1}

SUBMITTER_RECORDs (there may be more than one) are stored as {{man label|Repository}} records attached to the 'default source' except as indicated in bold below. The SUBMITTER_RECORD that corresponds with the SUBM record in the HEADER is used to set the [[Gramps_5.1_Wiki_Manual_-_Tools#Edit_Database_Owner_Information|database owner]].

SUBMITTER_RECORD:=
n @<XREF:SUBM>@ SUBM {1:1}
+1 NAME <SUBMITTER_NAME> {1:1}
+1 <<ADDRESS_STRUCTURE>> {0:1}
'''+1 <<MULTIMEDIA_LINK>> {0:M}'''
'''+1 LANG <LANGUAGE_PREFERENCE> {0:3}'''
'''+1 RFN <SUBMITTER_REGISTERED_RFN> {0:1}'''
'''+1 RIN <AUTOMATED_RECORD_ID> {0:1}'''
+1 <<CHANGE_DATE>> {0:1}

* Mutimedia link is ignored
* LANG is ignored
* RFN and RIN are ignored

===== INDIvidual =====

The INDIVIDUAL_RECORD is stored as a Gramps {{man label|Person}} record, except as indicated in bold below.

INDIVIDUAL_RECORD: =
n @<XREF:INDI>@ INDI {1:1}
+1 RESN <RESTRICTION_NOTICE> {0:1}
+1 <<PERSONAL_NAME_STRUCTURE>> {0:M}
+1 SEX <SEX_VALUE> {0:1}
+1 <<INDIVIDUAL_EVENT_STRUCTURE>> {0:M}
'''+1 <<INDIVIDUAL_ATTRIBUTE_STRUCTURE>> {0:M}'''
+1 <<LDS_INDIVIDUAL_ORDINANCE>> {0:M}
+1 <<CHILD_TO_FAMILY_LINK>> {0:M}
+1 <<SPOUSE_TO_FAMILY_LINK>> {0:M}
'''+1 SUBM @<XREF:SUBM>@ {0:M}'''
+1 <<ASSOCIATION_STRUCTURE>> {0:M}
+1 ALIA @<XREF:INDI>@ {0:M}
'''+1 ANCI @<XREF:SUBM>@ {0:M}'''
'''+1 DESI @<XREF:SUBM>@ {0:M}'''
+1 <<SOURCE_CITATION>> {0:M}
+1 <<MULTIMEDIA_LINK>> {0:M}
+1 <<NOTE_STRUCTURE>> {0:M}
+1 RFN <PERMANENT_RECORD_FILE_NUMBER> {0:1}
+1 AFN <ANCESTRAL_FILE_NUMBER> {0:1}
+1 REFN <USER_REFERENCE_NUMBER> {0:M}
'''+2 TYPE <USER_REFERENCE_TYPE> {0:1}'''
+1 RIN <AUTOMATED_RECORD_ID> {0:1}
+1 <<CHANGE_DATE>> {0:1}

* Link to submitter, ancestor interest and descendent interest indicators are silently ignored.
* The alias indicator ("An indicator to link different record descriptions of a person who may be the same person") is stored as an {{man label|Association}} called 'Alias'.
* The REFN and REFN:TYPE are stored as {{man label|Attributes}} of the {{man label|Person}}, but if there is more than one REFN, it may not be clear which TYPE is associated with which REFN.

Handling of the INDIVIDUAL_ATTRIBUTE_STRUCTURE is rather complicated. The following tags:
* EDUC (Scholastic achievement),
* NMR (Count of marriages),
* OCCU (Occupation),
* PROP (Possessions),
* RELI (Religious affiliation),
* RESI and
* TITL (Nobility title)
are all treated as Gramps {{man label|Event}}s and the associated information is stored in the event structure. The details following the main tag (shown in brackets in the list above) are stored as the {{man label|Description}} of the {{man label|Event}}. The <EVENT_DESCRIPTOR> following the TYPE tag will overwrite the {{man label|Description}} if the <EVENT_DESCRIPTOR> is not the attribute name.

The following tags:
* CAST (Caste name),
* DSCR (Physical description),
* INDO (National ID Number),
* NATI (National or tribal origin),
* NCHI (Count of Children) and
* SSN (Social Security Number)
are all treated as Gramps {{man label|Attributes}}s and most of the fields except the details following the main tag (shown in brackets in the list above), the source citation and the note structure are ignored, as indicated in bold below.

INDIVIDUAL_ATTRIBUTE_STRUCTURE: =
n CAST <CASTE_NAME> {1:1}
+1 <<EVENT_DETAIL>> {0:1}
etc.

EVENT_DETAIL: =
'''n TYPE <EVENT_DESCRIPTOR> {0:1}'''
'''n DATE <DATE_VALUE> {0:1}'''
'''n <<PLACE_STRUCTURE>> {0:1}'''
'''n <<ADDRESS_STRUCTURE>> {0:1}'''
'''n AGE <AGE_AT_EVENT> {0:1}'''
'''n AGNC <RESPONSIBLE_AGENCY> {0:1}'''
'''n CAUS <CAUSE_OF_EVENT> {0:1}'''
n <<SOURCE_CITATION>> {0:M}
+1 <<NOTE_STRUCTURE>> {0:M}
+1 <<MULTIMEDIA_LINK>> {0:M}
'''n <<MULTIMEDIA_LINK>> {0:M}'''
n <<NOTE_STRUCTURE>> {0:M}

* Individual attribute structure, type, date, place structure, address structure, age, agency, cause and multimedia link are all ignored.

===== FAM_RECORD =====

The FAM_RECORD is stored as a Gramps {{man label|Family}} record.

FAM_RECORD:=
n @<XREF:FAM>@ FAM {1:1}
+1 <<FAMILY_EVENT_STRUCTURE>> {0:M}
+1 HUSB @<XREF:INDI>@ {0:1}
+1 WIFE @<XREF:INDI>@ {0:1}
+1 CHIL @<XREF:INDI>@ {0:M}
+1 NCHI <COUNT_OF_CHILDREN> {0:1}
+1 SUBM @<XREF:SUBM>@ {0:M}
+1 <<LDS_SPOUSE_SEALING>> {0:M}
+1 <<SOURCE_CITATION>> {0:M}
+1 <<MULTIMEDIA_LINK>> {0:M}
+1 <<NOTE_STRUCTURE>> {0:M}
+1 REFN <USER_REFERENCE_NUMBER> {0:M}
+2 TYPE <USER_REFERENCE_TYPE> {0:1}
+1 RIN <AUTOMATED_RECORD_ID> {0:1}
+1 <<CHANGE_DATE>> {0:1}

* The link to submitter is silently ignored.
* The REFN and REFN:TYPE are stored as {{man label|Attributes}} of the {{man label|Family}}, but if there is more than one REFN, it may not be clear which TYPE is associated with which REFN.

===== SOURCE_RECORD =====

The SOURCE_RECORD is stored as a Gramps {{man label|Source}} record, except as indicated in bold below.

SOURCE_RECORD:=
n @<XREF:SOUR>@ SOUR {1:1}
'''+1 DATA {0:1}'''
'''+2 EVEN <EVENTS_RECORDED> {0:M}'''
'''+3 DATE <DATE_PERIOD> {0:1}'''
'''+3 PLAC <SOURCE_JURISDICTION_PLACE> {0:1}'''
'''+2 AGNC <RESPONSIBLE_AGENCY> {0:1}'''
'''+2 <<NOTE_STRUCTURE>> {0:M}'''
+1 AUTH <SOURCE_ORIGINATOR> {0:1}
+2 [CONT|CONC] <SOURCE_ORIGINATOR> {0:M}
+1 TITL <SOURCE_DESCRIPTIVE_TITLE> {0:1}
+2 [CONT|CONC] <SOURCE_DESCRIPTIVE_TITLE> {0:M}
+1 ABBR <SOURCE_FILED_BY_ENTRY> {0:1}
+1 PUBL <SOURCE_PUBLICATION_FACTS> {0:1}
+2 [CONT|CONC] <SOURCE_PUBLICATION_FACTS> {0:M}
+1 TEXT <TEXT_FROM_SOURCE> {0:1}
+2 [CONT|CONC] <TEXT_FROM_SOURCE> {0:M}
+1 <<SOURCE_REPOSITORY_CITATION>> {0:1}
+1 <<MULTIMEDIA_LINK>> {0:M}
+1 <<NOTE_STRUCTURE>> {0:M}
+1 REFN <USER_REFERENCE_NUMBER> {0:M}
+2 TYPE <USER_REFERENCE_TYPE> {0:1}
+1 RIN <AUTOMATED_RECORD_ID> {0:1}
+1 <<CHANGE_DATE>> {0:1}

* DATA and its subsidiary records are ignored

===== REPOSITORY_RECORD =====

The REPOSITORY_RECORD is stored as a Gramps {{man label|Repository}} record, except as indicated in bold below.

REPOSITORY_RECORD: =
n @<XREF:REPO>@ REPO {1:1}
+1 NAME <NAME_OF_REPOSITORY> {0:1}
+1 <<ADDRESS_STRUCTURE>> {0:1}
+1 <<NOTE_STRUCTURE>> {0:M}
'''+1 REFN <USER_REFERENCE_NUMBER> {0:M}'''
'''+2 TYPE <USER_REFERENCE_TYPE> {0:1}'''
'''+1 RIN <AUTOMATED_RECORD_ID> {0:1}'''
+1 <<CHANGE_DATE>> {0:1}

* REFN, REFN:TYPE and RIN are ignored

===== MULTIMEDIA_RECORD =====

The MULTIMEDIA_RECORD is stored as a Gramps {{man label|Media}} record, except as indicated in bold below.

MULTIMEDIA_RECORD:=
n @<XREF:OBJE>@ OBJE {1:1}
+1 FORM <MULTIMEDIA_FORMAT> {1:1}
+1 TITL <DESCRIPTIVE_TITLE> {0:1}
+1 <<NOTE_STRUCTURE>> {0:M}
+1 <<SOURCE_CITATION>> {0:M}
'''+1 BLOB {1:1}'''
'''+2 CONT <ENCODED_MULTIMEDIA_LINE> {1:M}'''
+1 OBJE @<XREF:OBJE>@ /* chain to continued object */ {0:1}
'''+1 REFN <USER_REFERENCE_NUMBER> {0:M}'''
'''+2 TYPE <USER_REFERENCE_TYPE> {0:1}'''
'''+1 RIN <AUTOMATED_RECORD_ID> {0:1}'''

* It is expected that there will be a 'FILE' tag to indicate the file holding the multimedia object. This usage is taken from GEDCOM 5.5.1, but the ability in GEDCOM 5.5.1 to have more than one <MUTIMEDIA_FILE_REFN> and having the FORM, TYPE and TITL subsidiary to the FILE gedcom_line is not supported (a later FILE may overwrite an earlier one - there is no error checking).
* BLOB is ignored
* REFN, REFN:TYPE and RIN are ignored

===== NOTE_RECORD =====

The NOTE_RECORD is stored as a Gramps {{man label|Note}} record, except as indicated in bold below.

NOTE_RECORD:=
n @<XREF:NOTE>@ NOTE <SUBMITTER_TEXT> {1:1}
+1 [ CONC | CONT] <SUBMITTER_TEXT> {0:M}
'''+1 <<SOURCE_CITATION>> {0:M}'''
'''+1 REFN <USER_REFERENCE_NUMBER> {0:M}'''
'''+2 TYPE <USER_REFERENCE_TYPE> {0:1}'''
'''+1 RIN <AUTOMATED_RECORD_ID> {0:1}'''
+1 <<CHANGE_DATE>> {0:1}

* source citation ignored
* REFN, REFN:TYPE and RIN are ignored

== Exporting data ==

{{man note| Export is saving a copy |When you export, you are saving a copy of the currently opened database. Exporting creates another file with a copy of your data. Note that the database that remains opened in your Gramps window is NOT the file saved by your export. Additional editing of the currently opened database will not alter the copy produced by the export.}}

To export data, choose Menu {{man menu|Family Trees ->Export...}} or the [[Gramps_5.1_Wiki_Manual_-_Keybindings#|keybinding]] {{Man key press|CTRL|E}}. This will bring up the {{man label|[[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Export_Assistant_dialog|Export Assistant]]}} dialog.

Exporting allows you to share any portion of your Gramps Family Tree(database) with other researchers as well as to enable you to transfer your data to another computer.

Gramps can export data to the following file formats:
* Comma Separated Values Spreadsheet(CSV)
* GEDCOM
* GeneWeb
* Gramps [[XML]] (family tree)
* Gramps [[XML]] Package (family tree and media)
* Web Family Tree
* vCalendar
* vCard

{{-}}
===Export Assistant dialog===

The {{man label|Export Assistant}} pages will guide you through the output file format selection (see Fig 5.16), and file format specific export options. After the {{man label|Final confirmation}} page, the export will be performed according to the choices you have made. At any time, you can click the {{man button|Back}} button and revise any selection, and then go forward to redo the export.
{{-}}
==== Saving your data ====
[[File:ExportAssistant-SavingYourData-wizard-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Export Assistant: Saving your data - wizard start page]]

General information about exporting from Gramps.

Select the {{man button|Next}} button to continue.
{{stub}}
{{-}}

==== Choose the output format ====
[[File:ExportAssistant-ChooseTheOutputFormat-wizard-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Export Assistant - Choose the output format - wizard dialog]]

Select the file format to export your data to:
* [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Comma_Separated_Values_Spreadsheet.28CSV.29_export|Comma Separated Values Spreadsheet (CSV)]]
* GEDCOM
* GeneWeb
* '''Gramps [[Gramps XML|XML]] (family tree)'''(default)
* Gramps [[XML]] Package (family tree and media)
* Web Family Tree
* vCalendar
* vCard

Then select the {{man button|Next}} button to continue.
{{-}}

==== Export options ====
[[File:ExportAssistant-ExportOptions-CSV-defaults-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Export Assistant - Export Options - wizard dialog (showing defaults for "Comma Separated Values Spreadsheet(CSV)") with highlight Bottom section for File format specific options]]

After you have adjusted your options in the two sections.
* Top unlabeled section: [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Filters_and_privacy|Filters and privacy]]
* Bottom unlabeled section: [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#File_format_specific_export_options|File format specific options]]

Select the {{man button|Next}} button to continue.
{{-}}
=====Filters and privacy=====

Gramps allows you to export your selected Family tree into common file formats.

The following filters provide options that allow you to fine tune your export.

Filters allow you to export a limited amount of data, based on the criteria you select.

======Privacy Filter:======
{{man label|[✓] Do not include records marked private}}: Check this box to prevent private records from being included in the exported file. (Checkbox checked by default)

======Living Filter:======
These option restrict data and help limit the information exported for living people. This means that all information concerning their birth, death, addresses, significant events, etc., will be omitted in the exported file. For example, you can choose to substitute the word '''Living''' for the first name (see your [[Gramps_5.1_Wiki_Manual_-_Settings#Text|settings]]); you can exclude notes; and you can exclude sources for [[Gramps_5.1_Wiki_Manual_-_Probably_Alive|living people]].

Sometimes, it is not always obvious from the data if someone is actually alive. Gramps uses an advanced algorithm to try to determine [[Gramps_5.1_Wiki_Manual_-_Probably_Alive|if a person could still be alive]]. Remember, Gramps is making its best guess, and it may not always be able to guess correctly all the time. Please double check your data.

Select from the following options:
*{{man label|Include all selected people}} (default)
*{{man label|Replace given names of living people}}
*{{man label|Replace complete name of living people}}
*{{man label|Do not include living people}}

======Person Filter:======
Select from the following options:
*{{man label|Include all selected people}} (default)
*{{man label|Descendants of [Active Person]}}
*{{man label|Descendant Families of [Active Person]}}
*{{man label|Ancestors of [Active Person]}}
*{{man label|People with common ancestor with [Active Person]}}
* Create a custom filter by selecting the ''Edit icon'' to show the {{man label|[[Gramps_5.1_Wiki_Manual_-_Filters#Define_Filter_dialog|Define filter]]}} dialog.
======Note Filter:======
Select from the following options:
*{{man label|Include all selected notes}} (default)
* Create a custom filter by selecting the ''Edit icon'' to show the {{man label|[[Gramps_5.1_Wiki_Manual_-_Filters#Define_Filter_dialog|Define filter]]}} dialog.
======Reference Filter:======
Select from the following options:
*{{man label|Include all selected records}} (default)
*{{man label|Do not include records not linked to a selected person}}

=====File format specific export options=====

Depending on the file format chosen, you may find a number of file format specific export options to choose from listed underneath the "Filters and privacy" section.

See the relevant section for each of file formats listed that have specific export options:
* [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Comma_Separated_Values_Spreadsheet.28CSV.29_export|Comma Separated Values Spreadsheet (CSV)]]
* [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Gramps_XML_.28family_tree.29_export|Gramps XML (family tree)]]
{{stub}}

==== Select save file ====
[[File:ExportAssistant-SelectSaveFile-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Export Assistant - Select save file - wizard dialog - example]]

Enter a export file {{man label|Name:}} <code>Untitled_1.<file format extension></code>(default) and choose the folder location to save the export file to (normally your '''Documents''' folder.

Then select the {{man button|Next}} button to continue.

If you don't have permission to save the file to that location you will see the {{man label|Could not create ''<file location and export file name>''}} warning dialog and then the Export Assistants {{man label|Saving failed}} wizard dialog, select the {{man button|Close}} button and start the export again this time choosing a suitable folder.
{{-}}

==== Final confirmation ====
[[File:ExportAssistant-FinalConfirmation-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Export Assistant - Final confirmation - wizard dialog - example]]

The Export Assistants {{man label|Final confirmation}} wizard dialog allows you to check the summarized details (Format/Name/Folder) of the export file to be created.

At this point you can press {{man button|Back}} to revisit your options or {{man button|Cancel}} to abort.

Or select the {{man button|Apply}} button to continue.
{{-}}

==== Summary ====
[[File:ExportAssistant-YourDataHasBeenSaved-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Export Assistant - Summary - wizard dialog - example]]

The Export Assistants {{man label|Summary}} wizard dialog shows the ''Filename:'' and confirms that you export data has been saved successfully.

Select the {{man button|Close}} button to exit the Export Assistant.
{{-}}

=== Comma Separated Values Spreadsheet(CSV) export===

[[File:ExportAssistant-ExportOptions-CSV-defaults-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Export Assistant - Export Options - wizard dialog (showing defaults for "Comma Separated Values Spreadsheet(CSV)") with highlight Bottom section for File format specific options]]

Comma Separated Values Spreadsheet(CSV): Allows exporting (and importing) a subset of your Gramps data in a simple spreadsheet format.

See [[Gramps 5.1 Wiki Manual - Manage Family Trees: CSV Import and Export|CSV Import and Export]] for additional information and examples.

Comma Separated Values Spreadsheet(CSV) has the following [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#File_format_specific_export_options|file format specific export options]]:
* Include people -
* Include marriages -
* Include children -
* Include places -
* Translate headers -
{{-}}
Also, see [[Gramps_5.1_Wiki_Manual_-_Settings#Export_View|Export (List) View]] as Spreadsheet.

=== GEDCOM export ===

{{man note|Gramps supports the GEDCOM 5.5.1 version last updated 15 November 2019.}}

Gramps allows you to export a database into the common legacy {{man label|GEDCOM}} format.

For more information on the GEDCOM format see: :
* https://en.wikipedia.org/wiki/GEDCOM
* https://www.familysearch.org/developers/docs/guides/gedcom
* https://www.familysearch.org/developers/docs/gedcom/

See [[Gramps and GEDCOM]] for details of data which is not exported when exporting to GEDCOM ({{man menu|Use Gramps XML for a full family tree export/backup}}).

{{man label|GEDCOM}} export has no [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#File_format_specific_export_options|file format specific export options]].

{{man note|If you have installed the third party addon [[GEDCOM Extensions]](.GED2)|it will have its own specific file format specific export options.}}

{{stub}}
{{-}}

=== GeneWeb export===
{{man label|GeneWeb}} export will save a copy of your data to the GeneWeb genealogy format.

To find out more about GeneWeb and its format, visit:
* http://www.geneweb.org

{{man label|GenWeb}} has no [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#File_format_specific_export_options|file format specific export options]]
{{-}}

=== Gramps XML (family tree) export ===

{{man warn|Privacy Filters |It is important to verify your privacy options on Exporter. Do not enable filters or privacy options for Gramps XML backups.}}

[[File:ExportAssistant-ExportOptions-GrampsXMLFamilyTree-defaults-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Export Assistant - Export Options - wizard (showing defaults for "Gramps XML (family tree)") with highlight Bottom section for File format specific options]]

{{man label|Gramps [[XML]] (family tree)}} export (.gramps): This format is the standard format for data-exchange and backups (see the related .gpkg format below for full portability including media objects). Exporting into Gramps [[XML]] format will produce a portable database. As XML is a text-based human-readable format, you may also use it to take a look at your data. Gramps guarantees you can open XML output of older versions of Gramps in newer version of Gramps (not the other way around though!).

If a media file is not found during export, you will see the same {{man label|Missing Media}} dialog you encounter with GEDCOM export.

{{man label|Gramps XML (family tree)}} has the following [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#File_format_specific_export_options|file format specific export options]]:
* Use Compression -
{{-}}
==== What's not included: ====
{{Template:Backup Omissions}}

=== Gramps XML Package (family tree and media) export ===

{{man warn|Privacy Filters |It is important to verify your privacy options on Exporter. Do not enable filters or privacy options for Gramps XML backups.}}

{{man label|Gramps XML Package (family tree and media)}} export (.gpkg): Exporting to the Gramps package format will create a compressed file that contains the Gramps XML database and copies of all associated media files. This is useful if you want to move your database to another computer or to share it with someone.

If a media file is not found during export, you will see the same {{man label|Missing Media}} dialog you encounter with GEDCOM export.

{{man label|Gramps XML Package (family tree and media)}} has no [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#File_format_specific_export_options|file format specific export options]]

==== What's not included: ====

{{Template:Backup Omissions}}

=== Web Family Tree export===
{{man label|Web Family Tree}} export creates a text file that can be used by the '''Web Family Tree''' program.

To find out more about Web Family Tree and its format, visit
* http://www.simonward.com/cgi-bin/page.pl?family/tree

{{man label|Web Family Tree}} has no [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#File_format_specific_export_options|file format specific export options]]
{{-}}

=== vCalendar export ===

{{man label|vCalendar}} export saves information in the format used in many calendaring applications, sometimes called PIM for Personal Information Manager.

For more information on the vCalendar format see:
* https://en.wikipedia.org/wiki/ICalendar#vCalendar_1.0

{{man label|vCalendar}} has no [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#File_format_specific_export_options|file format specific export options]]
{{-}}

=== vCard export===
{{man label|vCard}} export saves information in a format used in many addressbook applications, sometimes called PIM for Personal Information Manager.

For more information on the vCard format see:
* https://en.wikipedia.org/wiki/VCard

{{man label|vCard}} has no [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#File_format_specific_export_options|file format specific export options]]
{{-}}

{{man index|Gramps 5.1 Wiki Manual - Categories|Gramps 5.1 Wiki Manual - Manage Family Trees: CSV Import and Export|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees}}
{{grampsmanualcopyright}}

[[Category:Documentation]]

Gramps 5.1 Wiki Manual - Keybindings

2020-08-04T16:46:37Z

Eponymous: /* Editor Tab bindings */ Fixing Mac assignments

{{man index|Gramps 5.1 Wiki Manual - FAQ|Gramps 5.1 Wiki Manual - Command Line|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Keybindings}}
{{#vardefine:chapter|B}}
{{#vardefine:figure|0}}
This appendix lists keybindings (also known as ''Keyboard shortcuts'' or ''hotkeys'') that can be used in the Gramps dialogs as an alternative to using the mouse.

Some keybindings require the user to press a single key or a sequence of keys one after the other. Other keybindings require pressing and holding several keys simultaneously.
== List Views ==
=== Common keybindings ===

{{man tip|Keyboards are not all the same!|
Keybindings may depend on the keyboard layout (localization) and on your computer’s Operating System.{{-}}
[[File:windows_180x160.png|128px]] [[File:macos_200x200.png|128px]] [[File:Linux_220x261.png|128px]] [[File:Bsd daemon.png|128px]]}}
The following keybindings are available in all category [[Gramps_Glossary#view|views]].
{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="1" | [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Starting_a_new_Family_Tree|Manage family trees]]
| |{{Man key press|Ctrl|O}}
| |{{Man key press|Cmd|O}}
| |{{Man key press|Ctrl|O}}
|-
| id="2" | [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Importing_data|Import family tree]]
| |{{Man key press|Ctrl|I}}
| |{{Man key press|Cmd|I}}
| |{{Man key press|Ctrl|I}}
|-
| id="3" | [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Exporting_data|Export family tree]]
| |{{Man key press|Ctrl|E}}
| |{{Man key press|Cmd|E}}
| |{{Man key press|Ctrl|E}}
|-
| id="4" | Changes to the next [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Categories|Category]].
| |{{Man key press|Ctrl|N}}
| |{{Man key press|Cmd|N}}
| |{{Man key press|Ctrl|N}}
|-
| id="5" |Changes to the previous [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Categories|Category]].
| |{{Man key press|Ctrl|P}}
| |{{Man key press|Cmd|P}}
| |{{Man key press|Ctrl|P}}
|-
| id="45" |Change [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Categories|Category]] to Category number 0/1/2/../9
| |{{Man key press|Ctrl|1}} {{Man key press|Ctrl|2}} {{Man key press|Ctrl|3}} ...
| |{{Man key press|Cmd|1}} {{Man key press|Cmd|2}} {{Man key press|Cmd|3}}..
| |{{Man key press|Ctrl|1}} {{Man key press|Ctrl|2}} {{Man key press|Ctrl|3}}..
|-
| id="6" |Within the Category changes the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Views|view]] to view mode number 0/1/2/../9
| |{{Man key press|Ctrl|Alt|1}} {{Man key press|Ctrl|Alt|2}} {{Man key press|Ctrl|Alt|3}} ...
| |{{Man key press|Cmd|Opt|1}} {{Man key press|Cmd|Opt|2}} {{Man key press|Cmd|Opt|3}}..
| |{{Man key press|Ctrl|Alt|1}} {{Man key press|Ctrl|Alt|2}} {{Man key press|Ctrl|Alt|3}}..
|-
| id="8" |[[Gramps_5.1_Wiki_Manual_-_Navigation#Using_the_Clipboard|Open the Clipboard]]
| |{{Man key press|Ctrl|B}}
| |{{Man key press|Cmd|B}}
| |{{Man key press|Ctrl|B}}
|-
| id="9" |Add the selected item as a [[Gramps_5.1_Wiki_Manual_-_Navigation#Bookmarks|bookmark]]
| |{{Man key press|Ctrl|D}}
| |{{Man key press|Cmd|D}}
| |{{Man key press|Ctrl|D}}
|-
| id="10" |[[Gramps_5.1_Wiki_Manual_-_Navigation#Bookmarks|Organize the bookmarks]]
| |{{Man key press|Shift|Ctrl|D}}
| |{{Man key press|Shift|Cmd|D}}
| |{{Man key press|Shift|Ctrl|D}}
|-
| id="11" |Open the {{man label|[[Gramps_5.1_Wiki_Manual_-_Navigation#Edit|Undo History]]}} dialog
| |{{Man key press|Ctrl|H}}
| |{{Man key press|Shift|Cmd|H}}
| |{{Man key press|Ctrl|H}}
|-
| id="12" |Jump to a [[Gramps_5.1_Wiki_Manual_-_Settings#ID_Formats|Gramps ID]]
| |{{Man key press|Ctrl|J}}
| |{{Man key press|Cmd|J}}
| |{{Man key press|Ctrl|J}}
|-
| id="13" |Move to previous item in history
| |{{Man key press|Alt|Left}} (Left arrow)
| |{{Man key press|Ctrl|Opt|Left}} (Left arrow)
| |{{Man key press|Alt|Left}} (Left arrow)
|-
| id="14" |Move to next item in history
| |{{Man key press|Alt|Right}} (Right arrow)
| |{{Man key press|Ctrl|Opt|Right}} (Right arrow)
| |{{Man key press|Alt|Right}} (Right arrow)
|-
| id="15" |Go to the '''[[Gramps_5.1_Wiki_Manual_-_Settings#Setting_Home_person|Home Person]]'''
| |{{Man key press|Alt|Home}}
| |
| |{{Man key press|Alt|Home}}
|-
| id="16" |Same action as the [[File:Gramps-config.png|20px]] Configure active view button
| |{{Man key press|Shift|Ctrl|C}}
| |{{Man key press|Shift|Cmd|C}}
| |{{Man key press|Shift|Ctrl|C}}
|-
| id="7" |Toggle the left gramplet sidebar ([[Gramps_5.1_Wiki_Manual_-_Main_Window#Navigator|Navigator]] panel)
| |{{Man key press|Ctrl|M}}
| |{{Man key press|Cmd|M}}
| |{{Man key press|Ctrl|M}}
|-
| id="17" |Toggle the right gramplet sidebar ([[Gramps_5.1_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|Sidebar]])
| |{{Man key press|Shift|Ctrl|R}}
| |{{Man key press|Shift|Cmd|R}}
| |{{Man key press|Shift|Ctrl|R}}
|-
| id="18" |Toggle the bottom gramplet sidebar ([[Gramps_5.1_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|Bottombar]])
| |{{Man key press|Shift|Ctrl|B}}
| |{{Man key press|Shift|Cmd|B}}
| |{{Man key press|Shift|Ctrl|B}}
|-
| id="19" |Undo
| |{{Man key press|Ctrl|Z}}
| |{{Man key press|Cmd|Z}}
| |{{Man key press|Ctrl|Z}}
|-
| id="20" |Do again
| |{{Man key press|Shift|Ctrl|Z}}
| |{{Man key press|Shift|Cmd|Z}}
| |{{Man key press|Shift|Ctrl|Z}}
|-
| id="21" |Quit Gramps
| |{{Man key press|Ctrl|Q}}
| |{{Man key press|Cmd|Q}}
| |{{Man key press|Ctrl|Q}}
|-
| id="xx" | [[Gramps_5.1_Wiki_Manual_-_Navigation#Add|Add/Create]] a new object (Opens the related Editor) Person Family Event Place Source Citation Repository Media Note
| | {{Man key press|Shift|Alt|P}} {{Man key press|Shift|Alt|F}} {{Man key press|Shift|Alt|E}} {{Man key press|Shift|Alt|L}} {{Man key press|Shift|Alt|S}} {{Man key press|Shift|Alt|C}} {{Man key press|Shift|Alt|R}} {{Man key press|Shift|Alt|M}} {{Man key press|Shift|Alt|N}}
| | {{Man key press|Shift|Ctrl|Opt|P}} {{Man key press|Shift|Ctrl|Opt|F}} {{Man key press|Shift|Ctrl|Opt|E}} {{Man key press|Shift|Ctrl|Opt|L}} {{Man key press|Shift|Ctrl|Opt|S}} {{Man key press|Shift|Ctrl|Opt|C}} {{Man key press|Shift|Ctrl|Opt|R}} {{Man key press|Shift|Ctrl|Opt|M}} {{Man key press|Shift|Ctrl|Opt|N}}
| | {{Man key press|Shift|Alt|P}} {{Man key press|Shift|Alt|F}} {{Man key press|Shift|Alt|E}} {{Man key press|Shift|Alt|L}} {{Man key press|Shift|Alt|S}} {{Man key press|Shift|Alt|C}} {{Man key press|Shift|Alt|R}} {{Man key press|Shift|Alt|M}} {{Man key press|Shift|Alt|N}}
|}

=== All List Views bindings ===

The following bindings are available in all list views: People, Families, Events, Places, Sources, Citations, Repositories, Media and Notes View.
{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
!Note
|-
| id="22" |Edits the selected list item
| |{{Man key press|Ctrl|Enter}}
| |
| |{{Man key press|Ctrl|Enter}}
| |
|-
| id="23" |Adds a new item to the database
| |{{Man key press|Ctrl|Insert}}
| |
| |{{Man key press|Ctrl|Insert}}
| |
|-
| id="24" |Deletes the selected list item
| |{{Man key press|Ctrl|Delete}}
| |
| |{{Man key press|Ctrl|Delete}}
| |
|-
| id="46" |Activate the {{man button|Find}} field
|!-- Microsoft Windows --> |{{Man key press|Ctrl|F}}
|!-- Mac OS --> |{{Man key press|Cmd|F}}
|!-- KDE/GNOME --> |{{Man key press|Ctrl|F}}
| | List view interactive search ahead / Quick search
|}

=== People View bindings ===

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="25" |Expands and hides entries of the selected surname in Group mode
| |{{Man key press|Enter}}
| |{{Man key press|Enter}}
| |{{Man key press|Enter}}
|}

==Editors==

=== Editor Tab bindings ===
These bindings work on the tab pages of the editors (so not on the labels of the tabs!, press tab on label to move to tabpage content).

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="26" |Same action as the {{icon|Stock_edit}} button when that button is present
| |{{Man key press|Enter}}
| |{{Man key press|Return}} or {{Man key press|Enter}}
| |{{Man key press|Enter}}
|-
| id="27" |Same action as the {{icon|Stock_add}} button when that button is present
| |{{Man key press|Insert}}
| |
| |{{Man key press|Insert}}
|-
| id="28" |Same action as the {{icon|Stock_remove}} button when that button is present
| |{{Man key press|Delete}}
| |
| |{{Man key press|Delete}}
|-
| id="29" |Same action as the {{man button|Share}} button when that button is present
| |{{Man key press|Ctrl|O}}
| |{{Man key press|Cmd|O}}
| |{{Man key press|Ctrl|O}}
|-
| id="30" |Change tabpage to the tabpage to the left
| |{{Man key press|Alt|Left}} (Left arrow)
| |{{Man key press|Ctrl|Opt|Left}} (Left arrow)
| |{{Man key press|Alt|Left}} (Left arrow)
|-
| id="31" |Change tabpage to the tabpage to the right
| |{{Man key press|Alt|Right}} (Right arrow)
| |{{Man key press|Ctlr|Opt|Right}} (Right arrow)
| |{{Man key press|Alt|Right}} (Right arrow)
|}

{|{{prettytable}}
!Action/Function
!Mouse Key
|-
| id="32" |Call up [https://en.wikipedia.org/wiki/Context_menu context menu] popup
!Right-click
|-
| id="33" |Same action as the {{icon|Stock_edit}} {{man button|Edit}} button when that button is present
!Double-click
|-
| id="34" |Common action that is not the same as {{icon|Stock_edit}} {{man button|Edit}} button. Eg: on Family Editor Child tab, edit child
!Middle-click
|}

=== Editor bindings ===
These bindings work on Editors by activating focus or by changing state of toggle buttons ([[Accessibility]]).

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="35" |Change the privacy status.
| |{{Man key press|Ctrl|P}}
| |{{Man key press|Cmd|P}}
| |{{Man key press|Ctrl|P}}
|-
| id="36" |Call the Date editor (if present).
| |{{Man key press|Ctrl|D}}
| |{{Man key press|Cmd|D}}
| |{{Man key press|Ctrl|D}}
|-
| id="37" |Activate the {{icon|Stock_add}} {{man button|Add}} button (if present).
| |{{Man key press|Ctrl|A}}
| |{{Man key press|Cmd|A}}
| |{{Man key press|Ctrl|A}}
|-
| id="38" |Activate the {{icon|Stock_edit}} {{man button|Edit}} button (if present).
| |{{Man key press|Ctrl|E}}
| |{{Man key press|Cmd|E}}
| |{{Man key press|Ctrl|E}}
|-
| id="39" |Activate the {{man button|Select}} button (if present).
| |{{Man key press|Ctrl|S}}
| |{{Man key press|Cmd|S}}
| |{{Man key press|Ctrl|S}}
|-
| id="40" |Activate the {{man button|Father}} button (if present).
| |{{Man key press|Ctrl|F}}
| |{{Man key press|Cmd|F}}
| |{{Man key press|Ctrl|F}}
|-
| id="41" |Activate the {{man button|Mother}} button (if present).
| |{{Man key press|Ctrl|M}}
| |{{Man key press|Cmd|M}}
| |{{Man key press|Ctrl|M}}
|}

==Handy Shortcuts==

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
!Note
|-
| id="42" |Full screen
|{{man key press|F11}}
|
|{{man key press|F11}}
|Maximises Gramps to use the Full screen
|-
| id="43" |Show this user manual
|{{man key press|F1}}
|{{man key press|F1}}
|{{man key press|F1}}
|
|-
| id="44" |Select the {{man button|OK}} button
|{{man key press|Alt}}+{{man key press|O}}
|
|
|Handy for use with low resolution screens
|-
| id="45" |Select the {{man button|Cancel}} button
|{{man key press|Esc}}
|{{Man key press|⎋ Esc}}
|
|Handy for use with low resolution screens
|}

== Context menu==
See [[Gramps_5.1_Wiki_Manual_-_Settings#Context_menu]]

== See also ==
* [http://en.wikipedia.org/wiki/Table_of_keyboard_shortcuts Table of keyboard shortcuts] - for major operating systems.

{{-}}
{{man index|Gramps 5.1 Wiki Manual - FAQ|Gramps 5.1 Wiki Manual - Command Line|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Keybindings}}
{{grampsmanualcopyright}}

[[Category:Documentation]]

Gramps 5.1 Wiki Manual - Keybindings

2020-08-04T16:37:23Z

Eponymous: /* Handy Shortcuts */ Setting macOS esc. Confirmed.

{{man index|Gramps 5.1 Wiki Manual - FAQ|Gramps 5.1 Wiki Manual - Command Line|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Keybindings}}
{{#vardefine:chapter|B}}
{{#vardefine:figure|0}}
This appendix lists keybindings (also known as ''Keyboard shortcuts'' or ''hotkeys'') that can be used in the Gramps dialogs as an alternative to using the mouse.

Some keybindings require the user to press a single key or a sequence of keys one after the other. Other keybindings require pressing and holding several keys simultaneously.
== List Views ==
=== Common keybindings ===

{{man tip|Keyboards are not all the same!|
Keybindings may depend on the keyboard layout (localization) and on your computer’s Operating System.{{-}}
[[File:windows_180x160.png|128px]] [[File:macos_200x200.png|128px]] [[File:Linux_220x261.png|128px]] [[File:Bsd daemon.png|128px]]}}
The following keybindings are available in all category [[Gramps_Glossary#view|views]].
{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="1" | [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Starting_a_new_Family_Tree|Manage family trees]]
| |{{Man key press|Ctrl|O}}
| |{{Man key press|Cmd|O}}
| |{{Man key press|Ctrl|O}}
|-
| id="2" | [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Importing_data|Import family tree]]
| |{{Man key press|Ctrl|I}}
| |{{Man key press|Cmd|I}}
| |{{Man key press|Ctrl|I}}
|-
| id="3" | [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Exporting_data|Export family tree]]
| |{{Man key press|Ctrl|E}}
| |{{Man key press|Cmd|E}}
| |{{Man key press|Ctrl|E}}
|-
| id="4" | Changes to the next [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Categories|Category]].
| |{{Man key press|Ctrl|N}}
| |{{Man key press|Cmd|N}}
| |{{Man key press|Ctrl|N}}
|-
| id="5" |Changes to the previous [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Categories|Category]].
| |{{Man key press|Ctrl|P}}
| |{{Man key press|Cmd|P}}
| |{{Man key press|Ctrl|P}}
|-
| id="45" |Change [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Categories|Category]] to Category number 0/1/2/../9
| |{{Man key press|Ctrl|1}} {{Man key press|Ctrl|2}} {{Man key press|Ctrl|3}} ...
| |{{Man key press|Cmd|1}} {{Man key press|Cmd|2}} {{Man key press|Cmd|3}}..
| |{{Man key press|Ctrl|1}} {{Man key press|Ctrl|2}} {{Man key press|Ctrl|3}}..
|-
| id="6" |Within the Category changes the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Views|view]] to view mode number 0/1/2/../9
| |{{Man key press|Ctrl|Alt|1}} {{Man key press|Ctrl|Alt|2}} {{Man key press|Ctrl|Alt|3}} ...
| |{{Man key press|Cmd|Opt|1}} {{Man key press|Cmd|Opt|2}} {{Man key press|Cmd|Opt|3}}..
| |{{Man key press|Ctrl|Alt|1}} {{Man key press|Ctrl|Alt|2}} {{Man key press|Ctrl|Alt|3}}..
|-
| id="8" |[[Gramps_5.1_Wiki_Manual_-_Navigation#Using_the_Clipboard|Open the Clipboard]]
| |{{Man key press|Ctrl|B}}
| |{{Man key press|Cmd|B}}
| |{{Man key press|Ctrl|B}}
|-
| id="9" |Add the selected item as a [[Gramps_5.1_Wiki_Manual_-_Navigation#Bookmarks|bookmark]]
| |{{Man key press|Ctrl|D}}
| |{{Man key press|Cmd|D}}
| |{{Man key press|Ctrl|D}}
|-
| id="10" |[[Gramps_5.1_Wiki_Manual_-_Navigation#Bookmarks|Organize the bookmarks]]
| |{{Man key press|Shift|Ctrl|D}}
| |{{Man key press|Shift|Cmd|D}}
| |{{Man key press|Shift|Ctrl|D}}
|-
| id="11" |Open the {{man label|[[Gramps_5.1_Wiki_Manual_-_Navigation#Edit|Undo History]]}} dialog
| |{{Man key press|Ctrl|H}}
| |{{Man key press|Shift|Cmd|H}}
| |{{Man key press|Ctrl|H}}
|-
| id="12" |Jump to a [[Gramps_5.1_Wiki_Manual_-_Settings#ID_Formats|Gramps ID]]
| |{{Man key press|Ctrl|J}}
| |{{Man key press|Cmd|J}}
| |{{Man key press|Ctrl|J}}
|-
| id="13" |Move to previous item in history
| |{{Man key press|Alt|Left}} (Left arrow)
| |{{Man key press|Ctrl|Opt|Left}} (Left arrow)
| |{{Man key press|Alt|Left}} (Left arrow)
|-
| id="14" |Move to next item in history
| |{{Man key press|Alt|Right}} (Right arrow)
| |{{Man key press|Ctrl|Opt|Right}} (Right arrow)
| |{{Man key press|Alt|Right}} (Right arrow)
|-
| id="15" |Go to the '''[[Gramps_5.1_Wiki_Manual_-_Settings#Setting_Home_person|Home Person]]'''
| |{{Man key press|Alt|Home}}
| |
| |{{Man key press|Alt|Home}}
|-
| id="16" |Same action as the [[File:Gramps-config.png|20px]] Configure active view button
| |{{Man key press|Shift|Ctrl|C}}
| |{{Man key press|Shift|Cmd|C}}
| |{{Man key press|Shift|Ctrl|C}}
|-
| id="7" |Toggle the left gramplet sidebar ([[Gramps_5.1_Wiki_Manual_-_Main_Window#Navigator|Navigator]] panel)
| |{{Man key press|Ctrl|M}}
| |{{Man key press|Cmd|M}}
| |{{Man key press|Ctrl|M}}
|-
| id="17" |Toggle the right gramplet sidebar ([[Gramps_5.1_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|Sidebar]])
| |{{Man key press|Shift|Ctrl|R}}
| |{{Man key press|Shift|Cmd|R}}
| |{{Man key press|Shift|Ctrl|R}}
|-
| id="18" |Toggle the bottom gramplet sidebar ([[Gramps_5.1_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|Bottombar]])
| |{{Man key press|Shift|Ctrl|B}}
| |{{Man key press|Shift|Cmd|B}}
| |{{Man key press|Shift|Ctrl|B}}
|-
| id="19" |Undo
| |{{Man key press|Ctrl|Z}}
| |{{Man key press|Cmd|Z}}
| |{{Man key press|Ctrl|Z}}
|-
| id="20" |Do again
| |{{Man key press|Shift|Ctrl|Z}}
| |{{Man key press|Shift|Cmd|Z}}
| |{{Man key press|Shift|Ctrl|Z}}
|-
| id="21" |Quit Gramps
| |{{Man key press|Ctrl|Q}}
| |{{Man key press|Cmd|Q}}
| |{{Man key press|Ctrl|Q}}
|-
| id="xx" | [[Gramps_5.1_Wiki_Manual_-_Navigation#Add|Add/Create]] a new object (Opens the related Editor) Person Family Event Place Source Citation Repository Media Note
| | {{Man key press|Shift|Alt|P}} {{Man key press|Shift|Alt|F}} {{Man key press|Shift|Alt|E}} {{Man key press|Shift|Alt|L}} {{Man key press|Shift|Alt|S}} {{Man key press|Shift|Alt|C}} {{Man key press|Shift|Alt|R}} {{Man key press|Shift|Alt|M}} {{Man key press|Shift|Alt|N}}
| | {{Man key press|Shift|Ctrl|Opt|P}} {{Man key press|Shift|Ctrl|Opt|F}} {{Man key press|Shift|Ctrl|Opt|E}} {{Man key press|Shift|Ctrl|Opt|L}} {{Man key press|Shift|Ctrl|Opt|S}} {{Man key press|Shift|Ctrl|Opt|C}} {{Man key press|Shift|Ctrl|Opt|R}} {{Man key press|Shift|Ctrl|Opt|M}} {{Man key press|Shift|Ctrl|Opt|N}}
| | {{Man key press|Shift|Alt|P}} {{Man key press|Shift|Alt|F}} {{Man key press|Shift|Alt|E}} {{Man key press|Shift|Alt|L}} {{Man key press|Shift|Alt|S}} {{Man key press|Shift|Alt|C}} {{Man key press|Shift|Alt|R}} {{Man key press|Shift|Alt|M}} {{Man key press|Shift|Alt|N}}
|}

=== All List Views bindings ===

The following bindings are available in all list views: People, Families, Events, Places, Sources, Citations, Repositories, Media and Notes View.
{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
!Note
|-
| id="22" |Edits the selected list item
| |{{Man key press|Ctrl|Enter}}
| |
| |{{Man key press|Ctrl|Enter}}
| |
|-
| id="23" |Adds a new item to the database
| |{{Man key press|Ctrl|Insert}}
| |
| |{{Man key press|Ctrl|Insert}}
| |
|-
| id="24" |Deletes the selected list item
| |{{Man key press|Ctrl|Delete}}
| |
| |{{Man key press|Ctrl|Delete}}
| |
|-
| id="46" |Activate the {{man button|Find}} field
|!-- Microsoft Windows --> |{{Man key press|Ctrl|F}}
|!-- Mac OS --> |{{Man key press|Cmd|F}}
|!-- KDE/GNOME --> |{{Man key press|Ctrl|F}}
| | List view interactive search ahead / Quick search
|}

=== People View bindings ===

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="25" |Expands and hides entries of the selected surname in Group mode
| |{{Man key press|Enter}}
| |{{Man key press|Enter}}
| |{{Man key press|Enter}}
|}

==Editors==

=== Editor Tab bindings ===
These bindings work on the tab pages of the editors (so not on the labels of the tabs!, press tab on label to move to tabpage content).

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="26" |Same action as the {{icon|Stock_edit}} button when that button is present
| |{{Man key press|Enter}}
| |{{Man key press|Enter}}
| |{{Man key press|Enter}}
|-
| id="27" |Same action as the {{icon|Stock_add}} button when that button is present
| |{{Man key press|Insert}}
| |
| |{{Man key press|Insert}}
|-
| id="28" |Same action as the {{icon|Stock_remove}} button when that button is present
| |{{Man key press|Delete}}
| |
| |{{Man key press|Delete}}
|-
| id="29" |Same action as the {{man button|Share}} button when that button is present
| |{{Man key press|Ctrl|O}}
| |{{Man key press|Cmd|O}}
| |{{Man key press|Ctrl|O}}
|-
| id="30" |Change tabpage to the tabpage to the left
| |{{Man key press|Alt|Left}} (Left arrow)
| |{{Man key press|Ctrl|Alt|Left}} (Left arrow)
| |{{Man key press|Alt|Left}} (Left arrow)
|-
| id="31" |Change tabpage to the tabpage to the right
| |{{Man key press|Alt|Right}} (Right arrow)
| |{{Man key press|Ctlr|Alt|Right}} (Right arrow)
| |{{Man key press|Alt|Right}} (Right arrow)
|}

{|{{prettytable}}
!Action/Function
!Mouse Key
|-
| id="32" |Call up [https://en.wikipedia.org/wiki/Context_menu context menu] popup
!Right-click
|-
| id="33" |Same action as the {{icon|Stock_edit}} {{man button|Edit}} button when that button is present
!Double-click
|-
| id="34" |Common action that is not the same as {{icon|Stock_edit}} {{man button|Edit}} button. Eg: on Family Editor Child tab, edit child
!Middle-click
|}

=== Editor bindings ===
These bindings work on Editors by activating focus or by changing state of toggle buttons ([[Accessibility]]).

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="35" |Change the privacy status.
| |{{Man key press|Ctrl|P}}
| |{{Man key press|Cmd|P}}
| |{{Man key press|Ctrl|P}}
|-
| id="36" |Call the Date editor (if present).
| |{{Man key press|Ctrl|D}}
| |{{Man key press|Cmd|D}}
| |{{Man key press|Ctrl|D}}
|-
| id="37" |Activate the {{icon|Stock_add}} {{man button|Add}} button (if present).
| |{{Man key press|Ctrl|A}}
| |{{Man key press|Cmd|A}}
| |{{Man key press|Ctrl|A}}
|-
| id="38" |Activate the {{icon|Stock_edit}} {{man button|Edit}} button (if present).
| |{{Man key press|Ctrl|E}}
| |{{Man key press|Cmd|E}}
| |{{Man key press|Ctrl|E}}
|-
| id="39" |Activate the {{man button|Select}} button (if present).
| |{{Man key press|Ctrl|S}}
| |{{Man key press|Cmd|S}}
| |{{Man key press|Ctrl|S}}
|-
| id="40" |Activate the {{man button|Father}} button (if present).
| |{{Man key press|Ctrl|F}}
| |{{Man key press|Cmd|F}}
| |{{Man key press|Ctrl|F}}
|-
| id="41" |Activate the {{man button|Mother}} button (if present).
| |{{Man key press|Ctrl|M}}
| |{{Man key press|Cmd|M}}
| |{{Man key press|Ctrl|M}}
|}

==Handy Shortcuts==

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
!Note
|-
| id="42" |Full screen
|{{man key press|F11}}
|
|{{man key press|F11}}
|Maximises Gramps to use the Full screen
|-
| id="43" |Show this user manual
|{{man key press|F1}}
|{{man key press|F1}}
|{{man key press|F1}}
|
|-
| id="44" |Select the {{man button|OK}} button
|{{man key press|Alt}}+{{man key press|O}}
|
|
|Handy for use with low resolution screens
|-
| id="45" |Select the {{man button|Cancel}} button
|{{man key press|Esc}}
|{{Man key press|⎋ Esc}}
|
|Handy for use with low resolution screens
|}

== Context menu==
See [[Gramps_5.1_Wiki_Manual_-_Settings#Context_menu]]

== See also ==
* [http://en.wikipedia.org/wiki/Table_of_keyboard_shortcuts Table of keyboard shortcuts] - for major operating systems.

{{-}}
{{man index|Gramps 5.1 Wiki Manual - FAQ|Gramps 5.1 Wiki Manual - Command Line|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Keybindings}}
{{grampsmanualcopyright}}

[[Category:Documentation]]

User talk:Sam888

2020-08-04T15:46:06Z

Eponymous: /* Update MacOS page? */ new section

= Portuguese Translations issues =
== Mixed translations? ==

Hi,

I think there maybe a mistake here.

Both the Index page and the Preface page I reviewed were translated to Brazilian.
Is this intentional? If it is, I would need a different page set for Portuguese (maybe named Portugal?).
I wouldn't want to destroy anybody's work.

Thank you. [[User:Pmra]]

:: Spotted this that may interest you [https://gramps-project.org/bugs/view.php?id=10205 New manual/wiki language add ISO pt_PT for Portugal translations.] [[User:GulliblePangolin|GulliblePangolin]] ([[User talk:GulliblePangolin|talk]]) 00:26, 29 March 2020 (UTC)

::: Yes, it seems the same problem. So, what should I do, continue editing or wait for a new set of pages?[[User:Pmra]]

== Please Reverse Contributions ==

Hi,

I probably messed up the pages.
Could I ask you to revert all my contributions to the old state (Brazilian translations) and create a blank index page for Portugal?
I'm not sure I can do it and not very willing to try.

Many thanks in advance.
[[User:Pmra]]

:: I'll take another look in at it tomorrow and work out what needs to be done. [[User:Sam888|Sam888]] ([[User talk:Sam888|talk]]) 02:55, 6 April 2020 (UTC)

== Reverse Revertions? ==

Hi Sam,

I knew that the editing was in old revisions of the wiki. It was an opportunity to reduce the clutter in the current Category indices. Particularly important was consolidating the mis-categorized non-english pages. (Both so they didn't obstruct browsing by the English-only users and so the non-English speakers could find all the translated pages in their language.) The Category indices are almost unnavigable.

Isn't this a forgivable modification of historic pages?

Warm regards
[[User:Bamaustin|Bamaustin]] ([[User talk:Bamaustin|talk]]) 04:49, 6 April 2020 (UTC)
=Reminder to add when you can pretty please :)=
[[User_talk:GulliblePangolin#Add_Wikipedia:Citation_templates]]
[[User:GulliblePangolin|GulliblePangolin]] ([[User talk:GulliblePangolin|talk]]) 02:34, 14 May 2020 (UTC)
:Ok, on my list, as mentioned cannot promise a eta apart from within 6 months, [[User:Sam888|Sam888]] ([[User talk:Sam888|talk]]) 00:16, 16 May 2020 (UTC)

=Mediawiki request:Lua Script=
Hi Sam888, When you have a moment can you consider installing Lua script so we can use the current generation of templates from mediawiki/wikipedia some of the benefits are improved performance and simpler to program the templates. [[User:Daleathan|Daleathan]] ([[User talk:Daleathan|talk]]) 23:37, 29 May 2020 (UTC)
:: Ok I'd like this installed also please. Attempted to bring a template across from wikipedia and found out LUA was not installed here. --[[User:Gioto|Gioto]] ([[User talk:Gioto|talk]]) 22:45, 14 July 2020 (UTC)

Wouldn't a full implementation of Lua script interpreter require a huge commitment to adding Security, monitoring for malware and server overloads? Since it is user programming, it would probably also need a testbed site to minimize the risk of crashing the public site. There DOES seem to be a safer intermediate option where Lua Script can be used like a compiler to generate debugged static templates.

It seems like a more widely leveraged investment would be to add a more modern WYSIWYG page content editor. (Since the [https://www.mediawiki.org/wiki/Editor#Former javascript-based MediaWiki editor] we're currently using was deprecated in January!)

[[User:Bamaustin|Bamaustin]] ([[User talk:Bamaustin|talk]]) 23:46, 14 July 2020 (UTC)

:::I'll investigate if this is possible on our current hosting plan and if Gramp-project really needs to use LUA. (We are currently using MediaWiki 1.31.3 and that editor was removed in MediaWiki 1.32.x ) [[User:Sam888|Sam888]] ([[User talk:Sam888|talk]]) 00:35, 16 July 2020 (UTC)
::::Hi @Sam888 Thanks for the consideration to investigate. @Bamaustin I've no opinion about Lua and the commitment required security wise. Not sure how a replacement editor will help in my case as the template I was bringing over works outside of CSS code. Both your efforts are appreciated --[[User:Gioto|Gioto]] ([[User talk:Gioto|talk]]) 03:12, 16 July 2020 (UTC)

: Hi Sam888, some the reasons why I want LUA are mentioned on my talk page, thanks anyway --[[User:Daleathan|Daleathan]] ([[User talk:Daleathan|talk]]) 09:29, 20 July 2020 (UTC)

== Update MacOS page? ==

I'm happy to add some updates to the out-of-date [[Download#Mac_OS_X]] page. [[User:Eponymous|Eponymous]] ([[User talk:Eponymous|talk]]) 15:46, 4 August 2020 (UTC)

Gramps 5.1 Wiki Manual - User Directory

2020-08-04T15:32:44Z

Eponymous: /* POSIX - style systems */ MacOS terminology

{{man index|Gramps_5.1_Wiki_Manual_-_Command_Line#Environment_variables|Gramps 5.1 Wiki Manual - Error and Warning Reference|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_User_Directory}}
{{#vardefine:chapter|D}}
{{#vardefine:figure|0}}
This appendix provides the reference to the '''Gramps user directory''' available on various operating systems.

{{man note|The location of your '''Gramps user directory''' depends on the operating system you are using and how you have set up your computer.|Where '''''<code><~username></code>''''' is shown below it should be replaced by the name you use to log in to your computer.}}

__TOC__
== [[Gramps_Glossary#posix|POSIX]] - style systems ==
The default user directory location for Gramps in a [https://wikipedia.org/wiki/Posix POSIX]-style [https://wikipedia.org/wiki/Filesystem_Hierarchy_Standard environment] is:

/HOME/'''''<username>'''''/.gramps
which can also be entered as
'''''<~username>'''''/.gramps

This is true for [https://wikipedia.org/wiki/Bsd BSD], [https://wikipedia.org/wiki/Linux Linux], [https://wikipedia.org/wiki/Solaris_(operating_system) Solaris], [https://wikipedia.org/wiki/Unix Unix] and [https://wikipedia.org/wiki/Mac_OS_X Mac OS-X] when using [[Build_from_source#Mac_OS_X|Mac OS X Build from source]].

Alternately, you can leverage the '''$HOME''' [http://www.linfo.org/home_directory.html Home directory equivalent] to avoid dealing the complications of active user names. Although Gramps will not recognize directory equivalents for paths internally, you can use them within Linux to find Gramps user files. The '''Gramps user directory''' path above is simplified to either:

$HOME/.gramps
or
~/.gramps

Or if using MS Windows the following syntax is used

$HOME\.gramps
or
~\.gramps

=== MacOS ===
[[File:macos_200x200.png|right|128px|link=Download#macOS]]
On Apple Macs filenames starting with "." do not show up in Finder. To simplify access to the Gramps user directory, open a terminal window using the Terminal application and type:
ln -s ~/.gramps ~/Documents/Gramps
which will make Finder show the directory as a folder in your Documents folder named "Gramps". (You can replace "Gramps" with whatever name you wish, but use a / before any spaces.) Alternatively you can simply click on [https://osxdaily.com/2011/08/31/go-to-folder-useful-mac-os-x-keyboard-shortcut/ {{man menu|Go -> 'Go to Folder...'}}] in the Finder, and type
~/.gramps
in the resulting macOS {{man label|Go to the Folder}} dialog box.

====MacOS Application Package====
The [[Mac OS X:Application package]] uses a different, more MacOS-standard default location for the directory:
/Users/'''''<~username>'''''/Library/Application Support/gramps

== MS Windows ==
[[File:windows_180x160.png|right|128px|link=Download#MS_Windows]]On Microsoft Windows, filenames and folder for programs and userdata are [https://wikipedia.org/wiki/Hidden_file_and_hidden_directory hidden] in the ''File Explorer''. To make access to the Gramps user directory easy follow the following advice from Microsoft:
* [https://support.microsoft.com/en-ca/help/14201/windows-show-hidden-files Show hidden files - Windows Help]

The default location for an installation on a Windows 7 (and newer) system is
C:\Program Files\GrampsAIO64-5.X.X
or
C:\Program Files (x86)\GrampsAIO32-5.X.X

The default location for any Gramps user data on a Windows 7 (and newer) system is
C:\Users\'''''<~username>'''''\AppData\Roaming\gramps

Alternately, you can leverage the '''%AppData%''' [https://wikipedia.org/wiki/Environment_variable#APPDATA environment variable] to avoid dealing the complications of active user names. Although Gramps will not recognize Environment Variables for paths internally, you can use them within Windows to find Gramps user files. The '''Gramps user directory''' path above is simplified to:
%AppData%\gramps
{{-}}
== See Also ==
*[[Gramps_5.1_Wiki_Manual_-_Command_Line|Command Line]] Configuration (config) option

*{{man index|Gramps_5.1_Wiki_Manual_-_Command_Line#Environment_variables|Gramps 5.1 Wiki Manual - Error and Warning Reference|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_User_Directory}}
{{grampsmanualcopyright}}
[[Category:Documentation|U]]

Mac OS X:Application package

2020-08-04T15:24:25Z

Eponymous: /* Installing Gramps */ Updating

This page describes the installation of the ready-to-run Gramps application for Mac OS X. This is also known as the GTK-OSX port of Gramps for Mac. It is a single, stand-alone bundle which uses the native quartz windowing system of Mac OS X instead of X11.

== Before installation ==

'''MacOS versions''' Gramps 5.0 requires Mac OS X 10.9 (Mavericks) and later. Gramps 5.1 requires at least Mac OS X 10.10 (Yosemite).

'''Back up your databases:''' If you're using Time Machine, that's already taken care of. (You do test your Time Machine backups periodically, right?) But it doesn't hurt to have a spare copy set aside before starting up a new version. If you've been using the Gtk-OSX build, version 3.2.4 or later, just copy Library/Application Support/gramps/grampsdb. (Right click/option click and select "Make a copy" from the menu. It will be named grampsdb(2).

'''New Version Notice:''' If you are upgrading from the pre-built Gramps Application version 3.2.3 or earlier (or a build from source version) and you want to keep your old database and settings, you'll need to create a Library/Application Support/gramps folder with your existing data in it. Unless you've changed the location in Preferences, the data is in a hidden folder in your home directory called ".gramps". Select a Finder window and select Go>Go to Folder from the menu. Type "/Users/yourname/.gramps" in the dialog box that opens up, and click on "Go". (Yes, subsitute your userid for "yourname".) The hidden folder will appear, highlighted and open. Option-drag the whole thing to Library/Application Support (the one in your home folder, not the one in your boot drive's "root" directory). Slow-double-click on the new copy so that you can edit the name and delete the '.' at the beginning to unhide it.

== Installing Gramps ==

From the '''[[Download#Mac_OS_X]]''' page download the dmg. Once it's downloaded, you can open the file (just double click on it in Finder if your browser doesn't open it automatically) and drag the Gramps application wherever you like. Once installed on your computer, it opens like any other application.

'''Links with other programs:''' Double clicking an image in the media reference editor should bring up Apple Preview (or a whatever program you've set as the default to edit that kind of image) to view the image. Clicking the view button in an internet reference should bring up the URL in the default browser. Clicking the Google Maps button in the Places display should bring up the map in the browser.

Gramps doesn't use the X11 Mac package. It's useful to install [http://www.documentfoundation.org/download/ LibreOffice], [http://www.calligra-suite.org/ Calligra] (or [http://www.neooffice.org/ NeoOffice], a more mac-friendly version) to work on your reports after saving them from Gramps.

== What goes where ==

'''File structure:''' Gramps database and settings files can be found at the following places in the Mac file system (Gramps Version 3.2.5 and later): 
* The Gramps database with the user's genealogical information is stored under /Users/<username>/Library/Application Support/gramps/grampsdb. 
* Setting files (ini-files) are found here: /Users/<username>/Library/Application Support/gramps/gramps32 
* Start-up settings for Gramps (for e. g. the environment variable LANG) can be accessed through Gramps.app (generally in /Applications): Right click on "Gramps.app", select "Show Package Content" from the menu, the start-up settings are found in the file Contents/MacOS/Gramps.

== Advanced setup ==

If Gramps has the appropriate translation, calendar, etc. it will honor the settings in System Preferences>Language and Region provided that the combination results in a locale that exists in /usr/share/locale. It will always fall back to English if it can't figure out your Language & Region settings. Some examples: French and France, Belgium, or Canada work fine, as do German and Germany or Switzerland and Dutch and Netherlands or Belgium. German and France doesn't work, nor does Dutch and Switzerland.

If you want to run Gramps with different locale settings than you use for your system settings, you can use the "defaults" program from Terminal.app (Applications:Utilities:Terminal.app):
defaults write -app Gramps AppleLocale "de_DE"
to set Gramps to operate in German with German calendar and formatting.

To read the setting use:
defaults read -app Gramps
this gave "Can't determine domain name for application Gramps; defaults unchanged" for me; if you have problems you can use
defaults read org.gramps-project.gramps

The settings are stored in ~/Library/Preferences/org.gramps-project.gramps.plist

To remove the special settings
defaults delete -app Gramps AppleLanguages (or AppleLocale or AppleCollation).

Note that you will need to run Gramps at least once before the defaults system will recognize its existence; before that trying to use defaults will produce an error about there being no Gramps application.

[[Howto:Change the language of reports]] has more information on language features in Gramps. When reading it, remember that AppleLanguages (which corresponds to the language list on the Languages & Text system preference pane) sets the LANGUAGE environment variable and AppleLocale (Formats in the Languages & Test pane) sets the LANG variable.

=== Dictionaries ===
The spelling checker uses MySpell dictionaries -- the same ones that [http://www.documentfoundation.org/download/ LibreOffice] and NeoOffice use. Unfortunately, they bury them in their application bundles, so you can download them [http://archive.services.openoffice.org/pub/mirror/OpenOffice.org/contrib/dictionaries/ here]. You need to install them in /Library/Dictionaries, and you'll need to authenticate as an administrator to do so. If you have one of them installed and know how to make symbolic links from the command line, you'll find them in Contents/share/uno_packages/cache/uno_packages, scattered about in the hash-named directories. You'll need to link both the aff and dic files (e.g., en_US.aff and en_US.dic).

== Bugs ==

=== If something seems to go wrong ===

You'll find error messages in the console log, which you can view with /Applications/Utilities/Console.app

All of the known bugs in previous version have been corrected in Gramps {{Version_Mac}} and later. There will no doubt be new ones; report them in the usual way on [http://www.gramps-project.org/bugs/my_view_page.php Mantis] ([[Using the bug tracker]] instructions). When reporting what you're sure is an OSX specific bug, please set the Platform field to "mac" (no quotes, caps, or spaces!) so that I can find it easily.

Previous Gramps version 3.2.4, bugs are described at [[Mac OS X:Build from source:gtk-osx:bugs]].

== Updates ==

Gramps stores all its internal data in ~/Library/Application Support. So, to upgrade a Gramps application bundle to a newer version, just throw the old application in the Trash. Make a backup copy of your data, just in case, then download the new version of the application and just use it. If you don't like the new version and want the old one back, throw the new version in the Trash and fetch the old one back from the Trash. The Gramps version is shown in Finder if you use column view; otherwise right click on it and select Get Info.

[[Category:Developers/Packaging]]
[[Category:Documentation]]

Gramps 5.1 Wiki Manual - User Directory

2020-08-04T15:22:34Z

Eponymous: /* Mac OS X */ changed file name, put it in the more appropriate Documents folder, and was more specific about outcome.

{{man index|Gramps_5.1_Wiki_Manual_-_Command_Line#Environment_variables|Gramps 5.1 Wiki Manual - Error and Warning Reference|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_User_Directory}}
{{#vardefine:chapter|D}}
{{#vardefine:figure|0}}
This appendix provides the reference to the '''Gramps user directory''' available on various operating systems.

{{man note|The location of your '''Gramps user directory''' depends on the operating system you are using and how you have set up your computer.|Where '''''<code><~username></code>''''' is shown below it should be replaced by the name you use to log in to your computer.}}

__TOC__
== [[Gramps_Glossary#posix|POSIX]] - style systems ==
The default user directory location for Gramps in a [https://wikipedia.org/wiki/Posix POSIX]-style [https://wikipedia.org/wiki/Filesystem_Hierarchy_Standard environment] is:

/HOME/'''''<username>'''''/.gramps
which can also be entered as
'''''<~username>'''''/.gramps

This is true for [https://wikipedia.org/wiki/Bsd BSD], [https://wikipedia.org/wiki/Linux Linux], [https://wikipedia.org/wiki/Solaris_(operating_system) Solaris], [https://wikipedia.org/wiki/Unix Unix] and [https://wikipedia.org/wiki/Mac_OS_X Mac OS-X] when using [[Build_from_source#Mac_OS_X|Mac OS X Build from source]].

Alternately, you can leverage the '''$HOME''' [http://www.linfo.org/home_directory.html Home directory equivalent] to avoid dealing the complications of active user names. Although Gramps will not recognize directory equivalents for paths internally, you can use them within Linux to find Gramps user files. The '''Gramps user directory''' path above is simplified to either:

$HOME/.gramps
or
~/.gramps

Or if using MS Windows the following syntax is used

$HOME\.gramps
or
~\.gramps

=== Mac OS X ===
[[File:macos_200x200.png|right|128px|link=Download#macOS]]
On Apple Macs running OS X, filenames starting with "." do not show up in Finder. To simplify access to the Gramps user directory, open a terminal window using the Terminal application and type:
ln -s ~/.gramps ~/Documents/Gramps
which will make Finder show the directory as a folder in your Documents folder named "Gramps". (You can replace "Gramps" with whatever name you wish, but use a / before any spaces.) Alternatively you can simply click on [https://osxdaily.com/2011/08/31/go-to-folder-useful-mac-os-x-keyboard-shortcut/ {{man menu|Go -> 'Go to Folder...'}}] in the Finder, and type
~/.gramps
in the resulting macOS {{man label|Go to the Folder}} dialog box.

The [[Mac OS X:Application package]] uses a different, more MacOS-standard default location for the directory:
/Users/'''''<~username>'''''/Library/Application Support/gramps

== MS Windows ==
[[File:windows_180x160.png|right|128px|link=Download#MS_Windows]]On Microsoft Windows, filenames and folder for programs and userdata are [https://wikipedia.org/wiki/Hidden_file_and_hidden_directory hidden] in the ''File Explorer''. To make access to the Gramps user directory easy follow the following advice from Microsoft:
* [https://support.microsoft.com/en-ca/help/14201/windows-show-hidden-files Show hidden files - Windows Help]

The default location for an installation on a Windows 7 (and newer) system is
C:\Program Files\GrampsAIO64-5.X.X
or
C:\Program Files (x86)\GrampsAIO32-5.X.X

The default location for any Gramps user data on a Windows 7 (and newer) system is
C:\Users\'''''<~username>'''''\AppData\Roaming\gramps

Alternately, you can leverage the '''%AppData%''' [https://wikipedia.org/wiki/Environment_variable#APPDATA environment variable] to avoid dealing the complications of active user names. Although Gramps will not recognize Environment Variables for paths internally, you can use them within Windows to find Gramps user files. The '''Gramps user directory''' path above is simplified to:
%AppData%\gramps
{{-}}
== See Also ==
*[[Gramps_5.1_Wiki_Manual_-_Command_Line|Command Line]] Configuration (config) option

*{{man index|Gramps_5.1_Wiki_Manual_-_Command_Line#Environment_variables|Gramps 5.1 Wiki Manual - Error and Warning Reference|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_User_Directory}}
{{grampsmanualcopyright}}
[[Category:Documentation|U]]

Gramps 5.1 Wiki Manual - Keybindings

2020-04-26T13:46:35Z

Eponymous: /* Common keybindings */ Adding Mac Option key

{{man index|Gramps 5.1 Wiki Manual - FAQ|Gramps 5.1 Wiki Manual - Command Line|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Keybindings}}
{{#vardefine:chapter|B}}
{{#vardefine:figure|0}}
This appendix lists keybindings (also known as ''Keyboard shortcuts'' or ''hotkeys'') that can be used in the Gramps dialogs as an alternative to using the mouse.

Some keybindings require the user to press a single key or a sequence of keys one after the other. Other keybindings require pressing and holding several keys simultaneously. Keybindings may depend on the keyboard layout (localisation) and on your computer’s operating systems.

== List Views ==
=== Common keybindings ===

The following keybindings are available in all category views.
{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="1" | [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Starting_a_new_Family_Tree|Manage family trees]]
| |{{Man key press|Ctrl|O}}
| |{{Man key press|Cmd|O}}
| |{{Man key press|Ctrl|O}}
|-
| id="2" | [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Importing_data|Import family tree]]
| |{{Man key press|Ctrl|I}}
| |{{Man key press|Cmd|I}}
| |{{Man key press|Ctrl|I}}
|-
| id="3" | [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Exporting_data|Export family tree]]
| |{{Man key press|Ctrl|E}}
| |{{Man key press|Cmd|E}}
| |{{Man key press|Ctrl|E}}
|-
| id="4" | Changes to the next [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Categories|Category]].
| |{{Man key press|Ctrl|N}}
| |{{Man key press|Cmd|N}}
| |{{Man key press|Ctrl|N}}
|-
| id="5" |Changes to the previous [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Categories|Category]].
| |{{Man key press|Ctrl|P}}
| |{{Man key press|Cmd|P}}
| |{{Man key press|Ctrl|P}}
|-
| id="45" |Change [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Categories|Category]] to Category number 0/1/2/../9
| |{{Man key press|Ctrl|1}} {{Man key press|Ctrl|2}} {{Man key press|Ctrl|3}} ...
| |{{Man key press|Cmd|1}} {{Man key press|Cmd|2}} {{Man key press|Cmd|3}}..
| |{{Man key press|Ctrl|1}} {{Man key press|Ctrl|2}} {{Man key press|Ctrl|3}}..
|-
| id="6" |Within the Category changes the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Views|view]] to view mode number 0/1/2/../9
| |{{Man key press|Ctrl|Alt|1}} {{Man key press|Ctrl|Alt|2}} {{Man key press|Ctrl|Alt|3}} ...
| |{{Man key press|Cmd|Opt|1}} {{Man key press|Cmd|Opt|2}} {{Man key press|Cmd|Opt|3}}..
| |{{Man key press|Ctrl|Alt|1}} {{Man key press|Ctrl|Alt|2}} {{Man key press|Ctrl|Alt|3}}..
|-
| id="8" |[[Gramps_5.1_Wiki_Manual_-_Navigation#Using_the_Clipboard|Open the Clipboard]]
| |{{Man key press|Ctrl|B}}
| |{{Man key press|Cmd|B}}
| |{{Man key press|Ctrl|B}}
|-
| id="9" |Add the selected item as a [[Gramps_5.1_Wiki_Manual_-_Navigation#Bookmarks|bookmark]]
| |{{Man key press|Ctrl|D}}
| |{{Man key press|Cmd|D}}
| |{{Man key press|Ctrl|D}}
|-
| id="10" |[[Gramps_5.1_Wiki_Manual_-_Navigation#Bookmarks|Organize the bookmarks]]
| |{{Man key press|Shift|Ctrl|D}}
| |{{Man key press|Shift|Cmd|D}}
| |{{Man key press|Shift|Ctrl|D}}
|-
| id="11" |Open the {{man label|[[Gramps_5.1_Wiki_Manual_-_Navigation#Edit|Undo History]]}} dialog
| |{{Man key press|Ctrl|H}}
| |{{Man key press|Shift|Cmd|H}}
| |{{Man key press|Ctrl|H}}
|-
| id="12" |Jump to an Gramps ID
| |{{Man key press|Ctrl|J}}
| |{{Man key press|Cmd|J}}
| |{{Man key press|Ctrl|J}}
|-
| id="13" |Move to previous item in history
| |{{Man key press|Alt|Left}} (Left arrow)
| |{{Man key press|Ctrl|Opt|Left}} (Left arrow)
| |{{Man key press|Alt|Left}} (Left arrow)
|-
| id="14" |Move to next item in history
| |{{Man key press|Alt|Right}} (Right arrow)
| |{{Man key press|Ctrl|Opt|Right}} (Right arrow)
| |{{Man key press|Alt|Right}} (Right arrow)
|-
| id="15" |Go to the '''[[Gramps_5.1_Wiki_Manual_-_Settings#Setting_Home_person|Home Person]]'''
| |{{Man key press|Alt|Home}}
| |
| |{{Man key press|Alt|Home}}
|-
| id="16" |Same action as the [[File:Gramps-config.png|20px]] Configure active view button
| |{{Man key press|Shift|Ctrl|C}}
| |{{Man key press|Shift|Cmd|C}}
| |{{Man key press|Shift|Ctrl|C}}
|-
| id="7" |Toggle the left gramplet sidebar ([[Gramps_5.1_Wiki_Manual_-_Main_Window#Navigator|Navigator]] panel)
| |{{Man key press|Ctrl|M}}
| |{{Man key press|Cmd|M}}
| |{{Man key press|Ctrl|M}}
|-
| id="17" |Toggle the right gramplet sidebar ([[Gramps_5.1_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|Sidebar]])
| |{{Man key press|Shift|Ctrl|R}}
| |{{Man key press|Shift|Cmd|R}}
| |{{Man key press|Shift|Ctrl|R}}
|-
| id="18" |Toggle the bottom gramplet sidebar ([[Gramps_5.1_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|Bottombar]])
| |{{Man key press|Shift|Ctrl|B}}
| |{{Man key press|Shift|Cmd|B}}
| |{{Man key press|Shift|Ctrl|B}}
|-
| id="19" |Undo
| |{{Man key press|Ctrl|Z}}
| |{{Man key press|Cmd|Z}}
| |{{Man key press|Ctrl|Z}}
|-
| id="20" |Do again
| |{{Man key press|Shift|Ctrl|Z}}
| |{{Man key press|Shift|Cmd|Z}}
| |{{Man key press|Shift|Ctrl|Z}}
|-
| id="21" |Quit Gramps
| |{{Man key press|Ctrl|Q}}
| |{{Man key press|Cmd|Q}}
| |{{Man key press|Ctrl|Q}}
|-
| id="xx" | [[Gramps_5.1_Wiki_Manual_-_Navigation#Add|Add/Create]] a new object (Opens the related Editor) Person Family Event Place Source Citation Repository Media Note
| | {{Man key press|Shift|Alt|P}} {{Man key press|Shift|Alt|F}} {{Man key press|Shift|Alt|E}} {{Man key press|Shift|Alt|L}} {{Man key press|Shift|Alt|S}} {{Man key press|Shift|Alt|C}} {{Man key press|Shift|Alt|R}} {{Man key press|Shift|Alt|M}} {{Man key press|Shift|Alt|N}}
| | {{Man key press|Shift|Ctrl|Opt|P}} {{Man key press|Shift|Ctrl|Opt|F}} {{Man key press|Shift|Ctrl|Opt|E}} {{Man key press|Shift|Ctrl|Opt|L}} {{Man key press|Shift|Ctrl|Opt|S}} {{Man key press|Shift|Ctrl|Opt|C}} {{Man key press|Shift|Ctrl|Opt|R}} {{Man key press|Shift|Ctrl|Opt|M}} {{Man key press|Shift|Ctrl|Opt|N}}
| | {{Man key press|Shift|Alt|P}} {{Man key press|Shift|Alt|F}} {{Man key press|Shift|Alt|E}} {{Man key press|Shift|Alt|L}} {{Man key press|Shift|Alt|S}} {{Man key press|Shift|Alt|C}} {{Man key press|Shift|Alt|R}} {{Man key press|Shift|Alt|M}} {{Man key press|Shift|Alt|N}}
|}

=== All List Views bindings ===

The following bindings are available in all list views: People, Families, Events, Places, Sources, Citations, Repositories, Media and Notes View.
{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
!Note
|-
| id="22" |Edits the selected list item
| |{{Man key press|Ctrl|Enter}}
| |
| |{{Man key press|Ctrl|Enter}}
| |
|-
| id="23" |Adds a new item to the database
| |{{Man key press|Ctrl|Insert}}
| |
| |{{Man key press|Ctrl|Insert}}
| |
|-
| id="24" |Deletes the selected list item
| |{{Man key press|Ctrl|Delete}}
| |
| |{{Man key press|Ctrl|Delete}}
| |
|-
| id="46" |Activate the {{man button|Find}} field
|!-- Microsoft Windows --> |{{Man key press|Ctrl|F}}
|!-- Mac OS --> |{{Man key press|Cmd|F}}
|!-- KDE/GNOME --> |{{Man key press|Ctrl|F}}
| | List view interactive search ahead / Quick search
|}

=== People View bindings ===

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="25" |Expands and hides entries of the selected surname in Group mode
| |{{Man key press|Enter}}
| |{{Man key press|Enter}}
| |{{Man key press|Enter}}
|}

==Editors==

=== Editor Tab bindings ===
These bindings work on the tab pages of the editors (so not on the labels of the tabs!, press tab on label to move to tabpage content).

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="26" |Same action as the {{icon|Stock_edit}} button when that button is present
|{{Man key press|Enter}}
|{{Man key press|Enter}}
|{{Man key press|Enter}}
|-
| id="27" |Same action as the {{icon|Stock_add}} button when that button is present
|{{Man key press|Insert}}
|
|{{Man key press|Insert}}
|-
| id="28" |Same action as the {{icon|Stock_remove}} button when that button is present
|{{Man key press|Delete}}
|
|{{Man key press|Delete}}
|-
| id="29" |Same action as the {{man button|Share}} button when that button is present
|{{Man key press|Ctrl|O}}
|{{Man key press|Cmd|O}}
|{{Man key press|Ctrl|O}}
|-
| id="30" |Change tabpage to the tabpage to the left
|{{Man key press|Alt|Left}} (Left arrow)
|{{Man key press|Ctrl|Alt|Left}} (Left arrow)
|{{Man key press|Alt|Left}} (Left arrow)
|-
| id="31" |Change tabpage to the tabpage to the right
|{{Man key press|Alt|Right}} (Right arrow)
|{{Man key press|Ctlr|Alt|Right}} (Right arrow)
|{{Man key press|Alt|Right}} (Right arrow)
|}

{|{{prettytable}}
!Action/Function
!Mouse Key
|-
| id="32" |Call up [https://en.wikipedia.org/wiki/Context_menu context menu] popup
!Right-click
|-
| id="33" |Same action as the {{icon|Stock_edit}} {{man button|Edit}} button when that button is present
!Double-click
|-
| id="34" |Common action that is not the same as {{icon|Stock_edit}} {{man button|Edit}} button. Eg: on Family Editor Child tab, edit child
!Middle-click
|}

=== Editor bindings ===
These bindings work on Editors by activating focus or by changing state of toggle buttons ([[Accessibility]]).

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
|-
| id="35" |Change the privacy status.
|{{Man key press|Ctrl|P}}
|{{Man key press|Cmd|P}}
|{{Man key press|Ctrl|P}}
|-
| id="36" |Call the Date editor (if present).
|{{Man key press|Ctrl|D}}
|{{Man key press|Cmd|D}}
|{{Man key press|Ctrl|D}}
|-
| id="37" |Activate the {{icon|Stock_add}} {{man button|Add}} button (if present).
|{{Man key press|Ctrl|A}}
|{{Man key press|Cmd|A}}
|{{Man key press|Ctrl|A}}
|-
| id="38" |Activate the {{icon|Stock_edit}} {{man button|Edit}} button (if present).
|{{Man key press|Ctrl|E}}
|{{Man key press|Cmd|E}}
|{{Man key press|Ctrl|E}}
|-
| id="39" |Activate the {{man button|Select}} button (if present).
|{{Man key press|Ctrl|S}}
|{{Man key press|Cmd|S}}
|{{Man key press|Ctrl|S}}
|-
| id="40" |Activate the {{man button|Father}} button (if present).
|{{Man key press|Ctrl|F}}
|{{Man key press|Cmd|F}}
|{{Man key press|Ctrl|F}}
|-
| id="41" |Activate the {{man button|Mother}} button (if present).
|{{Man key press|Ctrl|M}}
|{{Man key press|Cmd|M}}
|{{Man key press|Ctrl|M}}
|}

==Handy Shortcuts==

{|{{prettytable}}
!Action/Function
!Microsoft Windows
!Mac OS
!KDE/GNOME
!Note
|-
| id="42" |Full screen
|{{man key press|F11}}
|
|{{man key press|F11}}
|Maximises Gramps to use the Full screen
|-
| id="43" |Show this user manual
|{{man key press|F1}}
|{{man key press|F1}}
|{{man key press|F1}}
|
|-
| id="44" |Select the {{man button|OK}} button
|{{man key press|Alt}}+{{man key press|O}}
|
|
|Handy for use with low resolution screens
|}

== See also ==
* [http://en.wikipedia.org/wiki/Table_of_keyboard_shortcuts Table of keyboard shortcuts] - for major operating systems.

{{-}}
{{man index|Gramps 5.1 Wiki Manual - FAQ|Gramps 5.1 Wiki Manual - Command Line|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Keybindings}}
{{grampsmanualcopyright}}

[[Category:Documentation]]

Gramps 5.1 Wiki Manual - Main Window

2020-04-25T11:15:09Z

Eponymous: /* Switching Categories */ Fixing Mac version

{{man index|Gramps 5.1 Wiki Manual - Getting started|Gramps 5.1 Wiki Manual - Categories|5.1}}
{{languages|Gramps 5.1 Wiki Manual - Main Window}}
{{#vardefine:chapter|3}}{{#vardefine:figure|0}}
'''Elements of Gramps main window''' ''or'' '''A Visual Guide to the Gramps Interface'''.

Graphical User Interfaces (GUIs) are a way of arranging information on a computer screen that is easy to understand and use because it uses icons, menus, and a mouse rather than only text.

While a GUI is much more intuitive than memorizing keyboard commands, it is hard to learn from the feature documentation without knowing the feature’s name to lookup. Many elements are not labeled in Gramps to reduce clutter and maximize space for displaying Genealogical information. There are even [[Gramps_5.1_Wiki_Manual_-_Settings#Display| preference options]] to not show text labels for the buttons (icons) in the Category Navigator panel.

So this section of the Wiki Manual gives the standardized names of Gramps screen elements. Armed with the standard names, you can more efficiently use a search engine (like Google) to find pages in the online manual that discuss that element. As an example, to search for Gramps Wiki Manual pages on the "Navigator Mode" phrase, use following the Google search terms:
"navigator mode" site:gramps-project.org/wiki

This particular search even finds descriptively named illustrations of selecting the modes for the Navigator sidebar. Selecting one of those images shows a webpage about the illustration and where it is used in the documentation. Those illustrated pages tend to have greater introductory material.

If a particular screen element does not appear among the images below, look through the [[screenshot| Gramps Screenshot Gallery]]. This page shows the Gramps thumbnail screenshots that are used throughout the documentation. Click the thumbnail image to show the full sized image and variants of that image, then scroll down to the "File usage" section to find Wiki pages that illustrate the features within that [[screenshot]]. Likewise, the [[Gramps_icon_set| Gramps Icon Gallery]] identifies the proper names of icons used throughout Gramps.

Once you are familiar with the screen elements, explore the [[Gramps_5.1_Wiki_Manual_-_Keybindings| keybindings or hotkeys]] to learn the shortcuts for features used so frequently that keyboard shortcuts have been created.

== Main Window ==

When opening a (new or existing) Family Tree database, the introductory Gramps [[Gramps_5.1_Wiki_Manual_-_Gramplets#What_is_a_Gramplet|Dashboard window]] will be shown in the "Display Area" with the Sidebar and Bottombar hidden. Upon selecting the [[Gramps_5.1_Wiki_Manual_-_Categories#Categories_of_the_Navigator|People Category]] from the Navigator, the Main Window layout will updated to show the "Person (List) View" in the "Display Area". See Fig. {{#var:chapter}}.{{#expr:{{#var:figure}}+1}}:
{{-}}
[[File:MainWindow-PeopleCategory-PeopleTreeView-annotated-50.png|800px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Annotated Main Gramps window parts, showing the People Category - People Tree View - example using the Grouped People option]]
{{-}}

The main Gramps window contains the following elements:
{{-}}
===Window Title Bar===
*Window Title Bar shows the name of selected Family Tree, the name of the Category view, Gramps application name and buttons to minimize, maximize and close Gramps. The window can also be dragged from the Title Bar.

=== Menubar ===
*Menubar: The menubar ([[Gramps_5.1_Wiki_Manual_-_Navigation#Main_Menus|Main Menu]]) is located at the very top of the window (right below the window title) and provides access to all the features of Gramps.
*Menus are contextual - the options shown depend on which category is active.
*Clicking a menu's header label opens that particular submenu. Submenu items may be dimmed (unavailable) if they are not usable with the active item.

[[Gramps_5.1_Wiki_Manual_-_Preface#Typographical_conventions_in_the_Gramps_Wiki_Manual|Typographically]], Menu selections will look like this in the wiki manual: {{Man menu|Menu -> Submenu -> Menu Item}}.

{{man tip| Visibility of elements |Using the {{man label|[[Gramps_5.1_Wiki_Manual_-_Navigation#View|View]]}} menu, you can hide or unhide several elements of Main Window. In addition, there are Preference option to hide or reveal aspects of the elements -- such as text labels, scrollbars and Close gadgets.}}

==== Pull-down menus ====
[[File:Bottombar-sidebar-drop-down-menu-50.png|450px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} unlabeled ''Down Arrowhead'' {{man button|&or;}} pull-down menu button]]Outside the menubar, the occurrence of an unlabeled ''Down Arrowhead'' {{man button|&or;}} '''pull-down menu''' button indicates additional options are available for the interface item to its left.
==== Pop-up menus ====
[[File:Clipboard-example-right-click-menu-41.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Clipboard - with example contextual pop-up menu from right-clicking a Family]]The most invisible interface option might be the '''contextual pop-up menu'''.

Right-clicking an interface item will reveal shortcuts to some frequently useful features for that item.

[[File:QuickViewReport-EditPerson-context-menu-popup-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Person Editor - with example contextual pop-up menu from right-clicking the empty header space]]Right-clicking on objects is a familiar theme in GUIs. But right-clicking in the empty header space of any Object Editor is less obvious. However, this reveals another contextual pop-up menu with other shortcuts to useful reporting and navigation options.

=== Toolbar ===
*Toolbar: The toolbar is located right below the menubar. It gives you access to the most frequently used functions of Gramps.
*Tools shown depend on which category is active
* ⚙ Configurable Options: most Category views have a [[File:Gramps-config.png]]{{man button|Configure...}} button as an alternative to choosing the {{Man menu|View ➡ Configure...}} from the View menu, or pressing the ''Configure active view'' [[Gramps_5.1_Wiki_Manual_-_Keybindings#Common_keybindings|keyboard keybinding]]. This option opens a dialog with choices for displaying records in the View.
*Hovering over a tool shows a tip of its function
[[File:ToolbarIcon-OpenTheToolsDialog-50.png|center|thumb|394px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Tip for the Tools button of the Dashboard category toolbar]]
The Toolbar can be hidden or revealed by the option in menu {{man menu|[[Gramps_5.1_Wiki_Manual_-_Navigation#View|View ->Toolbar]]}}.

{{man tip|[[5.1_Addons#Installing_Addons_in_Gramps|Installing]] a [[Third-party_Addons|Third party Addon]]|allows Gramps to show ''toolbar text labels'' for each Toolbar button. The [[Addon:Themes|Themes]] addon augments the [[Gramps_5.1_Wiki_Manual_-_Settings|Preferences]] dialog with a ''Theme'' tab.

One of options of the Theme tab is a ☑ {{man label|Toolbar Text}} checkbox. Selecting the checkbox causes the text labels to appear. ''This checkbox is'' ❏''deselected by default.''
[[File:Preferences-Themes-addon.png|450px|center|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Added Theme tab options for the Preferences dialog.]]}}

=== Navigator ===
*Navigator: The navigator is an optional sidebar located at the left of the window and allows selection of the different categories. See [[Gramps_5.1_Wiki_Manual_-_Categories#Categories_of_the_Navigator|Categories of the Navigator]]
:The Navigator is shown by default but this sidebar can be optionally hidden or revealed from the menu {{man menu|[[Gramps_5.1_Wiki_Manual_-_Navigation#View|View ->Navigator]]}} or the [[Gramps_5.1_Wiki_Manual_-_Keybindings#7|keybinding]] {{Man key press|CTRL|M}}. ({{Man key press|CMD|M}} on MacOS.)

Also see:
* [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Navigator_modes|Switching Navigator modes]]
* You can hide the text labels by deselecting the ☑{{man label|Show text label beside Navigator buttons}} option in the {{man menu|Edit -> Preferences}} [[Gramps_5.1_Wiki_Manual_-_Settings#Display|Display]] tab.

=== Display area ===
*Display area: The area in the center of the Gramps window is the display area. What it displays depends on the currently selected View category. [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Views|We will discuss Views in detail below]].

=== Status Bar and Progress Bar ===
*Status Bar and Progress Bar: These are located at the very bottom of the Gramps window.
** The Progress Bar is located in the lower left corner of the Gramps window. It displays the progress of time consuming operations, such as opening and saving large Family Tree databases, importing and exporting to other formats, generating web sites, etc. When you are not doing these types of operations, the Progress Bar is not shown.
** The Status Bar is located to the right of the Progress Bar. It displays information about current Gramps activity and contextual information about the selected items.
** The Status Bar may occasionally show a passing alert, [[Gramps_5.1_Wiki_Manual_-_Error_and_Warning_Reference#Warnings|warning]] of unusual conditions. An informative {{man button|[[Gramps_5.1_Wiki_Manual_-_Error_and_Warning_Reference#Warnings|Warning]]}} button with a superficial summary (like the one below) will be displayed for three minutes at the left of the Status Bar. Clicking this lightbulb icon will show details of these minor alerts.
[[File:Status-bar-warning-button-50.png|750px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing Warning button on the Status Bar]]

{{-}}
=== Bottombar and Sidebar ===

The {{man label|Gramplet Bar}} is also known as the Bottombar and Sidebar.

*Bottombar: The bottombar is located below the display area.

*Sidebar: The sidebar is located to the right of the display area.

{{-}}
The Bottombar and Sidebar can be individually hidden or revealed by options in menu {{man menu|[[Gramps_5.1_Wiki_Manual_-_Navigation#View|View]]}} or the relevant [[Gramps_5.1_Wiki_Manual_-_Keybindings#17|keybinding]]. If the Sidebar is hidden the {{man label|[[Gramps_5.1_Wiki_Manual_-_Main_Window#Search_Bar|Search bar]]}} will be displayed.
{{-}}

The Bottombar and the Sidebar allow [[Gramps_5.1_Wiki_Manual_-_Gramplets|Gramplets]] and [[Gramps_5.1_Wiki_Manual_-_Main_Window#Filters|filters]] to be displayed alongside a view.

{{-}}
====Gramplet Bar Menu====
[[File:Bottombar-sidebar-drop-down-menu-50.png|450px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Location of '''Gramplet Bar Menu''' unlabeled ''Down Arrowhead'' (&or;) Add/Remove/Restore Gramplets Menu ]]

You can also add / remove and restore the default Gramplets by clicking the {{man button| &or;}} (''Down Arrowhead'' button) also known as the '''Gramplet Bar Menu''' at the far top right of the bars titles, and then using one of the options from the drop-down menu eg:
*'''Gramplet Bar Menu'''
** {{man button|Add a gramplet}} - Displays a list of Gramplets available for use on that '''Gramplet Bar'''
** {{man button|Remove a gramplet}} - Displays a list of Gramplets currently shown on the '''Gramplet Bar''' available for removal.
** {{man button|Restore default gramplets}} - Displays the {{man label|[[Gramps_5.1_Wiki_Manual_-_Main_Window#Restore_to_defaults.3F_dialog|Restore to defaults?]]}} confirmation dialog, that allows you to restores the Gramplet Bar to its default Gramplets.
{{-}}
=====Restore to defaults? dialog=====
[[File:Grampletbar-restore-to-defaults-dialog-50.png|450px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Restore to defaults? dialog ]]

The {{man label|Restore to defaults?}} dialog, allows you to restore the Gramplet Bar to its default Gramplets. This action cannot be undone. Select {{man button|OK}} to confirm or select {{man button|Cancel}}.
{{-}}

====Search Bar====
[[File:MainWindow-SearchBar-annotated-sidebar-hidden-example-50.png|450px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} People Category View - showing Search Bar after Sidebar has been hidden]]

If the Sidebar is not displayed in a Category view with a list, then the {{man label|Search Bar}} is displayed instead. Available search options vary depending on Category View you are in. But a visible sidebar makes the Search Bar Invisible.
[[File:PeopleCategory-sidebar-filter-enabled-50.png|450px|thumb|center|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Family Category view - showing the sidebar superceding the Search Bar]]

A {{man label|Search Bar}} is available for the following Views and the Select windows for the following Categories: People, Relationships, Families, Events, Places, Sources, Citations, Repositories, Media, Notes. ''Not Available in the following Category Views: Dashboard, Relationships, Charts, Geography.''

Typing the characters into the {{man label|Search Bar}} and clicking the {{man button|Find}} button will display only lines that match the text.

{{-}}
Note that various {{man label|Selectors}} also have search bars:
* [[Gramps_5.1_Wiki_Manual_-_Categories#Select_Family_selector|Family Selector]]

[[File:SelectFamily-SelectorDialog-example-50.png|550px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} [[Gramps_5.1_Wiki_Manual_-_Categories#Select_Family_selector|Family Selector]] - showing Search Bar]]
{{-}}

== Switching Navigator modes ==

[[File:Navigator-mode-selection-dropdownlist-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Navigator mode selection drop down list]]

You can choose the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Navigator|navigator]] mode from the sidebar {{man label|Category}} drop down list:
* '''Category''' (Default)
* Drop-Down
* Expander
{{-}}
; '''Category''' navigator mode (default)
[[File:Navigator-mode-selection-category-default-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Category (default) Navigator mode]]

Category Sidebar - A sidebar to allow the selection of view categories.
{{-}}
; '''Drop-Down''' navigator mode
[[File:Navigator-mode-selection-drop-down-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Drop-Down navigator mode]]

Drop-down Sidebar - Selection of categories and views from drop-down lists.
{{-}}
; '''Expander''' navigator mode
[[File:Navigator-mode-selection-expander-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Expander navigator mode]]

Expander Sidebar - Selection of views from lists with expanders.
{{-}}
{{man note|Note|In the Plugin Manager, Navigator modes are called Sidebar plugins, but this is inconsistent, because the {{man menu|View->Sidebar}} menu item removes the ''right-hand'' filter/gramplet sidebar, not the ''left-hand'' category sidebar.}}
{{-}}

== Switching Categories ==

Gramps comes with number of different categories as standard. The built-in categories are described in [[Gramps_5.1_Wiki_Manual_-_Categories#Categories_of_the_Navigator|categories]].

{{man note|Expanding the Views|You can [[5.1_Addons|download addon]] a '[[Gramps_Glossary#view|Gramps View]]' in the General tab Preferences menu (or activate or remove previously downloaded Addon Views) via the Plugin Manager.
*If the view is a ''new mode'' (subcategory), the toolbar, menus and Navigator mode lists are modified to give access to the new layout.
*If it is a View of a ''existing category'', then the view layout is replaced for that category.
*If it is a ''new category'' of view, then an entire new visualization will be added with an additional icon appended to the navigator selections.}}

The way you change the currently displayed category depends on the navigator mode. Normally (for most navigator modes) you can select the category you want by clicking one of the navigator icons.

Alternatively you can use the [[Gramps_5.1_Wiki_Manual_-_Keybindings#4|keyboard shortcuts]] {{man key press|CTRL|N}} and {{man key press|CTRL|P}} ({{man key press|CMD|N}} and {{man key press|CMD|P}} on a Mac) go to the next or previous category respectively or use [[Gramps_5.1_Wiki_Manual_-_Keybindings#45|keyboard shortcuts]] {{man key press|CTRL|Alt|<number>}} ({{man key press|CMD|OPT|<number>}} on a Mac) Shortcut are only available for the first 10 categories (e.g. Repositories/Media/Notes categories miss out on shortcuts.) If you have hidden the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Navigator|Navigator]] then shortcuts will be the only way to change categories until you [[Gramps_5.1_Wiki_Manual_-_Navigation#View|turn the Navigator on]] again.
{{-}}

== Switching Views ==
A category can contain different ways of presenting the data, called a [[Gramps_Glossary#view|View]]. If there are several viewing modes, you can switch between modes interactively. The way you change between the modes depends on the Category View. The Configuration options for each mode are independently controlled.

In Views styled in tables of data with rows and columns, the modes are typically between a hierarchically grouped outline or a simple single-level sortable list. Table style view modes are configured with the [[Gramps_5.1_Wiki_Manual_-_Settings#Column_Editor|Column Editor]] and have have [[Gramps_5.1_Wiki_Manual_-_Settings#Sorting_columns|sorting]] options.

In some graphical Category Views (like [[Gramps_5.1_Wiki_Manual_-_Categories#Charts_Category|Charts]] and [[Gramps_5.1_Wiki_Manual_-_Categories#Geography_Category|Geography]]) there may be a wide variety of viewing modes.

[[File:Navigator-mode-selection-expander-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Navigator sidebar in Expander mode]]When there are multiple viewing modes, will be additional icon buttons on the toolbar to switch between those different viewing modes.

You can also switch via the {{man menu|View}} menu, or the View menu [[Gramps_5.1_Wiki_Manual_-_Keybindings#6|keybindings]] by pressing {{Man key press|Ctrl|Alt|''<number>''}} (for Linux & Windows) or {{Man key press|Cmd|Alt|''<number>''}} (for MacOS), where ''<number>'' corresponds to the order of viewing modes listed in the category's View menu.

Modes are also selectable from the Navigator sidebar when using the Drop-down or Expander arrangements. The Navigator sidebar defaults to the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Navigator_modes|Category arrangement]] which has no mode selector. Using the Drop-Down or Expander mode makes the additional viewing modes available as Navigator icons.
{{-}}

== Filters ==

[[File:PeopleCategory-sidebar-filter-enabled-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Filter Controls Displayed]]

Genealogical databases can contain information on many people, families, places, and objects. It is therefore possible for a View to contain a long list of data that is difficult to work with. Gramps gives you two different means for controlling this condition by allowing you to filter a list to a more manageable size.

These methods are '''Search''' and '''Filtering'''.

A search will search the text displayed in list, whereas filters display people whose data match the criteria of the filter.

Search is a simple but fast method of searching the columns displayed on the screen. When the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|sidebar]] is '''not''' displayed, the {{man label|[[Gramps_5.1_Wiki_Manual_-_Main_Window#Search_Bar|Search bar]]}} is displayed. Typing the characters into the {{man label|[[Gramps_5.1_Wiki_Manual_-_Main_Window#Search_Bar|Search bar]]}} and clicking the {{man button|Find}} button will display only lines that match the text.

Alternatively, you can enable a filter in either the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|bottombar or the sidebar]]. When the filter sidebar is displayed, the {{man label|Search bar}} is not displayed. The Filter allows you to interactively build a set of filter rules that can be applied to the display. The filter is applied based on the rules and the data, not on the screen display. Filters of the displayed category can also be constructed by clicking on the corresponding 'editor' button in the {{man menu|Edit}} menu.

Further details of how filters work is given in the [[Gramps_5.1_Wiki_Manual_-_Filters|Filters Chapter]]

{{-}}

{{man tip| Searching vs. Filtering |Searching only searches for exact text matches. If the date displayed is "Jan 1, 2000", a search of "1/1/2000" will fail, but a filter of "1/1/2000" will match.}}

When Gramps opens a Family Tree, no filtering is in effect. In People View, for example, all people in the Family Tree are listed by default.

== Troubleshooting a misbehaving interface ==
If your Gramps GUI is behaving contrary to the manner described in this guide, you may have an installation or minor compatibility issue.

It is likely that the behavior has been seen before and a solution has been identified.

Please review the [[:Category:Troubleshooting|Troubleshooting pages]]. If you are unable to discover the solution there, post a description of the problem to the general Gramps community on our [[Contact#Mailing_lists|user maillist]]. We help each other constantly there.
{{-}}
{{man index|Gramps 5.1 Wiki Manual - Getting Started|Gramps 5.1 Wiki Manual - Categories|5.1}}
{{languages|Gramps 5.1 Wiki Manual - Main Window}}
{{grampsmanualcopyright}}

[[Category:Documentation]]
[[Category:Gramps terminology]]
[[Category:Gramps terminology|Graphical User Interface (GUI) in Gramps]]
[[Category:Gramps terminology|GUI]]

Gramps 5.1 Wiki Manual - Main Window

2020-04-25T11:10:57Z

Eponymous: /* Switching Categories */ adding Mac equivalents

{{man index|Gramps 5.1 Wiki Manual - Getting started|Gramps 5.1 Wiki Manual - Categories|5.1}}
{{languages|Gramps 5.1 Wiki Manual - Main Window}}
{{#vardefine:chapter|3}}{{#vardefine:figure|0}}
'''Elements of Gramps main window''' ''or'' '''A Visual Guide to the Gramps Interface'''.

Graphical User Interfaces (GUIs) are a way of arranging information on a computer screen that is easy to understand and use because it uses icons, menus, and a mouse rather than only text.

While a GUI is much more intuitive than memorizing keyboard commands, it is hard to learn from the feature documentation without knowing the feature’s name to lookup. Many elements are not labeled in Gramps to reduce clutter and maximize space for displaying Genealogical information. There are even [[Gramps_5.1_Wiki_Manual_-_Settings#Display| preference options]] to not show text labels for the buttons (icons) in the Category Navigator panel.

So this section of the Wiki Manual gives the standardized names of Gramps screen elements. Armed with the standard names, you can more efficiently use a search engine (like Google) to find pages in the online manual that discuss that element. As an example, to search for Gramps Wiki Manual pages on the "Navigator Mode" phrase, use following the Google search terms:
"navigator mode" site:gramps-project.org/wiki

This particular search even finds descriptively named illustrations of selecting the modes for the Navigator sidebar. Selecting one of those images shows a webpage about the illustration and where it is used in the documentation. Those illustrated pages tend to have greater introductory material.

If a particular screen element does not appear among the images below, look through the [[screenshot| Gramps Screenshot Gallery]]. This page shows the Gramps thumbnail screenshots that are used throughout the documentation. Click the thumbnail image to show the full sized image and variants of that image, then scroll down to the "File usage" section to find Wiki pages that illustrate the features within that [[screenshot]]. Likewise, the [[Gramps_icon_set| Gramps Icon Gallery]] identifies the proper names of icons used throughout Gramps.

Once you are familiar with the screen elements, explore the [[Gramps_5.1_Wiki_Manual_-_Keybindings| keybindings or hotkeys]] to learn the shortcuts for features used so frequently that keyboard shortcuts have been created.

== Main Window ==

When opening a (new or existing) Family Tree database, the introductory Gramps [[Gramps_5.1_Wiki_Manual_-_Gramplets#What_is_a_Gramplet|Dashboard window]] will be shown in the "Display Area" with the Sidebar and Bottombar hidden. Upon selecting the [[Gramps_5.1_Wiki_Manual_-_Categories#Categories_of_the_Navigator|People Category]] from the Navigator, the Main Window layout will updated to show the "Person (List) View" in the "Display Area". See Fig. {{#var:chapter}}.{{#expr:{{#var:figure}}+1}}:
{{-}}
[[File:MainWindow-PeopleCategory-PeopleTreeView-annotated-50.png|800px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Annotated Main Gramps window parts, showing the People Category - People Tree View - example using the Grouped People option]]
{{-}}

The main Gramps window contains the following elements:
{{-}}
===Window Title Bar===
*Window Title Bar shows the name of selected Family Tree, the name of the Category view, Gramps application name and buttons to minimize, maximize and close Gramps. The window can also be dragged from the Title Bar.

=== Menubar ===
*Menubar: The menubar ([[Gramps_5.1_Wiki_Manual_-_Navigation#Main_Menus|Main Menu]]) is located at the very top of the window (right below the window title) and provides access to all the features of Gramps.
*Menus are contextual - the options shown depend on which category is active.
*Clicking a menu's header label opens that particular submenu. Submenu items may be dimmed (unavailable) if they are not usable with the active item.

[[Gramps_5.1_Wiki_Manual_-_Preface#Typographical_conventions_in_the_Gramps_Wiki_Manual|Typographically]], Menu selections will look like this in the wiki manual: {{Man menu|Menu -> Submenu -> Menu Item}}.

{{man tip| Visibility of elements |Using the {{man label|[[Gramps_5.1_Wiki_Manual_-_Navigation#View|View]]}} menu, you can hide or unhide several elements of Main Window. In addition, there are Preference option to hide or reveal aspects of the elements -- such as text labels, scrollbars and Close gadgets.}}

==== Pull-down menus ====
[[File:Bottombar-sidebar-drop-down-menu-50.png|450px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} unlabeled ''Down Arrowhead'' {{man button|&or;}} pull-down menu button]]Outside the menubar, the occurrence of an unlabeled ''Down Arrowhead'' {{man button|&or;}} '''pull-down menu''' button indicates additional options are available for the interface item to its left.
==== Pop-up menus ====
[[File:Clipboard-example-right-click-menu-41.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Clipboard - with example contextual pop-up menu from right-clicking a Family]]The most invisible interface option might be the '''contextual pop-up menu'''.

Right-clicking an interface item will reveal shortcuts to some frequently useful features for that item.

[[File:QuickViewReport-EditPerson-context-menu-popup-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Person Editor - with example contextual pop-up menu from right-clicking the empty header space]]Right-clicking on objects is a familiar theme in GUIs. But right-clicking in the empty header space of any Object Editor is less obvious. However, this reveals another contextual pop-up menu with other shortcuts to useful reporting and navigation options.

=== Toolbar ===
*Toolbar: The toolbar is located right below the menubar. It gives you access to the most frequently used functions of Gramps.
*Tools shown depend on which category is active
* ⚙ Configurable Options: most Category views have a [[File:Gramps-config.png]]{{man button|Configure...}} button as an alternative to choosing the {{Man menu|View ➡ Configure...}} from the View menu, or pressing the ''Configure active view'' [[Gramps_5.1_Wiki_Manual_-_Keybindings#Common_keybindings|keyboard keybinding]]. This option opens a dialog with choices for displaying records in the View.
*Hovering over a tool shows a tip of its function
[[File:ToolbarIcon-OpenTheToolsDialog-50.png|center|thumb|394px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Tip for the Tools button of the Dashboard category toolbar]]
The Toolbar can be hidden or revealed by the option in menu {{man menu|[[Gramps_5.1_Wiki_Manual_-_Navigation#View|View ->Toolbar]]}}.

{{man tip|[[5.1_Addons#Installing_Addons_in_Gramps|Installing]] a [[Third-party_Addons|Third party Addon]]|allows Gramps to show ''toolbar text labels'' for each Toolbar button. The [[Addon:Themes|Themes]] addon augments the [[Gramps_5.1_Wiki_Manual_-_Settings|Preferences]] dialog with a ''Theme'' tab.

One of options of the Theme tab is a ☑ {{man label|Toolbar Text}} checkbox. Selecting the checkbox causes the text labels to appear. ''This checkbox is'' ❏''deselected by default.''
[[File:Preferences-Themes-addon.png|450px|center|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Added Theme tab options for the Preferences dialog.]]}}

=== Navigator ===
*Navigator: The navigator is an optional sidebar located at the left of the window and allows selection of the different categories. See [[Gramps_5.1_Wiki_Manual_-_Categories#Categories_of_the_Navigator|Categories of the Navigator]]
:The Navigator is shown by default but this sidebar can be optionally hidden or revealed from the menu {{man menu|[[Gramps_5.1_Wiki_Manual_-_Navigation#View|View ->Navigator]]}} or the [[Gramps_5.1_Wiki_Manual_-_Keybindings#7|keybinding]] {{Man key press|CTRL|M}}. ({{Man key press|CMD|M}} on MacOS.)

Also see:
* [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Navigator_modes|Switching Navigator modes]]
* You can hide the text labels by deselecting the ☑{{man label|Show text label beside Navigator buttons}} option in the {{man menu|Edit -> Preferences}} [[Gramps_5.1_Wiki_Manual_-_Settings#Display|Display]] tab.

=== Display area ===
*Display area: The area in the center of the Gramps window is the display area. What it displays depends on the currently selected View category. [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Views|We will discuss Views in detail below]].

=== Status Bar and Progress Bar ===
*Status Bar and Progress Bar: These are located at the very bottom of the Gramps window.
** The Progress Bar is located in the lower left corner of the Gramps window. It displays the progress of time consuming operations, such as opening and saving large Family Tree databases, importing and exporting to other formats, generating web sites, etc. When you are not doing these types of operations, the Progress Bar is not shown.
** The Status Bar is located to the right of the Progress Bar. It displays information about current Gramps activity and contextual information about the selected items.
** The Status Bar may occasionally show a passing alert, [[Gramps_5.1_Wiki_Manual_-_Error_and_Warning_Reference#Warnings|warning]] of unusual conditions. An informative {{man button|[[Gramps_5.1_Wiki_Manual_-_Error_and_Warning_Reference#Warnings|Warning]]}} button with a superficial summary (like the one below) will be displayed for three minutes at the left of the Status Bar. Clicking this lightbulb icon will show details of these minor alerts.
[[File:Status-bar-warning-button-50.png|750px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing Warning button on the Status Bar]]

{{-}}
=== Bottombar and Sidebar ===

The {{man label|Gramplet Bar}} is also known as the Bottombar and Sidebar.

*Bottombar: The bottombar is located below the display area.

*Sidebar: The sidebar is located to the right of the display area.

{{-}}
The Bottombar and Sidebar can be individually hidden or revealed by options in menu {{man menu|[[Gramps_5.1_Wiki_Manual_-_Navigation#View|View]]}} or the relevant [[Gramps_5.1_Wiki_Manual_-_Keybindings#17|keybinding]]. If the Sidebar is hidden the {{man label|[[Gramps_5.1_Wiki_Manual_-_Main_Window#Search_Bar|Search bar]]}} will be displayed.
{{-}}

The Bottombar and the Sidebar allow [[Gramps_5.1_Wiki_Manual_-_Gramplets|Gramplets]] and [[Gramps_5.1_Wiki_Manual_-_Main_Window#Filters|filters]] to be displayed alongside a view.

{{-}}
====Gramplet Bar Menu====
[[File:Bottombar-sidebar-drop-down-menu-50.png|450px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Location of '''Gramplet Bar Menu''' unlabeled ''Down Arrowhead'' (&or;) Add/Remove/Restore Gramplets Menu ]]

You can also add / remove and restore the default Gramplets by clicking the {{man button| &or;}} (''Down Arrowhead'' button) also known as the '''Gramplet Bar Menu''' at the far top right of the bars titles, and then using one of the options from the drop-down menu eg:
*'''Gramplet Bar Menu'''
** {{man button|Add a gramplet}} - Displays a list of Gramplets available for use on that '''Gramplet Bar'''
** {{man button|Remove a gramplet}} - Displays a list of Gramplets currently shown on the '''Gramplet Bar''' available for removal.
** {{man button|Restore default gramplets}} - Displays the {{man label|[[Gramps_5.1_Wiki_Manual_-_Main_Window#Restore_to_defaults.3F_dialog|Restore to defaults?]]}} confirmation dialog, that allows you to restores the Gramplet Bar to its default Gramplets.
{{-}}
=====Restore to defaults? dialog=====
[[File:Grampletbar-restore-to-defaults-dialog-50.png|450px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Restore to defaults? dialog ]]

The {{man label|Restore to defaults?}} dialog, allows you to restore the Gramplet Bar to its default Gramplets. This action cannot be undone. Select {{man button|OK}} to confirm or select {{man button|Cancel}}.
{{-}}

====Search Bar====
[[File:MainWindow-SearchBar-annotated-sidebar-hidden-example-50.png|450px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} People Category View - showing Search Bar after Sidebar has been hidden]]

If the Sidebar is not displayed in a Category view with a list, then the {{man label|Search Bar}} is displayed instead. Available search options vary depending on Category View you are in. But a visible sidebar makes the Search Bar Invisible.
[[File:PeopleCategory-sidebar-filter-enabled-50.png|450px|thumb|center|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Family Category view - showing the sidebar superceding the Search Bar]]

A {{man label|Search Bar}} is available for the following Views and the Select windows for the following Categories: People, Relationships, Families, Events, Places, Sources, Citations, Repositories, Media, Notes. ''Not Available in the following Category Views: Dashboard, Relationships, Charts, Geography.''

Typing the characters into the {{man label|Search Bar}} and clicking the {{man button|Find}} button will display only lines that match the text.

{{-}}
Note that various {{man label|Selectors}} also have search bars:
* [[Gramps_5.1_Wiki_Manual_-_Categories#Select_Family_selector|Family Selector]]

[[File:SelectFamily-SelectorDialog-example-50.png|550px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} [[Gramps_5.1_Wiki_Manual_-_Categories#Select_Family_selector|Family Selector]] - showing Search Bar]]
{{-}}

== Switching Navigator modes ==

[[File:Navigator-mode-selection-dropdownlist-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Navigator mode selection drop down list]]

You can choose the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Navigator|navigator]] mode from the sidebar {{man label|Category}} drop down list:
* '''Category''' (Default)
* Drop-Down
* Expander
{{-}}
; '''Category''' navigator mode (default)
[[File:Navigator-mode-selection-category-default-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Category (default) Navigator mode]]

Category Sidebar - A sidebar to allow the selection of view categories.
{{-}}
; '''Drop-Down''' navigator mode
[[File:Navigator-mode-selection-drop-down-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Drop-Down navigator mode]]

Drop-down Sidebar - Selection of categories and views from drop-down lists.
{{-}}
; '''Expander''' navigator mode
[[File:Navigator-mode-selection-expander-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Expander navigator mode]]

Expander Sidebar - Selection of views from lists with expanders.
{{-}}
{{man note|Note|In the Plugin Manager, Navigator modes are called Sidebar plugins, but this is inconsistent, because the {{man menu|View->Sidebar}} menu item removes the ''right-hand'' filter/gramplet sidebar, not the ''left-hand'' category sidebar.}}
{{-}}

== Switching Categories ==

Gramps comes with number of different categories as standard. The built-in categories are described in [[Gramps_5.1_Wiki_Manual_-_Categories#Categories_of_the_Navigator|categories]].

{{man note|Expanding the Views|You can [[5.1_Addons|download addon]] a '[[Gramps_Glossary#view|Gramps View]]' in the General tab Preferences menu (or activate or remove previously downloaded Addon Views) via the Plugin Manager.
*If the view is a ''new mode'' (subcategory), the toolbar, menus and Navigator mode lists are modified to give access to the new layout.
*If it is a View of a ''existing category'', then the view layout is replaced for that category.
*If it is a ''new category'' of view, then an entire new visualization will be added with an additional icon appended to the navigator selections.}}

The way you change the currently displayed category depends on the navigator mode. Normally (for most navigator modes) you can select the category you want by clicking one of the navigator icons.

Alternatively you can use the [[Gramps_5.1_Wiki_Manual_-_Keybindings#4|keyboard shortcuts]] {{man key press|CTRL|N}} and {{man key press|CTRL|P}} ({{man key press|CMD|N}} and {{man key press|CMD|P}} on a Mac) go to the next or previous category respectively or use [[Gramps_5.1_Wiki_Manual_-_Keybindings#45|keyboard shortcuts]] {{man key press|CTRL|Alt|<number>}} ({{man key press|CTRL|OPT|<number>}} on a Mac) Shortcut are only available for the first 10 categories (e.g. Repositories/Media/Notes categories miss out on shortcuts.) If you have hidden the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Navigator|Navigator]] then shortcuts will be the only way to change categories until you [[Gramps_5.1_Wiki_Manual_-_Navigation#View|turn the Navigator on]] again.
{{-}}

== Switching Views ==
A category can contain different ways of presenting the data, called a [[Gramps_Glossary#view|View]]. If there are several viewing modes, you can switch between modes interactively. The way you change between the modes depends on the Category View. The Configuration options for each mode are independently controlled.

In Views styled in tables of data with rows and columns, the modes are typically between a hierarchically grouped outline or a simple single-level sortable list. Table style view modes are configured with the [[Gramps_5.1_Wiki_Manual_-_Settings#Column_Editor|Column Editor]] and have have [[Gramps_5.1_Wiki_Manual_-_Settings#Sorting_columns|sorting]] options.

In some graphical Category Views (like [[Gramps_5.1_Wiki_Manual_-_Categories#Charts_Category|Charts]] and [[Gramps_5.1_Wiki_Manual_-_Categories#Geography_Category|Geography]]) there may be a wide variety of viewing modes.

[[File:Navigator-mode-selection-expander-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Navigator sidebar in Expander mode]]When there are multiple viewing modes, will be additional icon buttons on the toolbar to switch between those different viewing modes.

You can also switch via the {{man menu|View}} menu, or the View menu [[Gramps_5.1_Wiki_Manual_-_Keybindings#6|keybindings]] by pressing {{Man key press|Ctrl|Alt|''<number>''}} (for Linux & Windows) or {{Man key press|Cmd|Alt|''<number>''}} (for MacOS), where ''<number>'' corresponds to the order of viewing modes listed in the category's View menu.

Modes are also selectable from the Navigator sidebar when using the Drop-down or Expander arrangements. The Navigator sidebar defaults to the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Switching_Navigator_modes|Category arrangement]] which has no mode selector. Using the Drop-Down or Expander mode makes the additional viewing modes available as Navigator icons.
{{-}}

== Filters ==

[[File:PeopleCategory-sidebar-filter-enabled-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Filter Controls Displayed]]

Genealogical databases can contain information on many people, families, places, and objects. It is therefore possible for a View to contain a long list of data that is difficult to work with. Gramps gives you two different means for controlling this condition by allowing you to filter a list to a more manageable size.

These methods are '''Search''' and '''Filtering'''.

A search will search the text displayed in list, whereas filters display people whose data match the criteria of the filter.

Search is a simple but fast method of searching the columns displayed on the screen. When the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|sidebar]] is '''not''' displayed, the {{man label|[[Gramps_5.1_Wiki_Manual_-_Main_Window#Search_Bar|Search bar]]}} is displayed. Typing the characters into the {{man label|[[Gramps_5.1_Wiki_Manual_-_Main_Window#Search_Bar|Search bar]]}} and clicking the {{man button|Find}} button will display only lines that match the text.

Alternatively, you can enable a filter in either the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|bottombar or the sidebar]]. When the filter sidebar is displayed, the {{man label|Search bar}} is not displayed. The Filter allows you to interactively build a set of filter rules that can be applied to the display. The filter is applied based on the rules and the data, not on the screen display. Filters of the displayed category can also be constructed by clicking on the corresponding 'editor' button in the {{man menu|Edit}} menu.

Further details of how filters work is given in the [[Gramps_5.1_Wiki_Manual_-_Filters|Filters Chapter]]

{{-}}

{{man tip| Searching vs. Filtering |Searching only searches for exact text matches. If the date displayed is "Jan 1, 2000", a search of "1/1/2000" will fail, but a filter of "1/1/2000" will match.}}

When Gramps opens a Family Tree, no filtering is in effect. In People View, for example, all people in the Family Tree are listed by default.

== Troubleshooting a misbehaving interface ==
If your Gramps GUI is behaving contrary to the manner described in this guide, you may have an installation or minor compatibility issue.

It is likely that the behavior has been seen before and a solution has been identified.

Please review the [[:Category:Troubleshooting|Troubleshooting pages]]. If you are unable to discover the solution there, post a description of the problem to the general Gramps community on our [[Contact#Mailing_lists|user maillist]]. We help each other constantly there.
{{-}}
{{man index|Gramps 5.1 Wiki Manual - Getting Started|Gramps 5.1 Wiki Manual - Categories|5.1}}
{{languages|Gramps 5.1 Wiki Manual - Main Window}}
{{grampsmanualcopyright}}

[[Category:Documentation]]
[[Category:Gramps terminology]]
[[Category:Gramps terminology|Graphical User Interface (GUI) in Gramps]]
[[Category:Gramps terminology|GUI]]

5.1 Addons

2020-04-24T09:42:18Z

Eponymous: /* Addon List */ Removing www. prefix from bug-report links. Causes lack of formatting (server issue?).

{{man note|This page list [[Third-party Addons|Third-party Addons]] written by users and developers to work only with Gramps version 5.1.|Please use carefully on data that is [[How_to_make_a_backup|backed up.]] Help make these Third-party Addons better by reporting any comments or problems to the author, or issues and Feature requests to the [[Using_the_bug_tracker|bug tracker]] Unless otherwise stated on this page, you can download these plugin by following these [[5.1_Addons#Installing_Addons_in_Gramps|instructions]] {{man menu|Please note that some Addons have prerequisites that need to be installed before they can be used.}} These Third-party Addons unless stated are not officially part of Gramps. This Addon/Plugin system is controlled by the [[Gramps_5.1_Wiki_Manual_-_Plugin_Manager|'''Plugin Manager''']].}}

Gramps comes with a core set of plugins which provide all of the critical features.

However, you can extend this functionality with additional Third-party Addons. These addons provide reports, listings, views, gramplets, and more.

From Gramps [[Gramps_{{Version manual}}_Wiki_Manual_-_Settings#General|Preferences]], you can check for available extra (or updated) addons and select which to download. Then, they will be retrieved from the internet from the Gramps-Project file server and installed locally on your computer.

Once installed, an addon is found in the same place as a built-in feature of the same [[Plugin_list_legend#Type|Type]]. That is, Tool add-ons become new menu items on the Tools menu... while add-on Gramplets become new choices in the appropriate Category View sidebar, bottombar or Dashboard options.

Installed add-ons can be enabled or disabled via the [[Gramps_{{Version manual}}_Wiki_Manual_-_Plugin_Manager|Plugin Manager]].

{{Man tip|Can't find it?|The Plug-in Manager and Preferences are good places to search when a feature is being elusive.

Add-ons aren't typically cross-referenced in the wiki and might not be where you'd expect in the interface.

''What you recalled as a Report might actually be a Quick View... and those are found in entirely different menus. Or you might've installed an Addon for a different machine or in another version of Gramps.''

So looking through the add-ons available for download and among those installed can help you rediscover the feature.}}

= Installing Addons in Gramps =
[[File:EditPreferences-General-tab-example-51.png|Right|thumb|550px|General Preferences]]
You can have Gramps manage the process of checking and downloading Addon updates.

To configure Gramps for Addons:

# Start Gramps
# Select Menu {{man menu|Edit -> Preferences...}}
# Go to the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#General|General]]}} tab
# In the '''Third party addons management''' section:
# Change {{man label|Check for addon updates:}} so when you start Gramps, it checks for updated Addons:
## ''Never'' - never checks for updates when you start Gramps (''This is the default setting''}
## ''Once a month'' - checks for updates when you start Gramps once a month
## '''Once a week''' - checks for updates when you start Gramps once a week ('''This is the recommended setting''')
## ''Once a day'' - checks for updates when you start Gramps once a day
## ''Always'' - checks for updates whenever you start Gramps
# Change {{man label|What to check}} so when you check for updates, it checks for:
## ''Updated addons only'' - does not check for new addons
## ''New addons only'' - does not check for updated addons (''This is the default setting'')
## '''New and updated addons''' - checks for all new and updated addons ('''This is the recommended setting''')
# Change the {{man label|Do not ask about previously notified addons}} check box:
## {{checkbox|1}} Check it so that new/updated addons are only asked about once; afterwards it doesn't show them to you ('''This is the recommended setting''')
## {{checkbox|0}} Uncheck it so that new/updated addons are always shown to you (''This is the default setting'')
# Assuming you have an '''Internet''' connection. You can now optionally select the {{man button|Check for updated addons now}} button to force a check for Addons using the updated settings.
# From the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Available_Gramps_Updates_for_Addons|Available Gramps Updates for Addons]]}} window you will be shown a list broken down by '''Type''' that you can view by selecting the "Select" column expand out each "Type".
# You can then select the check box of those Addons you want to install.
# Then select the {{man button|Install Selected Addons}} button to download those Addons from the ''Internet''.
# Once downloaded from the {{man label|Done downloading and installing addons}} dialog select the {{man button|Close}} button
# From the {{man label|Preferences}} dialog select {{man button|Close}} button.
# To use the Addons you need to {{man menu|Family Trees>Quit}} and restart Gramps.

[[File:AvailableGrampsUpdatesforAddons-example-listing-50.png|Right|thumb|550px|"Available Gramps Updates for Addons" window showing example listing output for Gramps 5.0]]

{{-}}

= Addon List =
Addons are listed inside of Gramps through the interface described above.
{{man tip|''See [[Plugin list legend]]|for details of on each columns.''}}
{| class="wikitable sortable"
|-
! Plugin / Documentation
! Type
! Image
! Description
! Use
! Rating (out of 4)
! Contact
! Download
|-
|[[All Names Quickview|All Names of All People - Quickview]]
|Quickview
|[[File:AllNamesOfAllPeople-Quickview-addon-example-50.png|right|150px]]
|Shows all names for all people
|All
|4
|[mailto:doug.blank@gmail.com Doug Blank]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/AllNamesQuickview.addon.tgz?raw=true AllNamesQuickview.addon.tgz]
|-
|[[AttachSourceTool|Attach Source Tool]]
|Tool
|[[File:AttachSource-Tool-Options-dialog-addon-example-50.png|right|150px]]
|A tool to attach a source to a group of people.
|All
|1
|[mailto:doug.blank@gmail.com Doug Blank]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/AttachSourceTool.addon.tgz?raw=true AttachSourceTool.addon.tgz]
|-
|[[AvatarGenerator|Avatar Generator]]
|Tool
|[[File:AvatarGeneratorTool-Before-and-After-example.gif|right|150px]]
|A tool that allows you to add and remove one or several images for a selected set of filtered people.
|All
|4
|[mailto:matt.familienforschung@gmail.com Matthias Kemmer]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/AvatarGenerator.addon.tgz?raw=true AvatarGenerator.addon.tgz]
|-
|[[Addon:MediaReport|Media Report]]
|Report
|[[File:Media Report Example.png|right|150px]]
|A text report for images, which allows custom headings and custom notes as well as image data like notes, citations, tags, attributes and people references.
|All
|4
|[mailto:matt.familienforschung@gmail.com Matthias Kemmer]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/MediaReport.addon.tgz?raw=true MediaReport.addon.tgz]
|-
|[[Addon:SetPrivacyTool|Set Privacy Tool]]
|Tool
|[[File:SetPrivacyTool.png|right|150px]]
|The Set Privacy Tool allows you to manage privacy status of people, events and media
|All
|4
|[mailto:matt.familienforschung@gmail.com Matthias Kemmer]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/SetPrivacyTool.addon.tgz?raw=true SetPrivacyTool.addon.tgz]
|-
|[[BirthdaysGramplet|Birthdays Gramplet]]
|Gramplet
|[[File:BirthdaysGramplet-addon-example-with-config-dialog-51.png|150px]]
|Display the upcoming birthdays
|All
|1
|[mailto:peter017@gmail.com Peter Potrowl]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/BirthdaysGramplet.addon.tgz?raw=true BirthdaysGramplet.addon.tgz]
|-
|[[BirthOrderTool|Birth Order Tool]]
|Tool
|[[File:BirthOrder.png|150px]]
|Sort children in families in their birth order
|All
|3
|[mailto:paulr2787@gmail.com Paul Culley]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/BirthOrder.addon.tgz?raw=true BirthOrder.addon.tgz]
|-
|[[Gramplets#GUI_Interface|Cairo Clock Gramplet]]
|Gramplet
|[[File:ClockGramplet-addon-example-50.png|right|150px]]
|A sample Cairo clock gramplet.
|Developer
|1
|[mailto:doug.blank@gmail.com Doug Blank]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/ClockGramplet.addon.tgz?raw=true ClockGramplet.addon.tgz]
|-
|[[Calculate Estimated Dates]]
|Tool
|[[File:CalculateEstimatedDates-addon-Select-tab-example-50.png|right|150px]]
|A tool to set estimated birth and death dates.
|All
|2
|[mailto:doug.blank@gmail.com Doug Blank]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/CalculateEstimatedDates.addon.tgz?raw=true CalculateEstimatedDates.addon.tgz]
|-
|[[CollectionsClipboardGramplet|Collections Clipboard Gramplet]]
|Gramplet
|[[File:ClipboardGramplet-Addon-example-50.png|right|150px]]
|Allows one to group items together for quick access.
|All
|2
|[mailto:doug.blank@gmail.com Doug Blank]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/ClipboardGramplet.addon.tgz?raw=true ClipboardGramplet.addon.tgz]
|-
|Command Line Merge
|Tool
|N/A
|Merge primary object via the command line. (Note: Used by Gramps project to test its code you can see an example of how it used programmatically [https://github.com/gramps-project/gramps/blob/master/gramps/gen/merge/test/merge_ref_test.py here])
|Developer
|3
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker] Michiel D. Nauta
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/CliMerge.addon.tgz?raw=true CliMerge.addon.tgz]
|-
|[[D3 Ancestral/Descendant Charts]]
|Web Report
|[[File:D3-AncestralCollapsibleTree-WebReport-Addon-example-50.png|150px]]
|Create ancestral/descendant web based interactive D3 charts.
|All
|3
|[mailto:matt.keenan@gmail.com Matt Keenan]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/D3Charts.addon.tgz?raw=true D3Charts.addon.tgz]
|-
|[[Database Differences Report]]
|Report
|[[File:Database-differences-report-example-50.png|150px]]
|Allows a mostly complete comparison between the current database and a Gramps XML file
|All
|2
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/Differences.addon.tgz?raw=true Differences.addon.tgz]
|-
|[[DataEntryGramplet|Data Entry Gramplet]]
|Gramplet
|[[File:DataEntryGramplet-addon-example-50.png|right|150px]]
|Quick Data Entry for People data
|Expert user
|4
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/DataEntryGramplet.addon.tgz?raw=true DataEntryGramplet.addon.tgz]
|-
|[[DateCalculator|Date Calculator Gramplet]]
|Gramplet
|[[File:DateCalculatorGramplet-addon-default-50.png|right|150px]]
|Allows you to do date math.
|Normal user
|3
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/DateCalculator.addon.tgz?raw=true DateCalculator.addon.tgz]
|-
|[[Deep Connections Gramplet]]
|Gramplet
|[[File:DeepConnectionsGramplet-addon-example-50.png|right|150px]]
|Finds deep relationships between home and active people
|All
|3
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/DeepConnectionsGramplet.addon.tgz?raw=true DeepConnectionsGramplet.addon.tgz]
|-
|[[DenominoViso|Denomino Viso]]
|Web report
|[[File:DenominoViso-WebReport-Addon-example-50.png|right|150px]]
|Creates interactive graphical ancestor/descendant tree on a webpage.
|All
|3
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker] Michiel Nauta
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/DenominoViso.addon.tgz?raw=true DenominoViso.addon.tgz]
|-
|[[Descendant and Detailed Descendant Book Reports]]
|Report
|[[File:DescendantBook-TextReports-addon-ReportOptions-tab-defaults-50.png|150px]]
|Create a book of descendant or detailed descendant reports using a filter.
|All
|4
|[mailto:matt.keenan@gmail.com Matt Keenan] [mailto:giansalvo.gusinu+gramps2020@gmail.com Giansalvo Gusinu]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/DescendantBooks.addon.tgz?raw=true DescendantBooks.addon.tgz]
|-
|[[Descendant Count Gramplet]]
|Gramplet and Quickview
|[[File:DescendantCountGramplet-50.png|right|150px]]
|Gives a count of descendants for each person
|All
|4
|[mailto:doug.blank@gmail.com Doug Blank]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/DescendantCount.addon.tgz?raw=true DescendantCount.addon.tgz]
|-
|[[DescendantsLines|Descendants Lines]]
|Report
|[[File:JohnShakespeare-DescendantsLines.png|150px]]
|Generates a graphical descendants tree using orthogonal edges and routing ("square edges").
|Developer Expert user Intermediate user
|3
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker] [[User:Lcc]] Adam Sampson
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/DescendantsLines.addon.tgz?raw=true DescendantsLines.addon.tgz]
|-
|[[Addon:DownloadMedia|Download Media]]
|Tool
|[[File:DownloadMediaTool-addon-dialog-50.png|right|150px]]
|Download media from web pages
|All
|1
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/DownloadMedia.addon.tgz?raw=true DownloadMedia.addon.tgz]
|-
|[[DynamicWeb report]]
|Report
|[[File:DynamicWeb-tree1.png|150px]]
|Exports the Family Tree as Web pages that are generated dynamically by client-side Javascript (no server required).
|All
|3
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker] [mailto:pierre.belissent@gmail.com Pierre Bélissent]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/DynamicWeb.addon.tgz?raw=true DynamicWeb.addon.tgz]
|-
|[[ExportRaw]]
|Exporter
|[[File:ExportRaw-option-addon-50.png|right|150px]]
|A Gramps exporter that will dump your BSDDB database into a flat text version (.raw) of the Python objects.
|Developer
|4
|[mailto:doug.blank@gmail.com Doug Blank]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/ExportRaw.addon.tgz?raw=true ExportRaw.addon.tgz]
|-
|[[Extract Place Data from a Place Title]]
|Tool
|[[File:ExtractPlaceData.png|right|150px]]
|Attempts to extract city and state/province from a place title
|All
|3
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/ExtractCity.addon.tgz?raw=true ExtractCity.addon.tgz]
|-
|[[Family Sheet]]
|Report
|[[File:FamilySheet-TextReports-Addon-example-50.png|right|150px|Sample Family Sheet]]
|Generates a form with all information about a person, its spouses and its children. (Requires: PIL (Python Imaging Library).)
|All
|4
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker] Reinhard Müller
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/FamilySheet.addon.tgz?raw=true FamilySheet.addon.tgz]
|-
|[[Family Tree]]
|Report
|[[File:FamilyTree-GraphicalReports-Addon-example-50.png|right|150px]]
|Generates a graphical tree of a family with its ancestors and/or descendants.
|All
|3
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker] Reinhard Müller
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/FamilyTree.addon.tgz?raw=true FamilyTree.addon.tgz]
|-
|[[Fix Capitalization of Given Names]]
|Tool
|[[File:FixCapitalizationOfGivenNames-Addon-dialog-example-50.png|right|150px]]
|Fix Capitalization of Given Names
|All
|2
|[mailto:don@gramps-project.org Donald N. Allingham] [mailto:doug.blank@gmail.com Doug Blank]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/ChangeGivenNames.addon.tgz?raw=true ChangeGivenNames.addon.tgz]
|-
|[[Form Addons]]
|Gramplet
|[[File:Form_Selector.png|150px]]
|Forms gramplet that allows users to create and edit structured source data in a single form, such as birth, marriage and death certificates and parish register entries.
|All
|1
|[mailto:nick__hall@hotmail.com Nick Hall]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/Form.addon.tgz?raw=true Form.addon.tgz]
|-
|[[GEDCOM Extensions]]
|Exporter
|[[File:GEDCOMExtensions-GED2-ChooseTheOutputFormat-tab-ExportAssistant-50.png|right|150px]]
|Collection of unofficial GEDCOM extensions which extend Gramps GedcomWriter to include common non-compliant GEDCOM additions..
|Expert user
|2
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker] [mailto:doug.blank@gmail.com Doug Blank]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/GedcomExtensions.addon.tgz?raw=true GedcomExtensions.addon.tgz]
|-
|[[Addon:GenealogyTree|GenealogyTree]]
|Report
|[[File:GenealogyTree-Addon-AncestorTree-example-50.png|150px]]
|Uses LaTeX genealogytree (the Pedigree and genealogical tree diagrams package) to create professional looking trees for the active person. Four report are available. '''Requires: texlive/texlive-pictures and texlive-fontsextra'''
|Developer Expert user Intermediate user
|3
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker] Nick Hall
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/GenealogyTree.addon.tgz?raw=true GenealogyTree.addon.tgz]
|-
|[[Addon:GetGOV|GetGOV]]
|Gramplet
|[[File:GetGOV-Gramplet-addon-detached-50.png|right|150px]]
|Download places from the [http://gov.genealogy.net/search/index GOV genealogical gazetteer].
|Expert user
|2
|[mailto:genealogy@garygriffin.net Gary Griffin]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/GetGOV.addon.tgz?raw=true GetGOV.addon.tgz]
|-
|[[Map Services|Google Earth]]
|Mapservice
|[[File:GoogleEarth-mapservices-selection-dropdown-50.png|right|150px]]
|Show places with GoogleEarth..
|All
|3
|[mailto:peter.talken@telia.com Peter Landgren]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/GoogleEarthWriteKML.addon.tgz?raw=true GoogleEarthWriteKML.addon.tgz]
|-
|[[SQLite Export Import|Gramps SQLite Export Import]]
|Exporter/Importer
|[[File:SQLite Export addon 51.png|right|150px]]
|A Gramps exporter and importer that will export/import your Family Tree as a fully-relational SQLite database.
|Expert users
|3
|[mailto:doug.blank@gmail.com Doug Blank]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/Sqlite.addon.tgz?raw=true Sqlite.addon.tgz]
|-
|[[Graph View]]
|View
|[[File:Graph-View-addon-example-51.png|right|150px]]
|A view that can display the active persons ancestor tree and descendant tree. '''Requires PyGoocanvas and Goocanvas.'''
|Expert users
|3
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker] [mailto:gary.burton@zen.co.uk Gary Burton]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/GraphView.addon.tgz?raw=true GraphView.addon.tgz]
|-
|[[Handle.bash]]
|External utility
|[[File:Bashhandle.gif|right|150px]]
|A bash script which makes it possible to work with multiple databases merging select branches at will without collisions.
|All
|3
|[[User:Lcc]] ([mailto:lcc.mailaddress@gmail.com e-mail])
|[[Media:Handle.bash.tar.gz|Handle.bash.tar.gz]]
|-
|[[HeadlineNewsGramplet|Headline News Gramplet]]
|Gramplet
|[[File:HeadlineNewsGramplet-51.png|right|150px]]
|Shows Gramps breaking news, once per hour
|All
|4
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/HeadlineNewsGramplet.addon.tgz?raw=true HeadlineNewsGramplet.addon.tgz]
|-
|[[House_Timeline_Gramplet|House Timeline Gramplet]]
|Gramplet
|[[File:HouseTimeline-detached-gramplet.PNG|right|150px]]
|Lists the Residents of an Address by Timeline
|All
|
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/tree/master/gramps51/download/HouseTimelineGramplet.addon.tgz?raw=true HouseTimelineGramplet.addon.tgz]
|-
|[[Addon:HtreePedigreeView|Htree Pedigree View]]
|View
|[[File:HtreePedigreeView-addon-example-50.png|right|150px]]
|The H-tree based layout can be used to display ancestral trees.
|All
|3
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/HtreePedigreeView.addon.tgz?raw=true HtreePedigreeView.addon.tgz]
|-
|[[Addon:HtmlView|Html View]]
|HtmlView
|[[File:Html View category.png|right|150px|Html View]]
|A view showing html pages embedded in Gramps
|All
|3
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/HtmlView.addon.tgz?raw=true HtmlView.addon.tgz]
|-
|[[ImportGramplet|Import Text Gramplet]]
|Gramplet
|[[File:ImportGramplet-Addon-CSV-example-50.png|right|150px]]
|Interface to import text directly in the following formats: CSV (spreadsheet input), Gramps XML, VCard.
|Developers
|2
|[mailto:doug.blank@gmail.com Doug Blank]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/ImportGramplet.addon.tgz?raw=true ImportGramplet.addon.tgz]
|-
|[[Import Merge Tool]]
|Tool
|[[File:ImportMerge.png|right|150px]]
|Compares a Gramps XML database with the current one, and allows merging of the differences.
|All
|?
|[mailto:paulr2787@gmail.com Paul Culley]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/ImportMerge.addon.tgz?raw=true ImportMerge.addon.tgz]
|-
|[[InformationGraph|Information Graph]]
|Report
|N/A
|Generate detailed GraphViz graphs by spidering over the database.
|All
|0
|[mailto:rah@bash.sh Bob Ham]
|[http://pkl.net/~node/software/GVInformationGraph.py GVInformationGraph.py]
|-
|[[Interactive Family Tree]]
|Tool
|[[File:Addon-Interactive-Family-Tree-Topola-example-51.png|right|150px]]
|Opens an interactive tree in the browser. This tool uses the [https://pewu.github.io/topola-viewer/ Topola Genealogy Viewer] to display the family tree.
|All
|4
|[https://github.com/PeWu/topola-viewer/issues GitHub issue tracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/Topola.addon.tgz?raw=true Topola.addon.tgz]
|-
|[[LastChange|Last Change]]
|Gramplet and Report
|[[File:LatestChangeGramplet-addon-example-50.png|right|150px]]
|A gramplet and report to display the last ten records changed in the open family tree. The gramplet only displays persons, while the report can display changed families, places, and events too.
|All
|1
|[mailto:jmodule@friant.org Jakim Friant]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/LastChange.addon.tgz?raw=true LastChange.addon.tgz]
|-
|[https://gramps-project.org/blog/2010/01/alternative-interfaces/ libaccess]
|Library
|N/A
|An experimental gen.lib interface.
|Developer
|1
|[mailto:doug.blank@gmail.com Doug Blank]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/libaccess.addon.tgz?raw=true libaccess.addon.tgz]
|-
|[[Lines of Descendency Report]]
|Report
|[[File:Lines-of-descendency.jpeg|right|150px]]
|Prints out all descendency lines from a given ancestor to a given descendant in text.
|All
|2.5
|[[User:Lcc]] ([mailto:lcc.mailaddress@gmail.com e-mail])
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/LinesOfDescendency.addon.tgz?raw=true LinesOfDescendency.addon.tgz]
|-
|[[Addon:MediaMerge|Merge Media]]
|Tool
|[[File:MediaMerge.png|right|150px]]
|Searches for Media entries that point to the same media file and merges them together.
|All
|4
|[mailto:paulr2787@gmail.com Paul Culley]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/MediaMerge.addon.tgz?raw=true MediaMerge.addon.tgz]
|-
|[[Media Verify Tool]]
|Tool
|[[File:MediaVerifyTool.png|right|150px]]
|Verify a one-to-one relationship between media objects and files in the media directory. The main purpose of the tool is to locate files that have been moved and fix the paths.
|All
|4
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/MediaVerify.addon.tgz?raw=true MediaVerify.addon.tgz]
|-
|[[MongoDB]]
|Database
|N/A
|MongoDB database backend support.
|Developer
|2
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/MongoDB.addon.tgz?raw=true MongoDB.addon.tgz]
|-
|[[NetworkChart|Network Chart]]
|Website
|[[File:Shakespeare_network_1_dynamic_url.svg|right|150px]]
|Generate a single graph showing connectivity between individuals
|Expert user
|3
|[mailto:familynetworkchart@gmail.com Mark B.]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/NetworkChart.addon.tgz?raw=true NetworkChart.addon.tgz]
|-
|[[NoteGramplet|Note Gramplet]]
|Gramplet
|[[File:NoteGramplet-addon-example-50.png|right|150px]]
|A data entry gramplet for notes.
|All
|3
|[mailto:doug.blank@gmail.com Doug Blank]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/NoteGramplet.addon.tgz?raw=true NoteGramplet.addon.tgz]
|-
|[[NoteCleanupTool|Note Cleanup Tool]]
|Tool
|[[File:Note_Cleanup_Tool.png|right|150px]]
|A tool to clean up html and convert to Styled Text in notes. Also converts Web links to Styled text.
|All
|3
|[mailto:paulr2787@gmail.com Paul Culley]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/NoteCleanup.addon.tgz?raw=true NoteCleanup.addon.tgz]
|-
|[[Number Of Descendants Quickview]]
|Quickview
|[[File:NumberOfDescendants-QuickView-Addon-example-50.png|right|150px]]
|Shows the number of descendants of the current active person
|All
|4
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker] Reinhard Müller
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/NumberOfDescendantsQuickview.addon.tgz?raw=true NumberOfDescendantsQuickview.addon.tgz]
|-
|[[PedigreeChart|Pedigree Chart]]
|Report
|[[File:PedigreeChart-Addon-example-50.png|right|150px]]
|A version of the classic pedigree chart that is suitable for printing. (Can optionally use - numpy if installed)
|All
|1
|[mailto:jmodule@friant.org Jakim Friant]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/PedigreeChart.addon.tgz?raw=true PedigreeChart.addon.tgz]
|-
|[[PersonEverything Report| Person Everything Report]]
|Report
|[[File:PersonEverything-example-html-51.png|right|150px]]
|Show absolutely everything about one person, including all events, notes, citations, sources, attributes, media and the family information about the families they are involved in.
|All
|4
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/PersonEverything.addon.tgz?raw=true PersonEverything.addon.tgz]
|-
|[[Photo Tagging Gramplet]]
|Gramplet
|[[File:Photo-Tagging-example-51.png|right|150px]]
|Enables tagging people in photographs, i.e. associating regions of images with Gramps persons. (Requires: OpenCV(for automatic face detection)& Numpy )
|All
|4
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/PhotoTaggingGramplet.addon.tgz?raw=true PhotoTaggingGramplet.addon.tgz]
|-
|[[Addon:PlaceCleanupGramplet|Place Cleanup Gramplet]]
|Gramplet
|[[File:PlaceCleanupMain.png|right|150px]]
|Place Cleanup Gramplet assists in merging places, as well as completing places from the GeoNames web database.
|All
|3
|[mailto:paulr2787@gmail.com Paul Culley]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/PlaceCleanup.addon.tgz?raw=true PlaceCleanup.addon.tgz]
|-
|[[Place completion tool]]
|Tool
|[[File:PlaceCompletion-Tool-Addon-50.png|right|150px]]
|A tool to fill in places.
|All
|3
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/PlaceCompletion.addon.tgz?raw=true PlaceCompletion.addon.tgz]
|-
|[[PostgreSQL]]
|Database
|N/A
|PostgreSQL database backend support.
|Expert User
|2
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/PostgreSQL.addon.tgz?raw=true PostgreSQL.addon.tgz]
|-
|[[Addon:Prerequisites Checker Gramplet|Prerequisites Checker Gramplet]]
|Gramplet
|[[File:PrerequisitesCheckerGramplet-Addon-example-50.png|150px]]
|Diagnostic tool to help work out if users have the required prerequisites installed as well as the latest version of Gramps.
|Expert user
|1
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/PrerequisitesCheckerGramplet.addon.tgz?raw=true PrerequisitesCheckerGramplet.addon.tgz]
|-
|[[Python Gramplet|Python Shell Gramplet]]
|Gramplet
|[[File:PythonGramplet-interactive-shell-example-50.png|right|150px]]
|Interactive Python Shell
|Developer
|4
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/PythonGramplet.addon.tgz?raw=true PythonGramplet.addon.tgz]
|-
|[[Plugin Manager Plugin]]
|Plugin lib and Gramplet
|[[File:PlugInManager-addon-example-50.png|right|150px]]
|A Plugin manager with additional capabilities
|All
|4
|[mailto:paulr2787@gmail.com Paul Culley]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/PluginManager.addon.tgz?raw=true PluginManager.addon.tgz]
|-
|[[QueryGramplet|Query Gramplet]]
|Gramplet and Report
|[[File:QueryGramplet.jpg|right|150px]]
|A SQL-like query system.
|All
|1
|[mailto:doug.blank@gmail.com Doug Blank]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/Query.addon.tgz?raw=true Query.addon.tgz]
|-
|[[Quilt Chart]]
|View
|[[File:QuiltView-Addon-example-50.png|right|150px]]
|A view that presents your family tree in the form of a grid.
|Expert users
|3
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker] Serge Noiraud, Nick Hall
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/QuiltView.addon.tgz?raw=true QuiltView.addon.tgz]
|-
|[[RelatedRelativesGramplet|Related Relatives Gramplet]]
|Gramplet
|[[File:RelatedRelativesGramplet-addon-example-50.png|150px]]
|Display all persons in the database with a relation to a relative.
|All
|1
|[mailto:heinzbrinker@yahoo.de Heinz Brinker]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/RelatedRelativesGramplet.addon.tgz?raw=true RelatedRelativesGramplet.addon.tgz]
|-
|[[Addon:RemoveTagTool|Remove Tag Tool]]
|Tool
|[[File:Remove Tag Tool.png|right|150px]]
|The Remove Tag Tool allows you to remove one tag from a selected set of filtered objects e.g. people.
|All
|4
|[mailto:matt.familienforschung@gmail.com Matthias Kemmer]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/RemoveTagTool.addon.tgz?raw=true RemoveTagTool.addon.tgz]
|-
|[[RepositoriesReport|Repositories Report]]
|Report
|[[File:RepositoriesReport.png|right|150px]]
|
|All
|3
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker] Jérôme Rapinat
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/RepositoriesReport.addon.tgz?raw=true RepositoriesReport.addon.tgz]
|-
|[[SetAttributeTool|Set Attribute Tool]]
|Tool
|[[File:SetAttributeTool-gramps50.png|right|150px]]
|A tool for setting attributes and their values on people.
|All
|2
|[mailto:doug.blank@gmail.com Doug Blank]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/SetAttributeTool.addon.tgz?raw=true SetAttributeTool.addon.tgz]
|-
|[[Addon:Themes|Themes]]
|Settings
|[[File:Preferences-Themes-addon.png|right|150px]]
|An addition to Preferences for simple Theme and Font adjustment. Especially useful for Windows users.
|All
|3
|[mailto:paulr2787@gmail.com Paul Culley]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/Themes.addon.tgz?raw=true Themes.addon.tgz]
|-
|[[This Day In Family History]]
|Gramplet
|[[File:This Day In Family History Gramplet - Sample output with content.png|150px]]
|Display the upcoming a concise report of the user defined list of events that happened on this day and month.
|All
|1
|Stephen Adams
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/ThisDayInFamilyHistory.addon.tgz?raw=true ThisDayInFamilyHistory.addon.tgz]
|-
|Thumbnail Generator
|Tool
|N/A
|Generates thumbnails for media files.
|All
|3
|[mailto:nick__hall@hotmail.com Nick Hall]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/ThumbnailGenerator.addon.tgz?raw=true ThumbnailGenerator.addon.tgz]
|-
|[[Types Cleanup Tool]]
|Tool
|[[File:TypesCleanup-Tool-Options-dialog-addon-example-51.png|right|150px]]
|A tool to Remove unneeded custom Types.
|All
|?
|[mailto:paulr2787@gmail.com Paul Culley]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/TypeCleanup.addon.tgzz?raw=true TypeCleanup.addon.tgz]
|-
|[[Timeline Quickview]]
|Quickview
|[[File:Timeline-QuickView-Addon-example-50.png|right|150px]]
|Shows timeline of events in immediate family members' lives
|All
|4
|[mailto:doug.blank@gmail.com Doug Blank]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/TimelineQuickview.addon.tgz?raw=true TimelineQuickview.addon.tgz]
|-
|[[TimelinePedigreeView|Timeline Pedigree View]]
|View
|[[File:TimelinePedigreeView-Addon-example-51.png|right|150px]]
|Pedigree showing timeline and relationships.
|All
|3
|[mailto:doug.blank@gmail.com Doug Blank]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/TimelinePedigreeView.addon.tgz?raw=true TimelinePedigreeView.addon.tgz]
|-
|[[ToDoReport|ToDo Report]]
|Report
|[[File:Addon-TodoReport-report-example-50.png|right|150px]]
|Tag notes as ToDo (or anything else) and you can generate a report with the notes and the records they are attached to. Another way of maintaining a to-do list within Gramps.
|All
|1
|[mailto:jmodule@friant.org Jakim Friant]
|[https://github.com/gramps-project/addons/blob/master/gramps51/download/ToDoReport.addon.tgz?raw=true ToDoReport.addon.tgz]
|-
|[[Web Connect Pack]]
|Library
|[[File:Web-connect-pack-UK-menu-51.png|right|150px]]
|Collection of Web sites for various countries (DE/FR/UK/US) Only install the country you need. (* Requires libwebconnect)
|All
|4
|[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|'''[https://github.com/gramps-project/addons/blob/master/gramps51/download/libwebconnect.addon.tgz?raw=true libwebconnect.addon.tgz]''' [https://github.com/gramps-project/addons/blob/master/gramps51/download/DEWebConnectPack.addon.tgz?raw=true DEWebConnectPack.addon.tgz] [https://github.com/gramps-project/addons/blob/master/gramps51/download/FRWebConnectPack.addon.tgz?raw=true FRWebConnectPack.addon.tgz] [https://github.com/gramps-project/addons/blob/master/gramps51/download/UKWebConnectPack.addon.tgz?raw=true UKWebConnectPack.addon.tgz] [https://github.com/gramps-project/addons/blob/master/gramps51/download/USWebConnectPack.addon.tgz?raw=true USWebConnectPack.addon.tgz]
|- 
|
|
|
|
|
|
|
|
|-
|}

= Manually installed Addons =

A few addons have to be installed manually (or are scripts and need to be installed as described in the documentation).

Addons in the exploratory stages tend to be initially posted to the [https://github.com/gramps-project?tab=repositories GitHub Gramps-Project repositories] and have to be manually installed. Be certain to backup your Tree before installing anything. There is a potential for data loss with such preliminary versions.

# Click on a download link from the list of Addons below.
# Open the .ZIP or .gz file and save the contents to your [[Gramps_5.1_Wiki_Manual_-_User_Directory|Gramps User Directory]], in the <code>gramps51/plugins</code> folder
# After manually installing any addons, you need to restart Gramps

{{man note|Addon/Plugin Errors|From the {{man menu|Help > [[Gramps_5.1_Wiki_Manual_-_Plugin_Manager|Plugin Manager]]}} you can see which addons/plugins failed to load by viewing the ''Status'' column, and then double clicking on such an entry shows you the error. You can email this error to the plugin contact.}}

{| class="wikitable sortable"
|-
! Plugin / Documentation
! Type
! Image
! Description
! Use
! Rating (out of 4)
! Contact
! Download
|-
|[[InformationGraph]]
|Report
|N/A
|Generate detailed GraphViz graphs by spidering over the database.
|All
|1
| [mailto:rah@bash.sh Bob Ham]
| [http://pkl.net/~node/software/GVInformationGraph.py GVInformationGraph.py]
|-
|[[Handle.bash]]
|External utility
|[[File:Bashhandle.gif|right|150px]]
|A bash script which makes it possible to work with multiple databases merging select branches at will without collisions.
|All
|3
| [[User:Lcc]] ([mailto:lcc.mailaddress@gmail.com e-mail])
| [[Media:Handle.bash.tar.gz|Handle.bash.tar.gz]]
|-
|}

=Plugins for other versions of Gramps=
Plugins for other versions of Gramps can be found on the following pages
*[[5.0 Addons]]
*[[4.2 Addons]]
*[[4.1 Addons]]
*[[4.0 Addons]]
*[[3.4 Addons]]
*[[3.3 Addons]]
*[[3.2 Addons]]
*[[3.1.x_Third-party_Plugins|3.1 Addons]]
*[[3.0.x_Third-party_Plugins|3.0 Addons]]
*[[2.2.x_Third-party_Plugins|2.2 Addons]]

=Writing a Plugin=
* See [[Writing a plugin|Writing a Plugin]] for information on developing your own addon.

=See also=
* [[Plugins Command Line]]
* [[Addons Status]] - General issues and compatibility status of above addons.

[[Category:Addons|*]]
[[Category:Plugins|*]]
[[Category:Developers/General]]
[[Category:Gramplets|*]]
[[Category:Tools|*]]
[[Category:Views|*]]

User:Eponymous/monobook.css

2020-04-23T22:46:42Z

Eponymous: Created page with "body {font: regular;}"

body {font: regular;}

Example.gramps

2020-04-20T08:38:03Z

Eponymous: /* Load example.gramps */ Adding hombrew info for MacOS

The '''example.gramps''' file ideally will have an example of everything, at least one, of everything Gramps does, or which it is possible to do in Gramps, even if obscure etc.

Your installation of Gramps should include an example family tree database. This is used to provide a known stable environment for testing, for working through tutorials, and for experimenting.

If you think you have an issue/bug in your ''Family Tree''/database, try the same operation with the example family tree. If the problem happens there as well, then it is probably not due to a [[Recover corrupted family tree|corruption in your data]].

==Load <code>example.gramps</code>==
Follow these steps to load the example family tree:
# Find <code>example.gramps.gz</code> or <code>example.gramps</code> on your system. For example:
#* on Linux <code>/usr/share/doc/gramps/example/gramps/</code>. If the file is named <code>example.gramps.gz</code>, rename it to <code>example.gramps</code> and gramps will recognize it. You can copy this file to a temporary location or import it directly from this directory.
#* on MS-Windows AIO <code>C:\Program Files\GrampsAIO64-X.X.X\share\doc\gramps\example\gramps</code> (On MS-Windows ensure you can see hidden files; see [[Gramps_{{Version manual}}_Wiki_Manual_-_User_Directory#MS_Windows|User Directory:MS Windows]])
#* on Apple MacOS
#** The example database is not included in the MacOS AIO(All in one package) and you may download the files from https://github.com/gramps-project/gramps/tree/maintenance/gramps51/example/gramps and import the Family Tree. (On MacOS ensure you can see hidden files; see: [[Gramps_{{Version manual}}_Wiki_Manual_-_User_Directory#Mac_OS_X|User Directory:Mac OS X]])
#** If installed via Homebrew, the example database is located inside the application bundle at <code>/Applications/Gramps.app/Contents/Resources/share/doc/gramps/example/gramps/</code>
# Start Gramps
# To create a new family tree {{man menu|Family Trees > Manage Family Trees...}} select the {{man button|New}} button. Give it some name, such as ''example''
# Open this new family tree. It will be empty.
# In Gramps, use {{man menu|Family Trees > Import...}} to [[Gramps_{{Version manual}}_Wiki_Manual_-_Manage_Family_Trees#Importing_data|import]] <code>example.gramps</code>.
#;Import Statistics of the example.gramps family tree
{| class="wikitable"
|
Number of new objects imported:
* People: 2157
* Families: 762
* [[Sources|{{man label|Sources}}]]: 4
* [[Events_in_Gramps|{{man label|Events}}]]: 3432
* Media Objects: 7
* [[Places_in_Gramps|{{man label|Places}}]]: 1294
* [[Repositories_in_Gramps|{{man label|Repositories}}]]: 3
* Notes: 19
* [[Tags_in_Gramps|{{man label|Tags}}]]: 2
* [[Citations#Why_Cite|{{man label|Citations}}]]: 2854

Media objects with relative paths have been
imported. These paths are considered relative to
the media directory you can set in the preferences,
or, if not set, relative to the user's directory.
|[[File:GEDCOM-ImportStatistics-dialog-50.png|right|200px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Import Statistics - dialog]]
|}

==Connecting to the example Media Objects==
There are seven example Media Objects (JPEG and PNG images) provided but the relative media path starting point (the Base Path) hasn't been defined in the Preferences. So these images won't be displayed until the media path has been re-defined. The media path can be reset now or if starting to experiment with images.
# In {{man menu|Edit > Preferences}}, change the {{man label|Base path for relative media paths:}} in the [[Gramps_{{Version manual}}_Wiki_Manual_-_Settings#General|{{man label|General}}]] tab. This could be in a new directory, to keep it separate to your own family tree media. (eg On Linux <code>~/gramps/example/</code>)
# Copy the media files from the example directory (that you found in step 1, above) to this media path directory.
{{man note|The example.gramps family tree data file| Alternately, a replacement Gramps ''[https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps51/example/gramps/example.gramps example.gramps]'' [[XML|{{man label|XML}}]] family tree database file (without the Media Objects) can be downloaded from the GitHub file store.}}
==See also==
* [[How to make a backup]]
* [[Recover corrupted family tree]]
* [[Data.gramps]]

[[Category:Documentation]]
[[Category:Gramps Examples]]
[[Category:Genealogy]]
[[Category:Developers/General]]