summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/xelatex/bidihl/bidihl-doc.tex
blob: c95e6138de5c6ff83e7b471476a5859137b8b1f3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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}{1,0.7,0} % orange
\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}