4
edits
Changes
m
{{Third-party plugin}}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.
{{man warn|1=🚧 Work In Progress|2=This wikipage is an outline from a template being roughed in. Please don't edit '''''just yet'''''. Instead, contribute suggestions Usage==Available to be added on the Discussion page. <br /><br />This page is not planned be linked to a public page until about {{safesubst<noinclude/>:CURRENTDAY}} {{safesubst<noinclude/>:CURRENTMONTHNAMEGEN}} {{safesubst<noinclude/>:CURRENTYEAR}}. <br /><br />If Dashboard, People and Relationship category views, this notice remains after Gramplet displays historical events that date, please feel welcome to remove this notice and consider occurred within the lifespan of the content 'fair game' for unlimited editingActive Person.}}
=Historical Context gramplet=The default list output shows unshaded rows for historical context during the lifetime of the Active Person.
This gramplet is Double-clicking a row will open the link in developmentyour preferred Internet browser. The documentation is currently in the GitHub (online code development management system) repository of Kaj Mikkelsen. Review the {{-}}=== Configuration options ===[[httpsFile://github.com/kajmikkelsen/TimeLineGramplet/blob/master/README.md READMEHistoricalContext-gramplet-options-tab-defaults-60.mdpng|thumb|right|450px|Configuration options dialog] in the [https://github.com/kajmikkelsen/TimeLineGramplet TimeLineGramplet] (the original development codename for the project) repository.
==== WikiContributor Help ====* [[Addon:House_Timeline_Gramplet|House Timeline]] - addon person gramplet* [[Addon:Category:WikiContributorsHistorical_Context|WikiContributors categoryHistorical Context]]- addon person gramplet <hr /> Edit * [[Template:AddonsGramps_{{man version}}_Wiki_Manual_-_Reports_-_part_4#Timeline_Chart|Timeline Chart]]builtin Report {| class="wikitable sortable"* [[Addon:Timeline_Pedigree_Report|Timeline Pedigree Report]] -addon Web pages Report! Plugin / Documentation! Type! Image! Description! Use! Rating (out of 4)! Contact! Download|-|<!-- Plugin / Documentation -->* [[Addon:All Names QuickviewTimelinePedigreeView|All Names of All PeopleTimeline Pedigree]]|<!-- Type -->Quickviewaddon Charts view mode|<!-- Image -->* [[FileAddon:AllNamesOfAllPeople-Quickview-addon-example-50.png|rightTimeLinesMap|150pxTimelines Map]]|<!-- Description -->Shows all names for all peopleaddon Geography view mode|<!-- Use -->All|<!-- Rating (out of 4) -->4 |<!-- Contact -->* [[httpsAddon://gramps-project.org/bugs/my_view_page.php Gramps BugtrackerTimeline_Quickview|Timeline]<br>[mailto:[email protected] Doug Blank]|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps52/download/AllNamesQuickview.addon.tgz?raw=true AllNamesQuickview.addon.tgz]|- <!-- Edit this section to compose a listing Quick view for your Addon -->Persons|<!-- Plugin / Documentation -->* [[Addon:Historical ContextCombinedView#Timeline_tab|Historical ContextTimeline tab]]|<!-- Type -->Gramplet|<!-- Image -->|<!-- Description -->|<!-- Use -->All|<!-- Rating (out of 4) -->|<!-- Contact -->[https://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]<br />Kaj Mikkelsen|<!-- Download -->|-|}the Combined view mode addon in Relationships category
minor grammar corrections
{{languages|Addon:Historical_Context}}
{{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.
It references [[FileAddon:HistoricalContext-gramplet-example-{{Stable_branch}}.pngHistorical_Context#Event_Lists|thumb|right|450px|Addon GUI (e.g. detached gramplet screen capture)Historical Context event lists]], which have the start year, end year, event description and URL with info about that event.
The {{man menu|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
: 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")
* {{checkbox|0}} {{man label|Use filter:}} - ''Use filter'' (deselected by default),enables the filter if selected.
* {{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.
* {{man label|Foreground color items in lifespan:}} - (black, default) text color
* {{man label|Background color items in lifespan:}} - (white, default) shading
* {{man label|Foreground color items outside lifespan:}} - (black, default) text color
* {{man label|Background color items outside lifespan:}} - (light grey, default) shading
* {{man label|Select from files}} - Shows the available [[Addon:Historical_Context#Event_Lists|Event Lists]]
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 seven files come with the addon and can be changed with any editor that saves in plain text:
* [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
* [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)
* [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
* [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
* [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.
===== 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. Short lines or those with too few (less than 3) delimiters will be skipped:
<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, 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 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 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.
<pre>
[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
</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 {{man menu|View -> Configuration}} is uses and saved, there will be <code>HistContext.ini</code> in the addon folder with the options:
<pre>
[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
</pre>
{{-}}
=== Alternative Color Picker ===
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.
See also:
* [[Gramps_{{man version}}_Wiki_Manual_-_Settings#Pick_a_Color_selector|Pick a Color selector]]
{{-}}
==See Also==
* GitHub
** [https://github.com/kajmikkelsen/ kajmikkelsen repository]
** [https://github.com/kajmikkelsen/TimeLineGramplet TimeLineGrampletHistContext HistContext]
* Discourse
** [https://gramps.discourse.group/t/my-first-gramplet-for-gramps-5-2/6348/45 My first gramplet - for gramps 5.2]
** [https://gramps.discourse.group/t/add-option-for-boolean-options-in-gramplet/6371 add option for boolean options in gramplet]
** [https://gramps.discourse.group/t/translating-addons/6106 translating addons]
** Discourse tag: [https://gramps.discourse.group/tag/timeline timeline]
* MantisBT
** Feature Requests {{bug|13498}}: To be implemented in Historical Context gramplet
[[Category:Addons]]
[[Category:Plugins]]