FEATURE: Automatically open documentation in browser

Author: amilcarlucas

MethodicConfigurator/backend_filesystem_program_settings.py

@@ -21,12 +21,18 @@
 from re import escape as re_escape
 from re import match as re_match
 from re import sub as re_sub
-from typing import Any
+from typing import Any, Union
 
 from platformdirs import site_config_dir, user_config_dir
 
 from MethodicConfigurator import _
 
+SETTINGS_DEFAULTS: dict[str, Union[int, bool]] = {
+    "Format version": 1,
+    "auto_open_doc_in_browser": True,
+    "annotate_docs_into_param_files": False,
+}
+
 
 class ProgramSettings:
     """
@@ -125,7 +131,7 @@ def __get_settings_as_dict() -> dict[str, Any]:
             pass
 
         if "Format version" not in settings:
-            settings["Format version"] = 1
+            settings["Format version"] = SETTINGS_DEFAULTS["Format version"]
 
         if "directory_selection" not in settings:
             settings["directory_selection"] = {}
@@ -137,6 +143,11 @@ def __get_settings_as_dict() -> dict[str, Any]:
         if "parameter_editor" not in settings["display_usage_popup"]:
             settings["display_usage_popup"]["parameter_editor"] = True
 
+        if "auto_open_doc_in_browser" not in settings:
+            settings["auto_open_doc_in_browser"] = SETTINGS_DEFAULTS["auto_open_doc_in_browser"]
+        if "annotate_docs_into_param_files" not in settings:
+            settings["annotate_docs_into_param_files"] = SETTINGS_DEFAULTS["annotate_docs_into_param_files"]
+
         return settings
 
     @staticmethod
@@ -235,3 +246,16 @@ def set_display_usage_popup(ptype: str, value: bool) -> None:
             settings, _, _ = ProgramSettings.__get_settings_config()
             settings["display_usage_popup"][ptype] = value
             ProgramSettings.__set_settings_from_dict(settings)
+
+    @staticmethod
+    def get_setting(setting: str) -> Union[int, bool]:
+        if setting in SETTINGS_DEFAULTS:
+            return ProgramSettings.__get_settings_as_dict().get(setting, SETTINGS_DEFAULTS[setting])
+        return False
+
+    @staticmethod
+    def set_setting(setting: str, value: Union[int, bool]) -> None:
+        if setting in SETTINGS_DEFAULTS:
+            settings, _, _ = ProgramSettings.__get_settings_config()
+            settings[setting] = value
+            ProgramSettings.__set_settings_from_dict(settings)

MethodicConfigurator/frontend_tkinter_parameter_editor.py

@@ -52,12 +52,13 @@ class DocumentationFrame:  # pylint: disable=too-few-public-methods
     functionality to open these links in a web browser.
     """
 
-    def __init__(self, root: tk.Widget, local_filesystem, current_file: str) -> None:
+    def __init__(self, root: tk.Widget, local_filesystem: LocalFilesystem, current_file: str) -> None:
         self.root = root
         self.local_filesystem = local_filesystem
         self.current_file = current_file
         self.documentation_frame: ttk.LabelFrame
         self.documentation_labels: dict[str, ttk.Label] = {}
+        self.auto_open_var = tk.BooleanVar(value=bool(ProgramSettings.get_setting("auto_open_doc_in_browser")))
         self.__create_documentation_frame()
 
     def __create_documentation_frame(self) -> None:
@@ -84,9 +85,32 @@ def __create_documentation_frame(self) -> None:
             label.grid(row=i, column=0, sticky="w")
             show_tooltip(label, descriptive_tooltips[i])
 
-            # Create labels for the second column with the documentation links
-            self.documentation_labels[text] = ttk.Label(documentation_grid)
-            self.documentation_labels[text].grid(row=i, column=1, sticky="w")
+            if i == 3:
+                bottom_frame = ttk.Frame(documentation_grid)
+                bottom_frame.grid(row=i, column=1, sticky="ew")  # ew to stretch horizontally
+
+                self.documentation_labels[text] = ttk.Label(bottom_frame)
+                self.documentation_labels[text].pack(side=tk.LEFT, fill="x", expand=True)
+                auto_open_checkbox = ttk.Checkbutton(
+                    bottom_frame,
+                    text=_("Automatically open documentation links in browser"),
+                    variable=self.auto_open_var,
+                    command=lambda: ProgramSettings.set_setting("auto_open_doc_in_browser", self.auto_open_var.get()),
+                )
+                show_tooltip(
+                    auto_open_checkbox,
+                    _(
+                        "Automatically open all the above documentation links in a browser\n"
+                        "whenever the current intermediate parameter file changes"
+                    ),
+                )
+                auto_open_checkbox.pack(side=tk.LEFT, expand=False)
+            else:
+                # Create labels for the second column with the documentation links
+                self.documentation_labels[text] = ttk.Label(documentation_grid)
+                self.documentation_labels[text].grid(row=i, column=1, sticky="ew")
+        documentation_grid.columnconfigure(0, weight=0)
+        documentation_grid.columnconfigure(1, weight=1)
 
         # Dynamically update the documentation text and URL links
         self.update_documentation_labels(self.current_file)
@@ -111,6 +135,14 @@ def update_documentation_labels(self, current_file: str) -> None:
         mandatory_text, mandatory_url = self.local_filesystem.get_documentation_text_and_url(current_file, "mandatory")
         self.__update_documentation_label(_("Mandatory:"), mandatory_text, mandatory_url, False)
 
+        if self.auto_open_var.get():
+            if wiki_url:
+                webbrowser_open(url=wiki_url, new=0, autoraise=False)
+            if external_tool_url:
+                webbrowser_open(url=external_tool_url, new=0, autoraise=False)
+            if blog_url:
+                webbrowser_open(url=blog_url, new=0, autoraise=True)
+
     def __update_documentation_label(self, label_key, text, url, url_expected=True) -> None:
         label = self.documentation_labels[label_key]
         if url: