Commit | Line | Data |
---|---|---|
00c64612 C |
1 | .nr LL 6.5i |
2 | .nr FL 6.0i | |
3 | .if t .nr PD .5v | |
4 | .if t .ds m \u\(ul\dm | |
5 | .if n .ds m -m | |
6 | .AM | |
7 | .OH '\fIThe -mx Macros\fR''\fIPage %\fR' | |
8 | .EH '\fIPage %\fR''\fIThe -mx Macros\fR' | |
9 | .TL | |
10 | The \*mx Macro Package: | |
11 | .sp .3 | |
12 | A Revised Version of \*ms | |
13 | .AU | |
14 | Bill Tuthill | |
15 | .AI | |
16 | Computing Services | |
17 | University of California | |
18 | Berkeley, CA 94720 | |
19 | .PP | |
20 | The \*ms macros have been slightly revised and re\%arranged | |
21 | in a new macro package for \fBnroff/troff\fR, called the \*mx macros. | |
22 | Because of the rearrangement, | |
23 | the new macros can be read by the computer | |
24 | in about half the time required by \*ms. | |
25 | This means that output will begin to appear between ten seconds | |
26 | and several minutes more quickly, depending on the system load. | |
27 | On long files, however, the savings in total time are not substantial. | |
28 | .PP | |
29 | Several bugs in \*ms have been fixed, including | |
30 | a bad problem with the .1C macro, | |
31 | minor difficulties with boxed text, | |
32 | a break induced by .EQ before initialization, | |
33 | the failure to set tab stops in displays, | |
34 | and several bothersome errors in the \fBrefer\fP macros. | |
35 | Macros used only at Bell Laboratories have been removed. | |
36 | There are a few extensions to existing \*ms macros, | |
37 | and a number of new macros, but all the documented \*ms macros | |
38 | still work exactly as they did before, and have the same names as before. | |
39 | Output produced with \*mx should look like output produced with \*ms. | |
40 | .PP | |
41 | One important new feature is automatically numbered footnotes. | |
42 | Footnote numbers are printed by means of a pre-defined string | |
43 | (\e\(**\(**), which you invoke separately from .FS and .FE. | |
44 | Each time it is used, this string increases the footnote number by one, | |
45 | whether or not you use .FS and .FE in your text. | |
46 | Footnote numbers will be superscripted on the phototypesetter | |
47 | and on daisy-wheel terminals, but on low-resolution devices | |
48 | (such as the lpr and a crt), they will be bracketed. | |
49 | If you use \e\(**\(** to indicate numbered footnotes, | |
50 | then the .FS macro will automatically include | |
51 | the footnote number at the bottom of the page. | |
52 | This footnote, for example, was produced as follows:\** | |
53 | .DS | |
54 | This footnote, for example, was produced as follows:\e\(**\(** | |
55 | \&.FS | |
56 | .sp -.2 | |
57 | ... | |
58 | \&.FE | |
59 | .DE | |
60 | .FS | |
61 | If you never use the ``\e\(**\(**'' string, | |
62 | no footnote numbers will appear anywhere in the text, | |
63 | including down here. | |
64 | The output footnotes will look exactly like | |
65 | footnotes produced with \*ms. | |
66 | .FE | |
67 | If you are using \e\(**\(** to number footnotes, | |
68 | but want a particular footnote to be marked with an asterisk or a dagger, | |
69 | then give that mark as the first argument to .FS: \(dg | |
70 | .DS | |
71 | then give that mark as the first argument to .FS: \e(dg | |
72 | \&.FS \e(dg | |
73 | .sp -.2 | |
74 | ... | |
75 | \&.FE | |
76 | .DE | |
77 | .FS \(dg | |
78 | In the footnote, the dagger will appear where the footnote | |
79 | number would otherwise appear, as on the left. | |
80 | .FE | |
81 | Footnote numbering will be temporarily suspended, | |
82 | because the \e\(**\(** string is not used. | |
83 | Instead of a dagger, you could use an asterisk * | |
84 | or double dagger \(dd, represented as \|\e(dd. | |
85 | .PP | |
86 | Another new feature is a macro for printing theses | |
87 | according to Berkeley standards. | |
88 | This macro is called .TM, which stands for thesis mode. | |
89 | (It is much like the .th macro in \*me.) | |
90 | It will put page numbers in the upper right-hand corner; | |
91 | number the first page; suppress the date; | |
92 | and doublespace everything except quotes, displays, and keeps. | |
93 | Use it at the top of each file making up your thesis. | |
94 | Calling .TM defines the .CT macro for chapter titles, | |
95 | which skips to a new page and moves the pagenumber to the center footer. | |
96 | The .P1 (P one) macro can be used even without thesis mode | |
97 | to print the header on page 1, | |
98 | which is suppressed except in thesis mode. | |
99 | If you want roman numeral page numbering, | |
100 | use an ``.af\0PN\0i'' request. | |
101 | .PP | |
102 | There is a new macro especially for bibliography entries, | |
103 | called .XP, which stands for exdented paragraph. | |
104 | It will exdent the first line of the paragraph by \en(PI units, | |
105 | usually 5n (the same as the indent for the first line of a .PP). | |
106 | Most bibliographies are printed this way. | |
107 | Here are some examples of exdented paragraphs: | |
108 | .XP | |
109 | Lumley, Lyle S., \fISex in Crustaceans: Shell Fish Habits,\fP\| | |
110 | Harbinger Press, Tampa Bay and San Diego, October 1979. | |
111 | 243 pages. | |
112 | The pioneering work in this field. | |
113 | .XP | |
114 | Leffadinger, Harry A., ``Mollusk Mating Season: 52 Weeks, or All Year?'' | |
115 | in \fIActa Biologica,\fP\| vol. 42, no. 11, November 1980. | |
116 | A provocative thesis, but the conclusions are wrong. | |
117 | .LP | |
118 | Of course, you will have to take care of | |
119 | italicizing the book title and journal, | |
120 | and quoting the title of the journal article. | |
121 | Indentation or exdentation can be changed | |
122 | by setting the value of number register PI. | |
123 | .PP | |
124 | If you need to produce endnotes rather than footnotes, | |
125 | put the references in a file of their own. | |
126 | This is similar to what you would do if you were | |
127 | typing the paper on a conventional typewriter. | |
128 | Note that you can use automatic footnote numbering | |
129 | without actually having .FS and .FE pairs in your text. | |
130 | If you place footnotes in a separate file, | |
131 | you can use .IP macros with \e\(**\(**\| as a hanging tag; | |
132 | this will give you numbers at the left-hand margin. | |
133 | With some styles of endnotes, | |
134 | you would want to use .PP rather then .IP macros, | |
135 | and specify \e\(**\(** before the reference begins. | |
136 | .PP | |
137 | There are four new macros to help produce a table of contents. | |
138 | Table of contents entries must be enclosed in .XS and .XE pairs, | |
139 | with optional .XA macros for additional entries; | |
140 | arguments to .XS and .XA specify the page number, | |
141 | to be printed at the right. | |
142 | A final .PX macro prints out the table of contents. | |
143 | Here is a sample of typical input and output text: | |
144 | .DS | |
145 | \&.XS ii | |
146 | Introduction | |
147 | \&.XA 1 | |
148 | Chapter 1: Review of the Literature | |
149 | \&.XA 23 | |
150 | Chapter 2: Experimental Evidence | |
151 | \&.XE | |
152 | \&.PX | |
153 | .sp .5 | |
154 | .lt 5.5i | |
155 | .tl ''\fBTable of Contents\fP'' | |
156 | .ta 5i 5.5iR | |
157 | .sp | |
158 | Introduction \ 1 ii\| | |
159 | Chapter 1: Review of the Literature \ 1 1 | |
160 | Chapter 2: Experimental Evidence \ 1 23 | |
161 | .sp .5 | |
162 | .DE | |
163 | The .XS and .XE pairs may also be used in the text, | |
164 | after a section header for instance, | |
165 | in which case page numbers are supplied automatically. | |
166 | However, most documents that require a table of contents | |
167 | are too long to produce in one run, | |
168 | which is necessary if this method is to work. | |
169 | It is recommended that you do a table of contents | |
170 | after finishing your document. | |
171 | To print out the table of contents, use the .PX macro; | |
172 | if you forget it, nothing will happen. | |
173 | .PP | |
174 | As an aid in producing text that will format correctly | |
175 | with both \fBnroff\fP and \fBtroff\fP, | |
176 | there are some new string definitions that define quotation marks | |
177 | and dashes for each of these two formatting programs. | |
178 | The \e\(**\^\u_\d string will yield two hyphens in \fBnroff\fP, | |
179 | but in \fBtroff\fP it will produce an em dash\*- | |
180 | like this one. | |
181 | The \e\(**Q and \e\(**U strings will produce | |
182 | `` and '' in \fBtroff\fP, but " in \fBnroff\fP. | |
183 | (In typesetting, the double quote is traditionally considered bad form.) | |
184 | .PP | |
185 | There are now a large number of optional | |
186 | foreign accent marks defined by the \*mx macros. | |
187 | All the accent marks available in \*ms are present, | |
188 | and they all work just as they always did. | |
189 | However, there are better definitions available | |
190 | by placing .AM at the beginning of your document. | |
191 | Unlike the \*ms accent marks, | |
192 | the accent strings should come \fIafter\fP\| the letter being accented. | |
193 | Here is a list of the diacritical marks, | |
194 | with examples of what they look like. | |
195 | .DS | |
196 | .ta 2i 3i | |
197 | name of accent input output | |
198 | \l'3.5i' | |
199 | acute accent e\e\(**\' e\*' | |
200 | grave accent e\e\(**\` e\*` | |
201 | circumflex o\e\(**\d^\u o\*^ | |
202 | cedilla c\e\(**, c\*, | |
203 | tilde n\e\(**\d~\u n\*~ | |
204 | question \e\(**? \*? | |
205 | exclamation \e\(**! \*! | |
206 | umlaut u\e\(**: u\*: | |
207 | digraph s \e\(**8 \*8 | |
208 | hac\*vek c\e\(**v c\*v | |
209 | macron a\e\(**_ a\*_ | |
210 | underdot s\e\(**. s\*. | |
211 | o-slash o\e\(**/ o\*/ | |
212 | angstrom a\e\(**o a\*o | |
213 | yogh kni\e\(**3t kni\*3t | |
214 | Thorn \e\(**(Th \*(Th | |
215 | thorn \e\(**(th \*(th | |
216 | Eth \e\(**(D- \*(D- | |
217 | eth \e\(**(d- \*(d- | |
218 | hooked o \e\(**q \*q | |
219 | ae ligature \e\(**(ae \*(ae | |
220 | AE ligature \e\(**(Ae \*(Ae | |
221 | oe ligature \e\(**(oe \*(oe | |
222 | OE ligature \e\(**(Oe \*(Oe | |
223 | .DE | |
224 | If you want to use these new diacritical marks, | |
225 | don't forget the .AM at the top of your file. | |
226 | Without it, some will not print at all, | |
227 | and others will be placed on the wrong letter. | |
228 | .PP | |
229 | It is also possible to produce custom headers and footers | |
230 | that are different on even and odd pages. | |
231 | The .OH and .EH macros define odd and even headers, | |
232 | while .OF and .EF define odd and even footers. | |
233 | Arguments to these four macros are specified as with .tl. | |
234 | This document was produced with: | |
235 | .DS | |
236 | \&.OH \'\ef\^IThe -mx Macros\'\'Page %\ef\^P\' | |
237 | \&.EH \'\ef\^IPage %\'\'The -mx Macros\ef\^P\' | |
238 | .DE | |
239 | Note that it would be a error to have an apostrophe in the header text; | |
240 | if you need one, you will have to use a different delimiter | |
241 | around the left, center, and right portions of the title. | |
242 | You can use any character as a delimiter, provided it doesn't appear | |
243 | elsewhere in the argument to .OH, .EH, .OF, or EF. | |
244 | .PP | |
245 | The \*mx macros work in conjunction with | |
246 | the \fBtbl\fR, \fBeqn\fR, and \fBrefer\fR preprocessors. | |
247 | Macros to deal with these items are read in only as needed, | |
248 | as are the thesis macros (.TM), | |
249 | the special accent mark definitions (.AM), | |
250 | table of contents macros (.XS and .XE), | |
251 | and macros to format the optional cover page. | |
252 | The code for the \*mx package lives in /usr/lib/tmac/tmac.x, | |
253 | and sourced files reside in the directory /usr/ucb/lib/mx. | |
254 | .sp | |
255 | .tl '''\*(DY' |