diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/xetex/latex/bidihl/bidihl-doc.tex |
Initial commit
Diffstat (limited to 'macros/xetex/latex/bidihl/bidihl-doc.tex')
-rw-r--r-- | macros/xetex/latex/bidihl/bidihl-doc.tex | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/macros/xetex/latex/bidihl/bidihl-doc.tex b/macros/xetex/latex/bidihl/bidihl-doc.tex new file mode 100644 index 0000000000..ebe84a90f2 --- /dev/null +++ b/macros/xetex/latex/bidihl/bidihl-doc.tex @@ -0,0 +1,35 @@ +\documentclass{ltxdoc} +\usepackage{framed} +\usepackage{holtxdoc} +\begin{document} +\title{The \xpackage{bidihl} Package} +\author{Vafa Khalighi\\\xemail{persian-tex@tug.org}} +\maketitle + +\begin{framed} +This manual is incomplete and the package is experimental. +\end{framed} + +\tableofcontents + +\section{Introduction} +The \xpackage{soul} package provides the \cs{hl} command for +highlighting text; unfortunately this packages does not work in right to left +documents. + +The \xpackage{bidihl} package allows users to highlight text in both right to left +and left to right directions; it needs the \xpackage{bidi} package and should always +be loaded before \xpackage{bidi} package. + + +\section{Basic usage} +\begin{declcs}{bidihl} \M{text} +\end{declcs} +Highlights the text. The default highlighting box color is yellow; if a different color is desired, then simply define a new color with +\texttt{bidihlcolor} as the name of the color; i.e. +\begin{verbatim} +\definecolor{bidihlcolor}{rgb}{1,0.7,0} % orange +\end{verbatim} + + +\end{document}
\ No newline at end of file |