Recite (the Web version)

~~ اقرأني بالعربية ~~

This is the web version of Recite for desktop, but for the Quran only, and with much, much more features.

Use it at: noureddin.github.io/recite.

---

Features

1. Two quiz modes:

   1. no-typing Uthmani script, and
   2. typing-only Imlaai script.

2. Opt-in audio recitation after completing every ayah, in either mode. (It can optionally be made before every ayah, which is called the "teacher mode".)

3. Night mode, in addition to the light mode, with your system preference as the default, but easy to change.

4. The ability to quiz yourself on any number of consecutive ayat, including for example a number of complete suar, an entire juz that starts in the middle of a sura and ends in the middle of another, etc.

5. Tajweed–color-coding in the No-typing Uthmani mode, or with no colorization.

6. The ability to use only the keyboard, only the mouse, only the touch-pad, or even only the touch screen.

7. Being responsive and so adapts to virtually any device, from a large TV to a mobile phone.

8. (For geeks) URL parameters to "pre-configure" the preferences and even what to recite. (Detailed below.)

9. (For developers) Easy to embed in other web apps. (Detailed below, under the "Even more advanced URL parameters" heading.)

URL Parameters (for advanced users)

https://noureddin.github.io/recite/?PARAMS

Examples of PARAMS:

• s=1: the entire first sura.
• s=2: the entire second sura.
• s=1-2: the first and second suar.
• s=-3: the first three suar (1 is optional here).
• s=78-: all the suar from An-Naba' (sura 78) till the end of the Quran.
• p=1: the entire first page (in Mushaf Medina).
• p=2: the entire second page (in Mushaf Medina).
• p=1-3: the first three pages (in Mushaf Medina).
• j=1: the entire first juz.
• j=30: the entire last juz.
• h=1: the entire first hizb (half juz).
• r=1: the entire first rub (quarter hizb, ie eighth of a juz).
• r=1-4: the first four rubs (in the entire Quran).
• r=10//0: the first rub in the 10th juz (when the Mushaf writes «جزء» in the margin).
• r=10//1: the second rub in the 10th juz (when the Mushaf writes «ربع» (¼) in the margin).
• r=10//2: the third rub in the 10th juz (when the Mushaf writes «نصف» (½) in the margin).
• r=10//3: the fourth rub in the 10th juz (when the Mushaf writes «ثلاثة أرباع» (¾) in the margin).
• r=10//4: the fifth rub in the 10th juz (when the Mushaf writes «حزب» in the margin).
• r=10//5: the sixth rub in the 10th juz (when the Mushaf writes «ربع» (¼) in the margin).
• r=10//6: the seveth rub in the 10th juz (when the Mushaf writes «نصف» (½) in the margin).
• r=10//7: the eighth (last) rub in the 10th juz (when the Mushaf writes «ثلاثة أرباع» (¾) in the margin).
• r=10//0-10//1: the first two rubs in the 10th juz.
• r=10//6-10//7: the last two rubs in the 10th juz.
• 1/2: only the second ayah of the first sura.
• 1/1-1/3: from the first ayah of first sura, till the third ayah of the first sura.
• 2/1-4/3: from the first ayah of second sura, till the third ayah of the fourth sura.

Any of these parameters can have a= to add ayat from after the specified region, and/or b= to add ayat from before the specified region. Examples:

• p=1-3&a=1: the first three pages (in Mushaf Medina), and one ayah after them.
• j=15&a=36: the entire 15th juz, and 36 ayah after it.
• j=2&b=5: the entire second juz, and five ayat before it.
• p=3&b=1&a=2: the third page, one ayah before it, and two ayat after it.

Other parameters you can add to pre-configure the preferences:

• d, or dark: select the dark mode by default.

• l, or light: de-select the dark mode.

• If neither dark or light is given, it follows system preference, until you change it from the UI if you wish.

• c=, or color=: select the text colorization in the Uthmani mode; it takes the following values:

  1. t, taj, or tajweed: Tajweed–color-coding (the default).
  2. b, bas, or basic: colorize different parts of the letters differently.
  3. n, no, or none: no colorization at all.

• m=, mv=, or mvbtns=: select the placement of the movement buttons in the Uthmani mode; it takes the following values:

  1. b: bottom (the default).
  2. r: right.
  3. l: left.

• q=, qz=, or quizmode=: select the quizmode; it takes the following values:

  1. u, uthm, or uthmani: select the no-typing Uthmani mode (the default; use only to annul a previous quizmode=imlaai).
  2. i, imla, or imlaai: select the typing-only Imlaai mode.

• txt: a shorthand for quizmode=imlaai or qz=i.

• by=: change the feedback rate in the Imlaai mode; it takes the following values:

  1. l or letter: by-letter (the default; use only to annul a previous by=word or by=aaya).
  2. w or word: by-word (hard). So it checks your input only after you finish a word by pressing space or enter.
  3. a or aaya: by-aaya (very hard). So it checks your input only after you finish an entire aaya (verse) by pressing enter. (Notice the spelling of aaya: it starts with two a letters and ends with just an a.)

• t, teach, or teacher: enable the teacher mode (play the audio recitation for the ayah before you start reciting it, not after).

• n, noteach, or noteacher: disable the teacher mode (the default; play the audio recitation for the ayah after you finish reciting it).

• qari=: select the Qari for the audio recitation; any invalid value (including no value) is considered as "no audio recitation". The Qaris file contains, for each audio recitation, its address followed by its name. The valid values for this option are the addresses (the lines that are all-English with no spaces).

  Note: Browsers don't allow any page to play audio before a user starts interacting with it, unless the user gave that domain the permission, so, if you use these parameters to select ayat, and a qari, and enable teacher mode, then you won't hear the first ayah. Click anywhere inside the page then press Escape to hear the first ayah. Or allow noureddin.github.io to autoplay audio.

  Tip: Pressing Escape anytime repeats the current audio recitation, which is particularly useful in the teacher mode.

• linebreaks to separate each ayah in its line in the Uthmani mode (the default; use only to annul a previous nolinebreaks).

• nolinebreaks to make all ayat flow in the Uthmani mode.

Please note that all these parameters only change the default; all of them are still changeable from the preferences window. (But take a look at "Even more advanced URL parameters" below.)

Even more advanced URL parameters

These are not changeable from the UI, only from the URL parameters; they are experimental features, too advanced, and/or too specific for almost all users.

• qariurl=: provide the url of your preferred audio recitation server, even a locally hosted one (e.g., http://0.0.0.0:6236, but NOT file:///). Makes the Qari selector empty. But changing the Qari selector overrides this. The given URL must be a full URL where ayat audio files can be found; e.g., one can append /001001.mp3 to the given URL and find the first ayah of the first sura.

• hc, or highcontrast: when enabled with the dark mode, it improves the contrast of most colors, including the tajweed colors.

• cn: at the end of a recitation, it appends a "phrase" from the next ayah if it's in the same sura.

• emu=, emulate=, or emulation=: to use a specific keyboard layout regardless of your currently activated layout, even if yours is an English layout. Currently supported layouts:

  • ibm: the common Arabic layout on IBM PCs.
  • mac: the common Arabic layout on Apple devices.
  • arak: the Arak improved layout.
  • dv: an experimental phonetic layout based on Dvorak.

• dt, or disableteacher: to remove teacher mode selector from the UI. The Teacher mode can still be set from the URL params. Useful to force a specific value for the option (e.g. no-teacher) in an embedding web app for example.

  Warning: It's still changeable from the JavaScript console; I couldn't disable this yet.

• dq, or disablequizmode: to remove quiz mode selector from the UI. The quiz mode can still be specified from the URL params. Useful to force a specific mode (e.g. Imlaai) in an embedding web app for example.

  Warning: It's still changeable from the JavaScript console; I couldn't disable this yet.

• dc, or disablecheat: to disable the cheating feature in Imlaai mode. Cheating is pressing the ! key ten times consecutively (when the input so far is correct) to automatically type the next correct letter for you.

  Warning: It's still changeable from the JavaScript console; I couldn't disable this yet.

• zz: for integration into another app. Made primarily for Zikr-uz-Zikr, but is generic enough to be used with other apps.

  When enabled it does the following:

  • On start, instead of the "New" button, an "Ignore" button is shown (in addition to "Repeat").
  • On start, the parent app is notified with the title of the recitation, in order to update its window's title.
  • On end, instead of showing the selectors (to select new ayat), it only shows "Ignore" and "Repeat" buttons.
  • On end, below the ending message, a "Return" button is shown.
  • If the user changes any setting, the parent app is notified immediately.

  To use this mode, load Recite in an iframe with zz URL param, and implement these functions in your global (i.e., window) namespace:

  • zz_show(): called after some basic loading is finished, so the parent shows Recite's iframe.

  • zz_done(): called when "Return" is clicked, after the end of the recitation.

  • zz_ignore(): called when "Ignore" is clicked, which can be anytime.

    Unlike zz_done() (the "Return" button), zz_ignore() means that the user doesn't want to register this recitation. So, if you're asking the user how their recitation/memorization was, don't do that if zz_ignore() is called instead of zz_done().

  • zz_set_title(title): called on start to set the parent window's title to the current recitation content, the same as the Recite's window's title without | رسيت and the title appearing above the header buttons.

  • zz_set_quizmode(uthm_or_imla): called when the user changes the quiz mode selector. Either "uthm" for Uthmani (the default) or "imla" for Imlaai.

  • zz_set_feedbackrate(emptystring_or_word): called when the user changes the feedback rate selector for the Imlaai mode. Empty string ("") is for by-letter (the default) and "word" is for by-word.

  • zz_set_tajweed(t_or_b_or_n): called when the user changes the text colorization selector for the Uthmani mode. "t" for Tajweed (the default), "b" for Basic (parts of characters), and "n" for None.

  • zz_set_dark(boolean): called when the user changes the dark mode checkbox. Either true for the dark mode, or false for the light mode (the default).

  • zz_set_mvbtns(b_or_r_or_l): called when the user changes the movement buttons for the Uthmani mode. "b" for Bottom (the default), "r" for Right, and "l" for Left.

  You are likely to load Recite with a specific range of ayat to start the recitation immediately.

  You can check Zikr-uz-Zikr's zz_* functions in zz.py.

---

Many thanks for Khaled Hosny for his work on Quran Data and Amiri Font.

Heartfelt thanks for the Verse By Verse MP3 Quran project, for providing the audio recitations for every project that needs them, including Recite Web and Ayat.

Thanks for my friends Ezz El Din and Ahmad Hassan for helping me in developing these applications and giving me invaluable feedback.

The logo is based on the beautiful Anchor by dwtoch on OpenClipArt.