-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Processing help system expects wrong link #25130
Comments
Author Name: Alexander Bruy (@alexbruy) I don't think this is an issue, as QGIS documentation for master is not ready yet and we can't be 100% sure that current structure won't change anymore. I suggest close this and update links only when QGIS documentation structure will be mature.
|
Author Name: Harrissou Santanna (@DelazJ)
The issue i'm reporting is about the structure of the link (using : instead of # and prepending qgis instead of group name) and I think it's valid, even if as you pointed the work on Processing algs is not yet finished. But:
|
Author Name: Alexander Bruy (@alexbruy) Harrissou Santanna wrote:
Please note that in its current state Processing docs relies on the groups and algorithms names which are localized and will be different for different locales. Same with provider names. IMHO all of these should rely on the corresponding ids which are used internally and non-translatable. I don't know much about how documentation team decide which structure to use for documentation. Just took couple of random algorithms from the Processing docs and URLs appear to have slightly different structure:
What I'm trying to say is that we need some standard URL scheme for all providers, we should avoid translatable strings in the URLs.
Neither am I, that's why I'm asking. |
Author Name: Harrissou Santanna (@DelazJ) Currently, few algorithms have been rewritten so it's normal that you find errors. Only these groups are done https://github.com/qgis/QGIS-Documentation/pulls?q=is%3Apr+is%3Aclosed+label%3A%22Processing+help%22. And the fix will follow the same structure for ALL algorithms (provider/group.html#algname)- actually the URL is built like this by Sphinx (and I don't know if we can override it - is it desirable?) but we chose to use same terms like in the application and in that sequence. Let's take the database group (http://docs.qgis.org/testing/en/docs/user_manual/processing_algs/qgis/database.html) which has been reworked. All the listed algs are shown the way they are in QGIS and if you check the link it follows the structure "provider/group.html#algorithmNameWithSpaceReplacedByHyphen" ie http://docs.qgis.org/testing/en/docs/user_manual/processing_algs/qgis/database.html#spatialite-execute-sql. I don't see the issue you mention about localization. This link will not change except for the language code part, right?
|
Author Name: Alexander Bruy (@alexbruy) Harrissou Santanna wrote:
No. For example, URL you mentioned with Ukrainian locale will look like http://docs.qgis.org/testing/en/docs/user_manual/processing_algs/qgis/базыданных.html#выполнить-sql-запрос-spatialite |
Author Name: Harrissou Santanna (@DelazJ) Alexander Bruy wrote:
That's rather weird. In the french locale, the last bits of the url are not translated. Still from the french locale, switching to japan, korean or russian (there seems to not be ukrainian on 2.18) the URL neither changes except for the language code part. Whatever language i try, the english source text is always used. |
Author Name: Alexander Bruy (@alexbruy) Harrissou Santanna wrote:
Just curious where you found french docs for master? |
Author Name: Harrissou Santanna (@DelazJ) Alexander Bruy wrote:
You know that it does not exist. I meant, if using uk locale, "database" and "spatialite-execute-sql" are translated, in fr i would also expect these translations. Something i do not get.
|
Author Name: matteo ghetta (@ghtmtt) Let me step in in this discussion, actually sorry for the delay ;) Besides the (eventual) locale problems I see also 2 potentially coding issues:
@http://docs.qgis.org/testing/en/docs/user_manual/processing_algs/native/native:clip@ where native should be replaced by qgis.
In this case I think we can (should?) change the name of the docs files instead of the algorithm group parameter. |
Author Name: Paolo Cavallini (@pcav) Wouldn't it be better to redirect to a page "docs missing - please write your and send it to ..."? |
Author Name: Harrissou Santanna (@DelazJ) Paolo Cavallini wrote:
This recalls me one of my first PRs to QGIS and i've been answered that "when someone is looking for a doc, most of the times it's because he does not know how that works. So hard to ask him to write the docs." :) It was not false! The issue I'm trying to raise here is that hitting most of the help button from algorithms dialog leads to no doc. Link construction in application and documentation do not match. From what i can see, changes have been made meanwhile but it does not fix the issue. We still need to handle use of "_" character in links (generated by Sphinx in case of spacing in file name (ie group) - which we need to properly show readable and translatable page title) and use of "-" character (in case of spacing in algorithmn name)
|
Author Name: Nyall Dawson (@nyalldawson) Proposed PR at #6298 |
Author Name: Nyall Dawson (@nyalldawson) Applied in changeset 2d1e918.
|
Author Name: Giovanni Manghi (@gioman)
|
Author Name: Harrissou Santanna (@DelazJ)
Original Redmine Issue: 17231
Affected QGIS version: master
Redmine category:processing/core
Assignee: Victor Olaya
When hitting the Help button in a Processing tool dialog, the expected link doesn't follow the same structure than links of QGIS Documentation.
For example if I hit the "Merge Vector Layers" tool under QGIS/Vector General group, I will get 'testing/en/docs/user_manual/processing_algs/qgis/ qgis:mergevectorlayers' while doc link is 'testing/en/docs/user_manual/processing_algs/qgis/ vector_general_tools.html#merge-vector-layers'
The text was updated successfully, but these errors were encountered: