summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/xelatex/quran-de/quran-de-doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/xelatex/quran-de/quran-de-doc.tex')
-rw-r--r--Master/texmf-dist/doc/xelatex/quran-de/quran-de-doc.tex43
1 files changed, 23 insertions, 20 deletions
diff --git a/Master/texmf-dist/doc/xelatex/quran-de/quran-de-doc.tex b/Master/texmf-dist/doc/xelatex/quran-de/quran-de-doc.tex
index 650dae1d151..e92ecd3bf7a 100644
--- a/Master/texmf-dist/doc/xelatex/quran-de/quran-de-doc.tex
+++ b/Master/texmf-dist/doc/xelatex/quran-de/quran-de-doc.tex
@@ -61,11 +61,11 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\title{\includegraphics[scale=.3]{quran.png}\\
-The \xpackage{quran-de} Package\footnote{To one having devoted his life to the Quran}\\
-\Large User documentation for \qurandeversion}
+The \xpackage{quran-de} Package\footnote{To one having devoted his life to the holy Quran}\\
+}
\author{Seiied Mohammad Javad Razavian\\\xemail{javadr@gmail.com}}
-\date{\qurandedate}
+\date{\qurandedate, Version \qurandeversion\footnote{First release: December 1st, 2018}}
\begin{document}
\maketitle
@@ -75,11 +75,11 @@ The \xpackage{quran-de} Package\footnote{To one having devoted his life to the Q
\section{Introduction}
The \xpackage{quran} package provides several macros for
-typesetting the whole or any parts of The Holy Quran based on its popular divisions. That package also develops
-commands for some translations of the Holy Quran including German, Engilsh, and Persian.
+typesetting the whole or any parts of the holy Quran based on its popular divisions. That package also develops
+commands for some translations of the holy Quran including German, Engilsh, and Persian.
Some people asked me to include the other translations into the \xpackage{quran} package,
but because of some technical issues I decided to create new packages for other translations.
-One of these variations is \xpackage{quran-de} including all German translations of the Holy Quran
+One of these variations is \xpackage{quran-de} including all German translations of the holy Quran
provided by \url{tanzil.net}, i.e. \emph{``Abu Rida Muhammad ibn Ahmad ibn Rassoul''},
\emph{``A. S. F. Bubenheim and N. Elyas''}, \emph{``Adel Theodor Khoury''},
and \emph{``Amir Zaidan.''}
@@ -91,27 +91,31 @@ The package will be loaded in the ordinary way
After loading the package, it writes some information about itself to the
terminal and to the log file, too. The information is something like:
+\begin{quote}
\begin{lstlisting}[style=BashInputStyle, language=tex, escapechar={|}]
-Package: quran-de |\qurandedate| |\qurandeversion| German translations extension to the quran package.
+Package: quran-de |\qurandedate| v|\qurandeversion|
+German translations extension to the quran package.
\end{lstlisting}
+\end{quote}
\section{Options of The Package}\label{sec:qurantypesetting}
-There are four options by the names of \xpackage{aburida}, \xpackage{bubenheim}, \xpackage{khoury},
-and \xpackage{zaidan}.
-\marginpar{\ttfamily aburida\smallskip}\marginpar{\ttfamily bubenheim\smallskip}
-\marginpar{\ttfamily khoury}\marginpar{\ttfamily zaidan\smallskip}\marginpar{\ttfamily all\smallskip}
+There are four options by the names of \xoption{aburida}, \xoption{bubenheim}, \xoption{khoury},
+and \xoption{zaidan}.
+\marginpar{\xoption{aburida}\smallskip}\marginpar{\xoption{bubenheim}\smallskip}
+\marginpar{\xoption{khoury}}\marginpar{\xoption{zaidan}\smallskip}\marginpar{\xoption{all}\smallskip}
If you pass any combinations of these options, you will be enabled to typeset these translations in a way
that the \xpackage{quran} package does.
-There is also \xpackage{all} option which loads all German translations provided by the \xpackage{quran-de} package.
-The package loads \xpackage{aburida} option by default.
+There is also \xoption{all} option which loads all German translations provided by the \xpackage{quran-de} package.
+The package loads \xoption{aburida} option by default.
This package is completely built on top of the \xpackage{quran} package, therefore you can pass every options
defined in that package to the \xpackage{quran-de} package.
\section{Differences between \xpackage{quran} and \xpackage{quran-de}}
-At first glance, \xpackage{quran-de} offers all functionalities of \xpackage{quran}. Therefore in this case
-both are the same except that \xpackage{quran-de} adds three other German translations, namely `bubenheim', `khoury', and `zaidan'. All German translations
+At first glance, \xpackage{quran-de} offers all functionalities of \xpackage{quran}. Therefore,
+both packages are the same in this manner except one difference. The \xpackage{quran-de} extends the \xpackage{quran}
+by adding three other German translations, namely `bubenheim', `khoury', and `zaidan'. All German translations
provided by the package are shown in table~\ref{tab:detrans}.
\begin{table}[!htbp]
@@ -131,21 +135,21 @@ provided by the package are shown in table~\ref{tab:detrans}.
\subsection{How to Change the Current German Translation}
The \xpackage{quran-de} package uses aburida's translation by default.
- The following macro could be used to change the default German tranliteration.
+ The following macro could be used to change the default German translation.
\begin{declcs}{deSetTrans}\marg{index}
\end{declcs}
- The \textit{index} could be an integer or a name; both `order' and `option's name' columns
+ The \meta{index} could be an integer or a name; both ``order'' and ``option's name''
shown in Table~\ref{tab:detrans} are appliable. Both \cs{deSetTrans\{4\}} and \cs{deSetTrans\{zaidan\}}, for example,
have the same effect.
\subsection{How to Get the Name of Current German Translation}
\begin{declcs}{deGetTrans}
\end{declcs}
- The above macro returns the name of current German translation, i.e. one of `aburida', `bubenheim', `khoury', or `zaidan'.
+ The above macro returns the name of current German translation, i.e. one of ``aburida'', ``bubenheim'', ``khoury'', or ``zaidan''.
\subsection{How to Typeset the German Translation}
- It's completely similiar to the \xpackage{quran} package when \texttt{transde} option is enabled.
+ It's completely similiar to the \xpackage{quran} package when \xoption{transde} option is enabled.
All the following macros are usable.
\begin{multicols}{2}
@@ -173,6 +177,5 @@ provided by the package are shown in table~\ref{tab:detrans}.
\centerline{\mxf{deSetTrans\{zaidan\}\textbackslash{}quransurahde*}
{\setLTR\deSetTrans{zaidan}\quransurahde*}}
-
\end{document}