Re: [QGIS-Developer] Adding help text for processing plugin

[Nyall Dawson]

On 9 May 2018 at 06:52, Phil Ribbens  wrote:
> Hi,
>
> I’m wondering if it’s possible to add help text (that will show up in
> right-hand sidebar) for a processing plugin that I’m developing in QGIS3.
>
> I think I found where the help text for the native QGIS plugins comes from
> (https://github.com/qgis/QGIS/blob/master/python/plugins/processing/algs/help/qgis.yaml),
> but I’m not sure how I might be able to provide my own help text for a
> processing plugin I’m developing.

You just need to implement the shortHelpString method in your
algorithm and return the translated help text.

Nyall


>
> Thanks,
> Phil Ribbens
>
> ___
> QGIS-Developer mailing list
> QGIS-Developer@lists.osgeo.org
> List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer

Re: [QGIS-Developer] Adding help text for processing plugin

[Etienne Trimaille]

You can check this example:
https://github.com/qgis/QGIS/blob/master/python/plugins/processing/script/ScriptTemplate.py#L77

2018-05-08 17:12 GMT-04:00 Nyall Dawson :

> On 9 May 2018 at 06:52, Phil Ribbens  wrote:
> > Hi,
> >
> > I’m wondering if it’s possible to add help text (that will show up in
> > right-hand sidebar) for a processing plugin that I’m developing in QGIS3.
> >
> > I think I found where the help text for the native QGIS plugins comes
> from
> > (https://github.com/qgis/QGIS/blob/master/python/plugins/
> processing/algs/help/qgis.yaml),
> > but I’m not sure how I might be able to provide my own help text for a
> > processing plugin I’m developing.
>
> You just need to implement the shortHelpString method in your
> algorithm and return the translated help text.
>
> Nyall
>
>
> >
> > Thanks,
> > Phil Ribbens
> >
> > ___
> > QGIS-Developer mailing list
> > QGIS-Developer@lists.osgeo.org
> > List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
> > Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
> ___
> QGIS-Developer mailing list
> QGIS-Developer@lists.osgeo.org
> List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer

Re: [QGIS-Developer] Adding help text for processing plugin

[Phil Ribbens]

Perfect, thank you so much!

> On May 8, 2018, at 5:17 PM, Etienne Trimaille  
> wrote:
> 
> You can check this example: 
> https://github.com/qgis/QGIS/blob/master/python/plugins/processing/script/ScriptTemplate.py#L77
>  
> 
> 
> 2018-05-08 17:12 GMT-04:00 Nyall Dawson  >:
> On 9 May 2018 at 06:52, Phil Ribbens  > wrote:
> > Hi,
> >
> > I’m wondering if it’s possible to add help text (that will show up in
> > right-hand sidebar) for a processing plugin that I’m developing in QGIS3.
> >
> > I think I found where the help text for the native QGIS plugins comes from
> > (https://github.com/qgis/QGIS/blob/master/python/plugins/processing/algs/help/qgis.yaml
> >  
> > ),
> > but I’m not sure how I might be able to provide my own help text for a
> > processing plugin I’m developing.
> 
> You just need to implement the shortHelpString method in your
> algorithm and return the translated help text.
> 
> Nyall
> 
> 
> >
> > Thanks,
> > Phil Ribbens
> >
> > ___
> > QGIS-Developer mailing list
> > QGIS-Developer@lists.osgeo.org 
> > List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer 
> > 
> > Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer 
> > 
> ___
> QGIS-Developer mailing list
> QGIS-Developer@lists.osgeo.org 
> List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer 
> 
> Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer 
> 

___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer