summaryrefslogtreecommitdiff
path: root/macros/xetex/latex/bidi-atbegshi/bidi-atbegshi-doc.tex
blob: 9d9276048c3e5f845d0237020c4e5ec669225eb7 (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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
\documentclass{ltxdoc}
\usepackage{holtxdoc}
\begin{document}
\title{The \xpackage{bidi-atbegshi} Package}
\author{Vafa Khalighi\\\xemail{tex.ctan@gmail.com}}
\maketitle
The \xpackage{bidi-atbegshi} adds bidi support to package \xpackage{atbegshi}; it modifies the \cs{AtBeginShipoutUpperLeft}, and \cs{AtBeginShipoutUpperLeftForeground} so that they properly both in LTR and RTL modes. In addition, it also defines the following commands:

\begin{declcs}{AtBeginShipoutUpperRight} \M{background material}
\end{declcs}
 This is a macro that puts material in the background of
 box \cs{AtBeginShipoutBox}.
 The \meta{background material} is set in an \cs{hbox}, the
 reference point is the upper right corner of the output page.


 The macro \cs{AtBeginShipoutUpperRight} is intended to be used
 in one of the hook setting macros, such as
 \cs{AtBeginShipout}, \cs{AtBeginShipoutFirst}, or
 \cs{AtBeginShipoutNext}.

 The \meta{background material} is set
 inside a \texttt{picture} environment:
 \begin{quote}
   |\begin{picture}(0,0)|\\
   \mbox{}\quad |\setlength{\unitlength}{1pt}%|\\
   \mbox{}\quad \meta{background material}\\
   |\end{picture}|
 \end{quote}
 
\begin{declcs}{AtBeginShipoutLowerLeft} \M{background material}
\end{declcs}
Similar to the \cs{AtBeginShipoutUpperRight} command but
 the reference point is the lower left corner of the output page.

\begin{declcs}{AtBeginShipoutLowerRight} \M{background material}
\end{declcs}
Similar to the \cs{AtBeginShipoutUpperRight} command but
 the reference point is the lower right corner of the output page.

 \begin{declcs}{AtBeginShipoutUpperRightForeground} \M{foreground material}
 \end{declcs}
 See \cs{AtBeginShipoutUpperRight}. The difference is that the material
 is put in the foreground.
 
  \begin{declcs}{AtBeginShipoutLowerLeftForeground} \M{foreground material}
 \end{declcs}
 See \cs{AtBeginShipoutLowerLeft}. The difference is that the material
 is put in the foreground.
 
  \begin{declcs}{AtBeginShipoutLowerRightForeground} \M{foreground material}
 \end{declcs}
 See \cs{AtBeginShipoutLowerRight}. The difference is that the material
 is put in the foreground.
 
  \begin{declcs}{LengthToUnit} \M{length with units}
 \end{declcs}
 For instance, \cs{LengthToUnit}\texttt{\{12pt\}} converts 12pt to 12 (stripping the unit).
\end{document}