From 62648df84b0cf1a8c15798eb85b4622b98d39faf Mon Sep 17 00:00:00 2001
From: Robert Alessi <alessi@robertalessi.net>
Date: Sun, 26 Aug 2018 15:50:47 +0200
Subject: done documenting the exporting mechanism

---
 arabluatex.dtx | 33 +++++++++++++++++++--------------
 1 file changed, 19 insertions(+), 14 deletions(-)

(limited to 'arabluatex.dtx')

diff --git a/arabluatex.dtx b/arabluatex.dtx
index 94e13b5..8bebc86 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -580,6 +580,7 @@
 % More standards will be included in future releases of
 % \package{arabluatex}.
 %
+% \label{ref:export-global-opt}
 % \DescribeOption{export} |export|$=$|true|\verb+|+|false|
 % \hfill\arabluaverb{Default: false}\\ \label{export-mode}
 % \NEWfeature{v.1.13} This option acts as a named argument and does
@@ -4050,9 +4051,10 @@ wa-ya.sIru ta.hta 'l-jild-i
 %
 % \subsection{Commands and environments}
 % \paragraph{\texttt{export} global option}
-% \DescribeOption{export}
-% First, \package{arabluatex} must be loaded with the |export| global
-% option enabled, like so:--- %
+% \DescribeOption{export} First, \package{arabluatex} must be loaded
+% with the |export| global option enabled,\footnote{See above
+% \vpageref{ref:export-global-opt} for more information.} like
+% so:--- %
 % \iffalse
 %<*example>
 % \fi
@@ -4158,32 +4160,35 @@ wa-ya.sIru ta.hta 'l-jild-i
 % \subsection{Further processing of Unicode converted files}
 % \label{sec:further-processing-utf-files}
 % Unicode files can be further processed by document converters such
-% as John McFarlane's |pandoc|\footnote{\url{http://pandoc.org/}}. To
-% take here one example, here is how |file_out.tex| can be converted
-% from \hologo{LuaLaTeX} into Open Document format (|.odt|):---%
+% as John McFarlane's |pandoc|\footnote{See
+% \url{http://pandoc.org/}}. To take here one simple example, here is
+% how |file_out.tex| can be converted from \hologo{LuaLaTeX} into Open
+% Document format (|.odt|):---%
 % \iffalse
 %<*example>
 % \fi
 \begin{arabluaverbatim}
-  pandoc -s file_out.tex -o file_out.odt
+  pandoc file_out.tex -s -o file_out.odt
 \end{arabluaverbatim}
 % \iffalse
 %</example>
 % \fi
 % 
-% However, specific commands such as \cs{txarb} or \cs{txtrans}, which
-% are not known to |pandoc|, must be redefined explicitly in the
-% preamble to prevent the converter from gobbling their arguments,
-% like so:---%
+% However, specific commands such as \cs{txarb}, \cs{txtrans} or
+% \cs{prname*}, which are not known to |pandoc|, must be redefined
+% explicitly in the preamble to prevent the converter from gobbling
+% their arguments, like so:---%
 % \iffalse
 %<*example>
 % \fi
 \begin{arabluaverbatim}
-  % preamble (below the line that loads arabluatex)
-  \usepackage{suffix}
+  % preamble:
+  \usepackage{arabluatex} % note that 'export' has been removed
   \renewcommand{\txarb}[1]{#1}
   \renewcommand{\txtrans}[1]{\emph{#1}}
-  \WithSuffix\renewcommand*{\prname}[1]{#1}
+  % now that \prname{} has been replaced with \prname*{} it should
+  % be safe to say:
+  \renewcommand{\prname}[2]{#2}
   % &c
 \end{arabluaverbatim}
 % \iffalse
-- 
cgit v1.2.3