| 1 |
\documentclass{ltxdoc} |
| 2 |
\usepackage{holtxdoc} |
| 3 |
\begin{document} |
| 4 |
\title{The \xpackage{bidipagegrid} package} |
| 5 |
\author{Vafa Khalighi\\\xemail{[email protected]}} |
| 6 |
\maketitle |
| 7 |
\vskip 0pt plus 3fill |
| 8 |
\fbox{% |
| 9 |
\begin{minipage}{\dimexpr(\textwidth-2\fboxsep-2\fboxrule)} |
| 10 |
If you want to report any bugs or typos and corrections in the documentation, |
| 11 |
or ask for any new features, or suggest any improvements, or ask any questions |
| 12 |
about the package, then please do not send any direct email to me; I will not |
| 13 |
answer any direct email. Instead please use the issue tracker: |
| 14 |
|
| 15 |
\medskip |
| 16 |
\centerline{\url{https://github.com/vafa/bidipagegrid/issues}} |
| 17 |
|
| 18 |
\medskip |
| 19 |
In doing so, please always explain your issue well enough, always include |
| 20 |
a minimal working example showing the issue, and always choose the appropriate |
| 21 |
label for your query (i.e. if you are reporting any bugs, choose `Bug' label). |
| 22 |
\end{minipage} |
| 23 |
} |
| 24 |
\tableofcontents |
| 25 |
\section{Introduction} |
| 26 |
The \xpackage{pagegrid} package of Heiko Oberdiek, prints page grid in the background. Unfortunately, this package does not play nicely with \xpackage{bidi} package. |
| 27 |
The \xpackage{bidipagegrid} package modifies \xpackage{pagegrid} package to allow bidirectional (both right to left and left to right) page grid in the background. |
| 28 |
|
| 29 |
\section{Documentation} |
| 30 |
The \xpackage{bidipagegrid} package provides all the options and user commands of \xpackage{pagegrid} package; in addition, it provides an option for the direction of the page grid, namely \texttt{direction} (for entire document). There are only two values for this option, \texttt{RTL}, and \texttt{LTR}. By default, \texttt{RTL} is active. If you want LTR page grid, you will load the package in this way: |
| 31 |
\begin{verbatim} |
| 32 |
\usepackage[direction=LTR]{bidipagegrid} |
| 33 |
\end{verbatim} |
| 34 |
|
| 35 |
|
| 36 |
The following two commands are also provided: |
| 37 |
\begin{description} |
| 38 |
\item[\cs{setLTRpagegrid}] sets the direction of the page grid to LTR. |
| 39 |
\item[\cs{setRTLpagegrid}] sets the direction of the page grid to RTL. |
| 40 |
\end{description} |
| 41 |
\end{document} |