diff options
Diffstat (limited to 'Master/texmf-dist/doc/xelatex/bidihl/bidihl-doc.tex')
-rw-r--r-- | Master/texmf-dist/doc/xelatex/bidihl/bidihl-doc.tex | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/xelatex/bidihl/bidihl-doc.tex b/Master/texmf-dist/doc/xelatex/bidihl/bidihl-doc.tex new file mode 100644 index 00000000000..38e41a4cb1b --- /dev/null +++ b/Master/texmf-dist/doc/xelatex/bidihl/bidihl-doc.tex @@ -0,0 +1,42 @@ +\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}{0.3,0.1,0} +\end{verbatim} + +The default highlighting box height is 10pt; again if a different height is desired, then change the length of \cs{bidihlboxheight}; i.e. +\begin{verbatim} +\setlength{\bidihlboxheight}{8pt} +\end{verbatim} +The height of the highlighting box does not automatically change; you have to set its length manually. + + + +\end{document}
\ No newline at end of file |