Difference between revisions of "Addon:Historical Context"

Latest revision as of 07:32, 13 May 2026

Languages:

This is a Third-party Addon. The Addon/Plugin system is controlled by the Plugin Manager.

Please use carefully on data that is backed up, and help make it better by reporting any issues to the bug tracker.
Unless otherwise stated on this page, you can download this addon by following these instructions.
Please note that some Addons have prerequisites that need to be installed before they can be used.

Example of the detached/undocked "Historical Context Gramplet" default output showing unshaded rows for Historical Context during the lifetime of Blanco, Daniel (1752-1805) from the Example.gramps family tree.

The Historical Context gramplet is based on the basic concept that the events in world history during a Person's lifetime provide context to the other events of their life. So the default list of world events might include pandemics, wars and other socio-political pressures. You can edit the lists or add your own. So you might make a list of genealogical record stores that are valuable to be checked for specific eras.

Some additional documentation is currently in the GitHub (online code development management system) repository of addon developer Kaj Mikkelsen. Review the README.md in the HistContext repository.

Usage

Available to be added on the Dashboard, People and Relationship category views, this Gramplet displays historical events that occurred within the lifespan of the Active Person.

It references Historical Context event lists, which have the start year, end year, event description and URL with info about that event.

The default list output shows unshaded rows for historical context during the lifetime of the Active Person.

Double-clicking a row will open the link in your preferred Internet browser.

Configuration options

Configuration options dialog

The View -> Configure... offers a variety of filtering options for the lists of Events.

Rows starting with this in the text column will be hidden: Filter out string - excludes Events where the "Text" column starts with a particular exact string

If the string is set to "Cen", then all lines where the text starts with "Cen" will be filtered out. (i.e., "Census" as well as "Century")

Use filter: - Use filter (deselected by default),enables the filter if selected.
Show outside life span:
Show outside life span (selected by default), show only those in the lifespan of the Active Person.

Foreground color items in lifespan: - (black, default) text color
Background color items in lifespan: - (white, default) shading
Foreground color items outside lifespan: - (black, default) text color
Background color items outside lifespan: - (light grey, default) shading
Select from files - Shows the available Event Lists

Select the Save button to apply the changes.

File locations

The Event Lists can be saved in the following location:

file path: gramps\gramps60\plugins\HistContext

Event Lists

The Historical Context event lists are CSV lists of dated Historical Events (with the semicolon as the delimiter) that are loaded and compared against the lifespan (birth year through death year) of the Active Person. These seven files come with the addon and can be changed with any editor that saves in plain text:

default_data_v1_0.txt - combined list of historic events
pandemi_v1_0.txt - list of Pandemic Events (after 1500 CE)
da_DK_data_v1_0.txt - list of Dansk historical events
en_US_data_v1_0.txt - list of USA Presidential terms
uk_UA_data_v1_0.txt - list of Ukrainian historical events
en_US_involuntary_v1_0.txt - involuntary commitment policies in the USA
en_US_prejudice_v1_0.txt - socio-political prejudice trends in the USA
If you have created a custom Event file (named custom_v1_0.txt) it will be shown.

CSV format

You can create a custom Event file (named custom_v1_0.txt) and those Events will be merged into the list. After creating the custom Event file, adding it as a Media object means the file will be included in backups with media. And if the default viewer for .txt files is a text editor instead of a simple view, then you can use Gramps to add or remove Events from its historical event list.

The format is one Event per line, each line. Short lines or those with too few (less than 3) delimiters will be skipped:

start date;end date;description;URL hotlink

For Events that only last one year, enter the same year for both start and end date. For ongoing Events, use Today for the end year. If either of the dates are missing, the gramplet assumes a lifespan of the Preferences limit for "Maximum age probably alive".

When entering a URL from services like Wikipedia, remove the subdomain language (i.e., en. for English) or platform (e.g., m. for mobile indicator subdomain). This allows Wikipedia to adapt to the target machine.

configuration options

The customizations for this Gramplet are stored in 3 locations: a common HistContext.ini the gramplet's folder, distributed splitbar .ini files for each view mode (e.g., People_personlistview_sidebar.ini in the gramps/gramps60 folder) and the gramps.ini file in the Gramps User Directory.

The undocked size options are saved independently in the .ini files for the splitbars in each view mode. The gramps.ini file merely has the window position for the undocked dashboard gramplet.

[HistContext]
name=HistContext
height=20
expand=True
detached_width=602
detached_height=496
state=maximized
help_url=Addon:Historical_Context
navtypes=['Person', 'Dashboard']
page=3

Configuration options are saved in the HistContext.ini found in the addon's subdirectory in the gramps/gramps60/HistContext.ini file. Once the View -> Configuration is uses and saved, there will be HistContext.ini in the addon folder with the options:

[myopt]
;;bg_sel_col='#ffffff'
;;bg_usel_col='#ededed'
;;fg_sel_col='#000000'
;;fg_usel_col='#000000'
;;files='custom_v1_0.txt'
;;filter_text='String in beginning of text'
;;hide_outside_span=1
;;use_filter=0

Alternative Color Picker

Click on any color swatch in the Colors tab of the Edit -> Preferences to show the palette Pick a Color selector dialog. Then click the + button in the Custom colors at the bottom to show the color picker. Copy the value to the Historical Context options. Cancel the gradient Pick a Color dialogs.

@@ Line 1: / Line 1: @@
 {{languages|Addon:Historical_Context}}
-{{Third-party plugin}}
+{{Third-party addon}}
+[[File:HistoricalContext-gramplet-detached-example-60.png|thumb|right|450px|Example of the detached/undocked "Historical Context Gramplet" default output showing unshaded rows for Historical Context during the lifetime of Blanco, Daniel (1752-1805) from the Example.gramps family tree.]]<!-- I1684 -->
+The {{man label|Historical Context gramplet}} is based on the basic concept that the events in world history during a Person's lifetime provide context to the other events of their life. So the default list of world events might include pandemics, wars and other socio-political pressures. You can edit the lists or add your own. So you might make a list of genealogical record stores that are valuable to be checked for specific eras.
-[[File:HistoricalContext-gramplet-example-52.png|thumb|right|450px|Historical Events for Blanco, Daniel (1752-1805) from the example.tree]]
+Some additional documentation is currently in the GitHub (online code development management system) repository of addon developer Kaj Mikkelsen. Review the [https://github.com/kajmikkelsen/HistContext/blob/master/README.md README.md] in the [https://github.com/kajmikkelsen/HistContext HistContext] repository.
-=Historical Context gramplet=
-This gramplet is a recent development released into the Addon Manager distribution system. Some of the documentation is currently in the GitHub (online code development management system) repository of Kaj Mikkelsen. Review the [https://github.com/kajmikkelsen/HistContext/blob/master/README.md README.md] in the [https://github.com/kajmikkelsen/HistContext HistContext] repository.
+==Usage==
+Available to be added on the Dashboard, People and Relationship category views, this Gramplet displays historical events that occurred within the lifespan of the Active Person.
-The basic concept is that the events in world history during a Person's lifetime provide context to the other events of their life. So the default lists of world events might include pandemics, wars and other socio-political pressures. You can edit the lists or add your own. So you might make a list of genealogical record stores that are valuable to be checked for specific eras.
+It references [[Addon:Historical_Context#Event_Lists|Historical Context event lists]], which have the start year, end year, event description and URL with info about that event.
-Available in the Dashboard, People and Relationship category views, this Gramplet displays historical events that occurred within the lifespan of the active person.
+The default list output shows unshaded rows for historical context during the lifetime of the Active Person.
-It references lists which have the start year, end year, the Event descriptions and a URL about that Event.
-A double-click on a row will open your preferred browser at the provided Link.
+Double-clicking a row will open the link in your preferred Internet browser.
 {{-}}
+=== Configuration options ===
+[[File:HistoricalContext-gramplet-options-tab-defaults-60.png|thumb|right|450px|Configuration options dialog]]
-[[File:HistoricalContext-gramplet-options-523.png|thumb|right|350px|Configuration options dialog for version 0.2.26]]
+The {{man menu|View -> Configure...}} offers a variety of filtering options for the lists of Events.
-== Configuration options ==
-The View -> Configure... offers a variety of filtering options for the lists of Events.
+* {{man label|Rows starting with this in the text column will be hidden:}} <code>Filter out</code> string - excludes Events where the "Text" column starts with a particular exact string
-* Filter string - excludes Events where the "Text" column starts with a particular exact string
 : If the string is set to "Cen", then all lines where the text starts with "Cen" will be filtered out. (i.e., "Census" as well as "Century")
-* Use filter - ''deselected by default'',enables the filter if selected
+* {{checkbox|0}} {{man label|Use filter:}} - ''Use filter'' (deselected by default),enables the filter if selected.
-* Hide outside life span - ''selected by default'', show only those in the life span of the Active Person.
+* {{man label|Show outside life span:}} {{checkbox|1}} ''Show outside life span'' (selected by default), show only those in the lifespan of the Active Person.
-* Files -
-* Foreground color items in lifespan - (black, default) text color
+* {{man label|Foreground color items in lifespan:}} - (black, default) text color
-* Background color items in lifespan - (white, default) shading
+* {{man label|Background color items in lifespan:}} - (white, default) shading
-: #ffffef pale yellow in screen capture
+* {{man label|Foreground color items outside lifespan:}} - (black, default) text color
-* Foreground color items outside lifespan - (black, default) text color
+* {{man label|Background color items outside lifespan:}} - (light grey, default) shading
-: #a00000 dark red in screen capture
+* {{man label|Select from files}} - Shows the available [[Addon:Historical_Context#Event_Lists|Event Lists]]
-* Background color items outside lifespan - (light grey, default) shading
+Select the {{man button|Save}} button to apply the changes.
 === File locations ===
+The ''Event Lists'' can be saved in the following location:
+* file path:  gramps\gramps60\plugins\HistContext
 ==== Event Lists ====
-The Historical Context event lists are CSV lists of dated Historical Events (with the semicolon as the delimiter) that are loaded and compared against the lifespan (birth year through death year) of the Active Person. These files can be changed with any editor that saves in plain text.
+The Historical Context event lists are CSV lists of dated Historical Events (with the semicolon as the delimiter) that are loaded and compared against the lifespan (birth year through death year) of the Active Person. These seven files come with the addon and can be changed with any editor that saves in plain text:
-* default_data_v1_0.txt - combined list of historic events
+* [https://github.com/gramps-project/addons-source/blob/maintenance/gramps60/default_data_v1_0.txt <code>default_data_v1_0.txt</code>] - combined list of historic events
-* pandemi_v1_0.txt - list of Pandemic Events (after 1500 CE)
+* [https://github.com/gramps-project/addons-source/blob/maintenance/gramps60/pandemi_v1_0.txt <code>pandemi_v1_0.txt</code>] - list of Pandemic Events (after 1500 CE)
-* da_DK_data_v1_0.txt- list of Dansk historical events
+* [https://github.com/gramps-project/addons-source/blob/maintenance/gramps60/da_DK_data_v1_0.txt <code>da_DK_data_v1_0.txt</code>] - list of Dansk historical events
-* en_US_data_v1_0.txt - list of USA Presidential terms
+* [https://github.com/gramps-project/addons-source/blob/maintenance/gramps60/en_US_data_v1_0.txt <code>en_US_data_v1_0.txt</code>] - list of USA Presidential terms
-* uk_UA_data_v1_0.txt - list of Ukrainian historical events
+* [https://github.com/gramps-project/addons-source/blob/maintenance/gramps60/HistContext/en_US_involuntary_v1_0.txt <code>uk_UA_data_v1_0.txt</code>] - list of Ukrainian historical events
+* [https://github.com/gramps-project/addons-source/blob/maintenance/gramps60/HistContext/en_US_involuntary_v1_0.txt <code>en_US_involuntary_v1_0.txt</code>] - involuntary commitment policies in the USA
+* [https://github.com/gramps-project/addons-source/blob/maintenance/gramps60/HistContext/en_US_prejudice_v1_0.txt <code>en_US_prejudice_v1_0.txt</code>] - socio-political prejudice trends in the USA
+* If you have created a custom Event file (named <code>custom_v1_0.txt</code>) it will be shown.
-If you have created a custom Event file (named <code>custom_v1_0.txt</code>) then those Events will be merged into the list. After creating the custom Event file, adding it as a Media object means the file will be included in backups with media. And if the default viewer for .txt files is a text editor instead of a simple view, then you can use Gramps to add or remove Events from its historical event list.
+===== CSV format =====
+You can create a custom Event file (named <code>custom_v1_0.txt</code>) and those Events will be merged into the list.
+{{man menu|After creating the custom Event file, adding it as a Media object means the file will be included in backups with media. And if the default viewer for .txt files is a text editor instead of a simple view, then you can use Gramps to add or remove Events from its historical event list.}}
-The format is one Event per line, each line:
+The format is one Event per line, each line. Short lines or those with too few (less than 3) delimiters will be skipped:
-<code>start year;end year;description;URL hotlink</code>
+<code>start date;end date;description;URL hotlink</code>
-For Events that only last one year, enter the same year for both start and end date. For ongoing Events, leave a blank for the end year. If either of the dates are missing the gramplet assumes a life span of 100 years. (Not the Preferences limit for "Maximum age probably alive".)
+For Events that only last one year, enter the same year for both start and end date. For ongoing Events, use <code>Today</code> for the end year. If either of the dates are missing, the gramplet assumes a lifespan of the Preferences limit for "Maximum age probably alive".
-When entering a URL from services like wikipedia, remove any language (e.g., <code>en.</code> for english) or platform (e.g., <code>m.</code> for mobile indicator subdomain). This allows wikipedia to adapt to the target machine.
+When entering a URL from services like Wikipedia, remove the subdomain language (i.e., <code>en.</code> for English) or platform (e.g., <code>m.</code> for mobile indicator subdomain). This allows Wikipedia to adapt to the target machine.
 ==== configuration options ====
-The customizations for this Gramplet are stored in 3 locations: a common <code>HistContext.ini</code> the the gramplet's folder, distributed splitbar <code>.ini</code> files for each view mode (e.g., <code>People_personlistview_sidebar.ini</code> in the <code>gramps/gramps{{Stable_branch}}</code> folder) and the <code>gramps.ini</code> file in the [[Gramps_Glossary#user_directory|Gramps User Directory]].
+The customizations for this Gramplet are stored in 3 locations: a common <code>HistContext.ini</code> the gramplet's folder, distributed splitbar <code>.ini</code> files for each view mode (e.g., <code>People_personlistview_sidebar.ini</code> in the <code>gramps/gramps{{Stable_branch}}</code> folder) and the <code>gramps.ini</code> file in the [[Gramps_Glossary#user_directory|Gramps User Directory]].
 The undocked size options are saved independently in the <code>.ini</code> files for the splitbars in each view mode. The <code>gramps.ini</code> file merely has the window position for the undocked dashboard gramplet.
@@ Line 67: / Line 77: @@
 </pre>
-Configuration options are saved in the HistContext.ini found in the addon's subdirectory in the gramps/gramps{{Stable_branch}}/HistContext.ini file. Once the View -> Configuration is uses and saved, there will be <code>HistContext.ini</code> in the addon folder with the options:
+Configuration options are saved in the HistContext.ini found in the addon's subdirectory in the gramps/gramps{{Stable_branch}}/HistContext.ini file. Once the {{man menu|View -> Configuration}} is uses and saved, there will be <code>HistContext.ini</code> in the addon folder with the options:
 <pre>
@@ Line 82: / Line 92: @@
 {{-}}
-=== alternative Color Picker ===
+=== Alternative Color Picker ===
-Click on any color swatch in the Colors tab of the Edit -> Preferences to show the palette Pick a Color dialog. Then click the + button in the Custom colors at the bottom to show the color picker. Copy the value to the Historical Context options. Cancel the gradient Pick a Color dialogs.
+Click on any color swatch in the Colors tab of the {{man menu|Edit -> Preferences}} to show the palette '''Pick a Color selector''' dialog. Then click the {{man button|+}} button in the Custom colors at the bottom to show the color picker. Copy the value to the ''Historical Context options''. Cancel the gradient Pick a Color dialogs.
-[[File:PickAColor-selector-dialog-52.png|left|thumb|250px|"Pick a Color" - palette selector dialog]]
-[[File:PickAColor-gradient-dialog-52.png|center|thumb|218px|"Pick a Color" - gradient selector dialog]]
+See also:
+* [[Gramps_{{man version}}_Wiki_Manual_-_Settings#Pick_a_Color_selector|Pick a Color selector]]
 {{-}}
@@ Line 104: / Line 114: @@
 * [[Addon:House_Timeline_Gramplet|House Timeline]] - addon person gramplet
 * [[Addon:Historical_Context|Historical Context]] - addon person gramplet
-* [[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_4#Timeline_Chart|Timeline Chart]] built-in Report
+* [[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_4#Timeline_Chart|Timeline Chart]] builtin Report
 * [[Addon:Timeline_Pedigree_Report|Timeline Pedigree Report]] - addon Web pages Report
 * [[Addon:TimelinePedigreeView|Timeline Pedigree]] - addon Charts view mode

Difference between revisions of "Addon:Historical Context"

Latest revision as of 07:32, 13 May 2026

Contents

Usage

Configuration options

File locations

Event Lists

CSV format

configuration options

Alternative Color Picker

See Also

Navigation menu

Views

Personal tools

Navigation

Contributor help pages

wiki

Search

Tools