Open Bug 1374605 Opened 2 years ago Updated Last year

[translate] Show file-level comments

Categories

(Webtools :: Pontoon, enhancement, P3)

enhancement

Tracking

(Not tracked)

People

(Reporter: tchevalier, Unassigned)

Details

The notes at the top of .lang files always contain critical information for the file (general context, testing URL, screenshots…) but they can’t be displayed in Pontoon.

Examples for snippets and a form:
https://github.com/mozilla-l10n/engagement-l10n/blob/master/en-US/snippets/2017/jul2017.lang#L1-L4
https://github.com/mozilla-l10n/engagement-l10n/blob/master/en-US/other/2017/mozfest_form.lang#L1

We should find a way to somehow expose this information in Pontoon
There's some talk about a "l10n brief" comment in ftl, too. Probably also valid for other file formats.
Right now, the first contiguous comment in the file which is not attached to a message or section is parsed as the resource comment. I would like to consider adding special sigils for it, e.g. /// or //!.
I'm not initially supportive of the special sigil for that (go away, sigils!), and I believe that the location of the comment (top of the file) is enough, but either way, FTL supports it.
We only need to figure out where to display this information, other than that it's pretty straightforward.
Priority: -- → P3
Summary: Expose .lang notes → [translate] Show file-level comments
What about showing comments as collapsable sections? We can have up to 3 of them: file, section, string. Maybe the file one could be collapsed to one line be default.

As someone who spends a lot of time writing those comments, I feel like the current situation is already far from ideal, with comments losing the original line endings. Maybe collapsable sections could help with that.
Also - for FTL it seems that the section comment is included, but with no distinction between that are the string comment - it just looks like:

    section comment string comment

which usually doesn't make any sense unless you specifically design the section and string comments with this in mind.
Since Pontoon doesn't have a special UI for group (section) comments, the best thing we can do right now is to add them to string comments. They usually apply to all strings within the group.
You need to log in before you can comment on or make changes to this bug.