Support for Source String Descriptions in YAML files

[niccokunzmann]

Describe the issue

I have a yaml file like this:

# Title of the page
# https://mywebsite/page.html#title
page-title: "Main Page"

I added these comments in order to allow the users to check out the place where the translations are on the page.

I had a look at https://docs.weblate.org/en/latest/formats.html - yaml section and the table.

Format	Linguality [1]	Plurals [2]	Descriptions [3]	Context [4]	Location [5]	Flags [8]	Additional states [6]
YAML files	mono	no	yes	no	no	no

Descriptions are allowed but I do not know how to add these to the file.

I already tried

• I've read and searched the documentation.
• I've searched for similar issues in this repository.

Steps to reproduce the behavior

Expected behavior

I would expect the comments to turn up here:

But the explanations are empty.

How do I add descriptions/explanations from the yaml file?

Screenshots

No response

Exception traceback

No response

How do you run Weblate?

weblate.org service

Weblate versions

No response

Weblate deploy checks

No response

Additional context

No response

[nijel]

"Explanation" is provided in Weblate, the comments from the file are shown as "Source string description". See for example https://hosted.weblate.org/translate/weblate/application/cs/?checksum=39b3998dcfe68cbf

[github-actions]

This issue looks more like a support question than an issue. We strive to answer these reasonably fast, but purchasing the support subscription is not only more responsible and faster for your business but also makes Weblate stronger.

In case your question is already answered, making a donation is the right way to say thank you!

[niccokunzmann]

Hm. Interesting. It seems like the comments have different meanings depending on how they are made:

#. Translators: Shown on wrong answer to the mathematics-based CAPTCHA
#: weblate/accounts/forms.py:513

#. is a "Source string description"
#: is a link to the file. I will see and try out a bit.

I think, I would have liked that explained or linked below the table of what supports description strings.

Hm. I do not see anything about that in the documentation. https://docs.weblate.org/en/latest/search.html?q=%23%3A&check_keywords=yes&area=default#

For me, this is unexpected behavior, not documented. I can not find the documentation. I think then, this is a "bug in the documentation".

I have added this: niccokunzmann/open-web-calendar@04d66c4
And here is the result:
https://hosted.weblate.org/translate/open-web-calendar/common-translations/de/?checksum=0e2e3d18c37eb5b5

And they do not turn up. I think, I have pulled the changes.

[niccokunzmann]

I wonder where this would be implemented. I think, since PO files can do that already and we have different types of input files, there is probably a modular structure for that that can be kind-of replicated.

[nijel]

This syntax is specific to PO files, see https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html

Looking at YAML handler, it doesn't seem to parse comments at all: https://github.com/translate/translate/blob/master/translate/storage/yaml.py, so it needs to be implemented there. Weblate will then display comments properly.

[github-actions]

The issue you've reported needs to be addressed in the translate-toolkit. Please file the issue there, and include links to any relevant specifications about the formats (if applicable).

[niccokunzmann]

I opened translate/translate#4883 so that the implementation part is done here. From my perspective this issue is not resolved now but a documentation issue:

The documentation claims that yaml files support Descriptions . However there is no documentation about how to add descriptions. This discussion seems to suggest that descriptions are not possible.

To close this issue:

• Either remove the yes for yaml in the description column of the table or add an example of how to add a description in the yaml Section.

Thanks for helping so far. What are your thoughts on this?

[nijel]

Correct, I've removed that in 0bc286e.

PS: This table really needs to be changed, see #9077

[niccokunzmann]

Thanks! I consider this issue as closed now, too :) Thank you!