Bug 474198 - "check-tp-kde" from pology detects some false positive errors for reStructuredText markup
Summary: "check-tp-kde" from pology detects some false positive errors for reStructure...
Status: RESOLVED MOVED
Alias: None
Product: kdenlive
Classification: Applications
Component: Documentation (show other bugs)
Version: 22.12.3
Platform: Other Linux
: NOR normal
Target Milestone: ---
Assignee: emohr
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-09-05 21:42 UTC by Josep Ma. Ferrer
Modified: 2023-09-09 10:43 UTC (History)
1 user (show)

See Also:
Latest Commit:
Version Fixed In:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Josep Ma. Ferrer 2023-09-05 21:42:14 UTC
SUMMARY
***
"posieve check-tp-kde" command from pology detects some false positive errors for reStructuredText markup.

Example:
$ cd kde-trunk-kf5/l10n-kf5/ca/messages/documentation-docs-kdenlive-org/
$ posieve check-tp-kde .
docs_kdenlive_org_effects_and_compositions___video_effects___blur_and_sharpen___contrast_adaptive_sharpen.po:70(#9)[msgstr:34:"<plane>"]: KDE4 markup: unrecognized tag 'plane'.
docs_kdenlive_org_effects_and_compositions___video_effects___blur_and_sharpen___contrast_adaptive_sharpen.po:70(#9)[msgstr:175]: KDE4 markup: mismatched tag.
[...]

Message #9 (line 70) in this file reads:

msgid ""
"**Planes** - Set the :term:`plane` the effect is to be applied to. Options "
"are: **Alpha**, **Y** (default), **U**, **V**, **Red**, **Green**, **Blue** "
"and **All**."

And the translated message is:

msgstr ""
"**Plans**: Establiu el :term:`pla <plane>` al qual s'aplicarà l'efecte. Les "
"opcions són: **Alfa**, **Y** (predeterminat), **U**, **V**, **Red**, "
"**Green**, **Blue** i **All**."

The problem is on the translation of "plane" to Catalan. We translate "plane" as "pla", but we need to add the English term to match the reStructuredText markup. 
So, the English text :term:`plane` becomes Catalan text :term:`pla <plane>`.
This is valid Sphinx/reStructuredText syntax to set custom link text for cross-reference links, instead of using the normal title of the referenced page or section: 
https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#ref-role

But "posieve check-tp-kde" thinks that "<plane>" is an invalid KDE4 markup, and throws the above errors.

This issue happens in other languages (sl-Slovenian, at least).

So, it's necessary to modify the pololgy/posieve/check-tp-kde code to avoid this false positive error.
***


STEPS TO REPRODUCE
1. Download a directory with po files with this especial reStructuredText markup. For example:
https://websvn.kde.org/trunk/l10n-kf5/ca/messages/documentation-docs-kdenlive-org/
2. Download and install pology from: https://invent.kde.org/sdk/pology
3. Run the pology command: 
$ posieve check-tp-kde .

OBSERVED RESULT
docs_kdenlive_org_effects_and_compositions___video_effects___blur_and_sharpen___contrast_adaptive_sharpen.po:70(#9)[msgstr:34:"<plane>"]: KDE4 markup: unrecognized tag 'plane'.
docs_kdenlive_org_effects_and_compositions___video_effects___blur_and_sharpen___contrast_adaptive_sharpen.po:70(#9)[msgstr:175]: KDE4 markup: mismatched tag.
[...and many more...]

EXPECTED RESULT
(not a single message)

SOFTWARE/OS VERSIONS (not relevant)
Windows: 
macOS: 
Linux/KDE Plasma: Debian GNU/Linux 12
(available in About System)
KDE Plasma Version: 5.27.5
KDE Frameworks Version: 5.103.0
Qt Version: 5.15.8

ADDITIONAL INFORMATION
Comment 1 emohr 2023-09-07 16:08:54 UTC
Hi Josep

term:`plane`. Term: is used for glossary. 

I found the following hint:
In i18n situation, you can specify “localized term : key” even if original text only have “term” part. In this case, translated “localized term” will be categorized in “key” group.
See: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#glossary-directive

This bug is addressed to Kdenlive. Isn’t it a pololgy issue? If yes, please change the “Product” to pololgy.

Eugen
Comment 2 Josep Ma. Ferrer 2023-09-07 21:35:04 UTC
Yes, this is an issue for "pology" (https://invent.kde.org/sdk/pology), but there isn't a Product category with Pology. Do I need to open an issue on Invent-Pology?
Comment 3 emohr 2023-09-08 06:33:49 UTC
Yes I would do that: open an issue on https://invent.kde.org/sdk/pology
Once done close the issue here.
Comment 4 Josep Ma. Ferrer 2023-09-09 10:42:28 UTC
I've opened an issue: https://invent.kde.org/sdk/pology/-/issues/9
So, I close this bug.
Thank you,
Josep M.