If faced some difficulties in defining elements for Quran citation. I would like to discuss it here. Here are some problems I found:
1) Do we need two different elements for inline Quran citation and Quran citation on a new line? It seems convenient but, on the other hand, it unclear how to choose between them.
Option 1: We can try to stick with the source text, i.e. if in the original text the citation is inline, then use <inline-quran>. This will require extra verification with the source.
Option 2: Keep only one element <quran> which can be both inline and block, and the developer to decide whether to render it inline or with a line-break.
Option 3: ?
2) Quran can be cited by: one or many ayahs and one or many words. How could we conveniently provide a range of citations by attributes?
Option 1: How about two attributes ref="surah:ayah[:word] and till="surah:ayah[:word]. The till attribute is optional and provided only in multi-ayah or multi-word citation cases.
Option 2: Create <quran-ayah> and <quran-word> elements for single ayah/word citation, and for many ayahs/words use wrapping elements <quran-ayahs> and <quran-words> like so:
3) Do we need <arabic> inside a Quran citation element? On the one hand, it would allow controlling that reference is correct, on the other hand, it is redundant and does not seem useful.
4) The translation of a Quran citation might not be presented. So, should it be an optional element?
5) Can Quran citation be in a footnote explanation?
6) Quran can be cited inside a quote. For instance:
Imam Ahmad recorded that Jabir said,
"The Prophet would never sleep until he recited:
Alif Lam Mim. The revelation of..., Surah As-Sajdah,
and
Blessed be He in Whose Hand is the dominion... Surah Al-Mulk (67).''
If faced some difficulties in defining elements for Quran citation. I would like to discuss it here. Here are some problems I found:
1) Do we need two different elements for inline Quran citation and Quran citation on a new line? It seems convenient but, on the other hand, it unclear how to choose between them. Option 1: We can try to stick with the source text, i.e. if in the original text the citation is inline, then use
<inline-quran>. This will require extra verification with the source. Option 2: Keep only one element<quran>which can be both inline and block, and the developer to decide whether to render it inline or with a line-break. Option 3: ?2) Quran can be cited by: one or many ayahs and one or many words. How could we conveniently provide a range of citations by attributes?
Option 1: How about two attributes
ref="surah:ayah[:word]andtill="surah:ayah[:word]. Thetillattribute is optional and provided only in multi-ayah or multi-word citation cases. Option 2: Create<quran-ayah>and<quran-word>elements for single ayah/word citation, and for many ayahs/words use wrapping elements<quran-ayahs>and<quran-words>like so:Option 3: ?
3) Do we need
<arabic>inside a Quran citation element? On the one hand, it would allow controlling that reference is correct, on the other hand, it is redundant and does not seem useful.4) The translation of a Quran citation might not be presented. So, should it be an optional element?
5) Can Quran citation be in a footnote explanation?
6) Quran can be cited inside a quote. For instance:
Page 1 here
6) We are better to collect some different examples of Quran citation to check our standard