[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 <delazj at gmail.com>:

> 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 <matteo.ghetta at gmail.com>:
>
>> > 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 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/20180209/c3ce308c/attachment.html>