summaryrefslogtreecommitdiff
path: root/macros/text1/cms_help_files/rhf.helpmark
blob: 28f4ce697f606dd264c351a16781ceb591e88f0d (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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
+-----------------------------------------------------------------------------+
|                              runningheadformat                              |
+-----------------------------------------------------------------------------+
 
Abbreviation:  ã|\rhfã%
 
Parameters:    ã|submarkupã%
 
Submarkup:     ã|\bothpages, \evenpages, \oddpagesã%
 
    ã|Description:ã%
The  \runningheadformat markup  provides running  titles at  the top  of all
pages except the title  page.  The default running  top title for TEXT1 is a
right justified page number.
 
ã|bothpagesã% is used to place the  same running head at the top of both the
even and odd pages.   The \line markup defines a  single title line.  Within
it, you  may center, left  align, or  right align text,  using the submarkup
\ctr, \lft, or  \rt.  Besides \line, you may  also use markup such as \hrule
and \verticalspace.
 
ã|evenpagesã% is  used to  place the same  running head  at the top  of each
even page.    The \line  markup defines  a single  title line.    Within it,
you may center,  left align, or right align  text, using the submarkup \ctr,
\lft, or  \rt.  Besides  \line, you may  also use markup such  as \hrule and
\verticalspace.
 
ã|oddpagesã% is  used to  place the  same running  head at  the top  of each
odd page.   The \line  markup defines a single  title line.   Within it, you
may  center, left  align, or  right align  text,  using the  submarkup \ctr,
\lft, or  \rt.  Besides  \line, you may  also use markup such  as \hrule and
\verticalspace.
 
    ã|Example:ã%
To customize running  titles, you modify the  \runningheadformat for the top
titles  and the  \runningfootformat for  bottom titles.    In  this example,
"Sociogeology" and a page number are placed at the top of every page.
 
\runningheadformat{\bothpages{\it
   \line{\lft{Sociogeology}\ctr{}\rt{\pn}}
   \vs{2pt}
   \hrule
   \verticalspace{18pt}
   }
}
 
+-----------------------------------------------------------------------------+
|                                                                             |
| Sociogeology                                                              1 |
| ........................................................................... |
+-----------------------------------------------------------------------------+
 
    ã|Example:ã%
This example alternates the author's name and page number at the top of even
and odd pages.  It complements the last example on the previous page.
 
\rhf{\evenpages{\vs{\bl}
           \line{\lft{Chert}}}
     \oddpages{\vs{\bl}
              \line{\rt{\pagenumber}}}
   }
 
Even pages will look like:
 
+-----------------------------------------------------------------------------+
|                                                                             |
| Chert                                                                       |
|                                                                             |
+-----------------------------------------------------------------------------+
 
Odd pages will look like:
 
+-----------------------------------------------------------------------------+
|                                                                             |
|                                                                          4  |
|                                                                             |
+-----------------------------------------------------------------------------+
 
    ã|Notes:ã%
An empty \lft, \ctr, or \rt may be omitted as was done in the above example.
    A construct such as,
 
\rhf{\bothpages{
         \line{\lft{page \pn}\ctr{\today}
            \rt{PNW Waterfalls}}}}
 
will not print the date centered on the page:
 
+-----------------------------------------------------------------------------+
|                                                                             |
| page 6                   February 5, 1987                   PNW Waterfalls  |
|                                                                             |
+-----------------------------------------------------------------------------+
 
To accomplish this, you should  print the left and right justified text with
\line, then space backwards one line (\verticalspace{-\bl}), then center the
date:
 
\rhf{\bothpages{\line{\lft{page \pn}
 
             \rt{PNW Waterfalls}}}
          \vs{-\bl}
          \line{\ctr{\today}}}
 
+-----------------------------------------------------------------------------+
|                                                                             |
| page 7                       February 5, 1987               PNW Waterfalls  |
|                                                                             |
+-----------------------------------------------------------------------------+
 
    The \runningheadformat markup must  come after the \monospace markup, if
both are used.
    If you want no page numbers, then enter the following:
 
\runningheadformat{\bothpages{}}