Add help_url to built-in tools

Add help_url to Reports, QuickViews, Graphical Reports, Web Reports, built-in tools and debug tools. Commit on behalf of Emyoulation.
gramps-project · Jan 31, 2025 · 4bc85b9 · 4bc85b9
1 parent a02aab4
commit 4bc85b9
Show file tree

Hide file tree

Showing 7 changed files with 82 additions and 1 deletion.
diff --git a/gramps/plugins/drawreport/drawplugins.gpr.py b/gramps/plugins/drawreport/drawplugins.gpr.py
@@ -24,6 +24,7 @@
 _ = glocale.translation.gettext
 
 MODULE_VERSION = "6.0"
+REPORTS_HELP = "Gramps_5.2_Wiki_Manual_-_Reports#Graphical_Reports"
 
 # this is the default in gen/plug/_pluginreg.py: plg.require_active = True
 
@@ -48,6 +49,7 @@
 plg.reportclass = "AncestorTree"
 plg.optionclass = "AncestorTreeOptions"
 plg.report_modes = [REPORT_MODE_BKI]
+plg.help_url = REPORTS_HELP
 
 plg = newplugin()
 plg.id = "ancestor_chart"
@@ -64,6 +66,7 @@
 plg.reportclass = "AncestorTree"
 plg.optionclass = "AncestorTreeOptions"
 plg.report_modes = [REPORT_MODE_GUI, REPORT_MODE_CLI]
+plg.help_url = REPORTS_HELP
 
 # ------------------------------------------------------------------------
 #
@@ -86,6 +89,7 @@
 plg.reportclass = "Calendar"
 plg.optionclass = "CalendarOptions"
 plg.report_modes = [REPORT_MODE_GUI, REPORT_MODE_BKI, REPORT_MODE_CLI]
+plg.help_url = REPORTS_HELP
 
 # ------------------------------------------------------------------------
 #
@@ -108,6 +112,7 @@
 plg.reportclass = "DescendTree"
 plg.optionclass = "DescendTreeOptions"
 plg.report_modes = [REPORT_MODE_BKI]
+plg.help_url = REPORTS_HELP
 
 plg = newplugin()
 plg.id = "descend_chart"
@@ -124,6 +129,7 @@
 plg.reportclass = "DescendTree"
 plg.optionclass = "DescendTreeOptions"
 plg.report_modes = [REPORT_MODE_GUI, REPORT_MODE_CLI]
+plg.help_url = REPORTS_HELP
 
 # ------------------------------------------------------------------------
 #
@@ -147,6 +153,7 @@
 plg.reportclass = "DescendTree"
 plg.optionclass = "DescendTreeOptions"
 plg.report_modes = [REPORT_MODE_BKI]
+plg.help_url = REPORTS_HELP
 
 plg = newplugin()
 plg.id = "family_descend_chart"
@@ -164,6 +171,7 @@
 plg.reportclass = "DescendTree"
 plg.optionclass = "DescendTreeOptions"
 plg.report_modes = [REPORT_MODE_GUI, REPORT_MODE_CLI]
+plg.help_url = REPORTS_HELP
 
 # ------------------------------------------------------------------------
 #
@@ -186,6 +194,7 @@
 plg.reportclass = "FanChart"
 plg.optionclass = "FanChartOptions"
 plg.report_modes = [REPORT_MODE_GUI, REPORT_MODE_BKI, REPORT_MODE_CLI]
+plg.help_url = REPORTS_HELP
 
 # ------------------------------------------------------------------------
 #
@@ -211,6 +220,7 @@
 plg.optionclass = "StatisticsChartOptions"
 plg.report_modes = [REPORT_MODE_GUI, REPORT_MODE_BKI, REPORT_MODE_CLI]
 plg.require_active = False
+plg.help_url = REPORTS_HELP
 
 # ------------------------------------------------------------------------
 #
@@ -233,3 +243,4 @@
 plg.reportclass = "TimeLine"
 plg.optionclass = "TimeLineOptions"
 plg.report_modes = [REPORT_MODE_GUI, REPORT_MODE_BKI, REPORT_MODE_CLI]
+plg.help_url = REPORTS_HELP
diff --git a/gramps/plugins/graph/graphplugins.gpr.py b/gramps/plugins/graph/graphplugins.gpr.py
@@ -23,6 +23,7 @@
 _ = glocale.translation.gettext
 
 MODULE_VERSION = "6.0"
+REPORTS_HELP = "Gramps_5.2_Wiki_Manual_-_Reports#Graphs"
 
 # this is the default in gen/plug/_pluginreg.py: plg.require_active = True
 
@@ -48,6 +49,7 @@
 plg.optionclass = "FamilyLinesOptions"
 plg.report_modes = [REPORT_MODE_GUI, REPORT_MODE_CLI]
 plg.require_active = False
+plg.help_url = REPORTS_HELP
 
 # ------------------------------------------------------------------------
 #
@@ -70,6 +72,7 @@
 plg.reportclass = "HourGlassReport"
 plg.optionclass = "HourGlassOptions"
 plg.report_modes = [REPORT_MODE_GUI, REPORT_MODE_CLI]
+plg.help_url = REPORTS_HELP
 
 # ------------------------------------------------------------------------
 #
@@ -92,3 +95,4 @@
 plg.reportclass = "RelGraphReport"
 plg.optionclass = "RelGraphOptions"
 plg.report_modes = [REPORT_MODE_GUI, REPORT_MODE_CLI]
+plg.help_url = REPORTS_HELP
diff --git a/gramps/plugins/quickview/quickview.gpr.py b/gramps/plugins/quickview/quickview.gpr.py
@@ -24,6 +24,7 @@
 _ = glocale.translation.gettext
 
 MODULE_VERSION = "6.0"
+QUICKVIEWS_HELP = "Gramps_5.2_Wiki_Manual_-_Reports#Quick_Views"
 
 # ------------------------------------------------------------------------
 #
@@ -44,6 +45,7 @@
     authors_email=["[email protected]"],
     category=CATEGORY_QR_DATE,
     runfunc="run",
+    help_url=QUICKVIEWS_HELP,
 )
 
 # ------------------------------------------------------------------------
@@ -65,6 +67,7 @@
     authors_email=["[email protected]"],
     category=CATEGORY_QR_MISC,
     runfunc="run",
+    help_url=QUICKVIEWS_HELP,
 )
 
 # ------------------------------------------------------------------------
@@ -86,6 +89,7 @@
     authors_email=["[email protected]"],
     category=CATEGORY_QR_PERSON,
     runfunc="run",
+    help_url=QUICKVIEWS_HELP,
 )
 
 
@@ -102,6 +106,7 @@
     authors_email=["[email protected]"],
     category=CATEGORY_QR_FAMILY,
     runfunc="run_fam",
+    help_url=QUICKVIEWS_HELP,
 )
 
 # ------------------------------------------------------------------------
@@ -123,6 +128,7 @@
     authors_email=["[email protected]"],
     category=CATEGORY_QR_PERSON,
     runfunc="run",
+    help_url=QUICKVIEWS_HELP,
 )
 
 # ------------------------------------------------------------------------
@@ -144,6 +150,7 @@
     authors_email=["[email protected]"],
     category=CATEGORY_QR_MISC,
     runfunc="run",
+    help_url=QUICKVIEWS_HELP,
 )
 
 # ------------------------------------------------------------------------
@@ -165,6 +172,7 @@
     authors_email=["[email protected]"],
     category=CATEGORY_QR_PERSON,
     runfunc="run_father",
+    help_url=QUICKVIEWS_HELP,
 )
 
 register(
@@ -180,6 +188,7 @@
     authors_email=["[email protected]"],
     category=CATEGORY_QR_PERSON,
     runfunc="run_mother",
+    help_url=QUICKVIEWS_HELP,
 )
 
 # ------------------------------------------------------------------------
@@ -201,6 +210,7 @@
     authors_email=["[email protected]"],
     category=CATEGORY_QR_EVENT,
     runfunc="run",
+    help_url=QUICKVIEWS_HELP,
 )
 
 # ------------------------------------------------------------------------
@@ -235,6 +245,7 @@
         authors_email=["[email protected]"],
         category=category,
         runfunc="run_%s" % item,
+        help_url=QUICKVIEWS_HELP,
     )
 
 register(
@@ -250,6 +261,7 @@
     authors_email=["[email protected]"],
     category=CATEGORY_QR_NOTE,
     runfunc="run",
+    help_url=QUICKVIEWS_HELP,
 )
 
 # ------------------------------------------------------------------------
@@ -274,6 +286,7 @@
     authors_email=["[email protected]"],
     category=CATEGORY_QR_REPOSITORY,
     runfunc="run",
+    help_url=QUICKVIEWS_HELP,
 )
 
 # ------------------------------------------------------------------------
@@ -295,6 +308,7 @@
     authors_email=["[email protected]"],
     category=CATEGORY_QR_PERSON,
     runfunc="run",
+    help_url=QUICKVIEWS_HELP,
 )
 
 register(
@@ -310,6 +324,7 @@
     authors_email=["[email protected]"],
     category=CATEGORY_QR_PERSON,
     runfunc="run_given",
+    help_url=QUICKVIEWS_HELP,
 )
 
 register(
@@ -325,6 +340,7 @@
     authors_email=["[email protected]"],
     category=CATEGORY_QR_MISC,
     runfunc="run_given",
+    help_url=QUICKVIEWS_HELP,
 )
 
 # ------------------------------------------------------------------------
@@ -345,4 +361,5 @@
     authors_email=["[email protected]"],
     category=CATEGORY_QR_PERSON,
     runfunc="run",
+    help_url=QUICKVIEWS_HELP,
 )