contrib/mom/BUGS

   1     Copyright 2004, 2005, 2006
   2       Free Software Foundation, Inc.
   3
   4     Copying and distribution of this file, with or without modification,
   5     are permitted in any medium without royalty provided the copyright
   6     notice and this notice are preserved.
   7
   8 Assume that anything that doesn't work or behaves oddly is a bug.
   9 The documentation should be taken as the authoritative source for
  10 how things ought to be.
  11
  12 Post to the groff mailing list with bug reports, questions and
  13 suggestions, or contact me directly at:
  14
  15     pschaffter@magma.ca
  16     or
  17     ptpi@golden.net
  18
  19 If writing me directly, please include the word "groff" or "mom" in
  20 the Subject line or you risk my spam filters nuking your message.
  21 Also, please--no html email.  That, too, gets nuked.
  22
  23 --Peter Schaffter
  24
  25 ========================================================================
  26 Version 1.5-a
  27 =============
  28 Indenting of references (collected with .REF) on endnotes pages when
  29 endnote numbers are right-aligned appears to be backwards; the
  30 first line of the reference is indented more than the second.
  31 ---Fixed---
  32
  33 Version 1.5
  34 ===========
  35 DROPCAP not printing the dropcap letter at all in PRINTSTYLE
  36 TYPEWRITE, nor when DROPCAP is used (accidentally?) after a legal
  37 "first" paragraph.
  38 ---FIXED---
  39
  40 DROPCAP going into an infinite loop when groff called with the
  41 -Tascii switch.
  42 ---FIXED---
  43
  44 SHIFT_LIST, when used anywhere but with a top-level list, is killing
  45 list indents for every list level *returned to* afterward.
  46 ---Fixed---
  47
  48 TOC page number for heads and subheads that get bumped to next page
  49 (because of .ne) off by 1.
  50 ---Fixed---
  51
  52 Moving backwards in nested lists not setting the proper indent.
  53 ---Fixed---
  54
  55 Default linebreak color missing in om.tmac.
  56 ---Fixed---
  57
  58 Some links in macrolist.html not pointing to html "name" owing to
  59 missing # in link names.
  60 ---Fixed---
  61
  62 Version 1.4-b
  63 =============
  64 Line lengths and indents not always being respected in LIST.
  65 ---Fixed---
  66
  67 CAPS OFF, called inline with \*[CAPS OFF] not working.
  68 (Added two new inlines, \*[UC] and \*[LC], to do the job.)
  69 ---Fixed---
  70
  71 When type is set after START but no docelement tag given, the
  72 expected family ($DOC_FAMILY) and font (R) are not in effect.
  73 ---Fixed---
  74
  75 When DOCTYPE is CHAPTER and .TITLE is omitted after .COLLATE, the
  76 title vanishes from page headers/footers.
  77 ---Fixed---
  78
  79 Version 1.4-a
  80 =============
  81 In collated documents, when using a different HEADER_FAMILY,
  82 if BLANKPAGE <n> is given after COLLATE (but before START) all
  83 subsequent text is set in the HEADER_FAMILY face rather than the
  84 standard text face.
  85 ---Fixed---
  86
  87 Document title identification string missing on endnotes pages when
  88 the endnote marker style is LINE.
  89 ---Fixed---
  90
  91 Space between endnote items on endnotes output pages not being
  92 inserted.
  93 ---Fixed---
  94
  95 Version 1.4
  96 ===========
  97 Invoking .FOOTERS isn't automatically putting pagination in the top
  98 margin.
  99 ---Fixed---
 100
 101 .PP_FONT after .COLLATE not being respected.
 102 ---Fixed---
 103
 104 $SAVED_PP_FT not being fed to .FT in .PP after .COLLATE
 105 ---Fixed---
 106
 107 .CODE OFF not always restoring previous family and font.
 108 ---Fixed---
 109
 110 .ITEM, when not in a list, should do nothing.
 111 ---Fixed---
 112
 113 Version 1.3-e_3
 114 ===============
 115 ENDNOTES is not, by default, printing headers on endnotes pages.
 116 ---Fixed---
 117
 118 Processing of the "Endnotes" title for the TOC is putting the
 119 page number 1 line too high and not inserting leader.
 120 ---Fixed---
 121
 122 Collated docs not respecting $PP_FT (it's picking up the font from
 123 the pagenumber font)
 124 ---Fixed---
 125
 126 Docheader spacing sometimes depositing too much space between
 127 various docheader elements in TYPEWRITE when DOCTYPE is DEFAULT or
 128 NAMED.
 129 ---Fixed---
 130
 131 When COLUMNS are on, subheads that are deferred to the next
 132 column/page because there isn't enough room for the s/h and one
 133 line of text are causing columns to overprint.
 134 ---Fixed---
 135
 136 HDRFTR_LEFT printing one line too high when .HEADER_COLOR is used.
 137 ---Fixed---
 138
 139 DOCTITLE link broken in the docs.
 140 ---Fixed---
 141
 142 Version 1.3-e_2
 143 ===============
 144 TOC formatting incorrect when the pound/number sign (#) is used in
 145 head elements.
 146 ---Fixed---
 147
 148 [Documentation]: The docs erroneously state that TOC control macros
 149 can be entered anywhere in a file prior to invoking TOC (they should
 150 be entered before START).
 151 ---Fixed---
 152
 153 Page numbers in the bottom margin being printed too low on output
 154 pages preceding an invocation of COLLATE or macros that call it.
 155 ---Fixed---
 156
 157 A superfluous blank, numbered page is being generated by COLLATE
 158 (and macros that call it, namely TOC and ENDNOTES) when the last
 159 line of output text before it falls on the last valid baseline of
 160 an output page.  Same thing happening occasionally with normal
 161 document termination.
 162 ---Fixed---
 163
 164 SHIFT_LIST not being observed when moving *back* to a shifted list;
 165 the list is reverting to the left margin.
 166 ---Fixed---
 167
 168 NUMBER_SUBHEADS not working with TYPESET when PARA_SPACE is on.
 169 ---Fixed---
 170
 171 Version 1.3-e_1
 172 ===============
 173 Missing #COLLATE register (accidentally wiped out) creating various
 174 problems with .COLLATE (missing headers, leading increasing
 175 slightly each time .COLLATE invoked, etc).
 176 ---Fixed---
 177
 178 Version 1.3-e
 179 =============
 180 mom failing during groff build while processing
 181 examples/typesetting.mom
 182 ---Fixed---
 183
 184 Windows user reports COLLATE fails with a bottom margin error
 185 (generated by mom).
 186 ---Fixed---
 187
 188 Version 1.3-d
 189 =============
 190 Small error in the examples of output in the "Footnotes and
 191 Punctuation" documentation section.
 192 ---Fixed----
 193
 194 PAD_LIST_DIGITS/SHIFT_LIST broken when the enumerator type is
 195 roman or ROMAN.
 196 ---Fixed---
 197
 198 COLLATE wiping out <doc element>_FAMILY settings.
 199 ---Fixed---
 200
 201 DOC_LEAD_ADJUST OFF not being observed when COLLATE is invoked.
 202 ---Fixed---
 203
 204 DROPCAP setting the dropcap too high in initial paragraph after a
 205 COLLATE.
 206 ---Fixed---
 207
 208 Version 1.3-c
 209 =============
 210 Owing to a superfluous "if" in the FONT macro, the "missing font"
 211 routine is being silently ignored.
 212 ---Fixed---
 213
 214 FOOTNOTE, used in nofill mode, adds a linebreak between the
 215 marker and the text of the footnote.
 216 ---Fixed---
 217
 218 Version 1.3-b
 219 =============
 220
 221 ITALIC_MEANS_ITALIC not being respected when DOCTYPE LETTER.
 222 ---Fixed---
 223
 224 Underlining of italic passages in PRINTSTYLE TYEPWRITE not spanning
 225 pages.
 226 ---Fixed---
 227
 228 PRINTSTYLE TYPEWRITE depositing extra space on new pages above quotes
 229 that span pages.
 230 ---Fixed---
 231
 232 MN doesn't accept OFF, QUIT, END, X, etc.
 233 ---Fixed---
 234
 235 Margin notes that begin flush with the last line of text on a page
 236 are running down the same page, instead of the remainder being
 237 collected and output on the next.
 238 ---Fixed---
 239
 240 MN sometimes erroneously dropping margin notes near the bottom of
 241 a page, even when they'd fit.  (MN-shifted not being removed by
 242 MN-top.)
 243 ---Fixed---
 244
 245 MN_INIT not accepting "" args for default values.
 246 ---Fixed---
 247
 248 Documentation for margin notes erroneously states that the first
 249 (optional) argument can be either "ragged" or "symmetric".  S/b
 250 "RAGGED" or "SYMMETRIC".
 251 ---Fixed---
 252
 253 Use of "" to tell MN_INIT to use the default for any specific
 254 argument in the arg list broken.
 255 ---Fixed---
 256
 257 Paragraphs that begin with a "smart" double quote when the
 258 preceding paragraph has no corresponding close quote (i.e. dialogue
 259 passages containing multiple paragraphs) are starting off with a
 260 close quote.
 261 ---Fixed---
 262
 263 Version 1.3-a
 264 =============
 265
 266 First baseline of type isn't going where it's supposed to when the
 267 docheader is turned off.
 268 ---Fixed---
 269
 270 Version 1.3
 271 ===========
 272
 273 Persistent error in html coding of docs (<nobr> tag).
 274 ---Fixed---
 275
 276 Version 1.2-f
 277 ============
 278
 279 Multiple line subheads near page bottom sometimes printing one line
 280 of subhead at page bottom, and subsequent lines on next page.
 281 ---Fixed---
 282
 283 Post-quote spacing still wonky when paragraph spacing is turned on.
 284 ---Fixed--- (for good would be nice)
 285
 286 RULE not always resetting quad and quad value.
 287 ---Fixed---
 288
 289 Version 1.2-e
 290 =============
 291
 292 Some string definitions in om.tmac had superfluous spaces after
 293 them (e.g. $COVERTITLE).
 294 ---Fixed---
 295
 296 Spacing under quotes not correct when paragraph spacing is turned
 297 on.
 298 ---Fixed---
 299
 300
 301 First word of last line before footnotes is getting chopped.
 302 ---Fixed---
 303
 304 Version 1.2-d
 305 =============
 306
 307 HEADER_FAMILY not changing header family.
 308 ---Fixed---
 309
 310 FAMILY, after COLLATE, not changing the family of all and every
 311 page element or tag.
 312 ---Fixed---
 313
 314 Heads and subheads at the start of docs are printing one line lower
 315 than they should.
 316 ---Fixed---
 317
 318 Gaps are appearing at the bottom of pages when there's a linebreak
 319 followed by a subhead.
 320 ---Fixed---
 321
 322 When LS is invoked after a single text line at the top of a page
 323 containing a T_MARGIN (set with T_MARGIN or PAGE), mom is performing
 324 spacing adjustments as if the first line doesn't exist.
 325 ---Fixed---
 326
 327 Changes made to ALD and LS in version 1.2-c should not apply when
 328 the document processing macros are used.  There is a significant
 329 conflict with the internal use of ALD when the docheader is only
 330 one line long (as, for example, when DOCTYPE is CHAPTER).
 331 ---Fixed, pending discovery of further conflicts---
 332
 333 Version 1.2-c
 334 =============
 335
 336 Deferred footnotes not always being output, and groff complains
 337 "ending diversion FN_OVERFLOW on exit."
 338 ---Fixed---
 339
 340 First .LS call after a top margin has been set (with .T_MARGIN
 341 or .PAGE) causing mom to move off the top margin baseline.  Also,
 342 there are conflicts between ALD, LS and T_MARGIN.
 343 ---Fixed---
 344
 345 DROPCAP not properly restoring a running \*[COND] or \*[EXT] after
 346 COND or EXT are given as arguments to DROPCAP.
 347 ---Fixed---
 348
 349 Version 1.2
 350 ===========
 351
 352 .PAD not co-operating with mom's fontstyles, esp. when a full
 353 family+fontstyle is given to .FT.
 354 ---Fixed---
 355
 356 .DROPCAP -- ditto the above.
 357 ---Fixed---
 358
 359 Version 1.1.9
 360 =============
 361
 362 Footnote markers not resetting properly on new pages when COLUMNS
 363 is enabled.
 364 ---Fixed---
 365
 366 When overflowed footnote material is the only footnote material on
 367 the page or in the column, no footnotes are output.
 368 ---Fixed---
 369
 370 The AUTOLEAD used in FOOTNOTE not being disabled after FOOTNOTES
 371 are output, or after PROCESS_FN_LEFTOVER/PROCESS_FN_IN_DIVER.
 372 ---Fixed---
 373
 374 COL_NEXT and COL_BREAK, when invoked during the last column on a
 375 page, are overprinting the last column instead of breaking to a new
 376 page when there are footnotes in the column.
 377 ---Fixed---
 378
 379 BR_AT_LINE_KERN not "break-and-spreading" text when used in
 380 justified copy.
 381 ---Fixed---
 382
 383 Version 1.1.8
 384 =============
 385
 386 BLOCKQUOTE_FAMILY not changing blockquote family.
 387 ---Fixed---
 388
 389 FOOTNOTE, whether in column mode or not, was using
 390 #FN_COUNT_FOR_COLS for all footnote markers and handling.
 391 ---Fixed---
 392
 393 Deferred footnotes that occured on the second to last page of
 394 documents not printing.
 395 ---Fixed---
 396
 397 Version 1.1.7-a
 398 ===============
 399
 400 Suite number in DOCTYPE LETTER not printing.
 401 ---Fixed---
 402
 403 Footer elements not always vertically aligning.
 404 ---Fixed---
 405
 406 Footer rule gap not always correctly observed.
 407 ---Fixed---
 408
 409 Page numbering, when at top of page, not always falling on
 410 HDRFTR_MARGIN.
 411 ---Fixed---
 412
 413 Default page numbering style for COPYSTYLE draft is DIGIT instead
 414 of roman.
 415 ---Fixed---
 416
 417 Hyphens around page numbering when style is DIGIT, ROMAN or ALPHA
 418 not vertically centered.
 419 ---Fixed---
 420
 421 EXT arg not working with DROPCAP.
 422 ---Fixed---
 423
 424 DOC_QUAD not automatically set immediately after START
 425 ---Fixed--
 426
 427 Tabs behaving erratically during document processing.
 428 ---Fixed---
 429
 430 Version 1.1.7
 431 =============
 432
 433 When DOCHEADER OFF <distance> is given, if <distance> falls short
 434 of the top margin of running text, <distance> is not respected and
 435 bottom margin falls low.
 436 ---Fixed---
 437
 438
 439 Version 1.1.6-e
 440 ===============
 441
 442 The " mark (doublequote), when entered while not in document
 443 processing mode (i.e. just straightforward typesetting), outputs
 444 nothing unless SMARQUOTES is invoked explicitly.
 445 ---Fixed---
 446
 447 Version 1.1.6-c
 448 ===============
 449
 450 In document processing mode, docs that use *none* of the
 451 docprocessing tags being ignored.
 452 ---Fixed---
 453
 454 Version 1.1.6-b
 455 ===============
 456
 457 String tabs not picking up #L_MARGIN when #L_MARGIN not explicitly
 458 set with L_MARGIN, PAPER or PAGE.
 459 ---Fixed---
 460
 461 Infinite loop when B_MARGIN is set lower than FOOTER_MARGIN during
 462 doc processing.
 463 ---Fixed---
 464
 465 Version 1.1.6-a
 466 ===============
 467
 468 Mom partially broken when run with groff 1.19.1.  Don't know yet
 469 what this is, whether bad coding in mom, or a problem with 1.19.1.
 470 Only solution for now: run mom 1.1.6 with groff 1.18.
 471 ----Fixed---
 472
 473 Top margin of endnotes pages after the first endnotes page when
 474 PRINTSTYLE is TYPEWRITE and endnotes single-spacing is turned on
 475 falling one line too high.
 476 ---Fixed---
 477
 478 Version 1.1.6
 479 =============
 480
 481 DOCHEADER OFF (distance) not being respected.
 482 ---Fixed---
 483
 484 FINIS killing ENDNOTES page numbering and heads.
 485 ---Fixed---
 486
 487 Version 1.1.5
 488 =============
 489
 490 Draft and revision not appearing in page headers.
 491 ---Fixed---
 492
 493 \*[RULE] not working properly with indents and justified copy.
 494 ---Fixed---
 495
 496 Post-epigraph spacing in TYPEWRITE causing some first pages to run too
 497 deep.
 498 ---Fixed---
 499
 500 Spacing of docheaders in TYPEWRITE not always consistent.
 501 ---Fixed---
 502
 503 Version 1.1.4
 504 =============
 505
 506 Blockquotes that span pages running too deep.
 507 ---Fixed---
 508
 509 Version 1.1.3
 510 =============
 511
 512 Footnotes not outputting on final page of document body when ENDNOTES
 513 is invoked.
 514 ---Fixed---
 515
 516 Pad not working properly and/or spitting out warnings when fill mode is
 517 on.
 518 ---Fixed---
 519
 520 Version 1.1.2
 521 =============
 522
 523 PAGENUM_STYLE being ignored unless entered after START.
 524 ---Fixed---
 525
 526 Version 1.1
 527 ===========
 528
 529 String tabs not working as advertised when set from within other tabs.
 530 ---Fixed---
 531
 532 .COLLATE sometimes depositing a header on the first page of a subsequent doc.
 533 ---Fixed with workaround BREAK_QUOTE---
 534
 535 .UNDERLINE_QUOTES in PRINTSTYLE TYPEWRITE not on by default as advertised.
 536 ---Fixed---
 537
 538 .TI not cooperating with other indent styles.
 539 ---Fixed---
 540
 541 .WS and .SS not cooperating.
 542 ---Fixed---
 543
 544 .RW and .EW not working.
 545 ---Fixed---
 546
 547 ========================================================================
 548
 549 KNOWN PROBLEMS
 550 --------------
 551
 552 The indent macros from the typesetting macro set may not always
 553 perform well in conjunction with the document processing macros,
 554 especially when documents are set in columns.  Mostly, this is the
 555 result of inadequate testing.  There are only so many "who'd want to
 556 do this anyway?" scenarios I can think of on my own.
 557
 558 Epigraphs at the bottoms of page may sometimes run exactly one line
 559 deeper than they should.  The alternative (from my point of view) is
 560 to have them run 1 line shorter than they should.  The problem stems
 561 from the fact the epigraphs are leaded differently than all other text,
 562 and there's only so much adjusting that can be done with the whitespace
 563 surrounding them to get them to bottom align.  Since stylistically,
 564 epigraphs should never appear at the bottom of a page/column without at
 565 least some running text beneath them in order to make sense of the role
 566 they play in page layout, this not likely to be fixed for some time.
 567