contrib/mom/ChangeLog

   1 *Tue Oct 21 2003
   2
   3 o Changed \n[#DRAFT] and \n[#REVISION] to strings \*[$DRAFT] and
   4   \*[$REVISION], allowing for the possibility of blank entries that
   5   don't mess up headers/footers with zeros if user doesn't want any
   6   numbers.
   7
   8 o Extended handling of draft and revision numbers and strings in
   9   headers/footers for increased flexibility.  It's possible now to
  10   have just about any combo of DRAFT_STRING, DRAFT, REVISION_STRING
  11   and REVISION, and have them come out in headers/footers as one
  12   intuitively expects/wants.
  13
  14 *Fri Jul 25 2003
  15
  16 o Added a .bp after .if \\n[#START]=1 in FOOTER.  Without it,
  17   in document processing mode, documents that use *none* of the
  18   docprocessing tags (yes, there are times when users want to do
  19   this) ignored the footer trap.
  20
  21 *Fri Jun 6 2003
  22
  23 o Changed register #DOCHEADER_LEAD_ADJ to string
  24
  25 *Wed May 21 2003
  26
  27 o DOC_TITLE changed to be used exclusively with DOCTYPE DEFAULT
  28
  29 o Fixed problem with restoration of previous doc pagenum
  30   style when endnotes use a different pagenum style (set with
  31   ENDNOTES_PAGENUM_STYLE)
  32
  33 o Fixed handling of headers/footers with respect to endnotes.  Now,
  34   when either headers or footers are on, mom picks up the correct
  35   page header/footer on the last page prior to ENDNOTES, gets the
  36   pageheaders correct for endnotes pages *including the last one*,
  37   and picks up correct page headers/footers for the subsequent docs
  38   after COLLATE
  39
  40 *Sat May 17 2003
  41
  42 o Added TOC (finally) and a nearly complete set of associated
  43   control macros
  44
  45 o Added new control macros to endnotes:
  46
  47   ENDNOTES_STRING_CAPS       - capitalize the endnotes string
  48   ENDNOTES_NO_COLUMNS        - allows docs in columns and endnotes not
  49   ENDNOTES_PAGENUM_STYLE     - set page numbering style for endnotes
  50   ENDNOTES_FIRST_PAGENUMBER  - set first pagenumber for endnotes
  51   ENDNOTES_ALLOWS_HEADERS    - page headers on endnotes pages off or on
  52   ENDNOTES_NO_FIRST_PAGENUM  - allows non-printing first page number when page footers are being used instead of headers
  53   ENDNOTES_SINGLE_SPACE      - for TYPEWRITE, if doc double-spaced
  54   SUSPEND/RESTORE_PAGINATION - turns page numbering off for endnotes
  55
  56 o Added an ADJUST option to ENDNOTE_LEAD
  57
  58 o Added DOC_TITLE (like TITLE, but sets document-wide title for collated docs)
  59
  60 o Added HDRFTR_CENTER_PAD, to allow adjustments to placement of
  61   HDRFTR_CENTER_STRING
  62
  63 o Added BLANKPAGE macro, to output blank pages (silently numbered)
  64
  65 o Extensive changes to DEFAULTS, START, COLLATE, HEAD, SUBHEAD and
  66   PARAHEAD because of new TOC and extended flexibility of ENDNOTES
  67   page design
  68
  69 o Fixed DOCHEADER OFF (distance), FINIS
  70
  71 -----------------------------------------------------------------------
  72
  73 *Sat Feb 22 2003
  74
  75 o (Re)-fixed handling of post epigraph spacing after #START for
  76   TYPEWRITE double-spaced.
  77
  78 ------------------------------------------------------------------------
  79
  80 *Sun Feb 16 2003
  81
  82 o Added James Ramsey's proposed CHAPTER_TITLE macro, along with his
  83   rewritten START macro and his utility macros to make START easier
  84   to read.
  85
  86 o Expanded handling of CHAPTER_TITLE to encompass TYPEWRITE, as well as
  87   plugging it into the docheaders.  Made CHAPTER_TITLE backwardly
  88   compatible so that pre-1.1.5 docs using CHAPTER_STRING to create a
  89   chapter title remain unaffected when groffed with 1.1.5.
  90
  91 o Created control macros for CHAPTER_TITLE FAMILY, FONT and SIZE.
  92   Added defaults for handling of CHAPTER title to DEFAULTS.  Documented
  93   CHAPTER_TITLE and everything that goes along with it.
  94
  95 o Fixed broken draft and revision in headers/footers.
  96
  97 o Fixed \*[RULE] so that it behaves properly with indents and justified
  98   copy.
  99
 100 o Fixed/tweaked handling of epigraph spacing in TYPEWRITE.
 101
 102 o Fixed broken spacing of docheaders in TYPEWRITE.
 103
 104 *Mon Feb 3 2003
 105
 106 o Fixed an oversight in CLOSING for DOCTYPE LETTER (closing wasn't
 107   being set flush left)
 108
 109 *Sun Sep 29 2002
 110
 111 o Changed .ne in .HEAD when PRINTSTYLE TYPESET from 5 to 4.  With 5,
 112   heads required at least 2 lines of text underneath or they'd be
 113   defered to the next page, which created too much whitespace at the
 114   end of the page.  Heads will now be processed on the same page if the
 115   head plus at least one line of text underneath fits.  I figure it's
 116   easier for the user to break to a new page manually if this behaviour
 117   is unsatisfactory than to massage the page to fix the excess
 118   whitespace.
 119
 120 *Sun Aug 25 2002
 121
 122 o Changed .IX to .IQ.  The older form still works, but emits a message
 123   advising the user to update to the newer.  (The macro in om.tmac
 124   still remains IX; IQ is an alias.)  Docs updated to reflect the
 125   change.
 126
 127 *Tue Aug 20 2002
 128
 129 o Added new (better) way to handle inline kerning.  \*[BU #] and
 130   \*[FU #] allow passing an argument to the inline string.  The older
 131   forms \*[BU#] and \*[FU#] still work, though.
 132
 133 o Changed handling of inline horizontal and vertical movements.
 134   Horizontal movements are now done with \*[BCK #<unit>] and
 135   \*[FWD #<unit>]; verticals with \*[UP #<unit>] and \*[DOWN #<unit>].
 136   The older forms \*[FP#] and \*[BP#] still work (horizontals), as do
 137   \*[ALD#] and \*[RLD#] (verticals).
 138
 139 ------------------------------------------------------------------------
 140
 141 *Mon Aug 19 2002
 142
 143 o Fixed ENDNOTES so footnotes output properly when ENDNOTES is called
 144
 145 o Added ENDNOTES_HDRFTR_CENTER so that default no-print of header
 146   center string on endnotes page(s) when DOCTYPE is CHAPTER can
 147   be disabled (i.e. header center will be printed).
 148
 149 *Sat Aug 10 2002
 150
 151 o Added .nf to top of PAD, with a test beforehand for current fill
 152   mode.  If fill mode was on, it's restored after PAD completes
 153   processing.  Updated reserved.html to include number register
 154   #FILL_MODE.
 155
 156 *Fri Jul 12 2002
 157
 158 o More fixes to underlining.
 159
 160 *Fri Jul 5 2002
 161
 162 o Added capability of endnotes and pertinent control macros to om.tmac.
 163
 164 o Added document entries pertaining to endnote macros.
 165
 166 o Incorporated endnote macros into elvis_syntax.
 167
 168 o Small doc fixes.
 169
 170 o Tidied up indenting of om.tmac.
 171
 172 o Fixed handling of underlining of italics in PRINTSTYLE TYPEWRITE
 173   (there was a problem with footnotes getting underlined when they
 174   shouldn't have been).
 175
 176 o Removed ENDNOTES from TODO
 177
 178 o Fixed the character translations for UNDERLINE so they work properly
 179   with digraphs.
 180
 181 *Mon Jul 1 2002
 182
 183 o Expanded docprocessing.html entry "Special Note on Chapters".  Tidied
 184   up html a bit.
 185
 186 *Sat Jun 15 2002
 187
 188 o Small fix to PAD to make the use of inlines within the pad string
 189   more intuitive.
 190
 191 o Added \*[RULE] ( = \l'\n(.lu' ) so that full measure rules (either to
 192   full line length or within tabs) are easier to set.
 193
 194 *Sat Jun 8 2002
 195
 196 o Macro .PS renamed to .PT_SIZE.  Alias .TS removed.
 197
 198 o .tr bits in .CAPS rewritten in the form .tr é\[`E].
 199
 200 o General cleanup of docs to reflect changes
 201
 202 o Small changes/additions to elvis_syn
 203
 204 *Thu Jun 6 2002
 205
 206 o In DOCTYPE, in .if '\\$1'LETTER', added .FOOTER_RIGHT_SIZE +0.
 207   Without it, the suite page was printing at the default
 208   FOOTER_RIGHT_SIZE of -.5, which didn't look good.
 209
 210 *Wed Jun  5 2002
 211
 212 o Makefile.sub (TFLAG): Add `$(top_builddir)/tmac'.
 213
 214 *Tue Jun  4 2002
 215
 216 o Makefile.sub (groff_bin_dirs): Fix typo (forgotten `src' element).
 217
 218 *Mon Jun  3 2002
 219
 220 o Makefile.sub (uninstall_sub): Don't use `momdocdir' but `htmldocdir'.
 221   Add missing backslash.
 222
 223 *Sat Jun  1 2002
 224
 225 o Makefile.in (prepare_make_examples): Test for `penguin.ps', not
 226   `examples/penguin.ps'.
 227
 228 *Wed May 29 2002
 229
 230 o Rewrote portions of PAGENUM_STYLE and COPYSTYLE so that PAGENUM_STYLE
 231   behaves as advertised.
 232
 233 *Fri May 24 2002
 234
 235 o /Makefile.sub (momdocdir): Removed.
 236   (HTMLDOCFILES): Prepend `momdoc/'.
 237   (EXTRAEXAMPLEFILES): Removed.  Added entries to...
 238   (EXAMPLEFILES): This.
 239   (.SUFFIXES, .mom.ps): New.
 240   (prepare_make_examples): Updated.
 241   (examples/*.ps): Removed; .mom.ps will handle this.
 242   (install_data): Updated.
 243
 244 *Thu May 23 2002
 245
 246 o Applied two small bug fixes to om.tmac (patches 1.1.1a and 1.1.1b).
 247
 248 o mom is now part of groff.
 249
 250 o Some renaming to avoid problems with 8+3 filesystems:
 251
 252     examples/docprocessing_typeset.mom   -> examples/typeset.mom
 253     examples/docprocessing_typewrite.mom -> examples/typewrite.mom
 254     examples/typesetting_macros.mom      -> examples/macros.mom
 255     examples/penguin_small2_bw.ps        -> examples/penguin.ps
 256
 257 o Removed `INSTALL' and `README' since groff takes care of installation
 258   now.
 259
 260 o Added Makefile.sub.
 261
 262 o Added mom.tmac (which simply calls om.tmac).
 263
 264 o Added groff_mom.man for orthogonality; it simply points to the HTML
 265   documentation.
 266
 267 *Thu May 16 2002
 268
 269 o Added macro DRAFT_WITH_PAGENUMBER so user can have draft/revision
 270   info attached to the pagenumber in COPYSTYLE DRAFT, instead of having
 271   it HEADER center.  Always having it HEADER center was creating problems
 272   with long doc titles, esp. with PRINTSTYLE TYPEWRITE (which is when
 273   COPYSTYLE DRAFT is most likely to be used).  Now user has the choice,
 274   in these circumstances, either to reduce HEADER_SIZE, or to displace
 275   the draft/revision info.  Also rewrote portions of COPYSTYLE so that
 276   if no revision number is given in the reference macros, "Rev. #"
 277   doesn't appear when COPYSTYLE DRAFT.
 278
 279 *Fri May 10 2002
 280
 281 o Added capability of user-defined, single string recto/verso
 282   headers/footers.
 283
 284 o Added new entries to docs about the above.  Made some additional
 285   small changes to toc.html, rectoverso.html, and headfootpage.html
 286   to supplement the new entries.
 287
 288 o Small fix to handling of footer separator rule -- was 1 point too low
 289   owing to fuzziness of #CAP_HEIGHT as returned by SIZESPECS.
 290
 291 o Added some more useful stuff to elvis_syntax.
 292
 293 *Sun May 05 2002
 294
 295 o Fix to DEFAULTS so that L_MARGIN and R_MARGIN are reprocessed if
 296   DOCTYPE LETTER.  R_MARGIN, as set by DOCTYPE LETTER had no preceding
 297   PAGEWIDTH or PAPER from which to get #PAGE_WIDTH for figuring out
 298   line length.
 299
 300 o Additional fix to DEFAULTS in handling DOCTYPE LETTER so that if user
 301   sets line length prior to START, no reprocessing of R_MARGIN occurs.
 302   This necessitated adding a new number register: #USER_SET_L_LENGTH
 303
 304 *Sat May 04 23:48:05 EDT 2002
 305
 306 o Added .cflags 4 /\(en -- was driving me nuts that lines wouldn't
 307   break after these characters; I'm assuming others feel the same way
 308
 309 * Fri May 03 2002
 310
 311 o Made some small fixes to space handling around quotes, mostly to do
 312   with quotes immediately after START and quotes after (sub)heads.
 313
 314 * Wed May 01 2002
 315
 316 o Fixed a small bug that was causing the first .PP after START to begin
 317   at the top margin of the page regardless of any type that preceded
 318   .PP when docheaders were off.
 319
 320 o Fixed HEADER so that when HEADERS are off the first line of type on
 321   pages after the first falls properly at the top margin
 322
 323 *Sat Apr 27 2002
 324
 325 o Renamed docprocessing_macros.mom in /examples to
 326   docprocessing_typeset.mom.  Added docprocessing_typewrite.mom, as
 327   well as a README file.
 328
 329 o Fixed UNDERLINE_QUOTES (for PRINTSTYLE TYPEWRITE) so they really are
 330   on by default as the docs say.
 331
 332 o Changes to doc entry on COLLATE:
 333
 334     - removed bit about using COLLATE after a cover page (I wrote the
 335       entry *before* I wrote the macro!).  Cover pages should be
 336       followed by NEWPAGE, not COLLATE.
 337
 338     - added caution about mixing PRINTSTYLEs
 339
 340     - added caution about using DOC_FAMILY to change family of all
 341       document elements after COLLATE
 342
 343 o Made HEADER_SIZE (and, by extension, FOOTER_SIZE) available to
 344   PRINTSTYLE TYPEWRITE.  Changed appropriate doc entries to reflect
 345   this.
 346
 347 *Wed Apr 24 2002
 348
 349 o Small change to DO_QUOTE to correct a problem with quotes and
 350   blockquotes that fall in the middle of paragraphs (i.e. text after
 351   the quote is not a new para).  Basically, added a bit that stores the
 352   current para indent, sets para indent to 0, invokes a PP, then
 353   restores the original para indent.
 354
 355 o Added new macro, BREAK_QUOTE, to deal with the problem of
 356   footnotes in quotes and blockquotes that cross pages or columns.
 357
 358   Quotes and blockquotes are read into diversions, which means they
 359   get their footnote information from the page/column on which they
 360   were started.  If a footnoted quote crosses a page/column, what
 361   sometimes happens is that the footnote itself is output at the
 362   bottom of page/column where the quote started, whereas the text
 363   marker for the footnote appears on the next page/column where the
 364   quote ends.  Furthermore, the text marker is the one appropriate
 365   to the previous page.  BREAK_QUOTE is a workaround.
 366
 367 o Added directory /examples to archive.
 368
 369 o Added typesetting_macros.mom, docprocessing_macros.mom, elvis_syntax
 370   and penguin_small2_bw.ps to /examples.
 371
 372 o Added BREAK_QUOTE to docs, made some additions to reserved words
 373   list, and corrected a few little doc errors.
 374
 375 *Mon Apr 22 2002
 376
 377 o Added default .L_MARGIN 1i and .R_MARGIN 1i to PAPER, PAGE, and
 378   PAGEWIDTH.  L_MARGIN is essential otherwise left indents and tabs
 379   don't have a register #L_MARGIN to work with.  The default right
 380   margin is a convenience only.  Updated the doc entries for L_MARGIN
 381   and R_MARGIN to reflect the change.
 382
 383 *Sun Apr 21 2002
 384
 385 o Changes to COLLATE:
 386
 387     - added some "resets" (LL, LS, QUAD)
 388     - added a check for whether pagination is at page top (either
 389       because FOOTERS are on or because PAGENUM_POS was user set).
 390       If pagination is on, and PAGENUM_POS is TOP, it's turned off
 391       for next page (start of next collated document) and restored
 392       for subsequent pages unless PAGENUM_ON_FIRST_PAGE is on, in
 393       which case the page number appears at page top.
 394
 395 o The macro TRAPS is always invoked at the end of DEFAULTS (which is
 396   called by START).  Formerly, TRAPS was only invoked at the start
 397   of a doc, not after COLLATE.  Now runs after COLLATE as well.
 398
 399 o Distance from $DOC_TYPE in DOCTYPE NAMED "<string>" to start of
 400   running text was one linespace too deep.  Fixed (in START).
 401
 402 o When 1st arg to PAGENUM_POS was user set to TOP, running text was
 403   printing 1 linespace too high, even when PAGINATION was OFF.  Same
 404   problem when HEADERS were OFF (i.e. nothing in the header margin at
 405   all).  Fixed by removing -\\n[#DOC_LEAD]u from all .sp |\\n[#T_MARGIN]u
 406   calls of .el portion after .ie \\n[#HEADERS_ON].
 407
 408 o Added new macro: PAGENUM_ON_FIRST_PAGE.  Normally, when FOOTERS are
 409   being used instead of HEADERS, mom doesn't print the page number at
 410   the top of the first page of a doc, or the first page of collated
 411   docs.  New macro allows user to get mom to put the page number on
 412   "first" pages if that's desired.  Updated docs to include the macro.
 413
 414 o More little fixes to docs.
 415
 416 *Thu Apr 18 2002
 417
 418 o Fixed TI (temporary indent) so that it continues to work as expected,
 419   even when called while another type of indent is in effect.
 420
 421 *Tue Apr 16 2002
 422
 423 o String tabs weren't working as advertised when set from within
 424   a tab.  Fixed.  Two new registers added: #ST_OFFSET and #IN_TAB.
 425   String tabs now behave poperly and intuitively when set within tabs.
 426
 427 o Added a note to docs about surrounding \w'...' escape with double-
 428   quotes when it's used as an argument to macros
 429
 430 o Added a note to docs that SILENT does not deposit a .br
 431
 432 *Mon Apr 15  2002
 433
 434 o Added new macro BR_AT_LINE_KERN if user wants mom to deposit .br's
 435   before .RW and/or .EW.
 436
 437 o Added 1/4 points to inline escapes \*[ALD] and \*[RLD].
 438
 439 o Added 1/4 points to inline escapes \*[FP] and \*[BP]
 440
 441 o Updated docs to reflect the above changes.
 442
 443 *Fri Apr 12 2002
 444
 445 o Fixed .RW and .EW which weren't working because of a missing \ in
 446   \\n(.f register.  Also made it so that .RW and .EW affect all fonts
 447   in positions 1, 2, 3, and 4 at once, hence line kerning now affects
 448   all fonts that appear after it, not just the font that was current at
 449   the time of the macros' invocation.
 450
 451 o .SS and .WS now working properly.  .WS no longer has any effect on
 452   .SS, which remains constant regardless of .WS.  Furthermore, .SS no
 453   longer gets its value by adding \*[$SS_VAR] + \n[.ss].  Instead,
 454   it remains constant.  Don't know what I was thinking when I wrote
 455   the routine in the first place.
 456
 457 o Updated and rewrote doc entry pertaining to SS
 458
 459 *Wed Apr 10 2002
 460
 461 o Renamed tmac.om to om.tmac to bring macro file's name into line
 462   with current groff policy
 463
 464 o Added more standard paper sizes to PAPER.
 465
 466 o Fixed T_MARGIN, LS, and AUTOLEAD so that if T_MARGIN is set before LS
 467   or AUTOLEAD at the top of a file, the first line of type falls
 468   properly on the baseline set by T_MARGIN.  Previously, LS and
 469   AUTOLEAD automatically advanced by the value passed to them before
 470   setting the first line of type, meaning that the first line of type
 471   fell at T_MARGINu+1v instead of T_MARGIN.
 472
 473 o Updated docs to reflect changes.
 474
 475 o Removed #TEST_FOR_NUMERIC from list of reserved words.
 476
 477 o Added "t" and #T_MARGIN_SET to list of reserved words.
 478
 479 *Sat Apr 6 2002
 480
 481 o Added FACTOR arg to AUTOLEAD, so if user wants autolead to be a factor
 482   of point size, instead of being the sum of pointsize + autolead, s/he
 483   has the choice.  Incorporated appropriate changes to PS and LS.
 484
 485 o Added new register #AUTOLEAD_FACTOR to reserved words.  Modified
 486   comments for AUTOLEAD, PS, and LS to reflect changes.  Also
 487   corrected an error where #AUTOLEAD_VALUE had mistakenly been written
 488   $AUTOLEAD_VALUE in comments in the macro file, and removed erroneous
 489   | <anything>.  Updated AUTOLEAD entry in momdoc/typesetting.html
 490   to reflect the changes.
 491
 492 *Wed Apr 3 2002
 493
 494 o Cleaned up html errors in the docs.
 495
 496 o Added "Next," "Prev" and "Top" links to top and bottom of doc files.
 497
 498 o Fixed some typos in the docs.