summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/xelatex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2023-11-01 20:11:39 +0000
committerKarl Berry <karl@freefriends.org>2023-11-01 20:11:39 +0000
commitd090e61f0bea55cb371aeb790140dbcb6c5d7d36 (patch)
tree06822d4e1ebba1518e6f3590aeec6fab81ad8602 /Master/texmf-dist/doc/xelatex
parentda50e031171c27c403dc48103741e4b677167635 (diff)
quran-id (1nov23)
git-svn-id: svn://tug.org/texlive/trunk@68719 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/xelatex')
-rw-r--r--Master/texmf-dist/doc/xelatex/quran-id/README22
-rw-r--r--Master/texmf-dist/doc/xelatex/quran-id/quran-id-doc.pdfbin0 -> 78812 bytes
-rw-r--r--Master/texmf-dist/doc/xelatex/quran-id/quran-id-doc.tex176
-rw-r--r--Master/texmf-dist/doc/xelatex/quran-id/quran-id-test.pdfbin0 -> 37768 bytes
-rw-r--r--Master/texmf-dist/doc/xelatex/quran-id/quran-id-test.tex43
-rw-r--r--Master/texmf-dist/doc/xelatex/quran-id/quran.pngbin0 -> 8846 bytes
6 files changed, 241 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/xelatex/quran-id/README b/Master/texmf-dist/doc/xelatex/quran-id/README
new file mode 100644
index 00000000000..5231bb70c38
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/quran-id/README
@@ -0,0 +1,22 @@
+_____________________
+The quran-id package
+v0.1
+
+The package is prepared for typesetting some of Indonesian translations of the Holy Quran.
+The supported translations are done by `Indonesian Ministry of Religious Affairs`,
+and `Jalal ad-Din al-Mahalli and Jalal ad-Din as-Suyuti`.
+
+For more information, please see the documentation.
+
+Current version release date: 2023/11/01
+___________________
+Seiied-Mohammad-Javad Razvian
+javadr@gmail.com
+
+Copyright © 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
+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/xelatex/quran-id/quran-id-doc.pdf b/Master/texmf-dist/doc/xelatex/quran-id/quran-id-doc.pdf
new file mode 100644
index 00000000000..60be8c4d77b
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/quran-id/quran-id-doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/xelatex/quran-id/quran-id-doc.tex b/Master/texmf-dist/doc/xelatex/quran-id/quran-id-doc.tex
new file mode 100644
index 00000000000..ad576f521fc
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/quran-id/quran-id-doc.tex
@@ -0,0 +1,176 @@
+\documentclass[a4paper]{ltxdoc}
+
+\usepackage{holtxdoc}
+\usepackage{url}
+\usepackage{booktabs}
+\usepackage{listings}
+\usepackage{tikz}
+\hypersetup{%
+ plainpages=false,%
+ bookmarksnumbered,%
+ pdftitle={The quran-id Package},%
+ pdfkeywords={quran-id, surah, ayah, juz, hizb, ruku, manzil},%
+ pdfauthor={Seiied-Mohammad-Javad Razavian},%
+ baseurl={http://mirrors.ctan.org/macros/xetex/latex/quran-id/doc/quran-id-doc.pdf},%
+}
+\usepackage[all]{quran-id}
+% 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-id} Package\footnote{To one having devoted his life to the holy Quran}\\
+}
+\author{Seiied Mohammad Javad Razavian\\\xemail{javadr@gmail.com}}
+
+\date{\quraniddate, Version \quranidversion\footnote{First release: November 1st, 2023}}
+
+\begin{document}
+\maketitle
+
+\tableofcontents
+%\newpage
+
+\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.
+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-id} including several Indonesian translations of the holy Quran
+provided by \url{tanzil.net}, i.e. \emph{``Indonesian Ministry of Religious Affairs''},
+%\emph{``Muhammad Quraish Shihab et al.''},
+and \emph{``Jalal ad-Din al-Mahalli and Jalal ad-Din as-Suyuti''}.
+
+
+\section{Loading The Package}
+The package will be loaded in the ordinary way
+\cs{usepackage[option]\{quran-id\}}.
+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-id |\quraniddate| v|\quranidversion|
+Indonesian translation extension to the quran package.
+\end{lstlisting}
+\end{quote}
+
+
+\section{Options of The Package}\label{sec:qurantypesetting}
+There are two options by the names of \xoption{bahasa}, and \xoption{jalalayn}.
+\marginpar{\xoption{bahasa}\smallskip}\marginpar{\xoption{jalalayn}\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 \xoption{all} option which loads all Indonesian translations provided by the \xpackage{quran-id} package.
+The package loads \xoption{bahasa} 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-id} package.
+
+\section{Differences between \xpackage{quran} and \xpackage{quran-id}}
+At first glance, \xpackage{quran-id} offers all functionalities of \xpackage{quran}. Therefore,
+both packages are the same in this manner except one difference. The \xpackage{quran-id} extends the \xpackage{quran}
+by adding three other Indonesian translations, namely `bahasa', and `jalalayn'. All Indonesian translations
+provided by the package are shown in table~\ref{tab:idtrans}.
+
+\begin{table}[!htbp]
+\centering
+\begin{tabular}{|c|l|c|}
+ \toprule
+ order & \multicolumn{1}{c|}{translator} & option's name \\\midrule
+ 1 & Indonesian Ministry of Religious Affairs & bahasa \\
+ 2 & Jalal ad-Din al-Mahalli and Jalal ad-Din as-Suyuti & jalalayn \\
+ \bottomrule
+\end{tabular}
+ \caption{Indonesian translations used in the package and their option's names}
+ \label{tab:idtrans}
+\end{table}
+
+\subsection{How to Change the Current Indonesian Translation}
+ The \xpackage{quran-id} package uses bahasa's translation by default.
+ The following macro could be used to change the default Indonesian translation.
+ \begin{declcs}{idSetTrans}\marg{index}
+ \end{declcs}
+ The \meta{index} could be an integer or a name; both ``order'' and ``option's name''
+ shown in Table~\ref{tab:idtrans} are appliable. Both \cs{idSetTrans\{2\}} and \cs{idSetTrans\{jalalayn\}}, for example,
+ have the same effect.
+
+\subsection{How to Get the Name of Current Indonesian Translation}
+ \begin{declcs}{idGetTrans}
+ \end{declcs}
+ The above macro returns the name of current Indonesian translation, i.e. one of ``bahasa'', or ``jalalayn''.
+
+
+\subsection{How to Typeset the Indonesian Translation}
+ It's completely similar to the \xpackage{quran} package.
+ All the following macros are usable.
+
+\begin{multicols}{2}
+ \begin{itemize}
+ \item \cs{quransurahid}
+ \item \cs{quranayahid}
+ \item \cs{quranpageid}
+ \item \cs{quranjuzid}
+ \item \cs{quranhizbid}
+ \item \cs{quranquarterid}
+ \item \cs{quranrukuid}
+ \item \cs{quranmanzilid}
+ \item \cs{qurantextid}
+ \end{itemize}
+\end{multicols}
+
+ \centerline{\mxf{quransurah*}
+ {\begin{arab}\small\quransurah*\end{arab}}}
+
+ \centerline{\mxf{idSetTrans\{bahasa\}\textbackslash{}quransurahid*}
+ {\idSetTrans{bahasa}\quransurahid*}}
+
+ \centerline{\mxf{idSetTrans\{jalalayn\}\textbackslash{}quransurahid*}
+ {\idSetTrans{jalalayn}\quransurahid* sdfasd}}
+
+\end{document}
+
diff --git a/Master/texmf-dist/doc/xelatex/quran-id/quran-id-test.pdf b/Master/texmf-dist/doc/xelatex/quran-id/quran-id-test.pdf
new file mode 100644
index 00000000000..b5bf0ad3f02
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/quran-id/quran-id-test.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/xelatex/quran-id/quran-id-test.tex b/Master/texmf-dist/doc/xelatex/quran-id/quran-id-test.tex
new file mode 100644
index 00000000000..66c37bfe937
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/quran-id/quran-id-test.tex
@@ -0,0 +1,43 @@
+\documentclass{article}
+\usepackage[margin=2cm]{geometry}
+\usepackage{arabxetex} % for typesetting Arabic text in Rigth−To−Left direction
+
+% trans={fa,en,de,lt} option would be sent to quran package
+\usepackage[all, trans={fa,en,de,lt}, wordwise]{quran-id}
+
+\newcommand{\compare}[1]{%
+ \def\setTr##1{\par\idSetTrans{##1}\fbox{\makebox[2cm]{\idGetTrans}}}
+ \noindent\hrulefill{\string #1}\hrulefill
+ \setTr{bahasa} #1
+ \setTr{jalalayn} #1
+\par
+}
+\newcommand{\para}[2]{\noindent%
+\begin{minipage}{.4\textwidth}
+\begin{arab}[utf]#1\end{arab}
+\end{minipage}\hfill
+\begin{minipage}{.55\textwidth}
+#2
+\end{minipage}
+}
+
+\begin{document}
+
+\quranayahid[1][1][4]+
+
+\begin{arab}[utf]
+\quranayah[2][5][2]+
+\end{arab}
+
+\para{\quranayah[Al-Ikhlas][1-4]}{\quranayahlt[Al-Ikhlas][1-4]}
+\bigskip
+\para{\quranayahfa[Al-Ikhlas][1-4]}{\quranayahen[Al-Ikhlas][1-4]}
+
+\quransurahid*
+
+\compare{\quransurahid*}
+\compare{\quranayahid[1][1]}
+\ToggleBasmalah
+\compare{\quranpageid*[2]}
+
+\end{document}
diff --git a/Master/texmf-dist/doc/xelatex/quran-id/quran.png b/Master/texmf-dist/doc/xelatex/quran-id/quran.png
new file mode 100644
index 00000000000..f4339119f88
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/quran-id/quran.png
Binary files differ