* src/devices/grops/grops.man: Improve section on creating EPS.
[s-roff.git] / contrib / mom / NEWS
blob5a7436b6d808c577f6f2f00c27be8a491a915e33
1 Release 1.1.6-e
2 ---------------
4 Extended handling of draft and revision numbers and strings in
5 headers/footers for increased flexibility.  It's possible now to
6 have just about any combo of DRAFT_STRING, DRAFT, REVISION_STRING
7 and REVISION, and have them come out in headers/footers as one
8 intuitively expects/wants.
10 Also added a new set of syntax highlighting rules for the vi clone,
11 elvis.  Version 2-2h-beta of elvis finally made possible the
12 highlighting of \*[...] inline escapes, whether or not they're
13 separated from surrounding text by spaces.  This is a terrific
14 improvement in elvis, and makes for greatly improved readability of
15 mom files.
17 Release 1.1.6-b - 1.1.6d
18 ------------------------
20 Trivial changes to documentation and some cleanups of the main
21 om.tmac file, including:
23 Added a .bp after .if \\n[#START]=1 in FOOTER.  Without it,
24 in document processing mode, documents that use *none* of the
25 docprocessing tags (yes, there are times when users want to do
26 this) ignored the footer trap.
28 Changed register #DOCHEADER_LEAD_ADJ to string
29 $DOCHEADER_LEAD_ADJ.  This means that .DOCHEADER_LEAD no longer
30 requires a unit of measure; points is assumed.
32 Release 1.1.6-b
33 ---------------
35 Added a SHIM macro that calculates and moves to the next "legal"
36 baseline during document processing (useful if user starts playing
37 around with spacing/leading on a page and needs to get the leading
38 back on track).
40 Fixed handling of DOCHEADER OFF <distance> so that the first line of
41 running text falls on a "legal" baseline when <distance> is given.
43 Release 1.1.6-a
44 ---------------
46 Problem with groff 1.19.1 fixed by Werner (.return handled arguments
47 incorrectly).
49 Fixed handling of page numbering style restoration in endnotes, so
50 that (collated) docs have the correct page numbering style when the
51 style has been changed for endnotes (with ENDNOTES_PAGENUM_STYLE).
53 DOC_TITLE has been made for use exclusively with DOCTYPE DEFAULT.
55 Fixed handling of headers/footers with respect to endnotes.  Now,
56 when either headers or footers are on, mom picks up the correct
57 page header/footer on the last page prior to ENDNOTES, gets the
58 pageheaders correct for endnotes pages *including the last one*, and
59 picks up correct page headers/footers for the subsequent docs after
60 COLLATE.
63 Release 1.1.6
64 -------------
66 BAD NEWS: mom appears to be crippled in some areas when run with
67 groff 1.19.1.  Pending a solution, mom must be run with groff 1.18
69 ***NEW***
71 Added TOC capabilities.
73 Extended range of endnotes control macros.  See the documentation
74 on endnotes control macros.
76 Added a new DOC_TITLE macro, to deal with collated documents that
77 have an overall title, while each doc has its own separate doc
78 title (from TITLE).
81 Release 1.1.5
82 -------------
84 ***NEW***
86 Added James Ramsey's CHAPTER_TITLE macro as well as control macros to
87 go with it.  Thanks James.  Also from James came a patch to handle
88 START differenty which has been incorporated into om.tmac.  Thanks
89 again, James.
91 Some bits and pieces of the docs have been tweaked, but nothing
92 changed.  Hopefully, the changes will make parts of the docs easier to
93 read and navigate.
95 ***FIXES***
97 o \*[RULE]
99 o broken draft and revision in docheaders
101 o post-epigraph spacing in TYPEWRITE
103 o header spacing in TYPEWRITE
105 ------------------------------------------------------------------------
107 Release 1.1.4
108 -------------
110 ***SIGNIFICANT CHANGE***
111 .IX is now deprecated, although it will continue to work as before.
112 The new form is .IQ (Indent Quit).  Groff will emit a message advising
113 users to update their docs.
115 ***NEW***
116 Four new inlines to deal with horizontal and vertical movements:
118     o \*[FWD n]
119     o \*[BCK n]
120     o \*[UP n]
121     o \*[DOWN n]
123 All four require a unit of measure after n.  These inlines are similar
124 to the older \*[FPn], \*[BPn], \*[ALDn] and \*[RLDn], however they're
125 not restricted to points, and any value can be entered for n (the older
126 forms -- which still work -- were restricted to 1 - 36).
128 ***CHANGED***
129 Inline kerning can now be accomplished with \*[BU n] and \*[FU n], where
130 n, after the space, is the desired number of kern units.  The older
131 forms \*[BUn] and \*[FUn] still work, up to 36 units.
133 ------------------------------------------------------------------------
135 Release 1.1.3c
136 --------------
138 ***NEW***
139 A new macro -- ENDNOTES_HDRFTR_CENTER -- added so that mom's default
140 behaviour of not printing the header center string when DOCTYPE is
141 CHAPTER can be disabled (i.e. she will print the center string).  The
142 macro is user-called with ENDNOTES_HEADER_CENTER or
143 ENDNOTES_FOOTER_CENTER.
145 ***FIXES***
146 PAD now works as advertised when fill mode is on.
148 ENDNOTES no longer disables printing of footnotes on last page of
149 document body.
151 Release 1.1.3
152 -------------
154 ***SIGNIFICANT CHANGE -- PLEASE TAKE NOTE***
155 As of 1.1.3, groff must be >= 1.18.
157 ***NEW***
158 Added endnotes functionality to mom, along with a slew of macros to
159 control how mom prints endnotes pages.  See the html documentation.
161 ***NEW***
162 Added inline \*[RULE], which draws a rule to the full measure of the
163 current line length ( to be used in place of \h'\n(.lu' ).  Weight of the
164 rule is dependent on the point size of type when \#[RULE] is called.
166 ***FIXES***
167 PAD -- works more intuitively now when the pad string contains inline
168 escapes for font, point size, etc.
170 UNDERLINE -- fixed character translations of digraphs so they get
171 underlined properly.  Also fixed a bug that was causing some footnotes
172 to get underlined when UNDERLINE was on in the body of the document.
174 ***UPDATES***
175 Html documentation
176 elvis_syn
178 Release 1.1.2a
179 --------------
181 ***SIGNIFICANT CHANGE -- PLEASE TAKE NOTE***
182 In order to help mom toward full groffship, the macro .PS has been
183 renamed to .PT_SIZE, and the alias .TS (for .TAB_SET) has been removed.
184 .PS and .TS are keywords used by pic and tbl respectively, and the mom
185 macros of the same name were in conflict.
187 Release 1.1.2
188 -------------
190 ***IT'S OFFICIAL!***
191 mom is now an official part of the groff.  New releases will be
192 incorporated into the groff package.  I'll still be posting each new
193 release on the mom homepage, so there's no need to download all of the
194 most recent version of groff just to get a newer mom. :)
196 ***CHANGES***
197 Fixed default footer separator rule adjustment so that it's closer to
198 the advertised "4 points above the tallest ascender in the footer."
200 Added more stuff to the elvis_syn file.  Still wouldn't mind someone
201 contributing some vim/emacs syntax highlighting.
203 Added .cflags 4 /\(em to om.tmac.  By default, mom now obligingly
204 breaks after / and \(en.
206 ***NEW***
207 Macro(s): HEADER_RECTO
208           HEADER_VERSO
209 With these macros, users can now define single-string recto/verso
210 headers/footers.  HEADER_RECTO (or FOOTER_RECTO) can be used to create
211 a one-part header/footer (instead of mom's default three-parters) that
212 appears on every page if RECTO_VERSO is OFF or, if RECTO_VERSO is on, if
213 no HEADER_VERSO (or FOOTER_VERSO) has been defined.  If a HEADER_VERSO
214 (or FOOTER_VERSO) is defined and RECTO_VERSO is on, _RECTO prints on
215 even pages and _VERSO on odd pages.
217 Added macro DRAFT_WITH_PAGENUMBER so user can have draft/revision
218 info attached to the pagenumber in COPYSTYLE DRAFT, instead of having
219 it HEADER center.  Always having it HEADER center was creating problems
220 with long doc titles, esp. with PRINTSTYLE TYPEWRITE (which is when
221 COPYSTYLE DRAFT is most likely to be used).
223 ***FIXES***
224 No more "can't break line" warnings in DOCTYPE LETTER.
226 If no REVISION number is given, Rev. 0 no longer appears HEADER_CENTER
227 in COPYSTYLE DRAFT
229 PAGENUM_STYLE now works as advertised.
231 Release 1.1.1
232 -------------
234 ***CHANGES***
235 Main macro file renamed to om.tmac, in keeping with current groff
236 policy.
238 Now okay to use groff mailing list for mom-related posts
240 ***NEW***
241 Toggle macro -- BR_AT_LINE_KERN.  When on, automatically deposits
242 a break whenever .RW or .EW are invoked.  Very useful when kerning
243 whole lines of rag copy.
245 ***NEW***
246 Toggle macro -- PAGENUM_ON_FIRST_PAGE.  Normally, when FOOTERS are
247 being used instead of HEADERS, mom doesn't print the page number at
248 the top of the first page of a doc, or the first page of collated docs.
249 PAGENUM_ON_FIRST_PAGE allows user to get mom to put the page number on
250 "first" pages if that's desired.
252 ***NEW***
253 Macro -- BREAK_QUOTE -- to deal with problem of footnoted quotes and
254 blockquotes that cross a page or column.
256 ***NEW***
257 New argument to AUTOLEAD -- FACTOR.  With FACTOR, you can, if you
258 wish, enter a factor by which AUTOLEAD multiplies the point size when
259 calculating lead automatically.
261 Improvements
262 ------------
264 PAPER now has a much larger selection of common paper sizes.
266 \*[ALD], \*[RLD], \*[FP] and \*[BP] now accept increments of quarter
267 points (expressed as decimal fractions).  \*[RLD1.75], for example,
268 reverses 1-3/4 points up on the line.
270 HEADER_SIZE now available to PRINTSTYLE TYPEWRITE.  This was necessary
271 to deal with the problem of excessively long HEADER_LEFT, _CENTER or
272 _RIGHT strings.
274 Fixes
275 -----
277 T_MARGIN -- can be set before or after LS or AUTOLEAD
278 SS       -- remains constant regardless of WS
279 WS       -- no longer affects SS
280 TI       -- now works as expected even when called while another indent
281             type is in effect
282 COLLATE  -- small fixes
284 Broken .RW and .EW fixed.
286 String tabs now behave properly when set from within tabs.
288 UNDERLINE_QUOTES (for PRINTSTYLE TYPEWRITE) are now, in fact, on by
289 default as the docs state.