contrib/groff/contrib/mom/ChangeLog

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