[QGIS-Developer] Processing Help system

[Nyall Dawson]

On 9 February 2018 at 11:32, Nyall Dawson <nyall.dawson at gmail.com> wrote:
> On 9 February 2018 at 03:01, Paolo Cavallini <cavallini at faunalia.it> 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