summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/xelatex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/xelatex')
-rw-r--r--Master/texmf-dist/doc/xelatex/quran-es/README20
-rw-r--r--Master/texmf-dist/doc/xelatex/quran-es/quran-es-doc.pdfbin0 -> 79818 bytes
-rw-r--r--Master/texmf-dist/doc/xelatex/quran-es/quran-es-doc.tex191
-rw-r--r--Master/texmf-dist/doc/xelatex/quran-es/quran-es-test.pdfbin0 -> 32510 bytes
-rw-r--r--Master/texmf-dist/doc/xelatex/quran-es/quran-es-test.tex56
-rw-r--r--Master/texmf-dist/doc/xelatex/quran-es/quran.pngbin0 -> 8846 bytes
6 files changed, 267 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/xelatex/quran-es/README b/Master/texmf-dist/doc/xelatex/quran-es/README
new file mode 100644
index 00000000000..c9ec784b616
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/quran-es/README
@@ -0,0 +1,20 @@
+_____________________
+The quran-es package
+v0.1
+
+This package is designed for typesetting select Spanish translations of the Holy Quran.
+It supports translations by `Raúl González Bórnez`, `Julio Cortes`, and `Muhammad Isa García`.
+
+For further details, please refer to the documentation.
+
+Release date of the current version: 2024/09/05
+___________________
+Seiied-Mohammad-Javad Razvian
+javadr@gmail.com
+
+Copyright © 2024
+This package may be distributed and/or modified under the terms of the LaTeX Project Public License,
+version 1.3c or later (at your option). The latest version of
+the license is at: http://www.latex-project.org/lppl.txt
+
+This work has the LPPL maintenance status 'author-maintained'.
diff --git a/Master/texmf-dist/doc/xelatex/quran-es/quran-es-doc.pdf b/Master/texmf-dist/doc/xelatex/quran-es/quran-es-doc.pdf
new file mode 100644
index 00000000000..1e77dc4d57e
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/quran-es/quran-es-doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/xelatex/quran-es/quran-es-doc.tex b/Master/texmf-dist/doc/xelatex/quran-es/quran-es-doc.tex
new file mode 100644
index 00000000000..000fafe720d
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/quran-es/quran-es-doc.tex
@@ -0,0 +1,191 @@
+\documentclass[a4paper]{ltxdoc}
+
+\usepackage{holtxdoc}
+\usepackage{url}
+\usepackage{booktabs}
+\usepackage{listings}
+\usepackage{tikz}
+\hypersetup{%
+ plainpages=false,%
+ bookmarksnumbered,%
+ pdftitle={The quran-es Package},%
+ pdfkeywords={quran-es, surah, ayah, juz, hizb, ruku, manzil},%
+ pdfauthor={Seiied-Mohammad-Javad Razavian},%
+ baseurl={http://mirrors.ctan.org/macros/xetex/latex/quran-es/doc/quran-es-doc.pdf},%
+}
+\usepackage[all]{quran-es}
+% because of definition of \XeTeX and \XeLaTeX symbols in bidi,
+% I should undef these macro that are also defined in holtxdoc package.
+\makeatletter
+\bidi@undef\XeTeX
+\bidi@undef\XeLaTeX
+\makeatother
+\usepackage{arabxetex}
+
+\makeatletter
+\bidi@BeforeBeginEnvironment{declcs}{\vspace*{-4mm}}
+\makeatother
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\def\boxcs#1{\leftline{\fbox{\mcs{#1}}}}
+\def\mcs#1{\lr{\texttt{\textbackslash{}#1}}}
+\def\tt#1{\lr{\texttt{#1}}}
+\lstdefinestyle{BashInputStyle}{
+ language=bash,
+ basicstyle=\footnotesize\sffamily,
+ frame=tb,
+ columns=fullflexible,
+ backgroundcolor=\color{gray!10},
+}
+
+% Define box and box title style
+\tikzstyle{mybox} = [draw=black, fill=gray!20, very thick,
+ rectangle, rounded corners, inner sep=10pt, inner ysep=20pt]
+\tikzstyle{fancytitle} =[fill=gray, text=white]
+
+\def\mx#1#2{\mybox{#1}{#2}{.45\textwidth}}
+\def\mxf#1#2{\mybox{#1}{#2}{\textwidth}}
+
+\def\mybox#1#2#3{
+\begin{tikzpicture}
+\node [mybox] (box){%
+ \begin{minipage}[t]{#3}
+ #2
+ \end{minipage}
+};
+\node[fancytitle, anchor=west, right=10pt] at (box.north west) {\small \cs{#1}};
+\node (hole) [anchor=north east, left=5pt ] at (box.north east) { \tikz\fill[very thick,white] (0,0) circle (12pt); };
+\node[ ] at (hole.center) {\includegraphics[width=.05\textwidth]{quran.png}};
+\end{tikzpicture}%
+}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\title{\includegraphics[scale=.3]{quran.png}\\
+The \xpackage{quran-es} Package\footnote{To one who has devoted his life to the Holy Quran}\\
+}
+\author{Seiied-Mohammad-Javad Razavian\\\xemail{javadr@gmail.com}}
+
+\date{\quranesdate, Version \quranesversion\footnote{Initial release: September 5, 2024}}
+
+\parindent=0pt
+
+\begin{document}
+\maketitle
+
+\tableofcontents
+%\newpage
+
+\section{Introduction}
+
+The \xpackage{quran} package offers various macros for typesetting the entire Holy Quran or specific sections,
+based on its commonly used divisions. Additionally, it provides commands for several translations
+of the Holy Quran, including German, English, French, and Persian.
+Requests for additional translations prompted the creation of separate packages due to technical constraints.
+One such package is \xpackage{quran-es}, which includes all Spanish translations of the Holy Quran provided by
+\href{https://tanzil.net}{tanzil.net},
+namely those by \emph{``Raúl González Bórnez''}, \emph{``Julio Cortes''}, and \emph{``Muhammad Isa García''}.
+
+
+\section{Loading The Package}
+
+The package can be loaded in the usual manner with the command:\\
+\cs{usepackage[option]\{quran-es\}}.
+
+Upon loading, the package outputs some information to both the terminal and the log file.
+This information typically includes:
+
+
+\begin{quote}
+\begin{lstlisting}[style=BashInputStyle, language=tex, escapechar={|}]
+Package: quran-es |\quranesdate| v|\quranesversion|
+Spanish translations extension to the quran package.
+\end{lstlisting}
+\end{quote}
+
+
+\section{Options of The Package}\label{sec:qurantypesetting}
+
+\marginpar{\xoption{bornez}\smallskip}\marginpar{\xoption{cortes}\smallskip}%
+\marginpar{\xoption{garcia}\smallskip}\marginpar{\xoption{all}\smallskip}%
+The package offers three options: \xoption{bornez}, \xoption{cortes}, and \xoption{garcia}.
+By specifying any combination of these options, you can typeset the corresponding translations
+in the same manner as the \xpackage{quran} package. Additionally, the \xoption{all} option loads all
+Spanish translations provided by the \xpackage{quran-es} package.
+By default, the package loads the \xoption{garcia} option.
+
+This package is built on top of the \xpackage{quran} package,
+so you can also pass any options defined in the \xpackage{quran} package to \xpackage{quran-es}.
+
+
+\section{Differences Between \xpackage{quran} and \xpackage{quran-es}}
+
+At first glance, \xpackage{quran-es} provides all the functionalities of \xpackage{quran}.
+The primary distinction is that \xpackage{quran-es} extends \xpackage{quran} by including three additional Spanish translations:
+`bornez`, `cortes`, and `garcia`. All Spanish translations offered by the package are listed in Table~\ref{tab:estrans}.
+
+
+
+
+\begin{table}[!htbp]
+\centering
+\begin{tabular}{|c|l|c|}
+ \toprule
+ Order & \multicolumn{1}{c|}{Translator} & Option's name \\\midrule
+ 1 & Raúl González Bórnez & bornez \\
+ 2 & Julio Cortes & cortes \\
+ 3 & Muhammad Isa García & garcia \\
+ \bottomrule
+\end{tabular}
+ \caption{Spanish translations included in the package}
+ \label{tab:estrans}
+\end{table}
+
+\subsection{How to Change the Current Spanish Translation}
+ The \xpackage{quran-es} package uses Muhammad Isa García's translation by default.
+ To change the default Spanish translation, you can use the following macro:
+ \begin{declcs}{esSetTrans}\marg{index}
+ \end{declcs}
+ The \meta{index} can be either an integer or a name. Both ``order'' and ``option’s name''
+ as shown in Table~\ref{tab:estrans} are valid.
+ For example, both \cs{esSetTrans\{2\}} and \cs{esSetTrans\{cortes\}} will produce the same effect.
+
+
+\subsection{How to Retrieve the Name of the Current Spanish Translation}
+ \begin{declcs}{esGetTrans}
+ \end{declcs}
+ The macro above returns the name of the current Spanish translation, which will be one of ``bornez'', ``cortes'', or ``garcia''.
+
+
+\subsection{How to Typeset the Spanish Translation}
+
+ The process is identical to that of the \xpackage{quran} package.
+ All of the following macros are available for use.
+
+\begin{multicols}{2}
+ \begin{itemize}
+ \item \cs{quransurahes}
+ \item \cs{quranayahes}
+ \item \cs{quranpagees}
+ \item \cs{quranjuzes}
+ \item \cs{quranhizbes}
+ \item \cs{quranquarteres}
+ \item \cs{quranrukues}
+ \item \cs{quranmanziles}
+ \item \cs{qurantextes}
+ \end{itemize}
+\end{multicols}
+
+ \centerline{\mxf{quransurah*}
+ {\begin{arab}\small\quransurah*\end{arab}}}
+
+ \centerline{\mxf{esSetTrans\{bornez\}\textbackslash{}quransurahes*}
+ {\esSetTrans{bornez}\quransurahes*}}
+
+ \centerline{\mxf{esSetTrans\{cortes\}\textbackslash{}quransurahes*}
+ {\esSetTrans{cortes}\quransurahes*}}
+
+ \centerline{\mxf{esSetTrans\{garcia\}\textbackslash{}quransurahes*}
+ {\esSetTrans{garcia}\quransurahes*}}
+
+\end{document}
+
diff --git a/Master/texmf-dist/doc/xelatex/quran-es/quran-es-test.pdf b/Master/texmf-dist/doc/xelatex/quran-es/quran-es-test.pdf
new file mode 100644
index 00000000000..13ba5e81121
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/quran-es/quran-es-test.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/xelatex/quran-es/quran-es-test.tex b/Master/texmf-dist/doc/xelatex/quran-es/quran-es-test.tex
new file mode 100644
index 00000000000..8b9f02819c6
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/quran-es/quran-es-test.tex
@@ -0,0 +1,56 @@
+\documentclass{article}
+\usepackage[margin=2cm]{geometry}
+\usepackage{arabxetex} % for typesetting Arabic text in Rigth−To−Left direction
+\usepackage[bornez, cortes, garcia, trans={en,lt}]{quran-es}
+
+\def\setTr#1{\par\esSetTrans{#1}\fbox{\ttfamily Translation by \esGetTrans:}\par\smallskip}
+\newcommand{\compare}[1]{%
+ \noindent\smallskip\par
+ \hrulefill{\string #1}\hrulefill
+ \par\smallskip
+ \begin{minipage}[t]{.31\textwidth}
+ \setTr{bornez} {#1}
+ \end{minipage}
+ \hfill
+ \begin{minipage}[t]{.31\textwidth}
+ \setTr{cortes} {#1}
+ \end{minipage}
+ \hfill
+ \begin{minipage}[t]{.31\textwidth}
+ \setTr{garcia} {#1}
+ \end{minipage}
+ \bigskip
+}
+
+\begin{document}
+
+\begin{arab}[utf]
+\quransurah*[1]
+\end{arab}
+\quransurahes*[1]
+
+\begin{minipage}{.4\textwidth}
+\begin{arab}[utf]
+\quranayah[Al-Ikhlas][1-4]
+\end{arab}
+\end{minipage}
+\hfill
+\begin{minipage}{.4\textwidth}
+\quranayahlt[Al-Ikhlas][1-4]
+\end{minipage}
+
+\begin{minipage}{.4\textwidth}
+\quranayahes[Al-Ikhlas][1-4]
+\end{minipage}
+\hfill
+\begin{minipage}{.4\textwidth}
+\quranayahen[Al-Ikhlas][1-4]
+\end{minipage}
+
+\ToggleBasmalah
+\compare{\quransurahes}
+% \compare{\quranayahes[1][1]}
+\ToggleBasmalah
+\compare{\quranpagees*[2]}
+
+\end{document}
diff --git a/Master/texmf-dist/doc/xelatex/quran-es/quran.png b/Master/texmf-dist/doc/xelatex/quran-es/quran.png
new file mode 100644
index 00000000000..f4339119f88
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/quran-es/quran.png
Binary files differ