aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2018-08-26 15:50:47 +0200
committerRobert Alessi <alessi@robertalessi.net>2018-08-26 15:50:47 +0200
commit62648df84b0cf1a8c15798eb85b4622b98d39faf (patch)
tree75320b77e6a8af723786435d083e4084dd80e8ee
parent8b10020879e9fe881d91aeff2c66b2670dfe25c7 (diff)
downloadarabluatex-62648df84b0cf1a8c15798eb85b4622b98d39faf.tar.gz
done documenting the exporting mechanism
-rw-r--r--arabluatex.dtx33
1 files changed, 19 insertions, 14 deletions
diff --git a/arabluatex.dtx b/arabluatex.dtx
index 94e13b5..8bebc86 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -580,6 +580,7 @@
580% More standards will be included in future releases of 580% More standards will be included in future releases of
581% \package{arabluatex}. 581% \package{arabluatex}.
582% 582%
583% \label{ref:export-global-opt}
583% \DescribeOption{export} |export|$=$|true|\verb+|+|false| 584% \DescribeOption{export} |export|$=$|true|\verb+|+|false|
584% \hfill\arabluaverb{Default: false}\\ \label{export-mode} 585% \hfill\arabluaverb{Default: false}\\ \label{export-mode}
585% \NEWfeature{v.1.13} This option acts as a named argument and does 586% \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
4050% 4051%
4051% \subsection{Commands and environments} 4052% \subsection{Commands and environments}
4052% \paragraph{\texttt{export} global option} 4053% \paragraph{\texttt{export} global option}
4053% \DescribeOption{export} 4054% \DescribeOption{export} First, \package{arabluatex} must be loaded
4054% First, \package{arabluatex} must be loaded with the |export| global 4055% with the |export| global option enabled,\footnote{See above
4055% option enabled, like so:--- % 4056% \vpageref{ref:export-global-opt} for more information.} like
4057% so:--- %
4056% \iffalse 4058% \iffalse
4057%<*example> 4059%<*example>
4058% \fi 4060% \fi
@@ -4158,32 +4160,35 @@ wa-ya.sIru ta.hta 'l-jild-i
4158% \subsection{Further processing of Unicode converted files} 4160% \subsection{Further processing of Unicode converted files}
4159% \label{sec:further-processing-utf-files} 4161% \label{sec:further-processing-utf-files}
4160% Unicode files can be further processed by document converters such 4162% Unicode files can be further processed by document converters such
4161% as John McFarlane's |pandoc|\footnote{\url{http://pandoc.org/}}. To 4163% as John McFarlane's |pandoc|\footnote{See
4162% take here one example, here is how |file_out.tex| can be converted 4164% \url{http://pandoc.org/}}. To take here one simple example, here is
4163% from \hologo{LuaLaTeX} into Open Document format (|.odt|):---% 4165% how |file_out.tex| can be converted from \hologo{LuaLaTeX} into Open
4166% Document format (|.odt|):---%
4164% \iffalse 4167% \iffalse
4165%<*example> 4168%<*example>
4166% \fi 4169% \fi
4167\begin{arabluaverbatim} 4170\begin{arabluaverbatim}
4168 pandoc -s file_out.tex -o file_out.odt 4171 pandoc file_out.tex -s -o file_out.odt
4169\end{arabluaverbatim} 4172\end{arabluaverbatim}
4170% \iffalse 4173% \iffalse
4171%</example> 4174%</example>
4172% \fi 4175% \fi
4173% 4176%
4174% However, specific commands such as \cs{txarb} or \cs{txtrans}, which 4177% However, specific commands such as \cs{txarb}, \cs{txtrans} or
4175% are not known to |pandoc|, must be redefined explicitly in the 4178% \cs{prname*}, which are not known to |pandoc|, must be redefined
4176% preamble to prevent the converter from gobbling their arguments, 4179% explicitly in the preamble to prevent the converter from gobbling
4177% like so:---% 4180% their arguments, like so:---%
4178% \iffalse 4181% \iffalse
4179%<*example> 4182%<*example>
4180% \fi 4183% \fi
4181\begin{arabluaverbatim} 4184\begin{arabluaverbatim}
4182 % preamble (below the line that loads arabluatex) 4185 % preamble:
4183 \usepackage{suffix} 4186 \usepackage{arabluatex} % note that 'export' has been removed
4184 \renewcommand{\txarb}[1]{#1} 4187 \renewcommand{\txarb}[1]{#1}
4185 \renewcommand{\txtrans}[1]{\emph{#1}} 4188 \renewcommand{\txtrans}[1]{\emph{#1}}
4186 \WithSuffix\renewcommand*{\prname}[1]{#1} 4189 % now that \prname{} has been replaced with \prname*{} it should
4190 % be safe to say:
4191 \renewcommand{\prname}[2]{#2}
4187 % &c 4192 % &c
4188\end{arabluaverbatim} 4193\end{arabluaverbatim}
4189% \iffalse 4194% \iffalse