/contrib/groff/contrib/mom/NEWS

https://bitbucket.org/freebsd/freebsd-head/ · #! · 446 lines · 328 code · 118 blank · 0 comment · 0 complexity · 0de55417ba2618123e363ba240e6dee0 MD5 · raw file

  1. Release 1.3
  2. -----------
  3. Added line numbering capabilities, with controls.
  4. Footnotes and endnotes can now be referenced by line number.
  5. Added ability to adjust vertical position of the title that appears
  6. on the first endnotes page.
  7. Footnotes can run on when being referenced by line number.
  8. Footnotes now have a post-footnote spacing option, for adding
  9. a little space between footnotes.
  10. Extended LIST so it accepts alpha, ROMAN and roman enumerators.
  11. Added margin notes capability.
  12. Added refer support.
  13. Added bibliography page support.
  14. Added QUOTE_AUTOLEAD and BLOCKQUOTE_AUTOLEAD, so user can have
  15. quotes and blockquotes leaded differently from running text.
  16. Change: the input line immediately after FOOTNOTE OFF must be
  17. entered as a literal continuation of the line prior to FOOTNOTE,
  18. including any initial spaces or punctuation marks. This allows
  19. for hassle-free placing of footnote markers in running text either
  20. before or after punctuation marks.
  21. Release 1.2-f
  22. -------------
  23. Added ADD_SPACE, to permit users to insert space at the top of
  24. running text (after the first page) when using the docprocessing
  25. macros.
  26. Releases 1.2-a and 1.2-b
  27. ------------------------
  28. My personal email address has changed. 1.2-a and -b have been
  29. updated to reflect that. Additionally, I made some small changes
  30. to the documentation.
  31. Release 1.2
  32. -----------
  33. As of 1.2, the recommended version of groff to use with mom has
  34. been bumped up from groff, 1.18 to groff, 1.19.2. Although mom will
  35. continue to work with groff, 1.18, her handling of .FAM(ILY) and .FT
  36. is now slightly different, therefore users of groff 1.18 may have to
  37. update documents created with mom so that every .FAM(ILY) request is
  38. followed by a .FT request before any text is input, otherwise mom
  39. will set the text after .FAM(ILY) in Courier (until she encounters a
  40. .FT request). People running groff, >= 1.19.2 don't have to worry
  41. about this, but I recommend that, regardless of which version you're
  42. running, you have a look at the document entries for FAMILY and FT
  43. in order to see how mom will be handling .FAMILY and .FT from now
  44. on.
  45. When used with groff >=1.19.2, mom now emits warnings if a style
  46. hasn't been registered, or if a font style doesn't exist in the
  47. current family. Invalid .FAM(ILY) calls now use a "fallback" font"
  48. (although no warning is issued). The fallback is user-settable.
  49. Mom's macro file, om.tmac, now sets up a fairly extensive list of
  50. font "styles," thus expanding the range of arguments that can be
  51. passed to .FT (formerly, just R, I, B and BI, unless users had
  52. already rolled their own solution to the problem of extensive type
  53. families containing fonts like condensed, demibold, black, light, etc).
  54. Users are advised to read the documentation sections on FAM(ILY),
  55. FT and FALLBACK_FONT, as well as the new appendix section, "Adding
  56. PostScript fonts to groff", for information on using mom's style
  57. extensions (and how to disable them, should they conflict with a
  58. user's present groff site-font/devps setup).
  59. A new macro, FALLBACK_FONT, has been added. It controls not only
  60. the fallback font for invalid .FAMILY calls, but also whether mom
  61. aborts on invalid .FT calls after issuing a warning, or continues
  62. processing using the fallback.
  63. Release 1.1.9
  64. -------------
  65. Added the (optional) generation of cover pages and document cover
  66. pages, plus a full suite of control macros for all cover page
  67. elements.
  68. Added new reference macros that apply to covers: COVERTITLE,
  69. DOC_COVERTITLE, COPYRIGHT and MISC.
  70. The need for TRAP OFF/TRAP to deal with ELs and TNs that fall at
  71. the bottom page has been obsoleted. However, both EL and TN, when
  72. invoked in any "nofill" mode (LEFT, RIGHT, CENTER, or the L | R | C
  73. arguments to TAB_SET or ST when no QUAD argument is given), must now
  74. have the input line preceding the EL or TN terminated by \c. Fill
  75. modes do not have this requirement, i.e. no \c is required.
  76. Footnotes that occur inside quotes, blockquotes and epigraphs now
  77. work just like regular footnotes, with no user intervention
  78. required. This obsoletes the macro BREAK_QUOTE.
  79. Removed all aliases that used the word COLOUR. Users must use
  80. COLOR wherever COLOR is needed. COLOUR, as a replacement/alias, is
  81. no longer supported.
  82. NEWPAGE, which used to be an alias of .bp, is now its own macro.
  83. Release 1.1.8
  84. -------------
  85. Added text color support. Users can now define or initialize a color,
  86. and afterwards change text color with an inline of the form
  87. \*[<colorname>], or with the macro .COLOR. In document processing,
  88. the docelement tag control macros have been expanded to include
  89. _COLOR, e.g. .HEAD_COLOR <predefined colorname> will colorize
  90. heads, PAGENUM_COLOR <predefined colorname) will colorize page
  91. numbering, etc.
  92. Adjusted vertical placement of hyphens around page numbering when
  93. PAGENUM_STYLE is DIGIT, ROMAN or ALPHA so that the hyphens appear
  94. properly centered on the page numbering character.
  95. Changed tab handling in document processing so that tab structures
  96. are preserved from page to page and column to column.
  97. Release 1.1.7-a
  98. ---------------
  99. Increased the flexibility of SMARTQUOTES so that they handle quoting
  100. styles by language, entered as a 2-digit language code argument to
  101. SMARTQUOTES. See docs.
  102. Re-wrote the DOCTYPE LETTER macros so that DATE, TO and FROM can be
  103. entered in any order the user wishes, with output that matches
  104. input. (Should have done this in the first place.)
  105. Release 1.1.7
  106. -------------
  107. Finally got around to writing "list" macros. See the docs.
  108. Added German-style lowered double quotes and two styles of
  109. guillemets to SMARTQUOTES.
  110. Added macro SIZE, intended to be called inline as \*[SIZE <n>].
  111. This brings mom's inline size change syntax into line with her other
  112. inlines. \*S[<n>] can still be used for the same thing.
  113. The file elvis_syntax (for elvis prior to 2.2h) is no longer being
  114. maintained. It was getting messy and long in the tooth. The
  115. official elvis syntax file is elvis_syntax.new, which works for
  116. 2.2h of elvis (and higher, one hopes). elvis users are encouraged
  117. to update to 2.2h or higher.
  118. Release 1.1.6-e
  119. ---------------
  120. Extended handling of draft and revision numbers and strings in
  121. headers/footers for increased flexibility. It's possible now to
  122. have just about any combo of DRAFT_STRING, DRAFT, REVISION_STRING
  123. and REVISION, and have them come out in headers/footers as one
  124. intuitively expects/wants.
  125. Also added a new set of syntax highlighting rules for the vi clone,
  126. elvis. Version 2-2h-beta of elvis finally made possible the
  127. highlighting of \*[...] inline escapes, whether or not they're
  128. separated from surrounding text by spaces. This is a terrific
  129. improvement in elvis, and makes for greatly improved readability of
  130. mom files.
  131. Release 1.1.6-b - 1.1.6d
  132. ------------------------
  133. Trivial changes to documentation and some cleanups of the main
  134. om.tmac file, including:
  135. Added a .bp after .if \\n[#START]=1 in FOOTER. Without it,
  136. in document processing mode, documents that use *none* of the
  137. docprocessing tags (yes, there are times when users want to do
  138. this) ignored the footer trap.
  139. Changed register #DOCHEADER_LEAD_ADJ to string
  140. $DOCHEADER_LEAD_ADJ. This means that .DOCHEADER_LEAD no longer
  141. requires a unit of measure; points is assumed.
  142. Release 1.1.6-b
  143. ---------------
  144. Added a SHIM macro that calculates and moves to the next "legal"
  145. baseline during document processing (useful if user starts playing
  146. around with spacing/leading on a page and needs to get the leading
  147. back on track).
  148. Fixed handling of DOCHEADER OFF <distance> so that the first line of
  149. running text falls on a "legal" baseline when <distance> is given.
  150. Release 1.1.6-a
  151. ---------------
  152. Problem with groff 1.19.1 fixed by Werner (.return handled arguments
  153. incorrectly).
  154. Fixed handling of page numbering style restoration in endnotes, so
  155. that (collated) docs have the correct page numbering style when the
  156. style has been changed for endnotes (with ENDNOTES_PAGENUM_STYLE).
  157. DOC_TITLE has been made for use exclusively with DOCTYPE DEFAULT.
  158. Fixed handling of headers/footers with respect to endnotes. Now,
  159. when either headers or footers are on, mom picks up the correct
  160. page header/footer on the last page prior to ENDNOTES, gets the
  161. pageheaders correct for endnotes pages *including the last one*, and
  162. picks up correct page headers/footers for the subsequent docs after
  163. COLLATE.
  164. Release 1.1.6
  165. -------------
  166. BAD NEWS: mom appears to be crippled in some areas when run with
  167. groff 1.19.1. Pending a solution, mom must be run with groff 1.18
  168. ***NEW***
  169. Added TOC capabilities.
  170. Extended range of endnotes control macros. See the documentation
  171. on endnotes control macros.
  172. Added a new DOC_TITLE macro, to deal with collated documents that
  173. have an overall title, while each doc has its own separate doc
  174. title (from TITLE).
  175. Release 1.1.5
  176. -------------
  177. ***NEW***
  178. Added James Ramsey's CHAPTER_TITLE macro as well as control macros to
  179. go with it. Thanks James. Also from James came a patch to handle
  180. START differenty which has been incorporated into om.tmac. Thanks
  181. again, James.
  182. Some bits and pieces of the docs have been tweaked, but nothing
  183. changed. Hopefully, the changes will make parts of the docs easier to
  184. read and navigate.
  185. ***FIXES***
  186. o \*[RULE]
  187. o broken draft and revision in docheaders
  188. o post-epigraph spacing in TYPEWRITE
  189. o header spacing in TYPEWRITE
  190. ------------------------------------------------------------------------
  191. Release 1.1.4
  192. -------------
  193. ***SIGNIFICANT CHANGE***
  194. .IX is now deprecated, although it will continue to work as before.
  195. The new form is .IQ (Indent Quit). Groff will emit a message advising
  196. users to update their docs.
  197. ***NEW***
  198. Four new inlines to deal with horizontal and vertical movements:
  199. o \*[FWD n]
  200. o \*[BCK n]
  201. o \*[UP n]
  202. o \*[DOWN n]
  203. All four require a unit of measure after n. These inlines are similar
  204. to the older \*[FPn], \*[BPn], \*[ALDn] and \*[RLDn], however they're
  205. not restricted to points, and any value can be entered for n (the older
  206. forms -- which still work -- were restricted to 1 - 36).
  207. ***CHANGED***
  208. Inline kerning can now be accomplished with \*[BU n] and \*[FU n], where
  209. n, after the space, is the desired number of kern units. The older
  210. forms \*[BUn] and \*[FUn] still work, up to 36 units.
  211. ------------------------------------------------------------------------
  212. Release 1.1.3c
  213. --------------
  214. ***NEW***
  215. A new macro -- ENDNOTES_HDRFTR_CENTER -- added so that mom's default
  216. behaviour of not printing the header center string when DOCTYPE is
  217. CHAPTER can be disabled (i.e. she will print the center string). The
  218. macro is user-called with ENDNOTES_HEADER_CENTER or
  219. ENDNOTES_FOOTER_CENTER.
  220. ***FIXES***
  221. PAD now works as advertised when fill mode is on.
  222. ENDNOTES no longer disables printing of footnotes on last page of
  223. document body.
  224. Release 1.1.3
  225. -------------
  226. ***SIGNIFICANT CHANGE -- PLEASE TAKE NOTE***
  227. As of 1.1.3, groff must be >= 1.18.
  228. ***NEW***
  229. Added endnotes functionality to mom, along with a slew of macros to
  230. control how mom prints endnotes pages. See the html documentation.
  231. ***NEW***
  232. Added inline \*[RULE], which draws a rule to the full measure of the
  233. current line length ( to be used in place of \h'\n(.lu' ). Weight of the
  234. rule is dependent on the point size of type when \#[RULE] is called.
  235. ***FIXES***
  236. PAD -- works more intuitively now when the pad string contains inline
  237. escapes for font, point size, etc.
  238. UNDERLINE -- fixed character translations of digraphs so they get
  239. underlined properly. Also fixed a bug that was causing some footnotes
  240. to get underlined when UNDERLINE was on in the body of the document.
  241. ***UPDATES***
  242. Html documentation
  243. elvis_syn
  244. Release 1.1.2a
  245. --------------
  246. ***SIGNIFICANT CHANGE -- PLEASE TAKE NOTE***
  247. In order to help mom toward full groffship, the macro .PS has been
  248. renamed to .PT_SIZE, and the alias .TS (for .TAB_SET) has been removed.
  249. .PS and .TS are keywords used by pic and tbl respectively, and the mom
  250. macros of the same name were in conflict.
  251. Release 1.1.2
  252. -------------
  253. ***IT'S OFFICIAL!***
  254. mom is now an official part of the groff. New releases will be
  255. incorporated into the groff package. I'll still be posting each new
  256. release on the mom homepage, so there's no need to download all of the
  257. most recent version of groff just to get a newer mom. :)
  258. ***CHANGES***
  259. Fixed default footer separator rule adjustment so that it's closer to
  260. the advertised "4 points above the tallest ascender in the footer."
  261. Added more stuff to the elvis_syn file. Still wouldn't mind someone
  262. contributing some vim/emacs syntax highlighting.
  263. Added .cflags 4 /\(em to om.tmac. By default, mom now obligingly
  264. breaks after / and \(en.
  265. ***NEW***
  266. Macro(s): HEADER_RECTO
  267. HEADER_VERSO
  268. With these macros, users can now define single-string recto/verso
  269. headers/footers. HEADER_RECTO (or FOOTER_RECTO) can be used to create
  270. a one-part header/footer (instead of mom's default three-parters) that
  271. appears on every page if RECTO_VERSO is OFF or, if RECTO_VERSO is on, if
  272. no HEADER_VERSO (or FOOTER_VERSO) has been defined. If a HEADER_VERSO
  273. (or FOOTER_VERSO) is defined and RECTO_VERSO is on, _RECTO prints on
  274. even pages and _VERSO on odd pages.
  275. Added macro DRAFT_WITH_PAGENUMBER so user can have draft/revision
  276. info attached to the pagenumber in COPYSTYLE DRAFT, instead of having
  277. it HEADER center. Always having it HEADER center was creating problems
  278. with long doc titles, esp. with PRINTSTYLE TYPEWRITE (which is when
  279. COPYSTYLE DRAFT is most likely to be used).
  280. ***FIXES***
  281. No more "can't break line" warnings in DOCTYPE LETTER.
  282. If no REVISION number is given, Rev. 0 no longer appears HEADER_CENTER
  283. in COPYSTYLE DRAFT
  284. PAGENUM_STYLE now works as advertised.
  285. Release 1.1.1
  286. -------------
  287. ***CHANGES***
  288. Main macro file renamed to om.tmac, in keeping with current groff
  289. policy.
  290. Now okay to use groff mailing list for mom-related posts
  291. ***NEW***
  292. Toggle macro -- BR_AT_LINE_KERN. When on, automatically deposits
  293. a break whenever .RW or .EW are invoked. Very useful when kerning
  294. whole lines of rag copy.
  295. ***NEW***
  296. Toggle macro -- PAGENUM_ON_FIRST_PAGE. Normally, when FOOTERS are
  297. being used instead of HEADERS, mom doesn't print the page number at
  298. the top of the first page of a doc, or the first page of collated docs.
  299. PAGENUM_ON_FIRST_PAGE allows user to get mom to put the page number on
  300. "first" pages if that's desired.
  301. ***NEW***
  302. Macro -- BREAK_QUOTE -- to deal with problem of footnoted quotes and
  303. blockquotes that cross a page or column.
  304. ***NEW***
  305. New argument to AUTOLEAD -- FACTOR. With FACTOR, you can, if you
  306. wish, enter a factor by which AUTOLEAD multiplies the point size when
  307. calculating lead automatically.
  308. Improvements
  309. ------------
  310. PAPER now has a much larger selection of common paper sizes.
  311. \*[ALD], \*[RLD], \*[FP] and \*[BP] now accept increments of quarter
  312. points (expressed as decimal fractions). \*[RLD1.75], for example,
  313. reverses 1-3/4 points up on the line.
  314. HEADER_SIZE now available to PRINTSTYLE TYPEWRITE. This was necessary
  315. to deal with the problem of excessively long HEADER_LEFT, _CENTER or
  316. _RIGHT strings.
  317. Fixes
  318. -----
  319. T_MARGIN -- can be set before or after LS or AUTOLEAD
  320. SS -- remains constant regardless of WS
  321. WS -- no longer affects SS
  322. TI -- now works as expected even when called while another indent
  323. type is in effect
  324. COLLATE -- small fixes
  325. Broken .RW and .EW fixed.
  326. String tabs now behave properly when set from within tabs.
  327. UNDERLINE_QUOTES (for PRINTSTYLE TYPEWRITE) are now, in fact, on by
  328. default as the docs state.