Import of mom
[s-roff.git] / contrib / mom / ChangeLog
blob2bb583fcdd790110b5eab9738656170cbaf8d7b3
1 *Thu May 23 2002
3 o Applied two small bug fixes to om.tmac (patches 1.1.1a and 1.1.1b).
5 o mom is now part of groff.
7 o Some renaming to avoid problems with 8+3 filesystems:
9     examples/docprocessing_typeset.mom   -> examples/typeset.mom
10     examples/docprocessing_typewrite.mom -> examples/typewrite.mom
11     examples/typesetting_macros.mom      -> examples/macros.mom
12     examples/penguin_small2_bw.ps        -> examples/penguin.ps
14 o Removed `INSTALL' and `README' since groff takes care of installation
15   now.
17 o Added Makefile.sub.
19 o Added mom.tmac (which simply calls om.tmac).
21 o Added groff_mom.man for orthogonality; it simply points to the HTML
22   documentation.
24 *Sat Apr 27 2002
26 o Renamed docprocessing_macros.mom in /examples to
27   docprocessing_typeset.mom.  Added docprocessing_typewrite.mom, as
28   well as a README file.
30 o Fixed UNDERLINE_QUOTES (for PRINTSTYLE TYPEWRITE) so they really are
31   on by default as the docs say.
33 o Changes to doc entry on COLLATE:
35     - removed bit about using COLLATE after a cover page (I wrote the
36       entry *before* I wrote the macro!).  Cover pages should be
37       followed by NEWPAGE, not COLLATE.
39     - added caution about mixing PRINTSTYLEs
41     - added caution about using DOC_FAMILY to change family of all
42       document elements after COLLATE
44 o Made HEADER_SIZE (and, by extension, FOOTER_SIZE) available to
45   PRINTSTYLE TYPEWRITE.  Changed appropriate doc entries to reflect
46   this.
48 *Wed Apr 24 2002
50 o Small change to DO_QUOTE to correct a problem with quotes and
51   blockquotes that fall in the middle of paragraphs (i.e. text after
52   the quote is not a new para).  Basically, added a bit that stores the
53   current para indent, sets para indent to 0, invokes a PP, then
54   restores the original para indent.
56 o Added new macro, BREAK_QUOTE, to deal with the problem of
57   footnotes in quotes and blockquotes that cross pages or columns.
59   Quotes and blockquotes are read into diversions, which means they
60   get their footnote information from the page/column on which they
61   were started.  If a footnoted quote crosses a page/column, what
62   sometimes happens is that the footnote itself is output at the
63   bottom of page/column where the quote started, whereas the text
64   marker for the footnote appears on the next page/column where the
65   quote ends.  Furthermore, the text marker is the one appropriate
66   to the previous page.  BREAK_QUOTE is a workaround.
68 o Added directory /examples to archive.
70 o Added typesetting_macros.mom, docprocessing_macros.mom, elvis_syntax
71   and penguin_small2_bw.ps to /examples.
73 o Added BREAK_QUOTE to docs, made some additions to reserved words
74   list, and corrected a few little doc errors.
76 *Mon Apr 22 2002
78 o Added default .L_MARGIN 1i and .R_MARGIN 1i to PAPER, PAGE, and
79   PAGEWIDTH.  L_MARGIN is essential otherwise left indents and tabs
80   don't have a register #L_MARGIN to work with.  The default right
81   margin is a convenience only.  Updated the doc entries for L_MARGIN
82   and R_MARGIN to reflect the change.
84 *Sun Apr 21 2002
86 o Changes to COLLATE:
88     - added some "resets" (LL, LS, QUAD)
89     - added a check for whether pagination is at page top (either
90       because FOOTERS are on or because PAGENUM_POS was user set).
91       If pagination is on, and PAGENUM_POS is TOP, it's turned off
92       for next page (start of next collated document) and restored
93       for subsequent pages unless PAGENUM_ON_FIRST_PAGE is on, in
94       which case the page number appears at page top.
96 o The macro TRAPS is always invoked at the end of DEFAULTS (which is
97   called by START).  Formerly, TRAPS was only invoked at the start
98   of a doc, not after COLLATE.  Now runs after COLLATE as well.
100 o Distance from $DOC_TYPE in DOCTYPE NAMED "<string>" to start of
101   running text was one linespace too deep.  Fixed (in START).
103 o When 1st arg to PAGENUM_POS was user set to TOP, running text was
104   printing 1 linespace too high, even when PAGINATION was OFF.  Same
105   problem when HEADERS were OFF (i.e. nothing in the header margin at
106   all).  Fixed by removing -\\n[#DOC_LEAD]u from all .sp |\\n[#T_MARGIN]u
107   calls of .el portion after .ie \\n[#HEADERS_ON].
109 o Added new macro: PAGENUM_ON_FIRST_PAGE.  Normally, when FOOTERS are
110   being used instead of HEADERS, mom doesn't print the page number at
111   the top of the first page of a doc, or the first page of collated
112   docs.  New macro allows user to get mom to put the page number on
113   "first" pages if that's desired.  Updated docs to include the macro.
115 o More little fixes to docs.
117 *Thu Apr 18 2002
119 o Fixed TI (temporary indent) so that it continues to work as expected,
120   even when called while another type of indent is in effect.
122 *Tue Apr 16 2002
124 o String tabs weren't working as advertised when set from within
125   a tab.  Fixed.  Two new registers added: #ST_OFFSET and #IN_TAB.
126   String tabs now behave poperly and intuitively when set within tabs.
128 o Added a note to docs about surrounding \w'...' escape with double-
129   quotes when it's used as an argument to macros
131 o Added a note to docs that SILENT does not deposit a .br
133 *Mon Apr 15  2002
135 o Added new macro BR_AT_LINE_KERN if user wants mom to deposit .br's
136   before .RW and/or .EW.
138 o Added 1/4 points to inline escapes \*[ALD] and \*[RLD].
140 o Added 1/4 points to inline escapes \*[FP] and \*[BP]
142 o Updated docs to reflect the above changes.
144 *Fri Apr 12 2002
146 o Fixed .RW and .EW which weren't working because of a missing \ in
147   \\n(.f register.  Also made it so that .RW and .EW affect all fonts
148   in positions 1, 2, 3, and 4 at once, hence line kerning now affects
149   all fonts that appear after it, not just the font that was current at
150   the time of the macros' invocation.
152 o .SS and .WS now working properly.  .WS no longer has any effect on
153   .SS, which remains constant regardless of .WS.  Furthermore, .SS no
154   longer gets its value by adding \*[$SS_VAR] + \n[.ss].  Instead,
155   it remains constant.  Don't know what I was thinking when I wrote
156   the routine in the first place.
158 o Updated and rewrote doc entry pertaining to SS
160 *Wed Apr 10 2002
162 o Renamed tmac.om to om.tmac to bring macro file's name into line
163   with current groff policy
165 o Added more standard paper sizes to PAPER.
167 o Fixed T_MARGIN, LS, and AUTOLEAD so that if T_MARGIN is set before LS
168   or AUTOLEAD at the top of a file, the first line of type falls
169   properly on the baseline set by T_MARGIN.  Previously, LS and
170   AUTOLEAD automatically advanced by the value passed to them before
171   setting the first line of type, meaning that the first line of type
172   fell at T_MARGINu+1v instead of T_MARGIN.
174 o Updated docs to reflect changes.
176 o Removed #TEST_FOR_NUMERIC from list of reserved words.
178 o Added "t" and #T_MARGIN_SET to list of reserved words.
180 *Sat Apr 6 2002
182 o Added FACTOR arg to AUTOLEAD, so if user wants autolead to be a factor
183   of point size, instead of being the sum of pointsize + autolead, s/he
184   has the choice.  Incorporated appropriate changes to PS and LS.
186 o Added new register #AUTOLEAD_FACTOR to reserved words.  Modified
187   comments for AUTOLEAD, PS, and LS to reflect changes.  Also
188   corrected an error where #AUTOLEAD_VALUE had mistakenly been written
189   $AUTOLEAD_VALUE in comments in the macro file, and removed erroneous
190   | <anything>.  Updated AUTOLEAD entry in momdoc/typesetting.html
191   to reflect the changes.
193 Release 1.1
194 -----------
196 *Wed Apr 3 2002
198 o Cleaned up html errors in the docs.
200 o Added "Next," "Prev" and "Top" links to top and bottom of doc files.
202 o Fixed some typos in the docs.