Merge pull request #5004 from jgrocha/helpviewer

[needs-docs] Refactoring of all help calls, deprecating QgsContextHelp+Helpviewer

Author: m-kuhn

python/console/console.py

@@ -31,8 +31,8 @@
 from .console_output import ShellOutputScintilla
 from .console_editor import EditorTabWidget
 from .console_settings import optionsDialog
-from qgis.core import QgsApplication, QgsContextHelp, QgsSettings
-from qgis.gui import QgsFilterLineEdit
+from qgis.core import QgsApplication, QgsSettings
+from qgis.gui import QgsFilterLineEdit, QgsHelp
 from functools import partial
 
 import sys
@@ -59,7 +59,7 @@ def show_console():
     # Shows help on first launch of the console
     settings = QgsSettings()
     if settings.value('pythonConsole/contextHelpOnFirstLaunch', True, type=bool):
-        QgsContextHelp.run("PythonConsole")
+        QgsHelp.openHelp("../pyqgis_developer_cookbook/intro.html#python-console")
         settings.setValue('pythonConsole/contextHelpOnFirstLaunch', False)
 
     return _console
@@ -657,7 +657,7 @@ def saveAsScriptFile(self, index=None):
                 self.updateTabListScript(pathFileName, action='remove')
 
     def openHelp(self):
-        QgsContextHelp.run("PythonConsole")
+        QgsHelp.openHelp("plugins/python_console.html")
 
     def openSettings(self):
         if optionsDialog(self).exec_():

python/core/core_auto.sip

@@ -19,7 +19,6 @@
 %Include qgscolorramp.sip
 %Include qgscolorscheme.sip
 %Include qgscolorschemeregistry.sip
-%Include qgscontexthelp.sip
 %Include qgsconditionalstyle.sip
 %Include qgscoordinatetransform.sip
 %Include qgscrscache.sip

python/core/qgscontexthelp.sip

@@ -8,6 +8,8 @@
 
 
 
+
+
 class QgsNewHttpConnection : QDialog
 {
 %Docstring
@@ -27,13 +29,9 @@ Constructor
   public slots:
     virtual void accept();
 
-
     void on_txtName_textChanged( const QString & );
-
     void on_txtUrl_textChanged( const QString & );
 
-    void on_buttonBox_helpRequested();
-
 };
 
 /************************************************************************

python/gui/qgsnewhttpconnection.sip

@@ -65,7 +65,11 @@ Returns the file format for storage
     void on_mRemoveAttributeButton_clicked();
     void on_mFileFormatComboBox_currentIndexChanged( int index );
     void on_mTypeBox_currentIndexChanged( int index );
-    void on_buttonBox_helpRequested();
+
+    void showHelp();
+%Docstring
+Open the associated help
+%End
     void nameChanged( const QString & );
     void selectionChanged();
 

python/gui/qgsnewvectorlayerdialog.sip

@@ -68,8 +68,6 @@ class QgsQueryBuilder : QDialog
     void on_btnNot_clicked();
     void on_btnOr_clicked();
 
-    void on_buttonBox_helpRequested();
-
     void test();
 %Docstring
  Test the constructed sql statement to see if the vector layer data provider likes it.

python/gui/qgsquerybuilder.sip

@@ -78,8 +78,6 @@ change search string shown in text field
  are inserted into the values list box.
 %End
 
-    void on_buttonBox_helpRequested();
-
     void saveQuery();
     void loadQuery();
 

python/gui/qgssearchquerybuilder.sip

@@ -77,7 +77,6 @@ class QgsSublayersDialog : QDialog
 %End
 
   public slots:
-    void on_buttonBox_helpRequested();
     int exec();
 %Docstring
  :rtype: int

python/gui/qgssublayersdialog.sip

@@ -47,7 +47,15 @@ adds symbols of some type to list
 called when the dialog is going to be closed
 %End
 
-    void on_buttonBox_helpRequested();
+    void onClose();
+%Docstring
+Close the dialog
+%End
+
+    void showHelp();
+%Docstring
+Open the associated help
+%End
 
     void itemChanged( QStandardItem *item );
 

python/gui/symbology/qgsstylemanagerdialog.sip

@@ -0,0 +1,37 @@
+#!/bin/bash
+###########################################################################
+#    chkdoclink.sh
+#    ---------------------
+#    Date                 : August 2017
+#    Copyright            : (C) 2017 by Jorge Gustavo Rocha
+#    Email                : jgr at geomaster dot pt
+###########################################################################
+#                                                                         #
+#   This program is free software; you can redistribute it and/or modify  #
+#   it under the terms of the GNU General Public License as published by  #
+#   the Free Software Foundation; either version 2 of the License, or     #
+#   (at your option) any later version.                                   #
+#                                                                         #
+###########################################################################
+
+# This script is used to check missing links to the documentation
+# This script only reports missing links
+# An option argument can be used to indicate the base URL of the documentation, for example:
+#
+# scripts/chkdoclink.sh http://docs.qgis.org/2.18/en/docs/user_manual/
+#
+# When no link is indicated, the link used is:
+# http://docs.qgis.org/testing/en/docs/user_manual/
+#
+# Nødebo, August 2017
+
+prefix=${1:-http://docs.qgis.org/testing/en/docs/user_manual/}
+find .. \( -name \*.h -o -name \*.cpp \) -exec grep -H "QgsHelp::openHelp(" \{\} \; | sed 's/:[^"]\+/\t/;s/" .\+$/"/' | sort | sed 's/^\.\.\/QGIS\///' | awk -F $'\t' '{print $1 ";" $2;}' | grep -v ";$" | sed 's/"//g' | while read line; do
+    file=${line%;*}
+    suffix=${line##*;}
+    link=$prefix$suffix
+    if ! wget --spider $link 2>/dev/null; then
+        echo "Documentation missing for: $file Key: $suffix"
+    fi
+done
+