[processing] Fix modeler help/description generation, allow setting

nyalldawson · nyalldawson · commit e2082a093580 · 2018-09-26T04:26:49.000+10:00
of model short description text Fixes #18767
diff --git a/python/core/auto_generated/processing/models/qgsprocessingmodelalgorithm.sip.in b/python/core/auto_generated/processing/models/qgsprocessingmodelalgorithm.sip.in
@@ -45,7 +45,7 @@ Constructor for QgsProcessingModelAlgorithm.
 
     virtual QString shortHelpString() const;
 
-    virtual QString helpUrl() const;
+    virtual QString shortDescription() const;
 
     virtual Flags flags() const;
 
diff --git a/python/plugins/processing/gui/HelpEditionDialog.py b/python/plugins/processing/gui/HelpEditionDialog.py
@@ -52,6 +52,7 @@ class HelpEditionDialog(BASE, WIDGET):
     ALG_CREATOR = 'ALG_CREATOR'
     ALG_HELP_CREATOR = 'ALG_HELP_CREATOR'
     ALG_VERSION = 'ALG_VERSION'
+    SHORT_DESCRIPTION = 'SHORT_DESCRIPTION'
 
     def __init__(self, alg):
         super(HelpEditionDialog, self).__init__(None)
@@ -103,6 +104,8 @@ def getHtml(self):
     def fillTree(self):
         item = TreeDescriptionItem(self.tr('Algorithm description'), self.ALG_DESC)
         self.tree.addTopLevelItem(item)
+        item = TreeDescriptionItem(self.tr('Short description'), self.SHORT_DESCRIPTION)
+        self.tree.addTopLevelItem(item)
         parametersItem = TreeDescriptionItem(self.tr('Input parameters'), None)
         self.tree.addTopLevelItem(parametersItem)
         for param in self.alg.parameterDefinitions():
diff --git a/src/core/processing/models/qgsprocessingmodelalgorithm.cpp b/src/core/processing/models/qgsprocessingmodelalgorithm.cpp
@@ -70,14 +70,15 @@ QString QgsProcessingModelAlgorithm::svgIconPath() const
 
 QString QgsProcessingModelAlgorithm::shortHelpString() const
 {
-  if ( mHelpContent.contains( QStringLiteral( "ALG_DESC" ) ) )
-    return mHelpContent.value( QStringLiteral( "ALG_DESC" ) ).toString();
-  return QString();
+  if ( mHelpContent.empty() )
+    return QString();
+
+  return QgsProcessingUtils::formatHelpMapAsHtml( mHelpContent, this );
 }
 
-QString QgsProcessingModelAlgorithm::helpUrl() const
+QString QgsProcessingModelAlgorithm::shortDescription() const
 {
-  return QgsProcessingUtils::formatHelpMapAsHtml( mHelpContent, this );
+  return mHelpContent.value( QStringLiteral( "SHORT_DESCRIPTION" ) ).toString();
 }
 
 QgsProcessingAlgorithm::Flags QgsProcessingModelAlgorithm::flags() const
diff --git a/src/core/processing/models/qgsprocessingmodelalgorithm.h b/src/core/processing/models/qgsprocessingmodelalgorithm.h
@@ -51,7 +51,7 @@ class CORE_EXPORT QgsProcessingModelAlgorithm : public QgsProcessingAlgorithm
     QIcon icon() const override;
     QString svgIconPath() const override;
     QString shortHelpString() const override;
-    QString helpUrl() const override;
+    QString shortDescription() const override;
     Flags flags() const override;
 
     bool canExecute( QString *errorMessage SIP_OUT = nullptr ) const override;
diff --git a/src/core/processing/qgsprocessingutils.cpp b/src/core/processing/qgsprocessingutils.cpp
@@ -595,23 +595,33 @@ QString QgsProcessingUtils::formatHelpMapAsHtml( const QVariantMap &map, const Q
 
   QString s = QObject::tr( "<html><body><h2>Algorithm description</h2>\n" );
   s += QStringLiteral( "<p>" ) + getText( QStringLiteral( "ALG_DESC" ) ) + QStringLiteral( "</p>\n" );
-  s += QObject::tr( "<h2>Input parameters</h2>\n" );
 
+  QString inputs;
   Q_FOREACH ( const QgsProcessingParameterDefinition *def, algorithm->parameterDefinitions() )
   {
-    s += QStringLiteral( "<h3>" ) + def->description() + QStringLiteral( "</h3>\n" );
-    s += QStringLiteral( "<p>" ) + getText( def->name() ) + QStringLiteral( "</p>\n" );
+    inputs += QStringLiteral( "<h3>" ) + def->description() + QStringLiteral( "</h3>\n" );
+    inputs += QStringLiteral( "<p>" ) + getText( def->name() ) + QStringLiteral( "</p>\n" );
   }
-  s += QObject::tr( "<h2>Outputs</h2>\n" );
+  if ( !inputs.isEmpty() )
+    s += QObject::tr( "<h2>Input parameters</h2>\n" ) + inputs;
+
+  QString outputs;
   Q_FOREACH ( const QgsProcessingOutputDefinition *def, algorithm->outputDefinitions() )
   {
-    s += QStringLiteral( "<h3>" ) + def->description() + QStringLiteral( "</h3>\n" );
-    s += QStringLiteral( "<p>" ) + getText( def->name() ) + QStringLiteral( "</p>\n" );
+    outputs += QStringLiteral( "<h3>" ) + def->description() + QStringLiteral( "</h3>\n" );
+    outputs += QStringLiteral( "<p>" ) + getText( def->name() ) + QStringLiteral( "</p>\n" );
   }
+  if ( !outputs.isEmpty() )
+    s += QObject::tr( "<h2>Outputs</h2>\n" ) + outputs;
+
   s += QLatin1String( "<br>" );
-  s += QObject::tr( "<p align=\"right\">Algorithm author: %1</p>" ).arg( getText( QStringLiteral( "ALG_CREATOR" ) ) );
-  s += QObject::tr( "<p align=\"right\">Help author: %1</p>" ).arg( getText( QStringLiteral( "ALG_HELP_CREATOR" ) ) );
-  s += QObject::tr( "<p align=\"right\">Algorithm version: %1</p>" ).arg( getText( QStringLiteral( "ALG_VERSION" ) ) );
+  if ( !map.value( QStringLiteral( "ALG_CREATOR" ) ).toString().isEmpty() )
+    s += QObject::tr( "<p align=\"right\">Algorithm author: %1</p>" ).arg( getText( QStringLiteral( "ALG_CREATOR" ) ) );
+  if ( !map.value( QStringLiteral( "ALG_HELP_CREATOR" ) ).toString().isEmpty() )
+    s += QObject::tr( "<p align=\"right\">Help author: %1</p>" ).arg( getText( QStringLiteral( "ALG_HELP_CREATOR" ) ) );
+  if ( !map.value( QStringLiteral( "ALG_VERSION" ) ).toString().isEmpty() )
+    s += QObject::tr( "<p align=\"right\">Algorithm version: %1</p>" ).arg( getText( QStringLiteral( "ALG_VERSION" ) ) );
+
   s += QStringLiteral( "</body></html>" );
   return s;
 }

Original file line number	Diff line number	Diff line change
`@@ -70,14 +70,15 @@ QString QgsProcessingModelAlgorithm::svgIconPath() const`
`70`	`70`
`71`	`71`	`QString QgsProcessingModelAlgorithm::shortHelpString() const`
`72`	`72`	`{`
`73`		`- if ( mHelpContent.contains( QStringLiteral( "ALG_DESC" ) ) )`
`74`		`- return mHelpContent.value( QStringLiteral( "ALG_DESC" ) ).toString();`
`75`		`- return QString();`
	`73`	`+ if ( mHelpContent.empty() )`
	`74`	`+ return QString();`
	`75`	`+`
	`76`	`+ return QgsProcessingUtils::formatHelpMapAsHtml( mHelpContent, this );`
`76`	`77`	`}`
`77`	`78`
`78`		`-QString QgsProcessingModelAlgorithm::helpUrl() const`
	`79`	`+QString QgsProcessingModelAlgorithm::shortDescription() const`
`79`	`80`	`{`
`80`		`- return QgsProcessingUtils::formatHelpMapAsHtml( mHelpContent, this );`
	`81`	`+ return mHelpContent.value( QStringLiteral( "SHORT_DESCRIPTION" ) ).toString();`
`81`	`82`	`}`
`82`	`83`
`83`	`84`	`QgsProcessingAlgorithm::Flags QgsProcessingModelAlgorithm::flags() const`