Initial import from FreeBSD RELENG_4:
[dragonfly.git] / contrib / groff / contrib / mom / ChangeLog
1 *Sun Aug 25 2002
2
3 o Changed .IX to .IQ.  The older form still works, but emits a message
4   advising the user to update to the newer.  (The macro in om.tmac
5   still remains IX; IQ is an alias.)  Docs updated to reflect the
6   change.
7
8 *Tue Aug 20 2002
9
10 o Added new (better) way to handle inline kerning.  \*[BU #] and
11   \*[FU #] allow passing an argument to the inline string.  The older
12   forms \*[BU#] and \*[FU#] still work, though.
13
14 o Changed handling of inline horizontal and vertical movements.
15   Horizontal movements are now done with \*[BCK #<unit>] and
16   \*[FWD #<unit>]; verticals with \*[UP #<unit>] and \*[DOWN #<unit>].
17   The older forms \*[FP#] and \*[BP#] still work (horizontals), as do
18   \*[ALD#] and \*[RLD#] (verticals).
19
20 *Mon Aug 19 2002
21
22 o Fixed ENDNOTES so footnotes output properly when ENDNOTES is called
23
24 o Added ENDNOTES_HDRFTR_CENTER so that default no-print of header
25   center string on endnotes page(s) when DOCTYPE is CHAPTER can
26   be disabled (i.e. header center will be printed).
27
28 *Sat Aug 10 2002
29
30 o Added .nf to top of PAD, with a test beforehand for current fill
31   mode.  If fill mode was on, it's restored after PAD completes
32   processing.  Updated reserved.html to include number register
33   #FILL_MODE.
34
35 *Mon Jul 29 2002
36
37 o Makefile.sub (FFLAG, TFLAG): Add paths to source directories.
38
39 *Wed Jul 24 2002
40
41 o Makefile.sub (groff_bin_path): Don't use ' \+' but '  *' for sed.
42   (GROFF): Set GROFF_COMMAND_PREFIX to empty value.
43
44 *Fri Jul 12 2002
45
46 o More fixes to underlining.
47
48 *Fri Jul 5 2002
49
50 o Added capability of endnotes and pertinent control macros to om.tmac.
51
52 o Added document entries pertaining to endnote macros.
53
54 o Incorporated endnote macros into elvis_syntax.
55
56 o Small doc fixes.
57
58 o Tidied up indenting of om.tmac.
59
60 o Fixed handling of underlining of italics in PRINTSTYLE TYPEWRITE
61   (there was a problem with footnotes getting underlined when they
62   shouldn't have been).
63
64 o Removed ENDNOTES from TODO
65
66 o Fixed the character translations for UNDERLINE so they work properly
67   with digraphs.
68
69 *Mon Jul 1 2002
70
71 o Expanded docprocessing.html entry "Special Note on Chapters".  Tidied
72   up html a bit.
73
74 *Tue Jun 18 2002
75
76 o examples/macros.mom: Fix path to penguin.ps.
77
78 *Sat Jun 15 2002
79
80 o Small fix to PAD to make the use of inlines within the pad string
81   more intuitive.
82
83 o Added \*[RULE] ( = \l'\n(.lu' ) so that full measure rules (either to
84   full line length or within tabs) are easier to set.
85
86 *Sat Jun  8 2002
87
88 o Macro .PS renamed to .PT_SIZE.  Alias .TS removed.
89
90 o .tr bits in .CAPS rewritten in the form .tr é\['E].
91
92 o General cleanup of docs to reflect changes.
93
94 o Small changes/additions to `elvis_syntax'.
95
96 *Thu Jun  6 2002
97
98 o In DOCTYPE, in .if '\\$1'LETTER', added .FOOTER_RIGHT_SIZE +0.
99   Without it, the suite page was printing at the default
100   FOOTER_RIGHT_SIZE of -.5, which didn't look good.
101
102 *Wed Jun  5 2002
103
104 o Makefile.sub (TFLAG): Add `$(top_builddir)/tmac'.
105
106 *Tue Jun  4 2002
107
108 o Makefile.sub (groff_bin_dirs): Fix typo (forgotten `src' element).
109
110 *Mon Jun  3 2002
111
112 o Makefile.sub (uninstall_sub): Don't use `momdocdir' but `htmldocdir'.
113   Add missing backslash.
114
115 *Sat Jun  1 2002
116
117 o Makefile.in (prepare_make_examples): Test for `penguin.ps', not
118   `examples/penguin.ps'.
119
120 *Wed May 29 2002
121
122 o Rewrote portions of PAGENUM_STYLE and COPYSTYLE so that PAGENUM_STYLE
123   behaves as advertised.
124
125 *Fri May 24 2002
126
127 o /Makefile.sub (momdocdir): Removed.
128   (HTMLDOCFILES): Prepend `momdoc/'.
129   (EXTRAEXAMPLEFILES): Removed.  Added entries to...
130   (EXAMPLEFILES): This.
131   (.SUFFIXES, .mom.ps): New.
132   (prepare_make_examples): Updated.
133   (examples/*.ps): Removed; .mom.ps will handle this.
134   (install_data): Updated.  
135
136 *Thu May 23 2002
137
138 o Applied two small bug fixes to om.tmac (patches 1.1.1a and 1.1.1b).
139
140 o mom is now part of groff.
141
142 o Some renaming to avoid problems with 8+3 filesystems:
143
144     examples/docprocessing_typeset.mom   -> examples/typeset.mom
145     examples/docprocessing_typewrite.mom -> examples/typewrite.mom
146     examples/typesetting_macros.mom      -> examples/macros.mom
147     examples/penguin_small2_bw.ps        -> examples/penguin.ps
148
149 o Removed `INSTALL' and `README' since groff takes care of installation
150   now.
151
152 o Added Makefile.sub.
153
154 o Added mom.tmac (which simply calls om.tmac).
155
156 o Added groff_mom.man for orthogonality; it simply points to the HTML
157   documentation.
158
159 *Thu May 16 2002
160
161 o Added macro DRAFT_WITH_PAGENUMBER so user can have draft/revision
162   info attached to the pagenumber in COPYSTYLE DRAFT, instead of having
163   it HEADER center.  Always having it HEADER center was creating problems
164   with long doc titles, esp. with PRINTSTYLE TYPEWRITE (which is when
165   COPYSTYLE DRAFT is most likely to be used).  Now user has the choice,
166   in these circumstances, either to reduce HEADER_SIZE, or to displace
167   the draft/revision info.  Also rewrote portions of COPYSTYLE so that
168   if no revision number is given in the reference macros, "Rev. #"
169   doesn't appear when COPYSTYLE DRAFT.
170
171 *Fri May 10 2002
172
173 o Added capability of user-defined, single string recto/verso
174   headers/footers.
175
176 o Added new entries to docs about the above.  Made some additional
177   small changes to toc.html, rectoverso.html, and headfootpage.html
178   to supplement the new entries.
179
180 o Small fix to handling of footer separator rule -- was 1 point too low
181   owing to fuzziness of #CAP_HEIGHT as returned by SIZESPECS.
182
183 o Added some more useful stuff to elvis_syntax.
184
185 *Sun May 05 2002
186
187 o Fix to DEFAULTS so that L_MARGIN and R_MARGIN are reprocessed if
188   DOCTYPE LETTER.  R_MARGIN, as set by DOCTYPE LETTER had no preceding
189   PAGEWIDTH or PAPER from which to get #PAGE_WIDTH for figuring out
190   line length.
191
192 o Additional fix to DEFAULTS in handling DOCTYPE LETTER so that if user
193   sets line length prior to START, no reprocessing of R_MARGIN occurs.
194   This necessitated adding a new number register: #USER_SET_L_LENGTH
195
196 *Sat May 04 23:48:05 EDT 2002
197
198 o Added .cflags 4 /\(en -- was driving me nuts that lines wouldn't
199   break after these characters; I'm assuming others feel the same way
200
201 * Fri May 03 2002
202
203 o Made some small fixes to space handling around quotes, mostly to do
204   with quotes immediately after START and quotes after (sub)heads.
205
206 * Wed May 01 2002
207
208 o Fixed a small bug that was causing the first .PP after START to begin
209   at the top margin of the page regardless of any type that preceded
210   .PP when docheaders were off.
211
212 o Fixed HEADER so that when HEADERS are off the first line of type on
213   pages after the first falls properly at the top margin
214
215 *Sat Apr 27 2002
216
217 o Renamed docprocessing_macros.mom in /examples to
218   docprocessing_typeset.mom.  Added docprocessing_typewrite.mom, as
219   well as a README file.
220
221 o Fixed UNDERLINE_QUOTES (for PRINTSTYLE TYPEWRITE) so they really are
222   on by default as the docs say.
223
224 o Changes to doc entry on COLLATE:
225
226     - removed bit about using COLLATE after a cover page (I wrote the
227       entry *before* I wrote the macro!).  Cover pages should be
228       followed by NEWPAGE, not COLLATE.
229
230     - added caution about mixing PRINTSTYLEs
231
232     - added caution about using DOC_FAMILY to change family of all
233       document elements after COLLATE
234
235 o Made HEADER_SIZE (and, by extension, FOOTER_SIZE) available to
236   PRINTSTYLE TYPEWRITE.  Changed appropriate doc entries to reflect
237   this.
238
239 *Wed Apr 24 2002
240
241 o Small change to DO_QUOTE to correct a problem with quotes and
242   blockquotes that fall in the middle of paragraphs (i.e. text after
243   the quote is not a new para).  Basically, added a bit that stores the
244   current para indent, sets para indent to 0, invokes a PP, then
245   restores the original para indent.
246
247 o Added new macro, BREAK_QUOTE, to deal with the problem of
248   footnotes in quotes and blockquotes that cross pages or columns.
249
250   Quotes and blockquotes are read into diversions, which means they
251   get their footnote information from the page/column on which they
252   were started.  If a footnoted quote crosses a page/column, what
253   sometimes happens is that the footnote itself is output at the
254   bottom of page/column where the quote started, whereas the text
255   marker for the footnote appears on the next page/column where the
256   quote ends.  Furthermore, the text marker is the one appropriate
257   to the previous page.  BREAK_QUOTE is a workaround.
258
259 o Added directory /examples to archive.
260
261 o Added typesetting_macros.mom, docprocessing_macros.mom, elvis_syntax
262   and penguin_small2_bw.ps to /examples.
263
264 o Added BREAK_QUOTE to docs, made some additions to reserved words
265   list, and corrected a few little doc errors.
266
267 *Mon Apr 22 2002
268
269 o Added default .L_MARGIN 1i and .R_MARGIN 1i to PAPER, PAGE, and
270   PAGEWIDTH.  L_MARGIN is essential otherwise left indents and tabs
271   don't have a register #L_MARGIN to work with.  The default right
272   margin is a convenience only.  Updated the doc entries for L_MARGIN
273   and R_MARGIN to reflect the change.
274
275 *Sun Apr 21 2002
276
277 o Changes to COLLATE:
278
279     - added some "resets" (LL, LS, QUAD)
280     - added a check for whether pagination is at page top (either
281       because FOOTERS are on or because PAGENUM_POS was user set).
282       If pagination is on, and PAGENUM_POS is TOP, it's turned off
283       for next page (start of next collated document) and restored
284       for subsequent pages unless PAGENUM_ON_FIRST_PAGE is on, in
285       which case the page number appears at page top.
286
287 o The macro TRAPS is always invoked at the end of DEFAULTS (which is
288   called by START).  Formerly, TRAPS was only invoked at the start
289   of a doc, not after COLLATE.  Now runs after COLLATE as well.
290
291 o Distance from $DOC_TYPE in DOCTYPE NAMED "<string>" to start of
292   running text was one linespace too deep.  Fixed (in START).
293
294 o When 1st arg to PAGENUM_POS was user set to TOP, running text was
295   printing 1 linespace too high, even when PAGINATION was OFF.  Same
296   problem when HEADERS were OFF (i.e. nothing in the header margin at
297   all).  Fixed by removing -\\n[#DOC_LEAD]u from all .sp |\\n[#T_MARGIN]u
298   calls of .el portion after .ie \\n[#HEADERS_ON].
299
300 o Added new macro: PAGENUM_ON_FIRST_PAGE.  Normally, when FOOTERS are
301   being used instead of HEADERS, mom doesn't print the page number at
302   the top of the first page of a doc, or the first page of collated
303   docs.  New macro allows user to get mom to put the page number on
304   "first" pages if that's desired.  Updated docs to include the macro.
305
306 o More little fixes to docs.
307
308 *Thu Apr 18 2002
309
310 o Fixed TI (temporary indent) so that it continues to work as expected,
311   even when called while another type of indent is in effect.
312
313 *Tue Apr 16 2002
314
315 o String tabs weren't working as advertised when set from within
316   a tab.  Fixed.  Two new registers added: #ST_OFFSET and #IN_TAB.
317   String tabs now behave poperly and intuitively when set within tabs.
318
319 o Added a note to docs about surrounding \w'...' escape with double-
320   quotes when it's used as an argument to macros
321
322 o Added a note to docs that SILENT does not deposit a .br
323
324 *Mon Apr 15  2002
325
326 o Added new macro BR_AT_LINE_KERN if user wants mom to deposit .br's
327   before .RW and/or .EW.
328
329 o Added 1/4 points to inline escapes \*[ALD] and \*[RLD].
330
331 o Added 1/4 points to inline escapes \*[FP] and \*[BP]
332
333 o Updated docs to reflect the above changes.
334
335 *Fri Apr 12 2002
336
337 o Fixed .RW and .EW which weren't working because of a missing \ in
338   \\n(.f register.  Also made it so that .RW and .EW affect all fonts
339   in positions 1, 2, 3, and 4 at once, hence line kerning now affects
340   all fonts that appear after it, not just the font that was current at
341   the time of the macros' invocation.
342
343 o .SS and .WS now working properly.  .WS no longer has any effect on
344   .SS, which remains constant regardless of .WS.  Furthermore, .SS no
345   longer gets its value by adding \*[$SS_VAR] + \n[.ss].  Instead,
346   it remains constant.  Don't know what I was thinking when I wrote
347   the routine in the first place.
348
349 o Updated and rewrote doc entry pertaining to SS
350
351 *Wed Apr 10 2002
352
353 o Renamed tmac.om to om.tmac to bring macro file's name into line
354   with current groff policy
355
356 o Added more standard paper sizes to PAPER.
357
358 o Fixed T_MARGIN, LS, and AUTOLEAD so that if T_MARGIN is set before LS
359   or AUTOLEAD at the top of a file, the first line of type falls
360   properly on the baseline set by T_MARGIN.  Previously, LS and
361   AUTOLEAD automatically advanced by the value passed to them before
362   setting the first line of type, meaning that the first line of type
363   fell at T_MARGINu+1v instead of T_MARGIN.
364
365 o Updated docs to reflect changes.
366
367 o Removed #TEST_FOR_NUMERIC from list of reserved words.
368
369 o Added "t" and #T_MARGIN_SET to list of reserved words.
370
371 *Sat Apr 6 2002
372
373 o Added FACTOR arg to AUTOLEAD, so if user wants autolead to be a factor
374   of point size, instead of being the sum of pointsize + autolead, s/he
375   has the choice.  Incorporated appropriate changes to PS and LS.
376
377 o Added new register #AUTOLEAD_FACTOR to reserved words.  Modified
378   comments for AUTOLEAD, PS, and LS to reflect changes.  Also
379   corrected an error where #AUTOLEAD_VALUE had mistakenly been written
380   $AUTOLEAD_VALUE in comments in the macro file, and removed erroneous
381   | <anything>.  Updated AUTOLEAD entry in momdoc/typesetting.html
382   to reflect the changes.
383
384 *Wed Apr 3 2002
385
386 o Cleaned up html errors in the docs.
387
388 o Added "Next," "Prev" and "Top" links to top and bottom of doc files.
389
390 o Fixed some typos in the docs.