diff --git a/CHANGELOG.md b/CHANGELOG.md index 935684fa..696bca4b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,29 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). --- +## [Unreleased] — 2026-02-22 + +### Added +- `data/en.yusufali.txt` — English translation by Abdullah Yusuf Ali (pipe-delimited `sura|ayah|text` format). +- `data/translit_en.txt` — English transliteration, sequential global-ayah format (Quran Unicode Project). +- `data/hindi-mokhtasar.json.zip` — Hindi Tafsir data (Al-Mokhtasar Fi Tafsir Al-Quran Al-Karim) in JSON format. +- `data/abridged-explanation-of-the-quran.json.zip` — English Explanation (Abridged) in JSON format. +- `output/quran_english_yusufali.txt` — new plain-text output for Yusuf Ali English translation. +- `output/quran_translit_unicode.txt` — new plain-text output for Quran Unicode Project transliteration. +- `output/quran_hindi_mokhtasar.txt` — new plain-text output for Al-Mokhtasar Hindi Tafsir. +- `output/quran_english_abridged.txt` — new plain-text output for the Abridged English Explanation. +- `docs.zip` — ZIP archive of the generated `docs/` HTML pages. +- `.github/workflows/scrape.yml` — GitHub Actions workflow (`Upload Audio to Hugging Face Hub`) to download Alafasy recitation audio and upload it to a Hugging Face dataset, then open a PR with an updated `config/audio_config.json`. + +### Changed +- `src/gentxtforquran.py` — extended to handle three additional input formats: + - **Pipe-delimited** (`sura|ayah|text`) for Yusuf Ali. + - **Sequential transliteration** (`num|text`) for the Quran Unicode Project file. + - **JSON ZIP** (key `"sura:ayah"` → `{text}`) for Hindi Tafsir and English Explanation sources. +- `src/gendocshtml.py` — updated to incorporate all new translations (Yusuf Ali, Quran Unicode Project transliteration, Al-Mokhtasar Hindi Tafsir, Abridged English Explanation) into the generated HTML pages. + +--- + ## [Unreleased] — 2026-02-20 ### Added diff --git a/README.md b/README.md index 93e7dcc5..b28fa268 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ Generate typeset PDF editions of the Qur'an with Arabic text alongside Hindi and | Script language | Python 3 | | Web output | Static HTML (GitHub Pages via `docs/`) | | Build system | GNU Make | +| CI / automation | GitHub Actions | --- @@ -31,7 +32,11 @@ Generate typeset PDF editions of the Qur'an with Arabic text alongside Hindi and │ ├── hi.hindi.txt # Hindi – Suhel Farooq Khan & Saifur Rahman Nadwi │ ├── en.sahih.txt # English – Saheeh International │ ├── en.pickthall.txt # English – Mohammed Marmaduke Pickthall +│ ├── en.yusufali.txt # English – Abdullah Yusuf Ali (pipe-delimited sura|ayah|text) │ ├── en.transliteration.txt # English transliteration (Tanzil.net) +│ ├── translit_en.txt # English transliteration, sequential (Quran Unicode Project) +│ ├── hindi-mokhtasar.json.zip # Hindi Tafsir JSON – Al-Mokhtasar Fi Tafsir Al-Quran Al-Karim +│ ├── abridged-explanation-of-the-quran.json.zip # English Explanation JSON – Abridged │ ├── suranamemal.txt # Surah name data (Malayalam script) │ └── surna.txt # Surah name reference data ├── latex/ # LaTeX document sources & generated content @@ -65,6 +70,15 @@ Generate typeset PDF editions of the Qur'an with Arabic text alongside Hindi and | `translit.pdf` | Transliteration | Tanzil.net | | `pickthall.pdf` | English | Mohammed Marmaduke Pickthall (1930, Public Domain) | +Plain-text outputs (generated by `src/gentxtforquran.py`) additionally cover: + +| Output file | Language | Source | +|-------------|----------|--------| +| `quran_english_yusufali.txt` | English | Abdullah Yusuf Ali | +| `quran_translit_unicode.txt` | Transliteration | Quran Unicode Project | +| `quran_hindi_mokhtasar.txt` | Hindi (Tafsir) | Al-Mokhtasar Fi Tafsir Al-Quran Al-Karim | +| `quran_english_abridged.txt` | English (Explanation) | Abridged Explanation of the Quran | + Arabic text uses the Standard Arabic Uthmani Script sourced from [tanzil.net](https://tanzil.net). --- @@ -126,9 +140,20 @@ cd latex && xelatex pickthall.tex # → output/pickthall.pdf (English – Pickth python3 src/gentxtforquran.py ``` -Produces `output/quran_hindi_farooq.txt`, `output/quran_hindi_suhail.txt`, -`output/quran_english_sahih.txt`, `output/quran_english_translit.txt`, -`output/quran_english_pickthall.txt`, and `output/quran_arabic.txt`. +Produces ten files in `output/`: + +| Output file | Content | +|-------------|---------| +| `quran_hindi_farooq.txt` | Hindi – Muhammad Farooq Khan & Muhammad Ahmed | +| `quran_hindi_suhail.txt` | Hindi – Suhel Farooq Khan & Saifur Rahman Nadwi | +| `quran_hindi_mokhtasar.txt` | Hindi Tafsir – Al-Mokhtasar Fi Tafsir Al-Quran Al-Karim (from JSON) | +| `quran_english_sahih.txt` | English – Saheeh International | +| `quran_english_translit.txt` | English transliteration – Tanzil.net | +| `quran_english_pickthall.txt` | English – Mohammed Marmaduke Pickthall | +| `quran_english_yusufali.txt` | English – Abdullah Yusuf Ali | +| `quran_english_abridged.txt` | English Explanation – Abridged (from JSON) | +| `quran_translit_unicode.txt` | Transliteration – Quran Unicode Project (sequential) | +| `quran_arabic.txt` | Arabic – Standard Uthmani Script | ### 4. Regenerate HTML documentation (GitHub Pages) @@ -156,6 +181,10 @@ make clean # Remove LaTeX build artefacts (aux, log, toc, out) - **Arabic text**: Standard Arabic Uthmani Script — [tanzil.net](https://tanzil.net) - **Hindi translations**: Downloaded from [zekr.org](http://zekr.org) - **English translations**: [tanzil.net](https://tanzil.net) and Pickthall (1930, Public Domain) +- **English – Yusuf Ali**: Public domain; pipe-delimited (`sura|ayah|text`) format +- **English transliteration (sequential)**: Quran Unicode Project (`translit_en.txt`) +- **Hindi Tafsir (Al-Mokhtasar)**: Distributed as `hindi-mokhtasar.json.zip` (JSON) +- **English Explanation (Abridged)**: Distributed as `abridged-explanation-of-the-quran.json.zip` (JSON) ---