Re: [QGIS-Developer] Processing Help system

[delazj]

Not me but this has been discussed a couple of times and the latest discussion 
began at 
https://github.com/qgis/QGIS-Documentation/pull/2258#issuecomment-352246124 
(some ideas/plans after). 

H. 

Le 18 févr. 2018 8:02 PM, Paolo Cavallini  a écrit :
>
> Il 13/02/2018 16:53, DelazJ ha scritto:
>
> > For me, processing help system is fixed but the help system itself is
> > not. It still suffers from suffers obstacles which it puts on the
> > capacity of the writers to update the user manual without complications:
> > section URLs are currently hard coded in application and changing a
> > section title (hence the url) breaks the help button. With a living doc
> > like the user manual, with all the new features and improvements QGIS
> > gets, it would be hard to keep same titles at same place forever (either
> > because it no longer describes new features of the dialog, or the dialog
> > gets renamed, or features are moved to another place, or we find a
> > better, more appropriate wording, or...) and documenters should not care
> > about that. For information we have pending PRs in docs that will break
> > some of the already connected links.
> > 
> > Developers improve the application, documenters improve the manuals and
> > we find a way to keep links working as long as possible without anyone
> > stressing. Please, let's do something more sustainable!
>
> Agreed, your approach sounds reasonable to me.
> Do you have a specific proposal? This could be a reasonable topic for a
> next QGIS Grant.
> All the best.
> -- 
> Paolo Cavallini - www.faunalia.eu
> QGIS & PostGIS courses: http://www.faunalia.eu/training.html
> https://www.google.com/trends/explore?date=all=IT=qgis,arcgis
> ___
> 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] Processing Help system

[Paolo Cavallini]

Il 13/02/2018 16:53, DelazJ ha scritto:

> For me, processing help system is fixed but the help system itself is
> not. It still suffers from suffers obstacles which it puts on the
> capacity of the writers to update the user manual without complications:
> section URLs are currently hard coded in application and changing a
> section title (hence the url) breaks the help button. With a living doc
> like the user manual, with all the new features and improvements QGIS
> gets, it would be hard to keep same titles at same place forever (either
> because it no longer describes new features of the dialog, or the dialog
> gets renamed, or features are moved to another place, or we find a
> better, more appropriate wording, or...) and documenters should not care
> about that. For information we have pending PRs in docs that will break
> some of the already connected links.
> 
> Developers improve the application, documenters improve the manuals and
> we find a way to keep links working as long as possible without anyone
> stressing. Please, let's do something more sustainable!

Agreed, your approach sounds reasonable to me.
Do you have a specific proposal? This could be a reasonable topic for a
next QGIS Grant.
All the best.
-- 
Paolo Cavallini - www.faunalia.eu
QGIS & PostGIS courses: http://www.faunalia.eu/training.html
https://www.google.com/trends/explore?date=all=IT=qgis,arcgis
___
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] Processing Help system

[matteo]

Hi,

sorry or the delay of the answer and thanks thanks thanks again
Harrissou for all the work done


> - All Processing help pull-requests have now got at least one round of
> review.

I'm rebasing all PRs to the renamed files.

> - Processing help files have been renamed to match groupId so pushing any
> algorithm help button should lead you at least to the page it "is"
> documented. You will not always directly get the algorithm section (it
> fails if name is not a single word like clip, intersection...) but I wonder
> if that's really an issue given that at the top of each page we have the
> TOC listing all provided algorithms --> you just need one more click.
> @Richard, did you have time to investigate the id span thingies you were
> referring to last day? Is it worth the effort? Could that live together
> with our current .. _qgis_clip: anchor?

even if the Help button opens the correct group page and the user needs,
sometimes, one more click to go to the correct algorithm, I think it is
a pity not having a correct section redirection.

> For me, processing help system is fixed but the help system itself is not.
> It still suffers from suffers obstacles which it puts on the capacity of
> the writers to update the user manual without complications: section URLs
> are currently hard coded in application and changing a section title (hence
> the url) breaks the help button. With a living doc like the user manual,
> with all the new features and improvements QGIS gets, it would be hard to
> keep same titles at same place forever (either because it no longer
> describes new features of the dialog, or the dialog gets renamed, or
> features are moved to another place, or we find a better, more appropriate
> wording, or...) and documenters should not care about that. For information
> we have pending PRs in docs that will break some of the already connected
> links.
> 
> Developers improve the application, documenters improve the manuals and we
> find a way to keep links working as long as possible without anyone
> stressing. Please, let's do something more sustainable!

I could agree more on this. Specifically for Processing algorithms the
obstacle to have a correct header redirection is really small: as you
know it is just a hyphen handling.

The whole QGIS Help system has impressively improved and we should try
to find a way to better linking dev and doc writer jobs.

Maybe we can have a session on this in Madeira

Thanks

Matteo



___
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] Processing Help system

[DelazJ]

Hi all,

For the record:
- All Processing help pull-requests have now got at least one round of
review.
- Processing help files have been renamed to match groupId so pushing any
algorithm help button should lead you at least to the page it "is"
documented. You will not always directly get the algorithm section (it
fails if name is not a single word like clip, intersection...) but I wonder
if that's really an issue given that at the top of each page we have the
TOC listing all provided algorithms --> you just need one more click.
@Richard, did you have time to investigate the id span thingies you were
referring to last day? Is it worth the effort? Could that live together
with our current .. _qgis_clip: anchor?

For me, processing help system is fixed but the help system itself is not.
It still suffers from suffers obstacles which it puts on the capacity of
the writers to update the user manual without complications: section URLs
are currently hard coded in application and changing a section title (hence
the url) breaks the help button. With a living doc like the user manual,
with all the new features and improvements QGIS gets, it would be hard to
keep same titles at same place forever (either because it no longer
describes new features of the dialog, or the dialog gets renamed, or
features are moved to another place, or we find a better, more appropriate
wording, or...) and documenters should not care about that. For information
we have pending PRs in docs that will break some of the already connected
links.

Developers improve the application, documenters improve the manuals and we
find a way to keep links working as long as possible without anyone
stressing. Please, let's do something more sustainable!
Thanks.

Regards,
Harrissou



2018-02-10 11:08 GMT+01:00 Richard Duivenvoorde :

> On 10-02-18 08:34, Alexander Bruy wrote:
> > Hi Richard,
> >
> > 2018-02-09 16:08 GMT+02:00 Richard Duivenvoorde :
> >> Would it be possible to write, the url which is searched for, to the
> >> MessageLog/Log Message Panel (in a tab named 'QGIS Help') or so?
> >
> > PR is here https://github.com/qgis/QGIS/pull/6303
> > Hope this is what you are asking for.
> >
> > Also this PR adds online User Guide as default help location to global
> settings.
>
> Thanks Alex! Comment added at PR
>
> Regards,
>
> Richard
>
> ___
> 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] Processing Help system

[Richard Duivenvoorde]

On 10-02-18 08:34, Alexander Bruy wrote:
> Hi Richard,
> 
> 2018-02-09 16:08 GMT+02:00 Richard Duivenvoorde :
>> Would it be possible to write, the url which is searched for, to the
>> MessageLog/Log Message Panel (in a tab named 'QGIS Help') or so?
> 
> PR is here https://github.com/qgis/QGIS/pull/6303
> Hope this is what you are asking for.
> 
> Also this PR adds online User Guide as default help location to global 
> settings.

Thanks Alex! Comment added at PR

Regards,

Richard

___
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] Processing Help system

[Alexander Bruy]

Hi Richard,

2018-02-09 16:08 GMT+02:00 Richard Duivenvoorde :
> Would it be possible to write, the url which is searched for, to the
> MessageLog/Log Message Panel (in a tab named 'QGIS Help') or so?

PR is here https://github.com/qgis/QGIS/pull/6303
Hope this is what you are asking for.

Also this PR adds online User Guide as default help location to global settings.


-- 
Alexander Bruy
___
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] Processing Help system

[Richard Duivenvoorde]

On 09-02-18 02:32, Nyall Dawson wrote:

> PR at https://github.com/qgis/QGIS/pull/6298
> 
> Feedback on this approach is welcome, but I think fixing in the code
> is correct vs fixing via redirects.

Hi Nyall,

THANKS! Working :-)

One thing which I would like to ask:

Would it be possible to write, the url which is searched for, to the
MessageLog/Log Message Panel (in a tab named 'QGIS Help') or so?

So (even a normal user) can when he/she sees a 'Oops no help' can check
if the actual url looked for is a valid one or not.

Somewhere like here:
https://github.com/qgis/QGIS/blob/master/src/gui/qgshelp.cpp#L75

We have a lot of different Oopsies possible to find out and/or fixed:
- redirects
- wrong group ids
- wrong names
- not picked up settings (
https://issues.qgis.org/issues/17670)
- local vs remote help (to be implemented
- wrong Documentation paths setting (or one of the vars in it)

Would be great if that could be checked.
This would FIX issue https://issues.qgis.org/issues/17666 :-)

Regards,

Richard Duivenvoorde
___
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] Processing Help system

[matteo]

> @Harrissou: I think Nyall's idea to use the id's is best, as the name
> could have been translated?

I also understood it this way (also Alex explained this). name() is what
users see (and could be translated) while id() is unique an not-translatable
___
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] Processing Help system

[Tom Chadwin]

I didn't know this, but apparently anything can be an anchor:

https://www.w3.org/TR/html4/struct/links.html#h-12.2.3

So the span is fine.

Tom



-
Buy Pie Spy: Adventures in British pastry 2010-11 on Amazon 
--
Sent from: http://osgeo-org.1560.x6.nabble.com/QGIS-Developer-f4099106.html
___
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] Processing Help system

[Richard Duivenvoorde]

(resending as was sent with wrong email...)

Ah, yes, confirmed... funny:



is usable as an anchor?

Well if it works (in all OS's and browsers?) it works :-)

Any html guru's here?

@Harrissou: I think Nyall's idea to use the id's is best, as the name
could have been translated?

Richard


On 09-02-18 12:16, Alexandre Neto wrote:
> but yes, it's not an anchor that is created.
> 
> Alexandre Neto >
> escreveu no dia sexta, 9/02/2018 às 11:12:
> 
> I was able to use this local URL (note that I haven't renamed the
> rst file ):
> 
> 
> output/html/en/docs/user_manual/processing_algs/qgis/vector_analysis_tools.html#nearestneighbouranalysis
> 
> Richard Duivenvoorde  > escreveu no dia sexta, 9/02/2018 às 11:10:
> 
> 
> I thought wat Alexandre was saying was ok, but trying it out, it
> seems
> just to create a 'span' with that id not a href#anchor ...
> 
> Anybody else can try?
> 
> Richard
> 
> On 09-02-18 11:55, Alexandre Neto wrote:
> > From what I understand, we should stick to the algorithm ID. The
> > provider is already implicit by the file structure. Assuming
> that that
> > ID is unique across all the providers.
> >
> > processing_algs > qgis > vector analysis tools
> >
> > matteo    >>
> > escreveu no dia sexta, 9/02/2018 às 10:44:
> >
> >     Hi Alexandre,
> >
> >     > We don't need to change the algorithms titles, we just
> need to add
> >     an extra
> >     > anchor with the algorithm ID before it:
> >     >
> >     > .. _nearestneighbouranalysis:
> >     >
> >     > Nearest neighbour analysis
> >     > --
> >     >
> >     > Description
> >     > ...
> >     >
> >     > 
> >
> >     thanks for the hint.
> >
> >     I've already put anchors before each algorithm, but with the
> >     provider name:
> >
> >     .. _qgis_nearestneighbouranalysis:
> >
> >     so I can get rid of the provider name and it should work
> correctly?
> >
> >     Thanks
> >
> >     Matteo
> >
> > --
> > Alexandre Neto
> > -
> > @AlexNetoGeo
> > http://sigsemgrilhetas.wordpress.com
> > http://gisunchained.wordpress.com
> 
> -- 
> Alexandre Neto
> -
> @AlexNetoGeo
> http://sigsemgrilhetas.wordpress.com
> http://gisunchained.wordpress.com
> 
> -- 
> Alexandre Neto
> -
> @AlexNetoGeo
> http://sigsemgrilhetas.wordpress.com
> http://gisunchained.wordpress.com

___
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] Processing Help system

[Alexandre Neto]

So, is it settled for Processing algorithms help? If so, we should
celebrate!!

Then, we need to think about the rest of the help system :D

DelazJ  escreveu no dia sexta, 9/02/2018 às 12:04:

> Actually, name() does not contain spacing and I think displayName is
> translated. So should not work as is
>
>
> 2018-02-09 13:01 GMT+01:00 DelazJ :
>
>> Hi,
>>
>> Maybe we can also fix this issue on the application side: in docs, we try
>> to give the section title the same name as the alg ie the way it's shown to
>> user (eg "hypsometric curves"). What Sphinx does is to concatenate it with
>> hyphen when building the url. How about doing this concatenation in helpUrl
>> function? this way, link from QGIS will already be
>> "helpId/groupID/algnameconcatenatedbyhyphen" --> same thing as generated by
>> docs!
>> In other words, in
>>
>>  algHelp = QgsHelp::helpUrl( QStringLiteral( "
>> processing_algs/%1/%2.html#%3" ).arg( mAlgorithm->provider()->helpId(),
>> mAlgorithm->groupId(), mAlgorithm->name() ) );
>>
>> replace the mAlgorithm->name() by something that replaces each space
>> between the words in name() by  a hyphen?
>>
>>  algHelp = QgsHelp::helpUrl( QStringLiteral( "
>> processing_algs/%1/%2.html#%3" ).arg( mAlgorithm->provider()->helpId(),
>> mAlgorithm->groupId(), mAlgorithm->name().replace (' ', '-') ) );
>>
>> Does that sound correct?
>>
>> my 2cts,
>> Harrissou
>>
>>
>> 2018-02-09 12:26 GMT+01:00 matteo :
>>
>>> > but yes, it's not an anchor that is created.
>>>
>>> changing the file name works fine. I have locally
>>>
>>>
>>> file:///home/matteo/lavori/QGIS/QGIS-Documentation/QGIS-Documentation/output/html/en/docs/user_manual/processing_algs/qgis/rasterterrainanalysis.html
>>>
>>> but not for anchors that are still taken from the header
>>>
>>>
>>> file:///home/matteo/lavori/QGIS/QGIS-Documentation/QGIS-Documentation/output/html/en/docs/user_manual/processing_algs/qgis/rasterterrainanalysis.html#hypsometric-curves
>>>
>>> even if the anchor name is different:
>>>
>>> .. _bla_bla_bla:
>>>
>>> Hypsometric curves
>>> --
>>> ___
>>> 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
>>>
>>
>>
> --
Alexandre Neto
-
@AlexNetoGeo
http://sigsemgrilhetas.wordpress.com
http://gisunchained.wordpress.com
___
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] Processing Help system

[DelazJ]

Actually, name() does not contain spacing and I think displayName is
translated. So should not work as is


2018-02-09 13:01 GMT+01:00 DelazJ :

> Hi,
>
> Maybe we can also fix this issue on the application side: in docs, we try
> to give the section title the same name as the alg ie the way it's shown to
> user (eg "hypsometric curves"). What Sphinx does is to concatenate it with
> hyphen when building the url. How about doing this concatenation in helpUrl
> function? this way, link from QGIS will already be 
> "helpId/groupID/algnameconcatenatedbyhyphen"
> --> same thing as generated by docs!
> In other words, in
>
>  algHelp = QgsHelp::helpUrl( QStringLiteral( "
> processing_algs/%1/%2.html#%3" ).arg( mAlgorithm->provider()->helpId(),
> mAlgorithm->groupId(), mAlgorithm->name() ) );
>
> replace the mAlgorithm->name() by something that replaces each space
> between the words in name() by  a hyphen?
>
>  algHelp = QgsHelp::helpUrl( QStringLiteral( "
> processing_algs/%1/%2.html#%3" ).arg( mAlgorithm->provider()->helpId(),
> mAlgorithm->groupId(), mAlgorithm->name().replace (' ', '-') ) );
>
> Does that sound correct?
>
> my 2cts,
> Harrissou
>
>
> 2018-02-09 12:26 GMT+01:00 matteo :
>
>> > but yes, it's not an anchor that is created.
>>
>> changing the file name works fine. I have locally
>>
>> file:///home/matteo/lavori/QGIS/QGIS-Documentation/QGIS-Docu
>> mentation/output/html/en/docs/user_manual/processing_algs/
>> qgis/rasterterrainanalysis.html
>>
>> but not for anchors that are still taken from the header
>>
>> file:///home/matteo/lavori/QGIS/QGIS-Documentation/QGIS-Docu
>> mentation/output/html/en/docs/user_manual/processing_algs/
>> qgis/rasterterrainanalysis.html#hypsometric-curves
>>
>> even if the anchor name is different:
>>
>> .. _bla_bla_bla:
>>
>> Hypsometric curves
>> --
>> ___
>> 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] Processing Help system

[DelazJ]

Hi,

Maybe we can also fix this issue on the application side: in docs, we try
to give the section title the same name as the alg ie the way it's shown to
user (eg "hypsometric curves"). What Sphinx does is to concatenate it with
hyphen when building the url. How about doing this concatenation in helpUrl
function? this way, link from QGIS will already be
"helpId/groupID/algnameconcatenatedbyhyphen" --> same thing as generated by
docs!
In other words, in

 algHelp = QgsHelp::helpUrl( QStringLiteral( "processing_algs/%1/%2.html#%3"
).arg( mAlgorithm->provider()->helpId(), mAlgorithm->groupId(), mAlgorithm->
name() ) );

replace the mAlgorithm->name() by something that replaces each space
between the words in name() by  a hyphen?

 algHelp = QgsHelp::helpUrl( QStringLiteral( "processing_algs/%1/%2.html#%3"
).arg( mAlgorithm->provider()->helpId(), mAlgorithm->groupId(), mAlgorithm->
name().replace (' ', '-') ) );

Does that sound correct?

my 2cts,
Harrissou


2018-02-09 12:26 GMT+01:00 matteo :

> > but yes, it's not an anchor that is created.
>
> changing the file name works fine. I have locally
>
> file:///home/matteo/lavori/QGIS/QGIS-Documentation/QGIS-
> Documentation/output/html/en/docs/user_manual/processing_algs/qgis/
> rasterterrainanalysis.html
>
> but not for anchors that are still taken from the header
>
> file:///home/matteo/lavori/QGIS/QGIS-Documentation/QGIS-
> Documentation/output/html/en/docs/user_manual/processing_algs/qgis/
> rasterterrainanalysis.html#hypsometric-curves
>
> even if the anchor name is different:
>
> .. _bla_bla_bla:
>
> Hypsometric curves
> --
> ___
> 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] Processing Help system

[matteo]

> but yes, it's not an anchor that is created.

changing the file name works fine. I have locally

file:///home/matteo/lavori/QGIS/QGIS-Documentation/QGIS-Documentation/output/html/en/docs/user_manual/processing_algs/qgis/rasterterrainanalysis.html

but not for anchors that are still taken from the header

file:///home/matteo/lavori/QGIS/QGIS-Documentation/QGIS-Documentation/output/html/en/docs/user_manual/processing_algs/qgis/rasterterrainanalysis.html#hypsometric-curves

even if the anchor name is different:

.. _bla_bla_bla:

Hypsometric curves
--
___
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] Processing Help system

[Alexandre Neto]

but yes, it's not an anchor that is created.

Alexandre Neto  escreveu no dia sexta, 9/02/2018 às
11:12:

> I was able to use this local URL (note that I haven't renamed the rst file
> ):
>
>
> output/html/en/docs/user_manual/processing_algs/qgis/vector_analysis_tools.html#nearestneighbouranalysis
>
> Richard Duivenvoorde  escreveu no dia sexta,
> 9/02/2018 às 11:10:
>
>>
>> I thought wat Alexandre was saying was ok, but trying it out, it seems
>> just to create a 'span' with that id not a href#anchor ...
>>
>> Anybody else can try?
>>
>> Richard
>>
>> On 09-02-18 11:55, Alexandre Neto wrote:
>> > From what I understand, we should stick to the algorithm ID. The
>> > provider is already implicit by the file structure. Assuming that that
>> > ID is unique across all the providers.
>> >
>> > processing_algs > qgis > vector analysis tools
>> >
>> > matteo >
>> > escreveu no dia sexta, 9/02/2018 às 10:44:
>> >
>> > Hi Alexandre,
>> >
>> > > We don't need to change the algorithms titles, we just need to add
>> > an extra
>> > > anchor with the algorithm ID before it:
>> > >
>> > > .. _nearestneighbouranalysis:
>> > >
>> > > Nearest neighbour analysis
>> > > --
>> > >
>> > > Description
>> > > ...
>> > >
>> > > 
>> >
>> > thanks for the hint.
>> >
>> > I've already put anchors before each algorithm, but with the
>> > provider name:
>> >
>> > .. _qgis_nearestneighbouranalysis:
>> >
>> > so I can get rid of the provider name and it should work correctly?
>> >
>> > Thanks
>> >
>> > Matteo
>> >
>> > --
>> > Alexandre Neto
>> > -
>> > @AlexNetoGeo
>> > http://sigsemgrilhetas.wordpress.com
>> > http://gisunchained.wordpress.com
>>
>> --
> Alexandre Neto
> -
> @AlexNetoGeo
> http://sigsemgrilhetas.wordpress.com
> http://gisunchained.wordpress.com
>
-- 
Alexandre Neto
-
@AlexNetoGeo
http://sigsemgrilhetas.wordpress.com
http://gisunchained.wordpress.com
___
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] Processing Help system

[Alexandre Neto]

I was able to use this local URL (note that I haven't renamed the rst file
):

output/html/en/docs/user_manual/processing_algs/qgis/vector_analysis_tools.html#nearestneighbouranalysis

Richard Duivenvoorde  escreveu no dia sexta, 9/02/2018
às 11:10:

>
> I thought wat Alexandre was saying was ok, but trying it out, it seems
> just to create a 'span' with that id not a href#anchor ...
>
> Anybody else can try?
>
> Richard
>
> On 09-02-18 11:55, Alexandre Neto wrote:
> > From what I understand, we should stick to the algorithm ID. The
> > provider is already implicit by the file structure. Assuming that that
> > ID is unique across all the providers.
> >
> > processing_algs > qgis > vector analysis tools
> >
> > matteo >
> > escreveu no dia sexta, 9/02/2018 às 10:44:
> >
> > Hi Alexandre,
> >
> > > We don't need to change the algorithms titles, we just need to add
> > an extra
> > > anchor with the algorithm ID before it:
> > >
> > > .. _nearestneighbouranalysis:
> > >
> > > Nearest neighbour analysis
> > > --
> > >
> > > Description
> > > ...
> > >
> > > 
> >
> > thanks for the hint.
> >
> > I've already put anchors before each algorithm, but with the
> > provider name:
> >
> > .. _qgis_nearestneighbouranalysis:
> >
> > so I can get rid of the provider name and it should work correctly?
> >
> > Thanks
> >
> > Matteo
> >
> > --
> > Alexandre Neto
> > -
> > @AlexNetoGeo
> > http://sigsemgrilhetas.wordpress.com
> > http://gisunchained.wordpress.com
>
> --
Alexandre Neto
-
@AlexNetoGeo
http://sigsemgrilhetas.wordpress.com
http://gisunchained.wordpress.com
___
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] Processing Help system

[Richard Duivenvoorde]

I thought wat Alexandre was saying was ok, but trying it out, it seems
just to create a 'span' with that id not a href#anchor ...

Anybody else can try?

Richard

On 09-02-18 11:55, Alexandre Neto wrote:
> From what I understand, we should stick to the algorithm ID. The
> provider is already implicit by the file structure. Assuming that that
> ID is unique across all the providers.
> 
> processing_algs > qgis > vector analysis tools
> 
> matteo >
> escreveu no dia sexta, 9/02/2018 às 10:44:
> 
> Hi Alexandre,
> 
> > We don't need to change the algorithms titles, we just need to add
> an extra
> > anchor with the algorithm ID before it:
> >
> > .. _nearestneighbouranalysis:
> >
> > Nearest neighbour analysis
> > --
> >
> > Description
> > ...
> >
> > 
> 
> thanks for the hint.
> 
> I've already put anchors before each algorithm, but with the
> provider name:
> 
> .. _qgis_nearestneighbouranalysis:
> 
> so I can get rid of the provider name and it should work correctly?
> 
> Thanks
> 
> Matteo
> 
> -- 
> Alexandre Neto
> -
> @AlexNetoGeo
> http://sigsemgrilhetas.wordpress.com
> http://gisunchained.wordpress.com

___
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] Processing Help system

[Alexandre Neto]

>From what I understand, we should stick to the algorithm ID. The provider
is already implicit by the file structure. Assuming that that ID is unique
across all the providers.

processing_algs > qgis > vector analysis tools

matteo  escreveu no dia sexta, 9/02/2018 às 10:44:

> Hi Alexandre,
>
> > We don't need to change the algorithms titles, we just need to add an
> extra
> > anchor with the algorithm ID before it:
> >
> > .. _nearestneighbouranalysis:
> >
> > Nearest neighbour analysis
> > --
> >
> > Description
> > ...
> >
> > 
>
> thanks for the hint.
>
> I've already put anchors before each algorithm, but with the provider name:
>
> .. _qgis_nearestneighbouranalysis:
>
> so I can get rid of the provider name and it should work correctly?
>
> Thanks
>
> Matteo
>
-- 
Alexandre Neto
-
@AlexNetoGeo
http://sigsemgrilhetas.wordpress.com
http://gisunchained.wordpress.com
___
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] Processing Help system

[matteo]

Hi Alexandre,

> We don't need to change the algorithms titles, we just need to add an extra
> anchor with the algorithm ID before it:
> 
> .. _nearestneighbouranalysis:
> 
> Nearest neighbour analysis
> --
> 
> Description
> ...
> 
> 

thanks for the hint.

I've already put anchors before each algorithm, but with the provider name:

.. _qgis_nearestneighbouranalysis:

so I can get rid of the provider name and it should work correctly?

Thanks

Matteo
___
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] Processing Help system

[Alexandre Neto]

We don't need to change the algorithms titles, we just need to add an extra
anchor with the algorithm ID before it:

.. _nearestneighbouranalysis:

Nearest neighbour analysis
--

Description
...



This produces a url like we need (assuming that we rename the rst files, of
course.




matteo  escreveu no dia sexta, 9/02/2018 às 10:21:

> Hey,
>
> > yes, but I think we first have to rename the rst files like:
> >
> >
> https://github.com/qgis/QGIS-Documentation/blob/master/source/docs/user_manual/processing_algs/qgis/vector_analysis_tools.rst
> >
> > to
> >
> >
> https://github.com/qgis/QGIS-Documentation/blob/master/source/docs/user_manual/processing_algs/qgis/vectoranalysis.rst
> >
> > so the output html name becomes 'vectoranalysis.html'. Apparently
> > filenames earlier where chosen for readability, but we now use the
> > 'groupid' (looking at Nyalls pull
> >
> https://github.com/qgis/QGIS/pull/6298/commits/2d1e9188f18c40028b5501fe4c719808e8e20800
> )
>
> yes, and this is an "easy" fix, just a couple of renamings
>
> > And THEN we need to make sure the section names/headers indeed are the
> > same as generated by the helpurl code, so the anchor is ok:
> >
> >
> https://docs.qgis.org/testing/en/docs/user_manual/processing_algs/qgis/vectoranalysis.html#nearestneighbouranalysis
> >
> > So as Nyall is saying: using the algorithm id instead of the name.
>
> while this is a not-so-small work, but easy to do it.
>
> The only thing I'm a little concerned is readability of the final html
> file.
>
> Changing the name of the alrotihm/section from Nearest neighbour
> analysis to nearestneighbouranalysis will bring us to have a
> concatenated name for all algorithms, right?
>
> I'm definitely not a sphinx guru, but is there the change to have a kind
> of :meta: tag before each section and use this :meta: to build the URL?
>
> Thanks Richard for the feedback
>
> Matteo
>
> ___
> 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

-- 
Alexandre Neto
-
@AlexNetoGeo
http://sigsemgrilhetas.wordpress.com
http://gisunchained.wordpress.com
___
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] Processing Help system

[matteo]

Hey,

> yes, but I think we first have to rename the rst files like:
> 
> https://github.com/qgis/QGIS-Documentation/blob/master/source/docs/user_manual/processing_algs/qgis/vector_analysis_tools.rst
> 
> to
> 
> https://github.com/qgis/QGIS-Documentation/blob/master/source/docs/user_manual/processing_algs/qgis/vectoranalysis.rst
> 
> so the output html name becomes 'vectoranalysis.html'. Apparently
> filenames earlier where chosen for readability, but we now use the
> 'groupid' (looking at Nyalls pull
> https://github.com/qgis/QGIS/pull/6298/commits/2d1e9188f18c40028b5501fe4c719808e8e20800)

yes, and this is an "easy" fix, just a couple of renamings

> And THEN we need to make sure the section names/headers indeed are the
> same as generated by the helpurl code, so the anchor is ok:
> 
> https://docs.qgis.org/testing/en/docs/user_manual/processing_algs/qgis/vectoranalysis.html#nearestneighbouranalysis
> 
> So as Nyall is saying: using the algorithm id instead of the name.

while this is a not-so-small work, but easy to do it.

The only thing I'm a little concerned is readability of the final html
file.

Changing the name of the alrotihm/section from Nearest neighbour
analysis to nearestneighbouranalysis will bring us to have a
concatenated name for all algorithms, right?

I'm definitely not a sphinx guru, but is there the change to have a kind
of :meta: tag before each section and use this :meta: to build the URL?

Thanks Richard for the feedback

Matteo

___
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] Processing Help system

[Alexander Bruy]

Hi Richard,

2018-02-09 11:47 GMT+02:00 Richard Duivenvoorde :
> One thing to note: If I am correct Alex (in cc) was the one who created
> all the templates for this algorithms via a script. I wonder if he saw
> that as a one-time template generation, or that it was his intention to
> keep stuff uptodate this way? @Alex?

Just small correction. I wasn't the one who created initial RST files, I only
used existing script to created new RST files for algorithms which were
added after integrating Processing documentation into User Guide.
Files were added because some community members were sure that having
such templates will encourage users to write documentation. But this did not
worked in the end.

-- 
Alexander Bruy
___
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] Processing Help system

[Richard Duivenvoorde]

Using the algorithm id
On 09-02-18 08:29, matteo wrote:
>> With the above PR the help directs to the URL using an id based
>> anchor, so the anchors themselves in the docs should be updated to fix
>> this.
> so the provider issue is fixed. Now from the doc side, we have to change
> the section headers so that they match the unique id of the algorithms
> in the code. Did I understand it correctly?

yes, but I think we first have to rename the rst files like:

https://github.com/qgis/QGIS-Documentation/blob/master/source/docs/user_manual/processing_algs/qgis/vector_analysis_tools.rst

to

https://github.com/qgis/QGIS-Documentation/blob/master/source/docs/user_manual/processing_algs/qgis/vectoranalysis.rst

so the output html name becomes 'vectoranalysis.html'. Apparently
filenames earlier where chosen for readability, but we now use the
'groupid' (looking at Nyalls pull
https://github.com/qgis/QGIS/pull/6298/commits/2d1e9188f18c40028b5501fe4c719808e8e20800)

And THEN we need to make sure the section names/headers indeed are the
same as generated by the helpurl code, so the anchor is ok:

https://docs.qgis.org/testing/en/docs/user_manual/processing_algs/qgis/vectoranalysis.html#nearestneighbouranalysis

So as Nyall is saying: using the algorithm id instead of the name.

One thing to note: If I am correct Alex (in cc) was the one who created
all the templates for this algorithms via a script. I wonder if he saw
that as a one-time template generation, or that it was his intention to
keep stuff uptodate this way? @Alex?

Regards,

Richard Duivenvoorde
___
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] Processing Help system

[Paolo Cavallini]

Il 09/02/2018 08:29, matteo ha scritto:

> so the provider issue is fixed. Now from the doc side, we have to change
> the section headers so that they match the unique id of the algorithms
> in the code. Did I understand it correctly?
> 
> Many thanks again

Thanks a lot Nyall.
Who can change to doc side of it? Need help?
All the best.

-- 
Paolo Cavallini - www.faunalia.eu
QGIS & PostGIS courses: http://www.faunalia.eu/training.html
https://www.google.com/trends/explore?date=all=IT=qgis,arcgis
___
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] Processing Help system

[matteo]

Hi Nyall,


>> PR at https://github.com/qgis/QGIS/pull/6298
>>
>> Feedback on this approach is welcome, but I think fixing in the code
>> is correct vs fixing via redirects.

that's great! thanks for the PR!

> Just a heads-up: I've noticed while testing the above PR that while it
> fixes the native/3d/qgis issue, there's an issue with how the anchor
> links in the docs have been named.
> 
> E.g.
> 
> https://docs.qgis.org/testing/en/docs/user_manual/processing_algs/qgis/database.html#import-into-spatialite
> 
> should actually be
> 
> https://docs.qgis.org/testing/en/docs/user_manual/processing_algs/qgis/database.html#importintospatialite
> 
> Using the algorithm id and not its name. The id is unique,
> non-translated, and guaranteed to be set for the lifetime of 3.x, but
> algorithm names are translated, can be tweaked and refined and are not
> locked.
> 
> With the above PR the help directs to the URL using an id based
> anchor, so the anchors themselves in the docs should be updated to fix
> this.

so the provider issue is fixed. Now from the doc side, we have to change
the section headers so that they match the unique id of the algorithms
in the code. Did I understand it correctly?

Many thanks again

Matteo

___
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] Processing Help system

[Nyall Dawson]

On 9 February 2018 at 11:32, Nyall Dawson  wrote:
> On 9 February 2018 at 03:01, Paolo Cavallini  wrote:
>> Il 08/02/2018 13:57, Richard Duivenvoorde ha scritto:
>>
>>> my 2cts: try to fix it either by fixing the code that creates the url
>>> for the  1. Help system URL (even if that would need a switch from
>>> native->qgis or so)..
>>> OR by just plain renaming those directories in the manual (2. doc URL)
>>> (as in Sphinx the links are never the the real html names, but to those
>>> ref-id's). Note that renaming files or directories means changing
>>> paths/resourcenames for transifex too.
>>>
>>> only if all fails I would start to create redirects, as in my experience
>>> these are very hard to maintain, especially when they need to work
>>> between different kind of QGIS versions
>>
>> agreed fully. as agreed upon during latest PSC meeting, the matter
>> should better be solved before Q3 release: it's such a pity having help
>> and not being able to display it to users.
>> I would ask Richard, who is familiar with the structure, to decide for
>> the best solution, and ask the most appropriate person to implement it.
>> QGIS:ORG has some limited resources to implement it if necessary.
>> Thanks again.
>
> PR at https://github.com/qgis/QGIS/pull/6298
>
> Feedback on this approach is welcome, but I think fixing in the code
> is correct vs fixing via redirects.

Just a heads-up: I've noticed while testing the above PR that while it
fixes the native/3d/qgis issue, there's an issue with how the anchor
links in the docs have been named.

E.g.

https://docs.qgis.org/testing/en/docs/user_manual/processing_algs/qgis/database.html#import-into-spatialite

should actually be

https://docs.qgis.org/testing/en/docs/user_manual/processing_algs/qgis/database.html#importintospatialite

Using the algorithm id and not its name. The id is unique,
non-translated, and guaranteed to be set for the lifetime of 3.x, but
algorithm names are translated, can be tweaked and refined and are not
locked.

With the above PR the help directs to the URL using an id based
anchor, so the anchors themselves in the docs should be updated to fix
this.

Nyall

>
> Nyall
___
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] Processing Help system

[Paolo Cavallini]

Il 08/02/2018 13:57, Richard Duivenvoorde ha scritto:

> my 2cts: try to fix it either by fixing the code that creates the url
> for the  1. Help system URL (even if that would need a switch from
> native->qgis or so)..
> OR by just plain renaming those directories in the manual (2. doc URL)
> (as in Sphinx the links are never the the real html names, but to those
> ref-id's). Note that renaming files or directories means changing
> paths/resourcenames for transifex too.
> 
> only if all fails I would start to create redirects, as in my experience
> these are very hard to maintain, especially when they need to work
> between different kind of QGIS versions

agreed fully. as agreed upon during latest PSC meeting, the matter
should better be solved before Q3 release: it's such a pity having help
and not being able to display it to users.
I would ask Richard, who is familiar with the structure, to decide for
the best solution, and ask the most appropriate person to implement it.
QGIS:ORG has some limited resources to implement it if necessary.
Thanks again.

-- 
Paolo Cavallini - www.faunalia.eu
QGIS & PostGIS courses: http://www.faunalia.eu/training.html
https://www.google.com/trends/explore?date=all=IT=qgis,arcgis
___
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] Processing Help system

[Richard Duivenvoorde]

On 08-02-18 08:50, matteo wrote:
> Hi devs,
> 
> I want to share a super brief summary of the brainstorming we had on
> this topic. I think it is better to speak about it in Madeira with all
> the interested people.
> 
> There are some small issues with the Help system and Processing (sphinx
> related): that is, URLs build from the Help system are (sometimes)
> different from those generated from Sphinx.
> 
> Differences are:
> 
> * Help system build URL with providerId/groupId/algorithmName.html
> * provider "native" is not present in sphinx
> * Help system concatenates words (eventually) while sphinx puts `-`
> between words
> 
> At the end, for some algorithm, we have documentation already merged,
> but unreachable from the UI of Processing, e.g.:
> 
> 1. Help system URL:
> 
> https://docs.qgis.org/testing/en/docs/user_manual/processing_algs/native/vectoroverlay.html#lineintersections
> 
> 2. doc URL:
> 
> https://docs.qgis.org/testing/en/docs/user_manual/processing_algs/qgis/vector_overlay_tools.html#line-intersections
> 
> I hope interested people can jump in this discussion on share some thoughts!

Hi Matteo,

my 2cts: try to fix it either by fixing the code that creates the url
for the  1. Help system URL (even if that would need a switch from
native->qgis or so)..
OR by just plain renaming those directories in the manual (2. doc URL)
(as in Sphinx the links are never the the real html names, but to those
ref-id's). Note that renaming files or directories means changing
paths/resourcenames for transifex too.

only if all fails I would start to create redirects, as in my experience
these are very hard to maintain, especially when they need to work
between different kind of QGIS versions

Regards,

Richard Duivenvoorde
___
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] Processing Help system

[Tom Chadwin]

If there is no easy proper fix for this, URL rewriting could handle it - I
don't know what server software is being used, but it should be possible.

Tom



-
Buy Pie Spy: Adventures in British pastry 2010-11 on Amazon 
--
Sent from: http://osgeo-org.1560.x6.nabble.com/QGIS-Developer-f4099106.html
___
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] Processing Help system

[matteo]

Hi devs,

I want to share a super brief summary of the brainstorming we had on
this topic. I think it is better to speak about it in Madeira with all
the interested people.

There are some small issues with the Help system and Processing (sphinx
related): that is, URLs build from the Help system are (sometimes)
different from those generated from Sphinx.

Differences are:

* Help system build URL with providerId/groupId/algorithmName.html
* provider "native" is not present in sphinx
* Help system concatenates words (eventually) while sphinx puts `-`
between words

At the end, for some algorithm, we have documentation already merged,
but unreachable from the UI of Processing, e.g.:

1. Help system URL:

https://docs.qgis.org/testing/en/docs/user_manual/processing_algs/native/vectoroverlay.html#lineintersections

2. doc URL:

https://docs.qgis.org/testing/en/docs/user_manual/processing_algs/qgis/vector_overlay_tools.html#line-intersections

I hope interested people can jump in this discussion on share some thoughts!

Cheers

Matteo


___
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] Processing Help system

[Paolo Cavallini]

Hi Matteo, all,
my proposals, see below:

Il 05/02/2018 14:23, matteo ha scritto:
> Last week I made a call for doc reviewer for the Processing Help System
> docs written till now (thanks to the grant proposal program).
> 
> Pretty most all of the native QGIS algorithm have been described and
> lots of improvements have been made (pictures, better descriptions,
> updated descriptions, etc.).
> 
> At the moment just a small part of the descriptions is available because
> a lot of docs are waiting for a review:
> 
> https://github.com/qgis/QGIS-Documentation/pulls?q=is%3Apr+is%3Aopen+label%3A%22Processing+help%22
> 
> I think these descriptions have to be reviewed before the release.

merge all; if some descriptions have to be improved or corrected, even
avter release; the earlier the merge, the better. having a much improved
help system and not showing it to users does not make sense.
if someone has serious objections please speak out, otherwise I'd just go.

> Also there are also some problems with some link (e.g. when the
> algorithm provider is labeled as *native* and not as *qgis*) and there
> is already a ticket opened [0].

if this is not too difficult, I suggest fixing it (Alaex, could you?).

> Finally: for some other algorithms (e.g. those of SAGA) there is no
> description. Clicking on the help button shows a **Not Found** page.
> What about having a kind of template "this algorithm is not described,
> if you want to help."

redirect all ``docs/user_manual/processing_algs/saga/*`` links to a page
with something like "Help missing - please help us improving this by
sending us your description of this alg" with either a link to a GH page
to be edited or a mailto (is there someone willing to take this review?
Matteo, would yo be available?

If necessart, we could use some additionsl funds from QGIS to finish up
and polish this important work.

All the best.
-- 
Paolo Cavallini - www.faunalia.eu
QGIS & PostGIS courses: http://www.faunalia.eu/training.html
https://www.google.com/trends/explore?date=all=IT=qgis,arcgis
___
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