[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 <rdmailings at duif.net>:

> On 10-02-18 08:34, Alexander Bruy wrote:
> > Hi Richard,
> >
> > 2018-02-09 16:08 GMT+02:00 Richard Duivenvoorde <rdmailings at duif.net>:
> >> 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 at lists.osgeo.org
> List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20180213/9224c3f1/attachment.html>