Re: [Qgis-developer] Improving Processing help files

[matteo]

Hi Johan,

thanks I will have a look at the repository

Thanks again

Matteo
___
Qgis-developer mailing list
Qgis-developer@lists.osgeo.org
List info: http://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: http://lists.osgeo.org/mailman/listinfo/qgis-developer

Re: [Qgis-developer] Improving Processing help files

[Johan Van de Wauw]

Hello matteo,

For the SAGA algorithms, the logical first place to update the
documentation would be in SAGA itself. It will be reviewed by the people
developing SAGA and can be synced to QGis
Our git repository is here:
https://sourceforge.net/p/saga-gis/code/ci/master/tree/ or you can use my
github mirror as well [1] if you prefer that workflow.

I'm available for help to get you started, or you can contact us through
saga-gis-develo...@lists.sourceforge.net

Kind Regards,
Johan
[1] https://github.com/johanvdw/SAGA-gis-git-mirror

On Tue, Dec 20, 2016 at 11:34 AM, Alexander Bruy 
wrote:

> Hi Matteo,
>
> IMHO better to defer this until we decide general approach for
> dealing with help. See:
>
> https://github.com/qgis/qgis3.0_api/issues/62
> https://github.com/qgis/qgis3_UIX_discussion/issues/15
> https://github.com/qgis/QGIS-Enhancement-Proposals/issues/51
>
> 2016-12-20 12:31 GMT+02:00 matteo :
> > Hi guys,
> >
> > I'm currently running some tests on QGIS3 - Processing and I just want
> > to share my idea.
> >
> > At the moment, for almost all the core algorithms, there is a small
> > lateral tab with a brief summary help.
> > Help is taken (please correct me) from qgis.yaml file within the help
> > folder of processing.
> >
> > IMHO, we can in some way improve the helping tab situation. My ideas are:
> >
> > * re-enabling a help tab (next to Log) where we can be more discursive
> > about the algorithm leaving there the side help tab
> > * IMHO, really important could be to enable the adding of images, this
> > can really help a lot (think of how faster is to understand with a
> > description linked to images)
> > * for external algorithms (SAGA but also GDAL) it would be really useful
> > to have some kind of help (SAGA) and some more descriptive help (GDAL)
> >
> >
> > What do you think about it? Could be difficult to extend a kind of rst
> > like syntax to build the helping tabs?
> >
> >
> > Obviously I can help (a little with the code and more with testing and
> > adding description)
> >
> >
> > Thanks to all!
> >
> >
> > Matteo
> > ___
> > Qgis-developer mailing list
> > Qgis-developer@lists.osgeo.org
> > List info: http://lists.osgeo.org/mailman/listinfo/qgis-developer
> > Unsubscribe: http://lists.osgeo.org/mailman/listinfo/qgis-developer
>
>
>
> --
> Alexander Bruy
> ___
> Qgis-developer mailing list
> Qgis-developer@lists.osgeo.org
> List info: http://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: http://lists.osgeo.org/mailman/listinfo/qgis-developer
>
___
Qgis-developer mailing list
Qgis-developer@lists.osgeo.org
List info: http://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: http://lists.osgeo.org/mailman/listinfo/qgis-developer

Re: [Qgis-developer] Improving Processing help files

[Alexander Bruy]

Hi Matteo,

IMHO better to defer this until we decide general approach for
dealing with help. See:

https://github.com/qgis/qgis3.0_api/issues/62
https://github.com/qgis/qgis3_UIX_discussion/issues/15
https://github.com/qgis/QGIS-Enhancement-Proposals/issues/51

2016-12-20 12:31 GMT+02:00 matteo :
> Hi guys,
>
> I'm currently running some tests on QGIS3 - Processing and I just want
> to share my idea.
>
> At the moment, for almost all the core algorithms, there is a small
> lateral tab with a brief summary help.
> Help is taken (please correct me) from qgis.yaml file within the help
> folder of processing.
>
> IMHO, we can in some way improve the helping tab situation. My ideas are:
>
> * re-enabling a help tab (next to Log) where we can be more discursive
> about the algorithm leaving there the side help tab
> * IMHO, really important could be to enable the adding of images, this
> can really help a lot (think of how faster is to understand with a
> description linked to images)
> * for external algorithms (SAGA but also GDAL) it would be really useful
> to have some kind of help (SAGA) and some more descriptive help (GDAL)
>
>
> What do you think about it? Could be difficult to extend a kind of rst
> like syntax to build the helping tabs?
>
>
> Obviously I can help (a little with the code and more with testing and
> adding description)
>
>
> Thanks to all!
>
>
> Matteo
> ___
> Qgis-developer mailing list
> Qgis-developer@lists.osgeo.org
> List info: http://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: http://lists.osgeo.org/mailman/listinfo/qgis-developer



-- 
Alexander Bruy
___
Qgis-developer mailing list
Qgis-developer@lists.osgeo.org
List info: http://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: http://lists.osgeo.org/mailman/listinfo/qgis-developer

[Qgis-developer] Improving Processing help files

[matteo]

Hi guys,

I'm currently running some tests on QGIS3 - Processing and I just want
to share my idea.

At the moment, for almost all the core algorithms, there is a small
lateral tab with a brief summary help.
Help is taken (please correct me) from qgis.yaml file within the help
folder of processing.

IMHO, we can in some way improve the helping tab situation. My ideas are:

* re-enabling a help tab (next to Log) where we can be more discursive
about the algorithm leaving there the side help tab
* IMHO, really important could be to enable the adding of images, this
can really help a lot (think of how faster is to understand with a
description linked to images)
* for external algorithms (SAGA but also GDAL) it would be really useful
to have some kind of help (SAGA) and some more descriptive help (GDAL)


What do you think about it? Could be difficult to extend a kind of rst
like syntax to build the helping tabs?


Obviously I can help (a little with the code and more with testing and
adding description)


Thanks to all!


Matteo
___
Qgis-developer mailing list
Qgis-developer@lists.osgeo.org
List info: http://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: http://lists.osgeo.org/mailman/listinfo/qgis-developer