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

QTML honorifics #11

Open mustafa0x opened 4 years ago

mustafa0x commented 4 years ago

The honorifics which will be part of Unicode 14 (the first two are from Unicode ~1):

rguliev commented 4 years ago
  • واٰله should be removed from صَلّى اللهُ عليهِ واٰله وسلّم, as ﷺ is the more standard honorific. صَلّى اللهُ عليهِ واٰله وسلّم will be added to Unicode 14, but it is more rarely used.
  • رحمة الله عليه (and its variations) should be replaced with رحمه الله. Similar to above, it is far more common, and it has been accepted by Unicode.

Sure. Thanks a lot! Could you please check all Arabic texts of honorifics and make a pull request?

The honorifics mentioned in QTML have all been accepted by Unicode. They should be included in Unicode 14 (1.5 years from now). However, they have been given code points that will almost certainly not change (I've confirmed this with a Unicode member). Thus, using the code points themselves makes more sense.

We had a discussion on this and ended up with XML for the following reasons:

Screenshot from 2019-12-20 16-51-35

mustafa0x commented 4 years ago

I don't feel like those arguments apply, since we're talking about the source, not the final distributed file.

Of course, one can always search for a Unicode-symbol and replace it, but then it breaks the logic of QTML: some parts would be searched by tags, the others by regexs. Quite confusing.

In general, semantic Unicode is superior to XML. And replacing a code point doesn't need a regex, but a dumb string replacement.

rguliev commented 4 years ago

I don't feel like those arguments apply since we're talking about the source, not the final distributed file.

Sorry, maybe I confused you, QTML is a format for the final distribution. I should write it explicitly in the docs.

mustafa0x commented 4 years ago

QTML must be converted to a final format (PDF, HTML, or system-ui) for user consumption. During that conversion you can address the issues you mentioned.

rguliev commented 4 years ago

Exactly! Web and mobile developers are supposed to be major users. We intend to add helper tools for their convenience. See my comment here #13