summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/lualatex/arabluatex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2016-12-18 23:29:45 +0000
committerKarl Berry <karl@freefriends.org>2016-12-18 23:29:45 +0000
commit6ee5064ea5567ae335e848923c0a40fc5ff9bec8 (patch)
tree6339cec289fb4fa7149a6254291a9459e532aa2b /Master/texmf-dist/source/lualatex/arabluatex
parent66a2f689fb7ae4e65915a089fe3b4fa8b08ec946 (diff)
arabluatex (18dec16)
git-svn-id: svn://tug.org/texlive/trunk@42746 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/lualatex/arabluatex')
-rw-r--r--Master/texmf-dist/source/lualatex/arabluatex/arabluatex.dtx89
1 files changed, 44 insertions, 45 deletions
diff --git a/Master/texmf-dist/source/lualatex/arabluatex/arabluatex.dtx b/Master/texmf-dist/source/lualatex/arabluatex/arabluatex.dtx
index 0f2dfb84820..68e76a011ff 100644
--- a/Master/texmf-dist/source/lualatex/arabluatex/arabluatex.dtx
+++ b/Master/texmf-dist/source/lualatex/arabluatex/arabluatex.dtx
@@ -516,20 +516,19 @@
% \DescribeMacro{\SetArbEasy} \NEWfeature{v1.4.4}
% \DescribeMacro{\SetArbEasy*} \DescribeMacro{\SetArbDflt} Such
% refinements as \enquote*{classic} \arb[trans]{maddaT} may be
-% discarded by the command \cs{SetArb\allowbreak{}Easy}, either
+% discarded by the \cs{SetArb\allowbreak{}Easy} command, either
% globally in the preamble or locally at any point of the
% document. The difference between \cs{SetArbEasy} and its
% \enquote*{starred} version \cs{SetArbEasy*} is that the former keeps
% the \arb[trans]{sukUn} that is generated by the |fullvoc| mode,
% while the latter further takes it away. Default \enquote*{classic}
-% rules may be set back at any point of the document with the command
-% \cs{SetArbDflt}. \NEWfeature{v1.6}
+% rules may be set back at any point of the document with the
+% \cs{SetArbDflt} command. \NEWfeature{v1.6}
% \DescribeMacro{\SetArbDflt*}Assimilation rules laid on
% \vref{ref:assimilation} may also be applied by the
% \enquote*{starred} version of this command \cs{SetArbDflt*} either
% in the preamble or at any point of the document.\footnote{For an
-% example, see \vref{sec:poetry-example}.} Examples
-% follow:---
+% example, see \vref{sec:poetry-example}.} Examples follow:---
% \begin{compactenum}[(a)]
% \item \cs{SetArbDflt}:
% \begin{compactenum}[i.]
@@ -580,9 +579,9 @@ Please note that this document is typeset with \cs{SetArbDflt} throughout.
% \fi
%
%\subsection{Typing Arabic}
-% \DescribeMacro{\arb} Once \package{arabluatex} is loaded, a command
-% \cs{arb}\marg{Arabic text} is available for inserting Arabic text in
-% paragraphs, like so:---
+% \DescribeMacro{\arb} Once \package{arabluatex} is loaded, a
+% \cs{arb}\marg{Arabic text} command is available for inserting Arabic
+% text in paragraphs, like so:---%
% \iffalse
%<*example>
% \fi
@@ -602,7 +601,7 @@ vowels (see §~3).
% \paragraph{Caveat}
% For some reason, left-to-right paragraphs that start with Arabic
% words lose their indentation. For the time being, this can be
-% circumvented by appending the command \cs{indent} at the
+% circumvented by appending the \cs{indent} command at the
% commencement of such paragraphs.
%
% \label{ref:ltr-lists}%
@@ -1187,7 +1186,7 @@ vowels (see §~3).
% \fi
\begin{arabluacode}[text only]
\textsc{Rem.} This particular feature must be put into operation by
- the command \cs{SetArbDflt*} explicitly. See above
+ the \cs{SetArbDflt*} command explicitly. See above
\vref{sec:classic-modern-typesetting} for further details. Other
kinds of assimilations, including the various cases of
\arb[trans]{'id.gAm}, will be included in \package{arabluatex}
@@ -1691,7 +1690,7 @@ vowels (see §~3).
% surrounding words by a stroke placed over them.
%
% \DescribeMacro{\abjad} \NEWfeature{v.1.1} \arb[trans]{'abjad}
-% numbers are inserted with the command \cs{abjad}\marg{number} in any
+% numbers are inserted with the \cs{abjad}\marg{number} command in any
% of the |voc|, |fullvoc| and |novoc| modes, where \meta{number} may
% be any number between 1 and 1999, like so:---
% \begin{quote}
@@ -1702,7 +1701,7 @@ vowels (see §~3).
% \begin{quoting}
% \textsc{Rem.}~\emph{a.} As can be seen in the above given example,
% \package{arabluatex} expresses the \arb[trans]{'abjad} numbers in
-% Roman numerals if it finds the command \cs{abjad} in any of the
+% Roman numerals if it finds the \cs{abjad} command in any of the
% transliteration modes.
%
% \textsc{Rem.}~\emph{b.} \cs{abjad} may also be found outside
@@ -1774,8 +1773,8 @@ vowels (see §~3).
% over them. This technique is used to distinguish further words that
% are proper names or book titles.
%
-% \DescribeMacro{\aemph} One may use the command \cs{aemph}\marg{Arabic
-% text} to use the same technique to emphasize words, like so:---
+% \DescribeMacro{\aemph} One may use the \cs{aemph}\marg{Arabic
+% text} command to use the same technique to emphasize words, like so:---
% \begin{quote}
% |\abjad{45}:| |kitAbu-hu| |\aemph{fI| |'l-`AdAt-i}|
% \arb[voc]{\abjad{45}: kitAbu-hu \aemph{fI 'l-`AdAt-i}}
@@ -1833,10 +1832,10 @@ vowels (see §~3).
% \hfill\arabluaverb{Default: false}\\ This named argument does not
% need a value as it defaults to |true| if it is used. If so, a
% delimiter is printed between each of the hemistichs. By default, it
-% is set to the \enquote*{star} character \enquote*{*}. The command
+% is set to the \enquote*{star} character \enquote*{*}. The
% \DescribeMacro{\SetHemistichDelim}\cs{SetHemistichDelim}\marg{delimiter}
-% may be used at any point of the document to change this default
-% setting.
+% command may be used at any point of the document to change this
+% default setting.
%
% \DescribeOption{utf} |utf|$=$|true|\verb+|+|false|
% \hfill\arabluaverb{Default: false}\\ As the preceding one, this
@@ -1846,7 +1845,7 @@ vowels (see §~3).
% schemes. See \vref{sec:unicode-input} for more details.
%
% \DescribeMacro{\bayt} Inside the |arabverse| environment, each line
-% is typeset by the command \cs{bayt} which takes two mandatory
+% is typeset by the \cs{bayt} command which takes two mandatory
% arguments and may accept one optional argument. Additionally, every
% \cs{bayt} command \emph{must} be followed with |\\| like so:---%
% \iffalse
@@ -1961,8 +1960,8 @@ vowels (see §~3).
% If the footnotes are abundant in number, it is advised to load the
% \package{footnote} package which \package{arabluatex} will then use
% to typeset any kind of footnote that is called from the arguments of
-% the \cs{bayt} command. Please note that the package
-% \package{footnote} must be loaded \emph{after} \package{arabluatex}.
+% the \cs{bayt} command. Please note that the \package{footnote}
+% package must be loaded \emph{after} \package{arabluatex}.
%
% \paragraph{Line numbering}
% Inside the |arabverse| environment, the |linenumbers| environment of
@@ -1992,7 +1991,7 @@ vowels (see §~3).
\SetArbDflt*
\begin{linenumbers*}
\bayt{qifA nabki min _dikr_A .habibiN wa-manzili}{bi-saq.ti
- \cap{'l-l}iw_A bayna \cap{'l-d}a_hUli wa-\cap{.h}awmali}\\
+ 'l-liw_A bayna \cap{'l-d}a_hUli wa-\cap{.h}awmali}\\
\bayt{fa-\cap{t}Udi.ha fa-'l-\cap{m}iqrATi lam ya`fu
rasmu-hA}{limA nasa^gat-hA min ^ganUbiN wa-^sam'ali}\\
\bayt{tar_A ba`ara 'l-'ar'Ami fI `ara.sAti-hA}{wa-qI`Ani-hA
@@ -2018,7 +2017,7 @@ vowels (see §~3).
% \SetArbDflt*
% \begin{linenumbers*}
% \bayt{qifA nabki min _dikr_A .habibiN wa-manzili}{bi-saq.ti
-% \cap{'l-l}iw_A bayna \cap{'l-d}a_hUli wa-\cap{.h}awmali}\\
+% 'l-liw_A bayna \cap{'l-d}a_hUli wa-\cap{.h}awmali}\\
% \bayt{fa-\cap{t}Udi.ha fa-'l-\cap{m}iqrATi lam ya`fu
% rasmu-hA}{limA nasa^gat-hA min ^ganUbiN wa-^sam'ali}\\
% \bayt{tar_A ba`ara 'l-'ar'Ami fI `ara.sAti-hA}{wa-qI`Ani-hA
@@ -2042,7 +2041,7 @@ vowels (see §~3).
% \SetArbDflt*
% \begin{linenumbers*}
% \bayt{qifA nabki min _dikr_A .habibiN wa-manzili}{bi-saq.ti
-% \cap{'l-l}iw_A bayna \cap{'l-d}a_hUli wa-\cap{.h}awmali}\\
+% 'l-liw_A bayna \cap{'l-d}a_hUli wa-\cap{.h}awmali}\\
% \bayt{fa-\cap{t}Udi.ha fa-'l-\cap{m}iqrATi lam ya`fu
% rasmu-hA}{limA nasa^gat-hA min ^ganUbiN wa-^sam'ali}\\
% \bayt{tar_A ba`ara 'l-'ar'Ami fI `ara.sAti-hA}{wa-qI`Ani-hA
@@ -2088,7 +2087,7 @@ vowels (see §~3).
% \DescribeMacro{\abraces} Parentheses, square and angle brackets may
% be input directly at the keyboard; however, words or letters that
% are to be read between braces must be passed as arguments to the
-% command \cs{abraces}:---
+% \cs{abraces} command:---%
% \iffalse
%<*example>
% \fi
@@ -2130,10 +2129,11 @@ vowels (see §~3).
%
% \paragraph{Convention} \DescribeMacro{\SetTranslitConvention} The
% transliteration mode, which is set to |dmg| by default, may be
-% changed at any point of the document by the command
-% \cs{SetTranslitConvention}\marg{mode}, where \meta{mode} may be
-% either |dmg| or |loc|. This command is also accepted in the preamble
-% should one wish to set the transliteration mode globally, eg.:---
+% changed at any point of the document by the
+% \cs{SetTranslitConvention}\marg{mode} command , where \meta{mode}
+% may be either |dmg| or |loc|. This command is also accepted in the
+% preamble should one wish to set the transliteration mode globally,
+% eg.:---%
% \iffalse
%<*example>
% \fi
@@ -2148,10 +2148,9 @@ vowels (see §~3).
% \paragraph{Style} \DescribeMacro{\SetTranslitStyle} Any
% transliterated Arabic text is printed in italics by default. This
% also can be changed either globally in the preamble or locally at
-% any point of the document by the command
-% \cs{SetTranslitStyle}\marg{style}, where \meta{style} may be any
-% font shape selection command, eg. \cs{upshape}, \cs{itshape},
-% \cs{slshape}, and so forth.
+% any point of the document by the \cs{SetTranslitStyle}\marg{style}
+% command , where \meta{style} may be any font shape selection
+% command, eg. \cs{upshape}, \cs{itshape}, \cs{slshape}, and so forth.
%
% \paragraph{Font} \NEWfeature{v1.4} \DescribeMacro{\SetTranslitFont}
% \cs{SetTranslitFont}\marg{font selection command} allows any
@@ -2173,7 +2172,7 @@ vowels (see §~3).
%
% \paragraph{Proper names} \DescribeMacro{\cap} Proper names or book
% titles that must have their first letters uppercased may be passed
-% as arguments to the command \cs{cap}\marg{word}. \cs{cap} is a
+% as arguments to the \cs{cap}\marg{word} command. \cs{cap} is a
% clever command, for it will give the definite article
% \arb[trans]{al-} in lower case in all positions. Moreover, if the
% inital letter, apart from the article, cannot be uppercased,
@@ -2210,7 +2209,7 @@ vowels (see §~3).
%
% \paragraph{Hyphenation}
% In case transliterated Arabic words break the \TeX\ hyphenation
-% algorithm, one may use the command |\-| to insert discretionary
+% algorithm, one may use the |\-| command to insert discretionary
% hyphens. This command will be discarded in all of the Arabic modes
% of \package{arabluatex}, but will be processed by any of the
% transliteration modes:---
@@ -2367,7 +2366,7 @@ muhaddamaTaN mi'_danatu-hu}: \arb[trans]{ra'aytu
%
% \DescribeMacro{\SetInputScheme} The input scheme, which is set to
% |arabtex| by default, may be changed at any point of the document by
-% the command \cs{SetInputScheme}\marg{scheme}, where \meta{scheme}
+% the \cs{SetInputScheme}\marg{scheme} command, where \meta{scheme}
% may be either |arabtex| or |buckwalter|. This command is also
% accepted in the preamble should one wish to set the input scheme
% globally, like so:---
@@ -2636,14 +2635,14 @@ part of the predicate\ldots} "ibn-u \cap{`a}mr-iNU}
% \arabluaverb{\renewcommand*{\thefootnote}{\textsuperscript{\LR{\arabic{footnote}}}}}
% \DescribeMacro{\FixArbFtnmk} Another solution is to put in the
% preamble, below the line that loads \package{arabluatex}, the
-% command \cs{FixArbFtnmk}. However, for more control over the layout
+% \cs{FixArbFtnmk} command. However, for more control over the layout
% of footnotes marks, it is advisable to use the package
% \package{scrextend}.\footnote{See
% \url{http://ctan.org/pkg/koma-script}; read the documentation of
% \package{KOMA-script} for details about the \cs{deffootnotemark} and
% \cs{deffootnote} commands.}
%
-% \DescribeMacro{\LRmarginpar} The command \cs{LRmarginpar} does for
+% \DescribeMacro{\LRmarginpar} The \cs{LRmarginpar} command does for
% marginal notes the same as \cs{LRfootnote} does for footnotes. Of
% course, it is supposed to be used in Arabic environments. Note that
% \cs{marginpar} also works in Arabic environments, but it acts as any
@@ -3143,7 +3142,7 @@ wa-ya.sIru ta.hta 'l-jild-i
% \end{macro}
% \end{macro}
% \begin{macro}{\cap} Proper Arabic names or book titles should be
-% passed to the command \cs{cap} so that they have their first letters
+% passed to the \cs{cap} command so that they have their first letters
% uppercased. \cs{cap} is actually coded in Lua.
% \begin{macrocode}
\DeclareDocumentCommand{\cap}{m}%
@@ -3275,20 +3274,20 @@ wa-ya.sIru ta.hta 'l-jild-i
% \begin{macro}{\bayt}
% \changes{v1.6}{2016/12/17}{New macro \cs{bayt} for typesetting
% each verse inside the \texttt{arabverse} environment} Each verse
-% consists of two hemistichs; therefore the command \cs{bayt} takes
+% consists of two hemistichs; therefore the \cs{bayt} command takes
% two arguments, the first receives the \arb[trans]{.sadr} and the
% second the \arb[trans]{`ajuz}. That two subsequent hemistichs
% should be connected with one another is technically named
% \arb[trans]{tadwIr}. In some of these cases, the hemistichs may be
% connected by a prominent horizontal flexible stroke which is drawn
-% by the command \cs{al@verse@stroke}.
+% by the \cs{al@verse@stroke} command.
% \begin{macro}{\SetHemistichDelim}
-% \changes{v1.6}{2016/12/17}{New command \cs{SetHemistichDelim} for
+% \changes{v1.6}{2016/12/17}{New \cs{SetHemistichDelim} command for
% changing the default delimiter between hemistichs} A hemistich
% delimiter also may be defined. By default, it is set to the
-% \enquote*{star} character: |*|. The command
-% \cs{SetHemistichDelim}\marg{delimiter} may be used at any point of
-% the document to change this default setting.
+% \enquote*{star} character: |*|. The
+% \cs{SetHemistichDelim}\marg{delimiter} command may be used at any
+% point of the document to change this default setting.
% \end{macro}
% \begin{macrocode}
\NewDocumentCommand{\arb@utf}{m}{%
@@ -3348,7 +3347,7 @@ wa-ya.sIru ta.hta 'l-jild-i
% \cs{abraces}\marg{Arabic text} puts its argument between
% braces. This macro is written in Lua and is dependent on the
% current value of |tex.textdir|.
-% \changes{v1.4.3}{2016/09/14}{New command \cs{abraces} which
+% \changes{v1.4.3}{2016/09/14}{New \cs{abraces} command which
% expresses its argument between braces.}
% \begin{macrocode}
\NewDocumentCommand{\abraces}{+m}{%