Difference between revisions of "Addon:Prerequisites Checker Gramplet"

From Gramps
Jump to: navigation, search
(good advice on mailing list)
m (note that it is a Dashboard gramplet)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Third-party plugin}}
 
{{Third-party plugin}}
[[File:PrerequisitesCheckerGramplet-Addon-example-50.png|right|450px|Prerequisites Checker Gramplet on the Dashboard]]
+
[[File:PrerequisitesCheckerGramplet-Addon-example-52.png|right|350px|Prerequisites Checker Gramplet undocked from the Dashboard]]
  
The {{man label|Prerequisites Checker}} Gramplet is a diagnostic tool to help work out if users have the required [https://github.com/gramps-project/gramps/blob/master/README.md prerequisites] installed as well as the latest version of Gramps.
+
The {{man label|Prerequisites Checker}} Gramplet is a Dashboard diagnostic tool to help work out if instances of Gramps have the required [https://github.com/gramps-project/gramps/blob/master/README.md prerequisites] installed as well as the latest version of core software.
  
Also helps on [https://en.wikipedia.org/wiki/Operating_system OS]'s like MicroSoft(Windows) and Apple(MacOS) where it's difficult for users to use the [[Gramps_{{Version manual}}_Wiki_Manual_-_Command_Line|command line]] to get information on Gramps via ( gramps -v )!
+
Also helps in [https://wikipedia.org/wiki/Operating_system OS]'s like Windows (Microsoft) and macOS (Apple) where it is less common for users to start programs via the [[Gramps_{{Version manual}}_Wiki_Manual_-_Command_Line|command line]] interface. The gramplet is a GUI alternative to getting information on Gramps via the <code>gramps -v</code> [[Gramps_5.2_Wiki_Manual_-_Command_Line#Version_options|version option]] from the Command Line!
  
{{-}}
 
 
== Usage ==
 
== Usage ==
  
Line 16: Line 15:
 
You may use the context menu (right click) and {{man button|Select All}} to copy the text to be added to a bug report if requested by a developer.
 
You may use the context menu (right click) and {{man button|Select All}} to copy the text to be added to a bug report if requested by a developer.
  
Once you have finished with the Prerequisites Checker Gramplet remove it from the Dashboard otherwise, it slows down Gramps by refreshing every time you change views!
+
Once you have finished with the Prerequisites Checker Gramplet, remove it from the Dashboard. Otherwise, it slows down Gramps by refreshing every time you change views!
  
 
== Prerequisites ==
 
== Prerequisites ==
None as this gramplet test for the presence of them.
+
None. This gramplet tests for the presence of them.
  
 
== Issues ==
 
== Issues ==
 +
See and raise issues using the [https://gramps-project.org/bugs/view_all_bug_page.php?filter=651ca0ce88d83 PrerequisitesCheckerGramplet] tag.
 +
 +
===Development details===
 +
Created 2018 for Gramps 5.0.x
 
* [https://github.com/gramps-project/addons-source/pull/109 PR109 Add new PreRequisites Checker Gramplet]
 
* [https://github.com/gramps-project/addons-source/pull/109 PR109 Add new PreRequisites Checker Gramplet]
*  Gramps [https://github.com/gramps-project/gramps/blob/master/README.md#requirements requirements], [https://github.com/gramps-project/gramps/blob/master/README.md#the-following-packages-are-strongly-recommended-to-be-installed strong recommendations] and [https://github.com/gramps-project/gramps/blob/master/README.md#the-following-packages-are-optional optional prerequisites]
 
  
 +
== See also ==
 +
Expanded descriptions of listed prequisites  are available in the Gramps README.md on GitHub:
 +
* [https://github.com/gramps-project/gramps/blob/master/README.md#requirements requirements]
 +
* [https://github.com/gramps-project/gramps/blob/master/README.md#the-following-packages-are-strongly-recommended-to-be-installed strong recommendations]
 +
* [https://github.com/gramps-project/gramps/blob/master/README.md#the-following-packages-are-optional optional prerequisites]
 +
Wiki articles describing Gramps logging of diagnostics, Warnings and errors:
 +
* "gramps -v” [[Gramps_5.2_Wiki_Manual_-_Command_Line#Version_options|version option of the Command Line]] 
 +
* Error and Warning reference : [[Gramps_{{man version}}_Wiki_Manual_-_Error_and_Warning_Reference#Warnings|Status bar warnings]]
 +
* [[Debugging_Gramps|Debugging Gramps]]
 +
* [[Logging_system|Logging System]]
 +
* GEPS request #38: [[GEPS_038:_Enhanced_Transaction_Log|Enhanced Transaction Log]]
 +
 +
[[Category:Addons]]
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]

Latest revision as of 18:30, 11 March 2024

Gramps-notes.png

Please use carefully on data that is backed up, and help make it better by reporting any comments or problems to the author, or 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.
This Addon/Plugin system is controlled by the Plugin Manager.

Prerequisites Checker Gramplet undocked from the Dashboard

The Prerequisites Checker Gramplet is a Dashboard diagnostic tool to help work out if instances of Gramps have the required prerequisites installed as well as the latest version of core software.

Also helps in OS's like Windows (Microsoft) and macOS (Apple) where it is less common for users to start programs via the command line interface. The gramplet is a GUI alternative to getting information on Gramps via the gramps -v version option from the Command Line!

Usage

context menu to add Prerequisites Checker Gramplet to Dashboard
  • Load your Family Tree and then select an empty area on the Dashboard and from the Add a gramplet menu select Prerequisites Checker Gramplet.


You may use the context menu (right click) and Select All to copy the text to be added to a bug report if requested by a developer.

Once you have finished with the Prerequisites Checker Gramplet, remove it from the Dashboard. Otherwise, it slows down Gramps by refreshing every time you change views!

Prerequisites

None. This gramplet tests for the presence of them.

Issues

See and raise issues using the PrerequisitesCheckerGramplet tag.

Development details

Created 2018 for Gramps 5.0.x

See also

Expanded descriptions of listed prequisites are available in the Gramps README.md on GitHub:

Wiki articles describing Gramps logging of diagnostics, Warnings and errors: