search

quranacademy / digital-quran-docs

Documentation for Quran Academy data distribution project: Digital Quran - https://quranacademy.gitbook.io/digital-quran/
39 stars 8 forks source link

Improve `inline-comment` semantics #12

Open mustafa0x opened 4 years ago

mustafa0x commented 4 years ago

Instead of brackets=round|square for inline-comment, it should be type=supplementary|explanation.

Where () is supplementary, and [] is explanation. Or the other way around. The issue requires some thought. =)

rguliev commented 4 years ago

It is a very delicate issue. I really like your suggestion, since it is more about semantics rather than styling. And I would prefer to keep only semantics in QTML. The problem with brackts-commets in a translation is that it is not obvious what the author intended to mark. For a new translation, we can ask the author and it's just fine. But old translations become difficult to mark properly, we will have to decide on our own which adds some voluntary.

We can do it this way. While the standard is under development, we can use the suggested attribute. When we find a real case with the problem, we will correct the standard.

@Imangazaliev what would you say?