=== Quran Pro ===
Contributors: abdullohukr
Tags: quran, islam, arabic, translation, tafsir
Requires at least: 5.8
Tested up to: 7.1
Requires PHP: 7.0
Stable tag: 3.21.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Find Quran ayahs and insert them into posts and pages with translation and tafsir.

== Description ==

Quran Pro inserts Quran ayahs into WordPress posts and pages:

* the Arabic text of several mushafs (Uthmani, Imlaei, IndoPak, tajweed …), with brackets, isti'adhah, basmalah and a reference such as [يونس ١];
* translations in 90+ languages and tafsirs, with a reference such as (Yunus: 1);
* ayah numbers, hizb, sajdah and pause marks on or off;
* fonts, sizes, bold, colour and alignment as set in the picker.

In the block editor open the **Quran Pro** panel (the Quran Pro logo at the top right; it opens by itself the first time). Put the cursor where the ayah should go, find it in the panel and press **Insert**: the ayah and its translation are inserted as ordinary paragraphs, which you can edit like any other text. The classic editor has an **Ayah** button above the editor. The panel is the
website https://quranpro.org/ in a frame; the result is saved in the post as ordinary HTML. The Arabic font (Scheherazade New, SIL Open Font License) comes with the plugin, so visitors load nothing from other servers, except the page fonts of the QPC mushafs when a post contains such an ayah (see "External services"). The block **Quran ayah** of version 1.0 still works.

== Installation ==

1. Plugins → Add New → Upload Plugin → choose `quran-pro.zip` → Install → Activate (or search for "Quran Pro" in Plugins → Add New).
2. Block editor: open a post, open the **Quran Pro** panel (the logo at the top right), put the cursor where the ayah should go, find the ayah in the panel and press **Insert**.
3. Classic editor: press the **Ayah** button above the editor, find the ayah and press **Insert**.

== External services ==

The plugin itself sends nothing from the WordPress site to anyone. The services below are contacted by the browser: in the post editor only when the panel, the "Ayah" button or the block "Quran ayah" is open (the panel opens by itself once, the first time the block editor is opened after the plugin is activated; it can be closed), and on the public site only for the page fonts described in point 1.

1. **Quran Pro** (https://quranpro.org/), the picker in which the ayah, translation and tafsir are chosen.
   * What it is used for: the picker page itself, the Quran text, the Uzbek translations and the search data; and the page fonts of the QPC mushafs (one font file per Mushaf page, for example `fonts/qpc/v4/p1.woff2`).
   * When: in the editor while the panel or the picker is open. The page fonts also in the editor when a post contains an ayah in a QPC mushaf, and on the public site when a visitor opens such a post (posts without such ayahs do not contact it).
   * What is sent: only the normal requests for these files (IP address, browser user agent). The chosen ayah goes from the panel to the editor inside the browser; nothing about the site, the post or its text is sent.
   * Terms of use: https://quranpro.org/terms.html · Privacy policy: https://quranpro.org/privacy.html
2. **Quran Pro public counter** (https://stats.abdulloh.org/), the numbers of users and inserted ayahs shown in the panel.
   * Off by default in WordPress: nothing is sent until the person turns on Settings → "Take part in the public counter".
   * When (only after it was turned on): while the panel is open. Once a day the panel sends "the panel was opened"; after an insert it sends how many ayahs were inserted; it also reads the totals.
   * What is sent: a random number made in this browser (not linked to any account), the event, the platform ("wp"), the version and the interface language. No name, e-mail, site address or text of a post.
   * It can be switched off again in the same place. Then nothing is sent.
   * Privacy policy: https://quranpro.org/privacy.html
3. **GitHub** (raw.githubusercontent.com) and **jsDelivr** (cdn.jsdelivr.net), where the service publishes its open data (repository abdullohukr/quranuz).
   * What it is used for: the texts of the translations and tafsirs (GitHub), and copies of the search data and of the QPC page fonts that the panel uses when https://quranpro.org/ does not answer (jsDelivr, then GitHub).
   * When and what is sent: while the panel is open, only the normal requests for these files.
   * GitHub terms: https://docs.github.com/site-policy/github-terms/github-terms-of-service · privacy: https://docs.github.com/site-policy/privacy-policies/github-general-privacy-statement
   * jsDelivr terms: https://www.jsdelivr.com/terms · privacy: https://www.jsdelivr.com/terms/privacy-policy
4. **Quran Pro tafsir storage** (https://tafsir.abdulloh.org/), the data for searching in the tafsirs.
   * When and what is sent: while the panel is open and a search reaches the tafsirs, only the normal requests for these files.
   * Privacy policy: https://quranpro.org/privacy.html
5. **Further copies of the QPC page fonts**, used by the panel only when the sources above do not answer, in this order: Hugging Face (huggingface.co), archive.org, and the QUL font CDN of Tarteel (static-cdn.tarteel.ai).
   * When and what is sent: while the panel shows an ayah in a QPC mushaf, only the normal requests for the font files.
   * Hugging Face terms: https://huggingface.co/terms-of-service · privacy: https://huggingface.co/privacy
   * archive.org terms and privacy: https://archive.org/about/terms
   * Tarteel terms: https://tarteel.ai/terms · privacy: https://tarteel.ai/privacy
6. **Cloudflare Web Analytics** (static.cloudflareinsights.com), which the host of https://quranpro.org/ may add to the panel's page.
   * When and what is sent: while the panel is open, a page view (address of the panel page, browser user agent); no cookies, nothing about the site, the post or its text.
   * Cloudflare privacy policy: https://www.cloudflare.com/privacypolicy/

== Screenshots ==

1. Insert Quran ayahs with translation: the ayah, the translation and the reference in one click.
2. Search in Arabic (with or without diacritics), by surah name, by reference such as 2:255, or in any translation.
3. Choose exactly what is inserted: brackets, isti'adhah, basmalah, references, ayah numbers, hizb, sajdah and pause marks.
4. About 200 translations in 90+ languages and about 100 tafsirs.

== Changelog ==

= 3.21.0 =
* Version follows the Quran Pro release (framed ayah pictures in the panel's picture window). Nothing else changed in the plugin.

= 3.20.0 =
* The plugin and the service are now called Quran Pro (formerly Khatt al-Quran); the site is https://quranpro.org/.
* The public counter is off in WordPress until you turn it on in the panel's Settings.
* With the cursor in a list item or a button the ayah goes after that block; an insert the editor refuses is reported.
* The QPC page fonts come only from the Quran Pro site; the panel logo is part of the plugin.

= 3.19.1 =
* In the panel's Settings you can choose the mark placed between the chosen places of an ayah: "…", "[…]", "..." or "—".
* A damaged history entry no longer shows words of another surah.

= 3.19.0 =
* Several places of one ayah can be chosen and inserted together, joined with "…"; words of the translation can be chosen by hand too.
* The "Expand" window shows the ayah and its translation large, to choose from a long text and insert from there.

= 3.18.1 =
* Translations that were switched off in the Settings no longer take memory.

= 3.18.0 =
* The panel shows a public counter of users and inserted ayahs. Only an anonymous random number and what happened are counted; in WordPress it is off until the person turns it on in the Settings (see "External services").

= 3.17.0 =
* Version follows the Khatt al-Quran release (the new things were for Microsoft Word). Nothing else changed in the plugin.

= 3.16.0 =
* Version follows the Khatt al-Quran release. Nothing else changed.

= 3.15.1 =
* The version of the plugin now follows the version of Khatt al-Quran releases. Nothing else changed since 1.1.5.

= 1.1.5 =
* The editor panel icon is the Khatt al-Quran logo.

= 1.1.4 =
* Live search reacts faster; the key Alt+F in the panel searches the text selected in the editor once.

= 1.1.3 =
* Live search: when it is switched on in the panel, the Arabic text selected in the editor is searched at once.

= 1.1.2 =
* The panel's "Undo" button takes the last inserted ayah out of the post again (only if it was not edited since; text typed by hand counts as an edit).

= 1.1.1 =
* The page fonts of the QPC mushafs come from a chain of sources: the Khatt al-Quran site, GitHub (jsDelivr), Hugging Face, archive.org, and the QUL font CDN last, so one outage does not break the ayahs.

= 1.1.0 =
* A side panel in the block editor (like the task pane in Word): the ayah and its translation are inserted at the cursor as ordinary paragraphs. The old block "Quran ayah" and the classic editor button are unchanged.
* The page-font (QPC) mushafs are inserted as text; their fonts are declared automatically in the editor and on the site.

= 1.0.0 =
* First version: block "Quran ayah", classic editor button, bundled Arabic font.
