Implement help text under each dialog.

Fixes please include link to GitHub User Manual in all set-up windows #697

geest/gui/dialogs/analysis_aggregation_dialog.py

@@ -16,9 +16,10 @@
     QCheckBox,
     QWidget,
     QHBoxLayout,
+    QSpacerItem,
 )
-from qgis.PyQt.QtGui import QPixmap
-from qgis.PyQt.QtCore import Qt
+from qgis.PyQt.QtGui import QPixmap, QDesktopServices
+from qgis.PyQt.QtCore import Qt, QUrl
 from qgis.core import Qgis
 from geest.utilities import (
     resources_path,
@@ -179,6 +180,33 @@ def __init__(self, analysis_item, parent=None):
 
         layout.addWidget(self.table)
 
+        help_layout = QHBoxLayout()
+        help_layout.addItem(
+            QSpacerItem(40, 20, QSizePolicy.Expanding, QSizePolicy.Minimum)
+        )
+        self.help_icon = QPixmap(resources_path("resources", "images", "help.png"))
+        self.help_icon = self.help_icon.scaledToWidth(20)
+        self.help_label_icon = QLabel()
+        self.help_label_icon.setPixmap(self.help_icon)
+        self.help_label_icon.setScaledContents(True)
+        self.help_label_icon.setSizePolicy(QSizePolicy.Fixed, QSizePolicy.Fixed)
+        self.help_label_icon.setMaximumWidth(20)
+        self.help_label_icon.setAlignment(Qt.AlignRight)
+        help_layout.addWidget(self.help_label_icon)
+
+        self.help_label = QLabel(
+            "For detailed instructions on how to use this tool, please refer to the <a href='https://worldbank.github.io/GEEST/docs/user_guide.html'>GEEST User Guide</a>."
+        )
+        self.help_label.setOpenExternalLinks(True)
+        self.help_label.setAlignment(Qt.AlignCenter)
+        layout.addWidget(self.help_label)
+        self.help_label.linkActivated.connect(self.open_link_in_browser)
+        help_layout.addWidget(self.help_label)
+        help_layout.addItem(
+            QSpacerItem(40, 20, QSizePolicy.Expanding, QSizePolicy.Minimum)
+        )
+        layout.addLayout(help_layout)
+
         # QDialogButtonBox for OK and Cancel
         self.button_box = QDialogButtonBox(
             QDialogButtonBox.Ok | QDialogButtonBox.Cancel
@@ -207,6 +235,10 @@ def __init__(self, analysis_item, parent=None):
         # Initial validation check
         self.validate_weightings()
 
+    def open_link_in_browser(self, url: str):
+        """Open the given URL in the user's default web browser using QDesktopServices."""
+        QDesktopServices.openUrl(QUrl(url))
+
     def toggle_guid_column(self):
         """Toggle the visibility of the GUID column."""
         log_message("Toggling GUID column visibility")

geest/gui/dialogs/dimension_aggregation_dialog.py

@@ -1,24 +1,22 @@
 from qgis.PyQt.QtWidgets import (
     QDialog,
     QDialogButtonBox,
-    QFrame,
     QHeaderView,
     QLabel,
     QDoubleSpinBox,
     QPushButton,
     QSizePolicy,
     QSpacerItem,
-    QSplitter,
     QTableWidget,
     QTableWidgetItem,
-    QTextEdit,
     QVBoxLayout,
     QCheckBox,
     QWidget,
     QHBoxLayout,
+    QSpacerItem,
 )
-from qgis.PyQt.QtGui import QPixmap
-from qgis.PyQt.QtCore import Qt
+from qgis.PyQt.QtGui import QPixmap, QDesktopServices
+from qgis.PyQt.QtCore import Qt, QUrl
 from qgis.core import Qgis
 from geest.utilities import (
     resources_path,
@@ -173,6 +171,33 @@ def __init__(self, dimension_name, dimension_data, dimension_item, parent=None):
 
         layout.addWidget(self.table)
 
+        help_layout = QHBoxLayout()
+        help_layout.addItem(
+            QSpacerItem(40, 20, QSizePolicy.Expanding, QSizePolicy.Minimum)
+        )
+        self.help_icon = QPixmap(resources_path("resources", "images", "help.png"))
+        self.help_icon = self.help_icon.scaledToWidth(20)
+        self.help_label_icon = QLabel()
+        self.help_label_icon.setPixmap(self.help_icon)
+        self.help_label_icon.setScaledContents(True)
+        self.help_label_icon.setSizePolicy(QSizePolicy.Fixed, QSizePolicy.Fixed)
+        self.help_label_icon.setMaximumWidth(20)
+        self.help_label_icon.setAlignment(Qt.AlignRight)
+        help_layout.addWidget(self.help_label_icon)
+
+        self.help_label = QLabel(
+            "For detailed instructions on how to use this tool, please refer to the <a href='https://worldbank.github.io/GEEST/docs/user_guide.html'>GEEST User Guide</a>."
+        )
+        self.help_label.setOpenExternalLinks(True)
+        self.help_label.setAlignment(Qt.AlignCenter)
+        layout.addWidget(self.help_label)
+        self.help_label.linkActivated.connect(self.open_link_in_browser)
+        help_layout.addWidget(self.help_label)
+        help_layout.addItem(
+            QSpacerItem(40, 20, QSizePolicy.Expanding, QSizePolicy.Minimum)
+        )
+        layout.addLayout(help_layout)
+
         # QDialogButtonBox for OK and Cancel
         self.button_box = QDialogButtonBox(
             QDialogButtonBox.Ok | QDialogButtonBox.Cancel
@@ -199,6 +224,10 @@ def __init__(self, dimension_name, dimension_data, dimension_item, parent=None):
         # Initial validation check
         self.validate_weightings()
 
+    def open_link_in_browser(self, url: str):
+        """Open the given URL in the user's default web browser using QDesktopServices."""
+        QDesktopServices.openUrl(QUrl(url))
+
     def toggle_guid_column(self):
         """Toggle the visibility of the GUID column."""
         log_message("Toggling GUID column visibility")

geest/gui/dialogs/factor_aggregation_dialog.py

@@ -12,9 +12,10 @@
     QWidget,
     QCheckBox,
     QHBoxLayout,
+    QSpacerItem,
 )
-from qgis.PyQt.QtGui import QPixmap
-from qgis.PyQt.QtCore import Qt
+from qgis.PyQt.QtGui import QPixmap, QDesktopServices
+from qgis.PyQt.QtCore import Qt, QUrl
 from qgis.core import Qgis
 from geest.utilities import resources_path, setting
 from ..datasource_widget_factory import DataSourceWidgetFactory
@@ -114,6 +115,33 @@ def __init__(self, factor_name, factor_data, factor_item, parent=None):
 
         layout.addWidget(self.table)
 
+        help_layout = QHBoxLayout()
+        help_layout.addItem(
+            QSpacerItem(40, 20, QSizePolicy.Expanding, QSizePolicy.Minimum)
+        )
+        self.help_icon = QPixmap(resources_path("resources", "images", "help.png"))
+        self.help_icon = self.help_icon.scaledToWidth(20)
+        self.help_label_icon = QLabel()
+        self.help_label_icon.setPixmap(self.help_icon)
+        self.help_label_icon.setScaledContents(True)
+        self.help_label_icon.setSizePolicy(QSizePolicy.Fixed, QSizePolicy.Fixed)
+        self.help_label_icon.setMaximumWidth(20)
+        self.help_label_icon.setAlignment(Qt.AlignRight)
+        help_layout.addWidget(self.help_label_icon)
+
+        self.help_label = QLabel(
+            "For detailed instructions on how to use this tool, please refer to the <a href='https://worldbank.github.io/GEEST/docs/user_guide.html'>GEEST User Guide</a>."
+        )
+        self.help_label.setOpenExternalLinks(True)
+        self.help_label.setAlignment(Qt.AlignCenter)
+        layout.addWidget(self.help_label)
+        self.help_label.linkActivated.connect(self.open_link_in_browser)
+        help_layout.addWidget(self.help_label)
+        help_layout.addItem(
+            QSpacerItem(40, 20, QSizePolicy.Expanding, QSizePolicy.Minimum)
+        )
+        layout.addLayout(help_layout)
+
         # Buttons
         self.button_box = QDialogButtonBox(
             QDialogButtonBox.Ok | QDialogButtonBox.Cancel
@@ -141,6 +169,10 @@ def __init__(self, factor_name, factor_data, factor_item, parent=None):
         self.setLayout(layout)
         self.populate_table()  # Populate the table after initializing data_sources and weightings
 
+    def open_link_in_browser(self, url: str):
+        """Open the given URL in the user's default web browser using QDesktopServices."""
+        QDesktopServices.openUrl(QUrl(url))
+
     def refresh_configuration(self, attributes: dict):
         """Refresh the configuration widget and table.