Open main menu

Gramps β

Changes

Addon:Historical Context

4,169 bytes added, 13 May
m
minor grammar corrections
{{languages|Addon:Historical_Context}}
{{Third-party pluginaddon}}[[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.
Some additional documentation is currently in the GitHub (online code development management system) repository of addon developer Kaj Mikkelsen. Review the [[Filehttps:HistoricalContext-gramplet-example-52//github.com/kajmikkelsen/HistContext/blob/master/README.png|thumb|right|450px|Historical Events for Blanco, Daniel (1752-1805) from md README.md] in the example[https://github.treecom/kajmikkelsen/HistContext HistContext]]=Historical Context gramplet=repository.
This gramplet is in development. The documentation is currently in ==Usage==Available to be added on the GitHub (online code development management system) repository Dashboard, People and Relationship category views, this Gramplet displays historical events that occurred within the lifespan of Kaj Mikkelsen. Review the [https://github.com/kajmikkelsen/HistContext/blob/master/README.md README.md] in the [https://github.com/kajmikkelsen/HistContext HistContext] repositoryActive Person.
Available in the Dashboard, People and Relationship category views, this Gramplet displays historical events that occurred within the lifespan of the active person. It references [[Addon:Historical_Context#Event_Lists|Historical Context event lists ]], which have the start year, end year, the Event descriptions event description and a URL with info about that Eventevent.
A doubleThe default list output shows unshaded rows for historical context during the lifetime of the Active Person. Double-click on clicking a row will open the link in your preferred Internet browser at the provided Link.
{{-}}
=== Configuration options ===
[[File:HistoricalContext-gramplet-options-tab-defaults-60.png|thumb|right|450px|Configuration options dialog]]
[[File:HistoricalContext-grampletThe {{man menu|View -> Configure...}} offers a variety of filtering options-52for the lists of Events.png|thumb|right|350px|Configuration options dialog)]]== Configuration options ==
The View -* {{man label|Rows starting with this in the text column will be hidden:}} <code> Configure... offers a variety of filtering options for the lists of Events.* 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 .* Hide {{man label|Show outside life span:}} {{checkbox|1}} ''Show outside life span - ''(selected by default''), show only those in the life span lifespan of the Active Person. * Files - * {{man label|Foreground color items in lifespan :}} - (#000000 black, default, black) text color * {{man label|Background color items in lifespan :}} - (#ffffff white, default, white) shading: #ffffef pale yellow in screen capture* {{man label|Foreground color items outside lifespan :}} - (#000000 black, default, black) text color: #a00000 dark red in screen capture* {{man label|Background color items outside lifespan :}} - (#ededed default, 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.
* default_data_v1_0===== CSV format =====You can create a custom Event file (named <code>custom_v1_0.txt - combined </code>) and those Events will be merged into the list of historic events. * pandemi_v1_0{{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 - list files is a text editor instead of Pandemic a simple view, then you can use Gramps to add or remove Events (after 1500 CE)* da_DK_data_v1_0.txt- list of Dansk from its historical events* en_US_data_v1_0.txt - event list of USA Presidential terms * uk_UA_data_v1_0.txt - list of Ukrainian historical events}}
If you have created a custom The format is one Event file per line, each line. Short lines or those with too few (named <code>custom_v1_0.txt</code>less than 3) then those Events delimiters will be merged into the list.skipped:
The format is one Event per line, each line:<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>start year;end year;description;URL hotlinkToday</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".
For Events that only last one yearWhen entering a URL from services like Wikipedia, enter remove the same year subdomain language (i.e., <code>en.</code> for both start and end dateEnglish) or platform (e.g. For ongoing Events, leave a blank <code>m.</code> for mobile indicator subdomain). This allows Wikipedia to adapt to the end yeartarget machine.
When entering ==== configuration options ====The customizations for this Gramplet are stored in 3 locations: a URL from services like wikipedia, remove any language (e.gcommon <code>HistContext.ini</code> the gramplet's folder, distributed splitbar <code>en.ini</code> files for english) or platform each view mode (e.g., <code>mPeople_personlistview_sidebar.ini</code> for mobile indicator subdomainin the <code>gramps/gramps{{Stable_branch}}</code> folder)and the <code>gramps. This allows wikipedia to adapt to ini</code> file in the target machine[[Gramps_Glossary#user_directory|Gramps User Directory]].
==== configuration options ====The configuration 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. Since the gramplets can be undocked, you could have several different sets of Events showing at the same time.
<pre>
</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>
{{-}}
=== alternative 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.[[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]]
{{-}}
** [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
 
* [[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]] builtin Report
* [[Addon:Timeline_Pedigree_Report|Timeline Pedigree Report]] - addon Web pages Report
* [[Addon:TimelinePedigreeView|Timeline Pedigree]] - addon Charts view mode
* [[Addon:TimeLinesMap|Timelines Map]] - addon Geography view mode
* [[Addon:Timeline_Quickview|Timeline]] - addon Quick view for Persons
* [[Addon:CombinedView#Timeline_tab|Timeline tab]] of the Combined view mode addon in Relationships category
[[Category:Addons]]
[[Category:Plugins]]
4
edits