diff options
author | Karl Berry <karl@freefriends.org> | 2023-08-01 20:07:10 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2023-08-01 20:07:10 +0000 |
commit | bdce98e4472517924611e5b6e6171d98254fd1cd (patch) | |
tree | e65899d954699e5fabbeb08e0d44cc13ceb68c52 /Master/texmf-dist/doc | |
parent | 70bd15820527430cb0777054da86546da3e8c9c9 (diff) |
quran (1aug23)
git-svn-id: svn://tug.org/texlive/trunk@67791 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/quran/README | 7 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/quran/quran-doc.pdf | bin | 361474 -> 373941 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/quran/quran-doc.tex | 442 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/quran/quran-test.pdf | bin | 34061 -> 60033 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/quran/quran-test.tex | 65 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/quran/quran-test1.pdf | bin | 56720 -> 58234 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/quran/quran-test1.tex | 27 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/quran/quran-test2.pdf | bin | 63669 -> 523833 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/quran/quran-test2.tex | 103 |
9 files changed, 382 insertions, 262 deletions
diff --git a/Master/texmf-dist/doc/latex/quran/README b/Master/texmf-dist/doc/latex/quran/README index 45296f54e6d..fdcbe8ab0f0 100644 --- a/Master/texmf-dist/doc/latex/quran/README +++ b/Master/texmf-dist/doc/latex/quran/README @@ -1,6 +1,6 @@ _____________________ The quran package -v2.0 +v2.2 The package is prepared for typesetting the holy Quran. This work provides several macros for typesetting the whole or @@ -8,15 +8,16 @@ any parts of the holy Quran based on its popular divisions. For more information, please see the documentation. -Current version release date: 2023/07/10 +Current version release date: 2023/08/01 ___________________ Seiied-Mohammad-Javad Razvian javadr@gmail.com Copyright © 2015-2023 It may be distributed and/or modified under the LaTeX Project Public License, -version 1.3c or higher (your choice). The latest version of +version 1.3c or higher "(your choice)". The latest version of this license is at: http://www.latex-project.org/lppl.txt This work is “author-maintained” (as per LPPL maintenance status) + by Seiied-Mohammad-Javad Razavian. diff --git a/Master/texmf-dist/doc/latex/quran/quran-doc.pdf b/Master/texmf-dist/doc/latex/quran/quran-doc.pdf Binary files differindex b04c85ed963..477b8b3dbae 100644 --- a/Master/texmf-dist/doc/latex/quran/quran-doc.pdf +++ b/Master/texmf-dist/doc/latex/quran/quran-doc.pdf diff --git a/Master/texmf-dist/doc/latex/quran/quran-doc.tex b/Master/texmf-dist/doc/latex/quran/quran-doc.tex index d7fa045148b..a117afc002a 100644 --- a/Master/texmf-dist/doc/latex/quran/quran-doc.tex +++ b/Master/texmf-dist/doc/latex/quran/quran-doc.tex @@ -34,7 +34,7 @@ \usepackage[toc]{multitoc} \usepackage{manfnt} -\usepackage[trans={lt, de, en, fa}, wordwise, uthmani]{quran} +\usepackage[trans={lt, de, en, fa, fr}, wordwise, uthmani]{quran} \newfontfamily\quran[Script=Arabic]{Scheherazade} \newfontfamily\amiri[Script=Arabic]{Amiri} \hypersetup{% @@ -125,14 +125,15 @@ The \xpackage{quran} Package\thanks{To one having devoted his life to the Holy Q \centerline{\large\bfseries Abstract} \bigskip The \xpackage{quran} package\footnote{This work has been inspired by \xpackage{lipsum} and -\xpackage{ptext} packages and released for the first time in June 2015 (Sha'ban 1436 AH).} +\xpackage{ptext} packages and was initially released in June 2015 (Sha'ban 1436 AH).} has been prepared for typesetting the Holy Quran. -It provides several macros for typesetting not only the whole or any parts of the Holy Quran based on its popular divisions, -but also any chunks of an ayah. -Four translations of the Holy Quran in German, English, French, and Persian in addition to its transliteration are also supported.% -\footnote{There are three packages, \xpackage{quran-de}, \xpackage{quran-ur}, and \xpackage{quran-bn} in companion with, which provide several other translations in Deutsch, Urdu and Bengali, respectively.} -Please, report any issues including bugs, typos in the documentation -or feature requests on \url{https://github.com/javadr/quran/issues}. +It provides several macros for typesetting not only the entire or any specific parts of the Holy Quran based on its popular divisions +but also any segments of an ayah. +Additionally, it supports four translations of the Holy Quran in German, English, French, and Persian, +as well as its transliteration.% +\footnote{There are three companion packages, \xpackage{quran-de}, \xpackage{quran-ur}, and \xpackage{quran-bn}, which provide several other translations in Deutsch, Urdu and Bengali, respectively.} +Please report any issues including bugs or typos in the documentation +or make feature requests on \url{https://github.com/javadr/quran/issues}. } \null\vfill @@ -146,7 +147,7 @@ or feature requests on \url{https://github.com/javadr/quran/issues}. \thispagestyle{empty} \null\vfil \section*{Acknowledgments} -I would like to express my very great appreciation to: +I would like to express my utmost gratitude to: \begin{enumerate} \parskip=0pt \item \emph{Vafa Khaligi} who paved the way for typesetting right-to-left in \XeTeX. @@ -162,9 +163,9 @@ I would like to express my very great appreciation to: \newpage \section{Loading Package} -The package can be loaded in the ordinary way +The package can be loaded in the usual manner using the command \cs{usepackage[option]\{quran\}}. All \tt{option}s are explained in the section \ref{sec:options}. -After loading the package, it writes some information about itself to the log file. The information is something like: +Once the package is loaded, it will write some information about itself to the log file. The information will be something like this: \begin{quote} \begin{lstlisting}[style=BashInputStyle, escapechar={|},] @@ -174,34 +175,35 @@ An easy way to typeset the whole or any parts of the Holy Quran \end{quote} \section{Typesetting The Holy Quran}\label{sec:qurantypesetting} -For typesetting any parts or whole of the Holy Quran, several macros are provided in the package. -These commands are responsible for typesetting all popular divisions of the Holy Quran based on Uthmani script, including Surah, Ayah, Page, Juz, Hizb, Quarter, Ruku, and Manzil as well as any chunks of an a yah. +For typesetting any part or the entirety of the Holy Quran, several macros are provided in the package. +These commands are responsible for typesetting all popular divisions of the Holy Quran based on Uthmani script, including Surah, Ayah, Page, Juz, Hizb, Quarter, Ruku, and Manzil, as well as any segments of an ayah. \subsection{Surah/Sovar} \begin{declcs}{quransurah}\oarg{surah range}\\ \cs{quransurah*}\oarg{surah range} \end{declcs} -This macro can typeset any surah of Quran. A \meta{range} consists +This macro can typeset any surah of the Quran. A \meta{range} consists either of a single \meta{number} or two numbers separated by a dash (-), as in \none-\ntwo. In \cs{quransurah} and similar commands, -if \meta{range} does not satisfy \none~<~\ntwo{} in addition to its domain, -this might fail or make some undesired results. As you know there are 114 surahs, so \meta{range} could -be an integer between 1 to 114. +if \meta{range} does not satisfy \none~<~\ntwo{} within its domain, +it might result in failure or produce undesired results. As you know there are 114 surahs in total, +so \meta{range} should be an integer between 1 to 114. -\cs{quransurah} terminates typesetting of every ayah using \cs{par} (depending on +The macro \cs{quransurah} terminates the typesetting of every ayah using \cs{par} (depending on the package option) while \cs{quransurah*} uses a blank space for each ayah. -As a simplified rule of thumb, \cs{quransurah} prints ayahs as multiple paragraphs while +As a simplified rule of thumb, \cs{quransurah} prints ayahs as multiple paragraphs whereas \cs{quransurah*} prints them as a single paragraph. -All starred macros in the package act similar in this manner; see page~\pageref{starred} for more details. +All starred macros in the package function similarly in this manner; for futhur details, +please refer to page~\pageref{starred}. -The macro also could accept the anglicized title of the surah's name, -e.g. both of \cs{quransurah[19]} and \cs{quransurah[Maryam]} have the same effect. +The macro also accepts the anglicized title of the surah's name. For instance, +both of \cs{quransurah[19]} and \cs{quransurah[Maryam]} have the same effect. \mgpar{quransurah[19]}\mgpar{quransurah[Maryam]} -See table~\ref{tab1} how to use the anglicized title of a surah instead of its order. -As some anglicized titles include a dash (-), therefore -\meta{range} has to be separated by two dashes (\tt{--}), e.g.\cs{quransurah[An-Nasr--An-Nas]}. +Refer to table~\ref{tab1} how to use the anglicized title of a surah instead of its order. +As some anglicized titles include a dash (-), the +\meta{range} has to be separated by two dashes (\tt{--}), for example, \cs{quransurah[An-Nasr--An-Naas]}. -\cs{quransurah} without its optional argument outputs the package's default surah, Al-Ikhlas, +\cs{quransurah} without its optional argument outputs the default surah of the package, Al-Ikhlaas, (as long as the default has not been overwritten, see below). \centerline{\mx{quransurah[94]}{\quransurah[94]} \hfill @@ -210,20 +212,21 @@ As some anglicized titles include a dash (-), therefore \centerline{\mxf{quransurah*[113-114]}{\quransurah*[113-114]}} \centerline{\mx{quransurah[109-110]}{\quransurah[109-110]} \hfill - \mx{quransurah[Al-Masadd--Al-Ikhlas]}{\quransurah[Al-Masadd--Al-Ikhlas]}} + \mx{quransurah[Al-Masad--Al-Ikhlaas]}{\quransurah[Al-Masad--Al-Ikhlaas]}} \centerline{\mx{quransurah*}{\quransurah*} \hfill\mx{quransurah}{\quransurah}} -In order to change the default surah, apply \cs{setsurahdefault\{m\}}. -As you've noticed the package's default is 112. \mgpar{setsurahdefault} -After changing package's default surah to 107 by \cs{setsurahdefault\{107\}}, the output would be like below: +In order to change the default surah, use \cs{setsurahdefault\{m\}}. +As you have noticed the package's default is 112. \mgpar{setsurahdefault} +After changing package's default surah to 107 with \cs{setsurahdefault\{107\}}, +the output would be as show below: \setsurahdefault{107} \centerline{\mxf{quransurah*}{\quransurah*}} \newcounter{ct} \def\mycell#1{% - \surahname[\value{#1}]% + \texttt{\surahname[\value{#1}]}% \addtocounter{ct}{38}% } \begin{table}[!htb] @@ -247,14 +250,15 @@ After changing package's default surah to 107 by \cs{setsurahdefault\{107\}}, th \begin{declcs}{quranayah}\oarg{surah range}\oarg{ayah range}\\ \cs{quranayah*}\oarg{surah range}\oarg{ayah range} \end{declcs} -\meta{range} is similar the one explained for \cs{quransurah} and this pattern is similar to all commands defined in the package. -Therefore, this command typesets the \textit{n}$^{th}$ ayah of a surah or \textit{m}$^{th}$ to \textit{n}$^{th}$ ayahs of a s urah. +\meta{range} is similar the one explained for \cs{quransurah} and +this pattern applies to all commands defined in the package. +Therefore, this command typesets the \textit{n}$^{th}$ ayah of a surah or \textit{m}$^{th}$ to \textit{n}$^{th}$ ayahs of a surah. \centerline{\mx{quranayah[33][33]}{\quranayah[33][33]} \hfill - \mx{quranayah[Al-Ahzab][33]}{\quranayah[Al-Ahzab][33]}} + \mx{quranayah[Al-Ahzaab][33]}{\quranayah[Al-Ahzaab][33]}} -The basmalah will not be printed if you want to typeset the first ayah of any surah per se. -Using \cs{basmalah} macro prior to the ayah will solve this issue. See page~\pageref{sec:basmalah} for more information. +The basmalah will not be printed if you intend to typeset the first ayah of any surah per se. +To address this issue, you can use the \cs{basmalah} macro before the ayah. For further information, please refer to page~\pageref{sec:basmalah}. \marginpar{\cs{basmalah}} \centerline{\mx{quranayah[Ibrahim][1]}{\quranayah[Ibrahim][1]} \hfill @@ -263,11 +267,11 @@ Using \cs{basmalah} macro prior to the ayah will solve this issue. See page~\p \centerline{\mx{quranayah*[Ash-Shura][22-26]}{\quranayah*[Ash-Shura][22-26]} \hfill \mx{quranayah*[42][22-26]}{\quranayah*[42][22-26]}} -Both \cs{quransurah} and \cs{quranayah} are \emph{case-insensitive} to the anglicized title of surah, i.e. -there are, for example, no differences among Al-Fatiha, al-fatiha, or any other possible combinations of lowercase and uppercase letters. +Both \cs{quransurah} and \cs{quranayah} are \emph{case-insensitive} to the anglicized title of surah. +In other words, there are, for example, no differences among `Al-Fatiha', `al-fatiha', or any other possible combinations of lowercase and uppercase letters. -\centerline{\mx{quransurah*[Al-Fatiha]}{\quransurah*[Al-Fatiha]} \hfill - \mx{quransurah*[aL-fAtIhA]}{\quransurah*[aL-fAtIhA]}} +\centerline{\mx{quransurah*[Al-Faatiha]}{\quransurah*[Al-Faatiha]} \hfill + \mx{quransurah*[aL-fAatIhA]}{\quransurah*[aL-fAatIhA]}} \subsection{Page/Pages} \begin{declcs}{quranpage}\oarg{page range}\\ @@ -275,7 +279,7 @@ there are, for example, no differences among Al-Fatiha, al-fatiha, or any other \end{declcs} Typesets the specified \meta{range} of page(s) of the Holy Quran. -The numbers in \meta{range} have to be between $1$ to $604$, based on the Medina Mushaf. +The numbers in \meta{range} should be between $1$ to $604$, based on the Medina Mushaf. \centerline{\hboxR{\mx{quranpage*[249]}{\quranpage*[249]} \hfill @@ -291,14 +295,16 @@ The numbers in \meta{range} have to be between $1$ to $604$, based on the Medina This macro typesets the specified \meta{range} of juz(zes) of the Holy Quran, ranging from $1$ to $30$. \subsection{Hizb/Ahzab} -Each juz of the Holy Quran is devided into two ahzab (groups), thus there are 60 hizbs (ahzab). -Following macro typesets hizb/ahzab of the Holy Quran. +Each juz of the Holy Quran is divided into two ahzab (groups), resulting in a total of 60 hizbs (ahzab). +The following macro typesets hizb/ahzab of the Holy Quran. \begin{declcs}{quranhizb}\oarg{hizb range}\\ \cs{quranhizb*}\oarg{hizb range} \end{declcs} +\centerline{\mxf{quranquarter*[110]}{\quranquarter*[110]}} + \subsection{Quarter/Quarters} Eash hizb of the Holy Quran is devided into four quarters, making eight quarters per juz, called maqra. There are 240 of these quarters (of hizb) in the Holy Quran. These maqras are often used as sections for revision when memorizing the Holy Quran.\footnote{\url{https://en.wikipedia.org/wiki/Juz'}} @@ -307,7 +313,7 @@ There are 240 of these quarters (of hizb) in the Holy Quran. These maqras are of \cs{quranquarter*}\oarg{quarter range} \end{declcs} - \centerline{\mxf{quranquarter*[110]}{\quranquarter*[110]}} + \subsection{Ruku/Rukus} ``The term ruk\= u --- roughly translated to ``passage", ``pericope" or ``stanza" --- is also used to denote a group of thematically related verses in the Qur'an. Longer suras (chapters) in the Qur'an are usually divided into several ruk\= us, so that the reciters could identify when to make ruk\= u in Salat without breaking an ongoing topic in the Quranic text."\footnote{\url{https://en.wikipedia.org/wiki/Ruku}} There are $556$ rukus. @@ -322,17 +328,18 @@ There are 240 of these quarters (of hizb) in the Holy Quran. These maqras are of \subsection{Manzil/Manazil} -``For the convenience of people who wish to read the Qur'an in a week the text may be divided into 7 portions, each portion is known as Manzil. +``For the convenience of people who wish to read the Qur'an in a week the text may be divided into 7 portions, +with each portion known as Manzil. -The following division to 7 equal portions is by Hamza Al-Zayyat (d.156/772): +The following division into 7 equal portions is attributed to Hamza Al-Zayyat (d.156/772): \begin{enumerate} - \item Al-Fatihah (chapter 1) through An-Nisa' (chapter 4) consisting of 4 surahs. - \item Al-Ma'ida (chapter 5) through At-Tawba (chapter 9) consisting of 5 surahs. + \item Al-Faatiha (chapter 1) through An-Nisaa (chapter 4) consisting of 4 surahs. + \item Al-Maaida (chapter 5) through At-Tawba (chapter 9) consisting of 5 surahs. \item Yunus (chapter 10) through An-Nahl (chapter 16) consisting of 7 surahs. - \item Al Isra' (chapter 17) through Al-Furqan (chapter 25) consisting of 9 surahs. - \item Ash-Shuara' (chapter 26) through Ya-Seen (chapter 36) consisting of 11 surahs. - \item As-Saaffat (chapter 37) through Al-Hujarat (chapter 49) consisting of 13 surahs. - \item Qaf (chapter 50) through An-Nass (chapter 114) consisting of 65 surahs.''\footnote{\url{https://en.wikipedia.org/wiki/Manzil}} + \item Al-Israa (chapter 17) through Al-Furqaan (chapter 25) consisting of 9 surahs. + \item Ash-Shu'araa (chapter 26) through YaSeen (chapter 36) consisting of 11 surahs. + \item As-Saaffaat (chapter 37) through Al-Hujuraat (chapter 49) consisting of 13 surahs. + \item Qaaf (chapter 50) through An-Naas (chapter 114) consisting of 65 surahs.''\footnote{\url{https://en.wikipedia.org/wiki/Manzil}} \end{enumerate} \begin{declcs}{quranmanzil}\oarg{manzil range}\\ @@ -342,8 +349,8 @@ The following division to 7 equal portions is by Hamza Al-Zayyat (d.156/772): The above macro typesets manzil/manazil of the Holy Quran. \subsection{Text of Quran} -The next macro is the heart of all macros in the package typesetting any range of Quran. As you know, there -are $6236$ ayahs in the Holy Quran. This macro can typeset a specific ayah or any range of ayahs. +The next macro is the core of all macros in the package, allowing typesetting of any range of Quranic verses. +As you know, there are $6236$ ayahs in the Holy Quran. This macro can typeset a specific ayah or any range of ayahs. \begin{declcs}{qurantext}\oarg{index range}\\ \cs{qurantext*}\oarg{index range} @@ -367,7 +374,7 @@ change the default text use \cs{setqurantextdefault\{m-n\}} \centerline{\mxf{qurantext*}{\qurantext*}} \subsection{Whole of The Holy Quran} -The following macros with the specified parameters can typeset whole of the Holy Quran: +The following macros, when provided with the specified parameters, can typeset the entire Holy Quran. \begin{multicols}{2} \begin{itemize} @@ -390,10 +397,10 @@ The following macros with the specified parameters can typeset whole of the Holy \end{itemize} \end{multicols} \subsection{Chunks of an Ayah}\label{chunk} -From ver 1.6 onward, the package is capable of typesetting not only a whole ayah but also any chunks of an ayah +Starting from version 1.6 onward, the package is capable of typesetting not only a whole ayah but also any chunks of an ayah if the \xmgpar{wordwise} option has been loaded.\footnote{This new practical feature has been suggested and supported financially by \emph{Atiyah Elsheikh} in Feburary 2020.} - In this case, \cs{quranayah} and \cs{qurantext} macros have some other optional parameters to do that. + In this case, \cs{quranayah} and \cs{qurantext} macros have additional optional parameters to enable this functionality. \begin{declcs}{quranayah}\oarg{surah range}\oarg{ayah range}\oarg{chunk range}\\ \cs{quranayah}\oarg{surah range}\oarg{ayah range}\oarg{chunk range}\tt{+} @@ -411,13 +418,14 @@ If \meta{chunk range} includes just one number, the output will be from the \centerline{\mx{quranayah[2][156][6]}{\quranayah[2][156][6]} \hfill \mx{quranayah[2][286][31-43]}{\quranayah[2][286][31-43]}} -The way the package enumerates the words of a specified \meta{range} could be shown in the footnote if these commands followed by \tt{+}. +The way the package enumerates the words of a specified \meta{ayah/index range} could be shown in the footnote +if the above commands followed by \tt{+}. -\centerline{\mxf{quranayah[Ar-Rad][23-24][10]+}{\quranayah[Ar-Rad][23-24][10]+}} +\centerline{\mxf{quranayah[Ar-Ra'd][23-24][10]+}{\quranayah[Ar-Ra'd][23-24][10]+}} -\pagebreak[4] +% \pagebreak[4] Fetching just one word from -an ayah needs the \meta{chunck range} to have both \meta{number}s as the same. +an ayah requires the \meta{chunck range} to have both \meta{number}s as the same. \centerline{\mx{quranayah[18][19][34-34]}{\quranayah[18][19][34-34]} } @@ -427,7 +435,7 @@ an ayah needs the \meta{chunck range} to have both \meta{number}s as the same. \begin{declcs}{surahname}\oarg{index}\\ \cs{surahname*}\oarg{index} \end{declcs} -These commands return the anglicized/arabic title of \textit{index}$^{th}$ surah of the Holy Quran, +These commands return the Anglicized/Arabic title of \textit{index}$^{th}$ surah of the Holy Quran, as depicted in table~\ref{tab1} and table~\ref{tab2} \centerline{\mx{surahname[19]}{\surahname[19]} @@ -438,7 +446,7 @@ as depicted in table~\ref{tab1} and table~\ref{tab2} \hboxR{\amiri\phantom{آح}\surahname*[\value{#1}]}% \addtocounter{ct}{#2}% } -\begin{table}[!hbt] +\begin{table}[!hbtp] \centering % \fontsize{12}{14}\selectfont \begin{RTL} @@ -462,7 +470,7 @@ as depicted in table~\ref{tab1} and table~\ref{tab2} \begin{declcs}{basmalah}\\ \cs{Basmalah} \end{declcs} -It provides Basmalah (\RLE{\quran\Basmalah}) in arabic text. There is a subtle +It provides Basmalah (\RLE{\quran\Basmalah}) in Arabic text. There is a subtle difference between \cs{Basmalah} and \cs{basmalah} -- the latter is sometimes followed by a \cs{par} (depending on the package option). @@ -472,7 +480,7 @@ difference between \cs{Basmalah} and \cs{basmalah} -- the latter is sometimes fo \subsection{Index Converting} \begin{declcs}{indexconvert}\marg{index}\marg{surah macro}\marg{ayah macro} \end{declcs} -It converts an index number between 1 to 6236 +It converts an index number between $1$ to $6236$ to its exact surah's index and ayah's index. The index must be either a number or a \TeX{} counter, and the surah macro and ayah would be defined as a \TeX{} counters if they are undefined. They will be set to the numbers representing the surah and ayah of the given index in text of the Holy Quran. @@ -495,12 +503,13 @@ Index \the\index\ belongs to ayah number \the\ayahcount\ of surah number \the\su }+} \section{Options to The Package}\label{sec:options} -All macros of the package, by default, will separate ayahs with \cs{par}. +All macros of the package, by default, separate ayahs with \cs{par}. The \xmgpar{nopar} option is available to change this default behaviour. In this case, ayahs will be separated with space instead \cs{par}. -Another way for achieving this, is using the starred version of macros. All macros of the package \marginpar{starred macros} +Another way to achieve this is by using the starred version of macros. +All macros of the package \marginpar{starred macros} have starred versions that omit the \cs{par} in typesetting ayahs of the Holy Quran. \label{starred} -With \xmgpar{nopar} option, starred macros act as if this option was not loaded. +With the \xmgpar{nopar} option, starred macros act as if this option was not loaded. \medskip @@ -510,15 +519,14 @@ causes none of these numbers will be printed with ayahs. \begin{declcs}{ToggleAyahNumber}{} \end{declcs} -This macro change the default behaviour of the package in typesetting of the index of ayahs wherever it called. -It means that the macro can enable/disable the ayahs' index in output text. +This macro changes the default behavior of the package in the typesetting of the index of ayahs wherever it is called. It means that the macro can enable/disable the ayahs' index in the output text. \centerline{\mxf{ToggleAyahNumber\textbackslash{}quransurah*[89]} {\ToggleAyahNumber\quransurah*[89]}} \medskip -Version 1.9 introduces a new option called `\xmgpar{ornbraces}`. +Version 1.9 introduces a new option called `\xmgpar{ornbraces}'. This option allows users to include ornamental braces around the Quran text, similar to the ones used around the Ayah numbers. To customize the ornamental braces, the `\cs{SetOrnamentalBraces}' macro can be utilized. @@ -529,43 +537,42 @@ users can personalize the appearance of the ornamental braces according to their \begin{declcs}{SetOrnamentalBraces}\marg{starting brace}\marg{ending brace} \end{declcs} -Version 1.6 comes wtih the \xmgpar{wordwise} option -which makes the package capable of outputing any chunks of an ayah. -See section~\ref{chunk} for more details. +The \xmgpar{wordwise} option makes the package capable of outputing any chunks of an ayah. +For more details, please refer to section~\ref{chunk}. \centerline{\mx{quranayah[9][111][1-23]}{\quranayah[9][111][1-23]}} - \centerline{\mxf{ToggleAyahNumber\textbackslash{}quranayah[An-Nisa][171-172][14-64]} - {\ToggleAyahNumber\quranayah[An-Nisa][171-172][14-64]}} + \centerline{\mxf{ToggleAyahNumber\textbackslash{}quranayah[An-Nisaa][171-172][14-64]} + {\ToggleAyahNumber\quranayah[An-Nisaa][171-172][14-64]}} \medskip -The package, by default, typesets the text of the Holy Quran in simple script, +The package, by default, typesets the text of the Holy Quran in the simple script, but \xmgpar{uthmani} and \xmgpar{uthmani-min} change the default to Uthmani script. Compare the following texts to figure out the differences between ``default'', ``uthmani'', and ``uthmani-min'' scripts. \makeatletter\let\qt@newcmd\renewcommand \input{qurantext-simple.def}% \makeatother - \centerline{\mxf{quranayah*[Al-Araf][54-56] (default)}{\quranayah*[al-araf][54-56]}} + \centerline{\mxf{quranayah*[Al-A'raaf][54-56] (default)}{\quranayah*[al-a'raaf][54-56]}} \makeatletter\let\qt@newcmd\renewcommand \input{qurantext-uthmani.def}% \makeatother - \centerline{\mxf{quranayah*[Al-Araf][54-56] (uthmani)}{\quranayah*[al-araf][54-56]}} + \centerline{\mxf{quranayah*[Al-A'raaf][54-56] (uthmani)}{\quranayah*[al-a'raaf][54-56]}} \makeatletter\let\qt@newcmd\renewcommand \input{qurantext-uthmani-min.def}% \makeatother - \centerline{\mxf{quranayah*[Al-Araf][54-56] (uthmani-min)}{\quranayah*[al-araf][54-56]}} + \centerline{\mxf{quranayah*[Al-A'raaf][54-56] (uthmani-min)}{\quranayah*[al-a'raaf][54-56]}} \makeatletter\let\qt@newcmd\renewcommand \input{qurantext-simple.def}% \makeatother \medskip -By version 1.3, the package can typeset the transliteration of the Holy Quran. -This option will be useful for whom doesn't really know how to read the arabic text. By loading \xmgpar{translt} -option all macros defined in section~\ref{sec:qurantypesetting} will have an ``\texttt{lt}" version. In other words, -the following macros are added by this option: +Starting from version 1.3, the package can typeset the transliteration of the Holy Quran. +This option will be useful for those who don't know how to read the Arabic text. +By loading the \xmgpar{translt} option, all macros defined in section~\ref{sec:qurantypesetting} +will have an ``\texttt{lt}" version. In other words, the following macros are added by this option: \begin{multicols}{3} \begin{itemize} @@ -592,6 +599,12 @@ These options were added because of some requests from users who had required th Loading \xmgpar{transde}, \xmgpar{transen}, \xmgpar{transfr}, or \xmgpar{transfa} brings some other macros for typesetting the translation in German, English, French, and Persian, respectively. + +The package can typeset translations of the Holy Quran in several languages. +These options were added in response to requests from users who needed the translation of the Holy Quran in their languages. +By loading the \xmgpar{transde}, \xmgpar{transen}, \xmgpar{transfr}, or \xmgpar{transfa} option, additional macros are provided for typesetting the translation in `German', `English', `French', and `Persian', respectively. + + By loading each of these options, all macros defined in section~\ref{sec:qurantypesetting} will have a ``\texttt{de}"/``\texttt{en}"/``\texttt{fr}"/``\texttt{fa}" version. In other words, these options will add the following macros: @@ -652,7 +665,10 @@ these options will add the following macros: \end{multicols} - All translations are from \url{tanzil.net}. For Germen, English, French, and Persian languages the ``Abu Rida Muhammad ibn Ahmad ibn Rassoul", ``Ahmed Ali", ``Muhammad Hamidullah", and ``Mohammad Mahdi Fooladvand" have been chosen respectively, by suggestion of the package's users. + All translations are sourced from \url{tanzil.net}. + For Germen, English, French, and Persian languages the ``Abu Rida Muhammad ibn Ahmad ibn Rassoul", + ``Ahmed Ali", ``Muhammad Hamidullah", and ``Mohammad Mahdi Fooladvand" have been chosen respectively, + by suggestion of the package's users. \medskip @@ -660,9 +676,9 @@ these options will add the following macros: any permutation of ``\texttt{lt}", ``\texttt{de}", ``\texttt{en}", ``\texttt{fr}", and ``\texttt{fa}", e.g. ``\xoption{trans=\{de, en, lt\}}". - \marginpar{\dbend} There is no way to load all of the translations together. It is out of \TeX{} memory capacity. For more details, see \emph{Why do I get the “! TeX capacity exceeded” error?} on page \pageref{sec:texcapacity}. - -\protected\def\frkothar{Au nom d'Allah, le Tout Miséricordieux, le Très Miséricordieux.\par Nous t'avons certes, accordé l'Abondance. (1)\par Accomplis la Salât pour ton Seigneur et sacrifie. (2)\par Celui qui te hait sera certes, sans postérité. (3)} + \marginpar{\dbend} Typically, there is no way to load all translations together + as it exceeds \TeX{} memory capacity. For more details and some hacks to break this limitation, + see \emph{Why do I get the ``! TeX capacity exceeded'' error?} on page \pageref{sec:texcapacity}. \centerline{\mxf{quransurah*[108]}{\quransurah*[108]}} @@ -670,12 +686,12 @@ these options will add the following macros: \hfill \mx{quransurahde[108]}{\setLTR\small\quransurahde[108]}} - \centerline{\mx{quransurahfr[108]}{\setLTR\quran\small\frkothar} + \centerline{\mx{quransurahfr[108]}{\setLTR\quran\small\quransurahfr[108]} \hfill \mx{quransurahfa[108]}{\quransurahfa[108]}} \section{Frequently Asked Questions} - \subsection{What is the best font for typesetting quran text?} + \subsection{What is the most suitable font for typesetting Quranic text?} ``Scheherazade"% \footnote{\url{http://software.sil.org/scheherazade/}} or ``Amiri"% @@ -683,27 +699,25 @@ these options will add the following macros: are strongly recommend. \begin{quote} \emph{Scheherazade} is released under the SIL Open Font License (OFL), version 1.1. Copyright (c) 2004-2015, - SIL International (http://scripts.sil.org/) with Reserved Font Names "Scheherazade" and "SIL". Therefore - you can freely download it. + SIL International (http://scripts.sil.org/) with Reserved Font Names ``Scheherazade'' and ``SIL''. + As a result, you are free to download it All examples in this document use this font. \end{quote} \begin{quote} - \emph{Amiri} is a classical Arabic typeface in Naskh style for typesetting books and other running text. - Amiri is a revival of the beautiful typeface pioneered in early 20$^{th}$ century by Bulaq Press in Cairo, + \emph{Amiri} is a classical Arabic typeface in Naskh style + designed for typesetting books and other running text. + It is a revival of the beautiful typeface pioneered in early 20$^{th}$ century by Bulaq Press in Cairo, also known as Amiria Press, after which the font is named. Amiri is a free, open source project that everyone is encouraged to use and modify. \end{quote} + \subsection{How to use \xpackage{quran} package?} - As you've noticed, for typesetting quran text you need a package that can typeset text - in RTL mode in additon to using UTF8 fonts, because \xpackage{quran} draws its text from a - unicoded databases. The \xpackage{polyglossia}, - \xpackage{fontspec}, and \xpackage{bidi} will do that for you. - You can also use \xpackage{xepersian} that relies on \xpackage{fontspec}, too. - Another choices are \xpackage{arabxetex} and \xpackage{arabluatex} that the latter just - works with \LuaLaTeX{} while former - ways work with \XeLaTeX. The \xpackage{arabxetex} and \xpackage{arabluatex} use Amiri font by default. - The following demonstrates some examples for all four approaches: + As you may have noticed, for typesetting quran text you need a package that can typeset text + in RTL mode and use UTF-8 fonts, as the \xpackage{quran} draws its text from a + Unicode database. + The recommended packages for this purpose are \xpackage{polyglossia}, \xpackage{fontspec}, and \xpackage{bidi}, which will provide the necessary functionality. Alternatively, you can use \xpackage{xepersian}, which also relies on \xpackage{bidi}, and \xpackage{fontspec}. + Another option is to use \xpackage{arabxetex} or \xpackage{arabluatex}. While the latter works only with \LuaLaTeX, the former supports \XeLaTeX. Both \xpackage{arabxetex} and \xpackage{arabluatex} use the Amiri font by default. Below are some examples demonstrating all four approaches: \begin{quote} @@ -781,8 +795,8 @@ fontspec{,} and bidi"] \end{quote} \subsection{How to set a default font for text of quran?} - If you want to automatically change the font of quran text in your document, - precede the \cs{qurantext} with your willing font like below: + If you want to automatically change the font of Quranic text in your document, + you can simply precede the \cs{qurantext} macro with the font you desire, like below: \begin{quote} @@ -806,7 +820,8 @@ fontspec{,} and bidi"] \end{quote} - By setting default font the way mentioned above, if you want to use \cs{qurantext}, you have to enclose it in curly braces. If you don't, + By setting the default font as mentioned above, if you want to use \cs{qurantext}, + you have to enclose it in curly braces. If you don't, it will affect the font of the following texts. \begin{quote} \begin{lstlisting}[style=BashInputStyle] @@ -831,22 +846,23 @@ fontspec{,} and bidi"] \subsection{Why do I get the ``\tt{! TeX capacity exceeded}'' error?} \label{sec:texcapacity} - Invention of \TeX{} dates back to many years ago. Although we have great hardware nowadays, - \TeX{} engine has been designed so that to use a very small amount of computer hardware - due to the limitation of the computer at the time of its invention. - The \xpackage{quran} makes a plenty of macros which deplete the \TeX's memory and therefore, sometimes lead to compile error. - To solve this issue, you can expand \TeX's memory; see the section ``Memory Limitations'' in the \xpackage{pgfplots} manual. - However, that does not mean that expanding TeX's memory is the best solution. - Instead, I would recommend redesigning your document. For exmaple, if you use \xoption{wordwise}, most of starred - version of macros which output a large portion of quran text will cause ``\tt{! TeX capacity exceeded}''. - In this case, make a similar output with using some smaller chunks. For instance, you want to typseset 10 first juzzes with - \cs{quranjuz*[1-10]} command and you may get + The invention of \TeX{} dates back many years ago. Although we have powerful hardware nowadays, + \TeX{} was originally designed to run efficiently on relatively limited computer hardware available at the time of its creation. + The \xpackage{quran} package introduces numerous macros that may deplete \TeX's memory, leading to compilation errors on occasion. + To address this issue, one potential solution is to expand \TeX's memory, which can be achieved by referring to the section ``Memory Limitations'' in the \xpackage{pgfplots} manual. + However, increasing \TeX's memory might not always be the most optimal approach. + Instead, I would recommend considering a redesign of your document. For example, if you are using the \xoption{wordwise} option, you may encounter ``\tt{! TeX capacity exceeded}'' errors when using the starred versions of macros that output large portions of Quran text. + + In such cases, you can achieve a similar output by using smaller chunks. For example, if you encounter errors like the following when attempting to typeset the first ten juzes with the \cs{quranjuz*[1-10]} command: + \begin{quote} \tt{! TeX capacity exceeded, sorry [main memory size=5000000]} \\or \\ \tt{! TeX capacity exceeded, sorry [parameter stack size=10000]} - \end{quote} errors. It would be better to typeset ecah juz - separately, or even each page of this range -- \cs{quranjuz*[1]} \cs{quranjuz*[2]} $\cdots$ \cs{quranjuz*[10]} or - \cs{quranpage*[1]} \cs{quranpage*[2]} $\cdots$ \cs{quranpage*[201]}. + \end{quote} + It would be more effective to typeset each juz separately or even each page within the range. + For instance, you can use the commands \cs{quranjuz*[1]} \cs{quranjuz*[2]} $\cdots$ \cs{quranjuz*[10]} + or \cs{quranpage*[1]} \cs{quranpage*[2]} $\cdots$ \cs{quranpage*[201]} to accomplish this. + \makeatletter \bidi@patchcmd{\History}{\raggedright}{}{}{} @@ -860,7 +876,7 @@ fontspec{,} and bidi"] \end{Version} \begin{Version}{2015/06/02 v0.2} - \item Redefinition of \cs{do@qt} in a nonrecursive style. The old recursive version sometimes led to \TeX\ stack overflow. + \item Redefinition of \cs{do@qt} in a non-recursive style. The old recursive version sometimes led to \TeX\ stack overflow. Thanks to \emph{Masoud Yazdani} for suggesting a solution to this issue. \end{Version} @@ -869,70 +885,69 @@ fontspec{,} and bidi"] Thanks to \emph{Mahmood AminToosi} for suggesting this feature. \end{Version} - \begin{Version}{2015/06/04 v0.4} %relactant about date - \item \cs{surahname} added. It outputs the arabic/anglicized title of a surah based on text direction. - \item The package renamed to \xpackage{quran}. + \begin{Version}{2015/06/04 v0.4} %reluctant about date + \item \cs{surahname} added. It outputs the Arabic/Anglicized title of a surah based on text direction. + \item Package renamed from \xpackage{qurantext} to \xpackage{quran} \end{Version} \begin{Version}{2015/06/24 v0.5} - \item Package renamed from \xpackage{qurantext} to \xpackage{quran} \item \cs{quranayah} added. It outputs a \meta{range} of ayahs from a surah. \item \cs{quransurah} added. It outputs a \meta{range} of surahs. Thanks to \emph{Mahmood AminToosi} for suggesting this new feature. \end{Version} \begin{Version}{2015/06/28 v0.6} - \item \cs{quranjuz} added outputing a juz's range of the Holy Quran. + \item \cs{quranjuz} added, which outputs a juz's range of the Holy Quran. \end{Version} \begin{Version}{2015/06/30 v0.7} - \item \cs{quranpage} added outputing one or more pages of the Holy Quran, + \item \cs{quranpage} added, which outputs one or more pages of the Holy Quran. \end{Version} \begin{Version}{2015/07/02 v0.71} - \item A \cs{par} was appended to the basmalah. Thanks to \emph{Mahmood AminToosi} for suggesting this feature. + \item Added a \cs{par} after the basmalah. This change was suggested by \emph{Mahmood AminToosi}. \end{Version} \begin{Version}{2015/07/02 v0.72} - \item \cs{basmalah} added which typesets basmalah -- \hboxR{\Basmalah}. + \item Added \cs{basmalah} which typesets basmalah -- \hboxR{\Basmalah}. \end{Version} \begin{Version}{2015/07/04 v0.8} - \item \cs{quranquarter} and \cs{quranruku} added. + \item Added \cs{quranquarter} and \cs{quranruku}. \end{Version} \begin{Version}{2015/07/07 v0.9} - \item \cs{quranhizb} and \cs{quranmanzil} added. + \item Added \cs{quranhizb} and \cs{quranmanzil}. \item The package was uploaded to CTAN. \end{Version} \begin{Version}{2015/07/10 v0.91} - \item ``Al-Ikhlas'' was set as default option for \cs{quransurah}. + \item ``Al-Ikhlaas'' was set as default option for \cs{quransurah}. \end{Version} \begin{Version}{2015/07/11 v0.94} - \item \cs{ChangeAyahNumber} and\cs{ChangeBasmalah} added. - These macros change the way ayah's number and basmalah will appear. - \item A minor bug in extra white spaces around one ayah is solved now. Thanks \emph{Masoud Yazdani} for reporting this issue. + \item Added two new macros, \cs{ChangeAyahNumber} and\cs{ChangeBasmalah}, to change the way ayah's number and basmalah will appear. + \item A minor bug related to extra white spaces around one ayah was fixed, thanks to \emph{Masoud Yazdani} by reporting this issue. \end{Version} \begin{Version}{2015/07/11 v0.941} - \item Reducing the size of quran text file by moving \cs{qt@par} from the file to \cs{qurantext}. + \item Reduced the size of the ``quran script'' file by moving \cs{qt@par} to the \cs{qurantext} macro. \end{Version} \begin{Version}{2016/02/05 v1.0} - \item Support for using anglicized title of surah instead its index in \cs{quransurah} and \cs{quranayah}. + \item Added support for using anglicized title of surah as well as its index in \cs{quransurah} and \cs{quranayah}. \end{Version} \begin{Version}{2016/02/09 v1.05} - \item \cs{ChangeBasmalah} and \cs{ChangeAyahNumber} renamed to \cs{ToggleBasmalah} and \cs{ToggleAyahNumber} respectively. - \item A minor bug in \cs{quransurah*} fixed -- unwanted extra spaces in the output. Thanks \emph{Hosein Behboody} for reporting this issue. + \item Renamed \cs{ChangeBasmalah} and \cs{ChangeAyahNumber} to \cs{ToggleBasmalah} and \cs{ToggleAyahNumber} respectively. + \item Fixed a minor bug in \cs{quransurah*} that caused unwanted extra spaces in the output. + Thanks \emph{Hosein Behboody} for reporting this issue. \end{Version} \begin{Version}{2016/04/21 v1.1} - \item \cs{indexconvert} macro converts a number between 1 to 6236 to its exact surah and ayah number in - the whole text of Quran. + \item Introduced \cs{indexconvert} macro, which converts a number between $1$ to $6236$ + to its exact surah and ayah number in the entire text of the Quran. \end{Version} \begin{Version}{2016/05/15 v1.14} @@ -940,19 +955,20 @@ fontspec{,} and bidi"] \end{Version} \begin{Version}{2016/10/05 v1.2} - \item Supports Uthmani script via \xoption{uthmani} option. This option asked by one of the package's user. + \item Added support for Uthmani script via \xoption{uthmani} option, + which was requested by one of the package's users. \end{Version} \begin{Version}{2016/11/07 v1.21} - \item Some minor bugs in uploading to CTAN + \item Fixed some minor bugs related to uploading to CTAN \end{Version} \begin{Version}{2016/11/08 v1.22} - \item Sources of two pdf files used in the documentation appended to the bundle. + \item The sources of two pdf files used in the documentation were appended to the bundle. \end{Version} \begin{Version}{2016/11/12 v1.24} - \item Documentation updates. + \item Documentation updates. \item Pause marks (waqf symbols) were missed from the penultimate version of uthmani script. \end{Version} @@ -973,60 +989,60 @@ fontspec{,} and bidi"] \begin{Version}{2017/08/22 v1.26} \item Minor improvements - \item Bug in \cs{quranayah[x][y]}; fixed by enclosing in a group. Thanks to \emph{Sayyed Saieed Mosavi Nadooshani} for reporting this issue. + \item Bug in \cs{quranayah[x][y]} fixed by enclosing in a group. Thanks to \emph{Sayyed Saieed Mosavi Nadooshani} for reporting this issue. \item Documentation updates. \end{Version} \begin{Version}{2016/08/22 v1.261} - \item Documentation updates--a typo in version number. + \item Documentation updates--a typo in version number. \end{Version} \begin{Version}{2017/10/22 v1.3} - \item Transliteration supported., now all macros have an ``lt" version for typesetting transliteration of the original macros. + \item Added support for transliteration. Now all macros have an ``lt" version for typesetting transliteration of the original macros. Thanks to \emph{Hamidreza Ahmadian} for suggesting this new feature. \end{Version} \begin{Version}{2017/10/28 v1.4} - \item Persian, English, and Deutsch translations added and ``fa", ``en", and ``de" version of macros defined for them. - Three new options, the `transfa`, `transen`, `transde` are defined. - \item There is also a new option, `\xoption{trans}' which can get the - `lt', `en', `de', and `fa' as its value seperated by comma. + \item Persian, English, and Deutsch translations added + with the addition of the "fa", "en", and "de" versions of macros for them. + Three new options, `\xoption{transfa}', `\xoption{transen}', and `\xoption{transde}', + are defined to enable these translations. + \item There is also a new option, `\xoption{trans}' which can take the values + `lt', `en', `de', and `fa' separated by commas, + allowing for multiple translations to be used simultaneously. \end{Version} \begin{Version}{2017/12/22 v1.41} - \item in previous versions, \cs{quransurah} and \cs{quranayah} macros were case-sensitive in case of using surah names, - but by this version both macros are case-insensitive, i.e. there in no diffirences between Al-Fatihda, al-fatiha, al-Fatiha, - and the other possible combinations of lower-uppercase letters. + \item In previous versions, \cs{quransurah} and \cs{quranayah} macros were case-sensitive when using surah names. However, starting from this version, both macros are case-insensitive. This means there is no difference between using "Al-Fatihda", "al-fatiha", "al-Fatiha", or any other possible combinations of lower and uppercase letters for specifying surah names. \end{Version} \begin{Version}{2017/12/22 v1.42} - \item \cs{quransurahX} and \cs{quranayahX} macros also act case-insensitive with anglicized title of surahs. - X stands for `en', `de', `fa', or `lt'. + \item Starting from this version, the \cs{quransurahX} and \cs{quranayahX} macros also support case-insensitivity with anglicized titles of surahs. The `X' in the macro names stands for `en', `de', `fa', or `lt'. \end{Version} \begin{Version}{2017/12/22 v1.42a} - \item Documentation update--a typo fixed. + \item Documentation update--a typo has been fixed. \item Some files were missed in the last update to CTAN. \end{Version} \begin{Version}{2018/11/29 v1.42b} - \item A typo in quran-transde.def. + \item A typo in quran-transde.def has been corrected. \end{Version} \begin{Version}{2018/12/01} - \item \xpackage{quran-de} package is released adding 3 more translations of the German language. + \item \xpackage{quran-de} package is released, adding 3 more translations in the German language. \end{Version} \begin{Version}{2018/12/31 v1.5} - \item Minor bugs in \cs{ToggleBasmalah} and \cs{quransurah}. + \item Minor bugs in \cs{ToggleBasmalah} and \cs{quransurah} have been fixed. \end{Version} \begin{Version}{2019/05/03} - \item \xpackage{quran-ur} package is released adding 8 translations of the Urdu language. + \item \xpackage{quran-ur} package is released, adding 8 translations in the Urdu language. \end{Version} \begin{Version}{2019/05/04 v1.51} - \item A typo in quran-transde.def. + \item A typo in quran-transde.def has been corrected. \end{Version} \begin{Version}{2020/03/07 v1.6} @@ -1034,39 +1050,39 @@ fontspec{,} and bidi"] This feature has been suggested and supported financially by \emph{Atiyah Elsheikh}. May God bless him. \item \cs{Basmalah} outputs basmalah without any surrounding whitespaces. - \item Documentation revision. + \item Documentation has beeb revision. \end{Version} \begin{Version}{2020/03/09 v1.61} - \item Applying current font in footnote by \cs{qt@doqt} when \cs{quranayah}/\cs{qurantext} is called by its ``\tt{+}'' optional argument. In the last version it used Amiri font. + \item The current font of text is now applied in the footnote when \cs{quranayah} or \cs{qurantext} is called with its ``\tt{+}'' optional argument. In the last version, it used the Amiri font for footnotes. \end{Version} \begin{Version}{2020/03/12 v1.62} - \item License update to LPPL Version 1.3c from LPPL Version 1.3 + \item The license has been updated to LPPL Version 1.3c from LPPL Version 1.3 \end{Version} \begin{Version}{2020/03/14 v1.63} - \item Pause marks (waqf symbols) have been removed from \cs{quranayah} and \cs{qurantext} - whenever \oarg{chunk range} optional parameter is used. + \item Pause marks (waqf symbols) have been removed from \cs{quranayah} and \cs{qurantext} whenever the optional parameter \oarg{chunk range} is used. \end{Version} \begin{Version}{2020/06/10 v1.7} \item French translation added and ``fr'' version of macros defined for it. New option, \xoption{transfr}, is defined for this translation. - \item There is also a new value `\xoption{fr}' for \xoption{trans} option. + \item There is also a new value `\xoption{fr}' for the \xoption{trans} option. \item Documentation updates. \end{Version} \begin{Version}{2020/06/12 v1.7a} - \item Some of missed files (the French part) uploaded to CTAN. + \item Some of the missed files (the French part) were uploaded to CTAN. \end{Version} \begin{Version}{2020/10/14 v1.8} - \item New option `\xoption{uthmani-min}'; same behavior like `\xoption{uthmani}' option prior to this release. - \item Now, the `\xoption{uthmani}' option typesets the text of the Holy Quran with more diacritical marks; requested on \href{https://github.com/javadr/quran/issues/4}{this issue}. + \item New option `\xoption{uthmani-min}'; it behaves the same as the `\xoption{uthmani}' option prior to this release. + \item Now, the `\xoption{uthmani}' option typesets the text of the Holy Quran with more diacritical marks, as requested on \href{https://github.com/javadr/quran/issues/4}{this issue}. \end{Version} \begin{Version}{2021/02/01} - \item \xpackage{quran-bn} package is released adding 2 translations of the Bengali language; requested on \href{https://github.com/javadr/quran/issues/2}{this issue}. + \item \xpackage{quran-bn} package is released, adding 2 translations of the Bengali language + as requested on \href{https://github.com/javadr/quran/issues/2}{this issue}. \end{Version} \begin{Version}{2021/02/02 v1.81} @@ -1075,13 +1091,66 @@ fontspec{,} and bidi"] \begin{Version}{2023/06/28 v1.9; Eid al-Adha 1444 AH} \item The new option `\xoption{ornbraces}' adds ornamental braces around the Quran text. - \item \cs{SetOrnamentalBraces} personalizes the ornamental braces surrounding the Quran text. + \item \cs{SetOrnamentalBraces} allows for personalization of the ornamental braces surrounding the Quran text. \end{Version} \begin{Version}{2023/07/10 v2.0} \item The text of the Holy Quran in the package has been updated to comply with \href{https://tanzil.net/updates/}{Tanzil text version 1.1}. \end{Version} + \begin{Version}{2023/07/27 v2.1} + \item Anglicized names of Quran surahs Revised Using \href{http://tanzil.net/res/text/metadata/quran-data.xml}{Quran Metadata}. + See table~\ref{tab:newnames} + \item Fixed the issue with dropping \cs{par} introduced in version 1.9. + \end{Version} + + \begin{table}[!htbp] + \ttfamily\small + \begin{tabular}{|c|l|l||c|l|l|} + \hline + Order & \multicolumn{1}{c|}{Ver.$\leq 2.0$} & \multicolumn{1}{c||}{Ver.$\geq 2.1$} & + Order & \multicolumn{1}{c|}{Ver.$\leq 2.0$} & \multicolumn{1}{c|}{Ver.$\geq 2.1$} \\ + \hline + 1 & Al-Fatiha & Al-Faatiha & 3 & Aal-e-Imran & Aal-i-Imraan \\ + 4 & An-Nisa & An-Nisaa & 5 & Al-Maeda & Al-Maaida \\ + 6 & Al-Anaam & Al-An'aam & 7 & Al-Araf & Al-A'raaf \\ + 8 & Al-Anfal & Al-Anfaal & 9 & At-Taubah & At-Tawba \\ + 13 & Ar-Rad & Ar-Ra'd & 14 & Ibrahim & Ibraahim \\ + 17 & Al-Isra & Al-Israa & 20 & Taha & Taa-Haa \\ + 21 & Al-Anbiya & Al-Anbiyaa & 23 & Al-Mumenoon & Al-Muminoon \\ + 25 & Al-Furqan & Al-Furqaan & 26 & Ash-Shuara & Ash-Shu'araa \\ + 33 & Al-Ahzab & Al-Ahzaab & 35 & Fatir & Faatir \\ + 36 & Ya-Seen & Yaseen & 37 & As-Saaffat & As-Saaffaat \\ + 38 & Sad & Saad & 40 & Ghafir & Ghaafir \\ + 44 & Ad-Dukhan & Ad-Dukhaan & 45 & Al-Jathiya & Al-Jaathiya \\ + 46 & Al-Ahqaf & Al-Al-Ahqaaf & 49 & Al-Hujraat & Al-Hujuraat \\ + 50 & Qaf & Qaaf & 51 & Adh-Dhariyat & Adh-Dhaariyat \\ + 52 & At-tur & At-Tur & 55 & Al-Rahman & Ar-Rahmaan \\ + 56 & Al-Waqia & Al-Waaqia & 58 & Al-Mujadila & Al-Mujaadila \\ + 60 & Al-Mumtahina & Al-Mumtahana & 62 & Al-Jumua & Al-Jumu'a \\ + 63 & Al-Munafiqoon & Al-Munaafiqoon & 64 & At-Taghabun & At-Taghaabun \\ + 65 & At-Talaq & At-Talaaq & 70 & Al-Maarij & Al-Ma'aarij \\ + 74 & Al-Muddathir & Al-Muddaththir & 75 & Al-Qiyama & Al-Qiyaama \\ + 76 & Al-Insan & Al-Insaan & 77 & Al-Mursalat & Al-Mursalaat \\ + 79 & An-Naziat & An-Naazi'aat & 82 & AL-Infitar & Al-Infitaar \\ + 84 & Al-Inshiqaq & Al-Inshiqaaq & 86 & At-Tariq & At-Taariq \\ + 87 & Al-Ala & Al-A'laa & 88 & Al-Ghashiya & Al-Ghaashiya \\ + 93 & Ad-Dhuha & Ad-Dhuhaa & 94 & Al-Inshirah & Ash-Sharh \\ + 99 & Al-Zalzala & Az-Zalzala & 100 & Al-Adiyat & Al-Aadiyaat \\ + 101 & Al-Qaria & Al-Qaari'a & 102 & At-Takathur & At-Takaathur \\ + 107 & Al-Maun & Al-Maa'un & 108 & Al-Kauther & Al-Kawthar \\ + 109 & Al-Kafiroon & Al-Kaafiroon & 111 & Al-Masadd & Al-Masad \\ + 112 & Al-Ikhlas & Al-Ikhlaas & 114 & An-Nas & An-Naas \\ + \hline + \end{tabular} + \caption{Revision of Anglicized Names of Quran Surahs in ver. 2.1}\label{tab:newnames} + \end{table} + + \begin{Version}{2023/08/01 v2.2} + \item Added support for old Anglicized names of Quran surahs, making the package backward compatible. + \end{Version} + + \def\cb{{\tiny$\bullet$\space}} \def\mrule{\leaders\vrule height 2.5pt depth -1.5pt \hfill} \begin{small} @@ -1098,29 +1167,30 @@ fontspec{,} and bidi"] \endlastfoot 2015/06/01 & 0.1 & \cb Initial release in Parsi\LaTeX, named \xpackage{qurantext} \par \cb \cs{qurantext} \\ - 2015/06/02 & 0.2 & \cb Implementation of \cs{do@qt} in a nonrecursive style \\ - 2015/06/02 & 0.3 & \cb Provision of ayah's number.\\ - 2015/06/04 & 0.4 & \cb \cs{surahname} outputing the arabic/anglicized title of a surah\par - \cb package renamed to \xpackage{quran}\\ + 2015/06/02 & 0.2 & \cb Implementation of \cs{do@qt} in a non-recursive style \\ + 2015/06/02 & 0.3 & \cb Ayah's number has been appended to each verse.\\ + 2015/06/04 & 0.4 & \cb \cs{surahname} outputing the Arabic/Anglicized title of a surah\par + \cb The package renamed to \xpackage{quran}\\ 2015/06/24 & 0.5 & \cb \cs{quranayah} and \cs{quransurah} \\ 2015/06/28 & 0.6 & \cb \cs{quranjuz} \\ 2015/06/30 & 0.7 & \cb \cs{quranpage} \\ - 2015/07/02 & 0.71 & \cb Basmalah was followed by \cs{par}\\ + 2015/07/02 & 0.71 & \cb Basmalah was followed by a \cs{par}\\ 2015/07/02 & 0.72 & \cb \cs{basmalah} -- \hboxR{\Basmalah} \\ 2015/07/04 & 0.8 & \cb \cs{quranquarter} and \cs{quranruku} \\ 2015/07/07 & 0.9 & \cb \cs{quranhizb} and \cs{quranmanzil}\par - \cb The package was uploaded to CTAN. \\ - 2015/07/10 & 0.91 & \cb ``Al-Ikhlas'' as a default parameter for \cs{quransurah} \\ - 2015/07/11 & 0.94 & \cb \cs{ChangeAyahNumber} and\cs{ChangeBasmalah} \par Resolving a minor bug \\ + \cb Initial release of the package in CTAN. \\ + 2015/07/10 & 0.91 & \cb ``Al-Ikhlaas'' as a default parameter for \cs{quransurah} \\ + 2015/07/11 & 0.94 & \cb \cs{ChangeAyahNumber} and\cs{ChangeBasmalah} \par + \cb Resolved a minor bug \\ 2015/07/11 & 0.941 & \cb Improvement in \cs{qurantext} \\ 2016/02/05 & 1.0 & \cb \cs{quransurah} and \cs{quranayah} support anglicized title of surahs \\ 2016/02/09 & 1.05 & \cb \cs{ChangeBasmalah} and \cs{ChangeAyahNumber} renamed to \cs{ToggleBasmalah} and \cs{ToggleAyahNumber}\par - \cb A minor bug in \cs{quransurah*} fixed\\ + \cb Fixed a minor bug in \cs{quransurah*}\\ 2016/04/21 & 1.1 & \cb \cs{indexconvert} \\ 2016/05/15 & 1.14 & \cb Documentation updates \\ 2016/10/05 & 1.2 & \cb \xoption{uthmani} option supporting Uthmani script \\ - 2016/11/07 & 1.21 & \cb Some minor bugs \\ + 2016/11/07 & 1.21 & \cb Fixed some minor bugs \\ 2016/11/08 & 1.22 & \cb Documentation updates \\ 2016/11/12 & 1.24 & \cb Documentation updates\par \cb Pause marks (waqf symbols) were missed from uthmani script\\ @@ -1138,11 +1208,11 @@ fontspec{,} and bidi"] 2017/12/22 & 1.41 & \cb case-insensitive \cs{quransurah} and \cs{quranayah} \\ 2017/12/22 & 1.42 & \cb case-insensitive \cs{quransurahX} and \cs{quranayahX} \par\tt{X} $\in$ \{`en', `de', `fa', `lt'\} \\ 2017/12/22 & 1.42a & \cb Documentation updates \\ - 2018/11/29 & 1.42b & \cb A typo in \tt{quran-transde.def}\\ + 2018/11/29 & 1.42b & \cb Fixed a typo in \tt{quran-transde.def}\\ 2018/12/01 & \multicolumn{2}{c|}{ \null \mrule {\space}First release of the \xpackage{quran-de} package \mrule \space\null}\\ 2018/12/31 & 1.5 & \cb Bug fix in \cs{ToggleBasmalah} and \cs{quransurah} \\ 2019/05/03 & \multicolumn{2}{c|}{ \null \mrule {\space}First release of the \xpackage{quran-ur} package \mrule \space\null}\\ - 2019/05/04 & 1.51 & \cb A typo in \tt{quran-transde.def}\\ + 2019/05/04 & 1.51 & \cb Fixed a typo in \tt{quran-transde.def}\\ 2020/03/07 & 1.6 & \cb \cs{qurantext} and \cs{quranayah} support any chunks of an ayah\par \cb \cs{Basmalah} \hfil \cb Documentation revision\\ 2020/03/09 & 1.61 & \cb Minor update in \cs{quranayah} and \cs{qurantext} \\ @@ -1158,6 +1228,8 @@ fontspec{,} and bidi"] 2021/02/02 & 1.81 & \cb Documentation updates \\ 2023/06/28 & 1.9 & \cb `\xoption{ornbraces}' option \par\cb \cs{SetOrnamentalBraces} to customize the ornamental braces. \\ 2023/07/10 & 2.0 & \cb Quran text update in compliance with tanzil version 1.1. \\ + 2023/07/27 & 2.1 & \cb Revision of the Anglicized names of Quran surahs \\ + 2023/08/01 & 2.2 & \cb Added support for old Anglicized names of Quran surahs \\ \bottomrule \end{longtable} \end{small} diff --git a/Master/texmf-dist/doc/latex/quran/quran-test.pdf b/Master/texmf-dist/doc/latex/quran/quran-test.pdf Binary files differindex b1dbb191020..9e24257de15 100644 --- a/Master/texmf-dist/doc/latex/quran/quran-test.pdf +++ b/Master/texmf-dist/doc/latex/quran/quran-test.pdf diff --git a/Master/texmf-dist/doc/latex/quran/quran-test.tex b/Master/texmf-dist/doc/latex/quran/quran-test.tex index 54820b29198..c63164a02b1 100644 --- a/Master/texmf-dist/doc/latex/quran/quran-test.tex +++ b/Master/texmf-dist/doc/latex/quran/quran-test.tex @@ -1,23 +1,56 @@ -\documentclass[twocolumn]{article} -\usepackage{arabxetex} % for typesetting Arabic text in Rigth−To−Left direction -\usepackage[trans={en, lt, de, fa}, uthmani]{quran} +\documentclass{article} +\usepackage[margin=1.5cm, top=0cm]{geometry} +\usepackage{multicol} +% for typesetting Arabic text in Rigth−To−Left direction +\usepackage{arabxetex} +\newfontfamily\bengali{NotoSansBengali-Regular} -\def\titlerule#1{\hrulefill #1: \par} +\usepackage[trans={en, lt, de, fa, fr}, uthmani]{quran} +\usepackage{quran-ur} +\usepackage{quran-bn} + +\title{The First Surah of The Holy Quran and Its Translations} +\author{}\date{} \begin{document} +\parindent=0pt +\maketitle + +\thispagestyle{empty} + +\begin{multicols}{2} + + \section*{Surah \surahname[1]} + \begin{arab}[utf] + \qurantext + \end{arab} + + \section*{Transliteration} + \qurantextlt + + \section{Persian Translation} + \begin{arab}[utf] + \qurantextfa + \end{arab} + + + \section{German Traslation} + \qurantextde + + \section{English Translation} + \qurantexten + + \section{French Translation} + \qurantextfr + + \section{Urdu Translation} + \begin{arab}[utf] + \qurantextur + \end{arab} + \section{bengali Translation} + {\bengali\qurantextbn} -\begin{arab}[utf] -\qurantext\par -\titlerule{\beginL Persian Translation\endL} -\qurantextfa\par -\end{arab} -\newpage -\titlerule{Transliteration} -\qurantextlt\par -\titlerule{German Traslation} -\qurantextde\par -\titlerule{English Translation} -\qurantexten\par +\end{multicols} \end{document} diff --git a/Master/texmf-dist/doc/latex/quran/quran-test1.pdf b/Master/texmf-dist/doc/latex/quran/quran-test1.pdf Binary files differindex d2b98d147bd..84c465224ed 100644 --- a/Master/texmf-dist/doc/latex/quran/quran-test1.pdf +++ b/Master/texmf-dist/doc/latex/quran/quran-test1.pdf diff --git a/Master/texmf-dist/doc/latex/quran/quran-test1.tex b/Master/texmf-dist/doc/latex/quran/quran-test1.tex index 06141c715d9..cfacb4c87ff 100644 --- a/Master/texmf-dist/doc/latex/quran/quran-test1.tex +++ b/Master/texmf-dist/doc/latex/quran/quran-test1.tex @@ -1,18 +1,35 @@ \documentclass[12pt]{article} -\usepackage[uthmani, wordwise]{quran} %%% for typesetting arabic text \usepackage{polyglossia} \setotherlanguage{arabic} \usepackage{fontspec} \setmainfont{Scheherazade} +\usepackage[uthmani, wordwise, ornbraces, nonumber]{quran} %%% for typesetting in Rigth-To-Left direction \usepackage{bidi} -\begin{document} - +\parindent=0pt +\pagestyle{empty} +\begin{document} \setRTL -\textarabic{\quranayah[2][10-20][1-99]} -\textarabic{\textbf{\quranayah*[2][10-20][100]}} + +\section{\LRE{Getting a Portion of an Ayah/Ayat}} +\textarabic{\quranayah[92][1-21][22-32]+} +\textarabic{\quranayah[92][1-21][73]} + +\section{\LRE{Changing the Ornamental Braces}} + +\SetOrnamentalBraces{[[}{]]} +\textarabic{\quranayah*[2][286][5-24]+} + +\section{\LRE{Toggling the Effect of Ayah Number}} +\ToggleAyahNumber +\textarabic{\qurantext*[1-7][28]+} + +\section{\LRE{Toggling the Effect of Basmalah}} +\ToggleBasmalah +\textarabic{\quransurah*[110-114]} + \end{document} diff --git a/Master/texmf-dist/doc/latex/quran/quran-test2.pdf b/Master/texmf-dist/doc/latex/quran/quran-test2.pdf Binary files differindex 3377ba9805b..586c41f3b78 100644 --- a/Master/texmf-dist/doc/latex/quran/quran-test2.pdf +++ b/Master/texmf-dist/doc/latex/quran/quran-test2.pdf diff --git a/Master/texmf-dist/doc/latex/quran/quran-test2.tex b/Master/texmf-dist/doc/latex/quran/quran-test2.tex index baed4dcdf95..7e2c88117f8 100644 --- a/Master/texmf-dist/doc/latex/quran/quran-test2.tex +++ b/Master/texmf-dist/doc/latex/quran/quran-test2.tex @@ -1,96 +1,93 @@ %This document wants to the explain the quran package with some examples. \documentclass{article} +\usepackage{fullpage} \usepackage{forloop} -\usepackage[trans={lt,de,en,fa}, wordwise]{quran} -%The xepersian package automatically load bidi, and I've loaded it because I want to set a font that supports Arabic letters -\usepackage{xepersian} +\usepackage{quran} + +%The xepersian package automatically load bidi, +% It is loaded because it could be able to set a font that supports Arabic letters +\usepackage{xepersian} % This macro set the main text font for non-latin letter, and it can scale font. \settextfont[Scale=1.1]{Scheherazade} -\def\surna[#1]{\centerline{\hss\surahname*[#1]\hss\surahname[#1]\hss}} -\def\test#1{% - \par - \surna[#1] - \quransurah*[#1] - \bigskip -} +\def\surna[#1]{\centerline{\hss سورة \surahname*[#1]\hss \lr{Surah \surahname[#1]}\hss}} \begin{document} -\quransurah*[1] +\parindent=0pt -\quranayah*[2][286][5-24] +\quransurah[1] -\quranayah*[1][1-7][3-4] +\section{\lr{Typesetting Basmalah}} -\qurantext*[1-2][6]+ - -\qurantext*[1-2][6-8] +\surna[108] % Surah Al-Ikhlas % For typesetting بِسمِ اللَّهِ الرَّحمٰنِ الرَّحيمِ use below macro -%\centerline{\basmalah} - +\centerline{\basmalah} +{\ToggleBasmalah \quransurah[108] % Surah Al-Kauther +} -%%\surna[110]\quransurah*[110] % Surah Al-Nasr - -%The below typeset 104th surah through 113th surah. -%%\quransurah*[104-113] - -\makeatletter -\surna[\qt@surah@default]\quransurah* % Surah Al-Ikhlas -\makeatother +\section{Examples} +\begin{latin} +In the following examples, several macros have been used to get some portion of Quran. +\end{latin} -\quranayah[33][33] -\quranayah*[76][1-22] +\subsection{\lr{Typesetting Surah}} +\surna[110] +\quransurah*[110] % Surah Al-Nasr -%%You can typeset whole of Holy Quran with below commands. -\newcounter{ct} -\forloop{ct}{110}{\value{ct} < 115} {\test{\the\value{ct}}} +%The below typeset 104th surah through 113th surah. +\quransurah*[104-113] +\subsection{\lr{Typesetting Juz}} %%You can typeset whole of Holy Quran with below commands. %%\newcounter{jz} %%\forloop{jz}{1}{\value{jz} < 31} {\quranjuz[\value{jz}]} +{\tiny\quranjuz*[30]} -%%\quranjuz*[28-30] +\subsection{\lr{Typesetting Quran Pages}} +\quranpage*[256] -%\quranpage*[256] -%\quranpage*[3-4] +\quranpage*[3-4] %%You can typeset whole of Holy Quran with below commands, just replace 8 with 605. \newcounter{pg} \forloop{pg}{1}{\value{pg} < 8} { \hfill صفحة \arabic{pg} \par -\quranpage*[\value{pg}]\vfill} +\quranpage*[\value{pg}]\bigskip} -%\quranhizb*[57-60] +\subsection{\lr{Typesetting Hizb}} +{\tiny \quranhizb*[57-60]} -%\quranquarter*[1-4] -%\quranquarter*[239-240] +\subsection{\lr{Typesetting Quarter}} +{\tiny \quranquarter*[1-4] +\quranquarter*[239-240]} -%\quranruku[313] -%\quranruku[556] +\subsection{\lr{Typesetting Ruku}} +\quranruku[313] +\quranruku[556] -%\quranmanzil*[2] +\subsection{\lr{Typesetting Manzil}} +{\tiny \quranmanzil*[2]} -%%\surna[1]\qurantext % Surah Al-Hamd -%%\surna[1]\qurantext* % Surah Al-Hamd +\subsection{\lr{Typesetting any Portion of Quran Script}} +% \surna[1] +% \qurantext % Surah Al-Hamd -%%\surna[114]\qurantext[6231-6236] % Surah Al-Nas +\surna[1] +\qurantext* % Surah Al-Hamd -%%\surna[114]\qurantext*[6231-6236] % Surah Al-Nas +%\surna[114]\qurantext[6231-6236] % Surah Al-Nas -%%%\surna[2]\qurantext*[8-293] % Surah Al-Baqara - -%\qurantext[1-6236] % The whole of Holy Quran +\surna[114] +\qurantext*[6231-6236] % Surah Al-Nas +\surna[2] +\qurantext*[142-160] % Surah Al-Baqara -\newcount\mysurah -\newcount\myayah -\indexconvert{1436}{\mysurah}{\myayah} -سوره \the\mysurah +%\qurantext[1-6236] % The whole of Holy Quran -آیه \the\myayah \end{document} |