Debian Codegraph @

texmf-dist/doc/latex/memoir/README

raw
1 Memoir is a flexible class for typesetting poetry, fiction,
2 non-fiction and mathematical works as books, reports, articles or
3 manuscripts. Documents can use 9pt, 10pt, 11pt, 12pt, 14pt, or 17pt as the
4 normal fontsize and, if you have scalable fonts, 20pt, 25pt, 30pt, 36pt,
5 48pt, or 60pt sizes, or even larger. Many methods are provided to let
6 you create your particular design. The class incorporates over 30 of the
7 more popular packages.
8
9 IF YOU HAVE ANY QUESTIONS PLEASE ASK THEM ON TEX.STACKEXCHANGE.COM
10 (PLEASE USE THE MEMOIR TAG) OR BY EMAIL TO THE MAINTAINER.
11 PLEASE ADD MEMOIR TO THE SUBJECT.
12
13 PLEASE DON'T WRITE PETER DIRECTLY AS HE IS AWAY MORE OFTEN THAN
14 NOT.
15
16 Lars Madsen <[email protected]> is maintaining memoir.
17
18
19 WORD OF ADVISE: It is not recommended to manually update memoir into
20 an old LaTeX installation. Not all changes are compatible with older
21 un-updated LaTeX systems and we often make no attempt to be backwards
22 compatible. Instead we assume that users use updated memoir with an
23 updated LaTeX installation.
24
25 Changes (2025/11/04)
26
27 o memoir v3.8.4b
28
29 -- There was a mistake in the manner we build the manual for release,
30 thus the references where missing. Now fixed. Reported via private
31 email.
32
33
34 Changes (2025/10/02)
35
36 o memoir v3.8.4
37
38 -- bumped required kernel to 2023/06/01
39
40 -- general cleanup
41
42 -- When creating \immediateaddtocontents we copy and patch
43 \addtocontents, with 2025 kernel the second patch failed due to
44 updated kernel code, now back in line whenever the new macro used
45 exists
46
47 -- removed reference to obsolete subfigure package, replaced with
48 reference to subcaption.
49
50 -- remembered to redefine \addtopsmarks as it was using a macro now
51 deprecated
52
53 -- fixed typo in \m@m@makecoltext that caused \enlargethispage to
54 malfunction. Reported in
55 https://tex.stackexchange.com/q/747571/3929
56
57 -- changed \bookrefname, \partrefname and \appendixrefname to use
58 \bookname, \partname and \appendixname instead of being hardcoded.
59 Suggested in private email
60
61 -- marked \fref, \tref, \pref, \Aref, \Bref, \Pref, \Cref, \Sref as
62 deprecated encouraging users to define their own version in the
63 preamble. Too many packages these days provide referencing macros,
64 general use classes should not.
65
66 Any use of them will now give a warning, encouraging the user to
67 define the macro in their preamble instead.
68
69 -- added \settitlingpagenumbering and adjusted the titlingpage env
70 such that inside it \thepage uses the formatting macro set via
71 \settitlingpagenumbering (it expects a macro to format the presence
72 of a counter).
73
74 The main use is \settitlingpagenumbering{\Alph} when using hyperref
75 in order to get rid of a duplicate destination warning caused by
76 the titlingpage env.
77
78 -- \createplainmark simplified via Expl3
79
80 -- dropped the use of the textcase package as the functionality is now
81 in the kernels \MakeUppercase and \MakeLowercase macros. We provide
82 \MakeTextUppercase and \MakeTextLowercase as aliases unless
83 textcase is manually loaded by the user.
84
85 Internally we reverted back to using \MakeUppercase and
86 \MakeLowercase.
87
88 -- \settocpreprocessor marked deprecated as the problem it was addes
89 to solve (upper/lower casing toc entries), is now fixed in the
90 \MakeUppercase and \MakeLowercase macros provided by the kernel.
91
92 -- Fixed typo in \cftbookbreak
93
94 -- copied a feature from book.cls where \chapter writes
95 \chaptername/\appendixname plus number to the log.
96
97 Felt like a nice debugging tool.
98
99 -- replaced all uses of \phantomsection with more suitable
100 \MakeLinkTarget's
101
102 -- added suitable \MakeLinkTarget to \book, \part and \chapter when
103 ever they are used and there is not \refstepcounter involved (aka
104 say \chapter* or within \frontmatter). This is required on the road
105 to supporting tagging.
106
107 -- the overwriting of \@xsect changed to a patch
108
109 -- fixed issues with \cftaddtitleline and cftaddnumtitleline
110
111 -- Removed email addresses of issue/suggestion reporters from the
112 sources. Seemed like an invasion of privacy to keep them from 20+
113 years ago.
114
115 -- fixed issue with \bitwonumcaption which caused duplicate target
116 warning when used with hyperref.
117
118 -- fixed a bug in \subcaption and friends initially reported here:
119 https://github.com/latex3/latex2e/issues/1861
120
121 Ulrikes proposed solution simplifies our code a lot, and removes a
122 \let\label... which is a dangerous construction nowadays.
123
124 As a consequence the allowed \label syntax of \label(bookmark}{key}
125 inside \subcaption and friends has been discontinued.
126
127 -- additions to \end@float and \end@dblfloat changed to cmd-before
128 hooks.
129
130 -- adjusted \subtop and \subbottom such that \label inside contents
131 works, not just as part of subtitle.
132
133 Plan to rework these two a bit more in 3.8.5
134
135
136 o memhfixc v1.24
137
138 -- some old code removed
139
140 -- \@sbook adjusted to look more like the current hyperref version of
141 \@spart.
142
143 -- added \bookautorefname for more languages
144
145
146 Changes (2025/03/10)
147
148 o memoir v3.8.3b
149
150 -- there was a bug in how \mem@cft@vspace@cmd was used inside
151 \newlistentry, so it would fail if we used
152 \setcftvspacecmd{\addvspace} in a document that had, say,
153 \tableofcontents and \section. This should now be fixed.
154
155 Reported in private email.
156
157
158 Changes (2025/03/06)
159
160 o memoir v3.8.3
161
162 -- A few places we loaded package using \usepackage, now changed to
163 \RequirePackage. Plus under very large font sizes, don't auto load
164 `fontenc` under Xe- and LuaLaTeX.
165
166 -- Has started marking some macros and envs as deprecated, to be
167 removed at a later date (2026). Each will give a warning at their
168 first use. The macros/envs include:
169
170 -- \addtodef(*), \addtoiargdef(*) and \patchcommand They have better
171 alternatives in the etoolbox and xpatch packages (which we already
172 load). Additionally these macros does not preserve robustness, the
173 macros from xpatch does.
174
175 -- \newloglike, \provideloglike
176 Users should use \DeclareMathOperator from amsopn (amsmath)
177
178
179 -- The redefinitions of \title, \author, \date, \thanks now done via
180 \xpretocmd and \xapptocmd instead of \addtoiargdef which did not
181 preserve robustness.
182
183 -- The provided code for \counterwithin/out and \@removefromreset has
184 fininally been removed. All three macros have been in the
185 LaTeX-kernel since 2018.
186
187 -- Internal code cleanup regarding macros that are not used
188
189 -- Reimplemented how verse numbers are added thus fixing
190 <https://tex.stackexchange.com/q/609802/3929>
191
192 This is a slight change in behavior, as now line numbers are always
193 added at the start of the line and not the end. Old implementation
194 added the numbers at the end, and thus they are aligned with the
195 last line of a line broken line.
196
197 -- Changed the implementation for \cftinserthook. It can have some
198 ordering issuses when \include is used, \cftinserthook* should now
199 help.
200
201 Note that it may force a \clearpage so should only be used between
202 \include's
203
204 -- Changed \settocdepth in a similar fashion to \cftinserthook.
205
206 -- Memoir will now warn if the fancyhdr package is loaded. Users
207 should use the build in interface instead.
208
209 Additionally warn against titlesec and titlepos
210
211 -- Chose different defaults for \partmark and \bookpagemark.
212
213 Problem reported in <https://tex.stackexchange.com/q/737771/3929>
214
215 -- Breaking change: Changed the code for the "article" chapter
216 style. \chapterheadstart was changed to use \addvspace (like
217 \section) instead of \vspace. This will lead to a (small) difference in
218 vertical spacing when the "article" chapter style is used, fx under
219 the "article" class option.
220
221 Problem reported in <https://tex.stackexchange.com/q/732129/3929>
222
223 -- changed \cftchapterbreak so it now also contains the vertical skip
224 (similar to what \part and book does). Unsure why it did not
225 already
226
227 Note that this may affect existing documents if users have
228 redefined \cftchapterbreak in order to change the penalty
229
230 -- refactored \cftbookbreak, \cftpartbreak and \cftchapterbreak such
231 that the penalty used is now configurable as \cftbeforebookpenalty,
232 \cftbeforepartpenalty and \cftbeforechapterpenalty.
233
234 They all have the same default value of -\@highpenalty
235
236 -- In \cftchapterbreak and in all toc entries generated by
237 \newlistentry the macro that executes \cftbeforeXskip has now been
238 factored out into a macro that can be set using
239
240 \setcftvspacecmd{\macro}
241
242 The default is still \vskip, but users might want to change it to
243 \addvspace for new documents.
244
245 Issue reported in private email.
246
247 One can argue that \addvspace would be the best choice going
248 forward, but this also means slightly shifting upwards the first
249 page of the toc for all memoir docs that uses \tableofcontents. For
250 now this has been deemed undesirable.
251
252 -- no longer load the mparhack package in twocolumn mode. There are
253 packages there are incomparible with it, thus better for the user
254 to explicitly load it themself if they need it.
255
256 Issue reported in private email.
257
258
259 o memhfixc v1.23
260
261 -- renamed Hpagenote counter to mem@Hpagenote to avoid hyperef warning.
262
263 -- added \bookautorefname support for french, requested in private email.
264
265
266
267 Changes (2024/01/26)
268
269 o memoir v3.8.2
270
271 -- In v3.8 I forgot to add some internal testing code related to
272 \@startsection. The code experiment has now been added, but is not
273 enabled by default.
274
275 -- Axel Sommerfeldt suggested a useful macro abstraction for
276 sidecaption and sidecontcaption that simplifies his adjustments
277 whenever the caption package is loaded.
278
279 -- Fixed a small (but important) typo in my maintainers note (Peter started
280 memoir in 2001, not 2021)
281
282 -- The Nov-2023 kernel update gave issued with our version of \verb.
283 Now fixed by un-embedding the verbatim package. Issue first
284 reported by Andrew Swann.
285
286 -- Fixed a typo in \m@make@footnotetext where ##1 got interpreted as a
287 macro name, not contents. Reported by Richard Zach.
288
289 -- Replaced the embedded copy of the shortvrb package by loading the
290 package instead.
291
292 -- Replaced the embedded and modified copy of the verbatim package by
293 just loading the package.
294
295 Have chosen to *not* patch in the modification back in. Primarily
296 because they are (1) disabled by default, (2) unknown how many
297 users actually use them, (3) the implementation had errors.
298
299 \setverbatimfont and the system to make comment-like envs of course
300 stayed.
301
302 The features removed are
303
304 - marking tabs using several spaces
305 - wrapping webatim text at white space
306
307 Macros disabled
308
309 - \tabson (\tabsoff redef to do nothing)
310 - \wrappingon (\wrappingoff redef to do nothing)
311
312 No longer used
313
314 - \verbatimbreakchar
315 - \verbatimindent
316
317 Removing the embedded verbatim copy also fixes the issue with
318 \verb+a b+ behaving like \verb*+a b+.
319
320 Many of the other verbatim-like creations have had tabs support
321 removed
322
323 -- In verbatim 1.5x the macro \verbatiminput* has been altered
324 slightly such that it also marks tabs as spaces (just like \verb*
325 now also does via a kernel update). If 1.5x has not been released
326 yet, we automatically apply that patch.
327
328 -- Updated \readverbatim* with the same patch as \verbatiminput* so it
329 also marks tabs as spaces.
330
331
332
333 o memhfixc v1.22
334
335 -- The change Axel S. suggested in memoir removes the need for
336 memhfixc to redefine \endsidecaption and \endsidecaption, thus
337 those redefinitions have been removed.
338
339
340 Changes (2023/08/21)
341
342 o memoir v3.8.1
343
344 -- The new additions to \@xfloat via AddToHook is too fragile (the
345 float package changes \@xfloat in an incompatible way). We've moved
346 the additions to the \@floatboxreset.
347
348
349 Changes (2023/08/14)
350
351 o memoir v3.8a
352
353 -- forgot to enable the announced stop if the LaTeX format is to old.
354 -- updated the bibliography to more recent years.
355
356 Changes (2023/08/08)
357
358 o memoir v3.8
359
360 -- now requires a LaTeX format from 2021/06/01 or newer.
361
362 The class will halt compilation (in all interaction modes) if the
363 format is too old.
364
365 -- \titleref is now an alias for \nameref (autoloaded).
366 The class have been adjusted to provide info for sectionals and
367 normal captions.
368
369 The titleref package will remain marked as being emulated
370 as it shouldn't be used with the class (and haven't been updated in
371 20+ years).
372
373 -- nameref paches in the class are no longer needed
374
375 -- label handling for subcaptions and friends have been reimplemented.
376
377 -- no longer re-defines \label as per request of the LaTeX Team.
378
379 -- booktabs is now loaded as a required package instead of being
380 embedded
381
382 -- Fixed typo in the caption of figure 2.13. Thanks to Vladimir
383 G. Ivanović for the report.
384
385 -- removed etex loading (was only loaded for kernels from before
386 2015). The noetex class option removed as well.
387
388 -- reimplemented \pagenumbering(*) as a single macro
389
390 -- additions to \@xfloat is now done via a cmd/after hook if the
391 format version supports it.
392
393 -- Definition of \theHpoem changed to \providecommand
394
395 -- The \theH<counter> macros defined in memoir was modified to use
396 \the\value{counter} instead of just \arabic{counter} as some
397 packages change \arabic.
398
399 -- \toclevel@part was actually never fixed in v3.7.19, now it is
400
401 -- added \@currentcounter in various places that manually
402 set \@currentlabel (primarily footnote constructions). Reported by
403 Gustavo Barros.
404
405 -- replaced hardcoded \footnotesize in \verbfootnote by \foottextfont
406
407 -- made a small change to footnote formatting. Now one can use
408 \raggedright in \footnotetext to get raggedright footnotes. Use
409 with care as \raggedright does change various paragraph settings
410
411 -- replaced etoolbox loading by xpatch (which loads etoolbox) as it
412 can patch more.
413
414 -- Added a Hook named memoir/subcaption/aftercounter which is executed
415 after \refstepcounter in \subcaption, \subbottom, \subtop
416 etc. Requested by Gustavo Barros.
417
418 -- Redefinition of \@setsize removed, was copied from setspace.sty
419 which states that it was only needed for some 209 packages.
420
421
422 The following macros have been disabled (to either give a warning or
423 an error).
424
425 -- \namerefon and \namerefoff => warning (now always on)
426
427 -- \currenttitle => error (given that many things are now "titled",
428 relying on this to get the current "title" is too risky, use proper
429 \label+\titleref instead)
430
431 -- \theTitleReference => warning (was used in the old implementation
432 of \titleref and \currenttitle)
433
434
435 o memhfixc v1.21
436
437 -- All nameref patches have been removed
438 -- provided \subfigureautorefname
439
440
441 Changes (2022/11/17)
442
443 o memoir v3.7.19
444
445 -- changed version numbering to v3.7.<num> (no plans to switch to 3.8
446 anytime soon)
447 -- changed several \theH... definitions to \def to work better with
448 coming hyperref/tagging changes
449 -- similar for \toclevel@... macros
450 -- only declare \stockwidth and \stockheight if the kernel hadn't done
451 so already
452
453 o memhfixc v1.20
454
455 -- removed patch for \@starttoc and thus \Hy@AtBeginDocument is no
456 longer used in memhfixc
457
458
459
460
461 Changes (2022/07/29)
462
463 o memoir v3.7r
464
465 -- fixed typo in menual (table 7.2), \tocmark and similar does not
466 take arguments, they have a static definition. Reported in private
467 email by Ronno Das.
468 -- fixed sporious space in \m@m@addamp, see
469 https://tex.stackexchange.com/a/647910/3929 for details.
470 -- made the font sizing macros robust (\normalsize, \small, ...)
471 like with the standard classes (reported via private email)
472 -- Addressed an issue where the combination of \DoubleSpacing and
473 \paragraphfootnotes lead to an arithmetic overflow.
474
475 Same fix has been applied to \paragraphfootstyle{...} where
476 additionally a hardcoded 64 has been replaced by \footfudgefiddle.
477 -- NB: Next memoir version will be labelled v3.7.19 (not v3.7s)
478
479
480
481
482 Changed (2022/02/20)
483
484 o memoir v3.7q
485
486 -- Added memhfixc autoloading to memoir (via
487 \AtEndPackage{hyperref}...), then the equivalent code can be
488 removed from hyperref
489 -- now auto loads the etoolbox package in order to enable a future
490 patching approach instead of overwriting kernel macros
491 (nb: re-coding has not started yet)
492 -- changed definition of \medspace into \providecommand for better
493 testing with older kernels
494 -- added some code to a hook provided by footmisc fixing a bug with
495 the combination of memoir+footmisc+reledmac, especially the 2022
496 update of footmisc
497 -- fixed typo in manual regarding \setupmaintoc, see
498 https://tex.stackexchange.com/q/602963/3929 for details.
499 -- The LaTeX team changed the order of the file/package hook names
500 into a more precise scheme. \AtBegin/EndFile, \AtBegin/EndPackage,
501 \AtBegin/EndClass changed accordingly
502
503 Changed (2021/06/16)
504
505 o memoir v3.7p
506
507 -- moved various \theHxxx definitions from memhfixc directly into
508 memoir. They are only relevant when hyperref is loaded, but do no
509 harm otherwise.
510
511 o memhfixc v1.19
512
513 -- moved several hyperref related additions from memhfixc to memoir
514
515
516 Changed (2021/03/23)
517
518 o memoir v3.7o
519
520 -- \footref will be added to the kernel, so we now "provide" it instead
521 -- as of late 2020 the caption package will now adjust it self to the
522 class. It will even map several of the caption styling macros the
523 class provides onto the the corresponding setup in the caption
524 package. Special thanks to Axel Sommerfeldt for this
525 feature. Therefore we no longer reset in preparation for caption.
526 -- The mparhack package is no longer marked as emulated as we did not
527 emulate the fix for the bug regarding \if@firstcolumn. If a document
528 specifies as twocolumn, we automatically load mparhack
529 -- some internal cleanup and added some recommended alternatives
530
531
532
533 Changed (2020/10/04)
534
535 o memoir v3.7n
536
537 -- The new implementations for the \AtEndPackage and friends only
538 require single #s not # doubling as in the old implementation. That
539 is not backwards compatible. # doubling now forced in the new
540 implementation as well.
541
542
543 Changed (2020/09/10)
544
545 o memoir v3.7m
546
547 In preparation for the LaTeX format/kernel update (2020/10/01) several class
548 file hook features will change to use these new kernel features, see the manuals
549 for lthooks, ltfilehook, ltshipout for details on these new hooks.
550
551 Thus from the 2020/10/01 LaTeX forward onwards we have the changes
552 below. Until 2020/10/01 the new format can be tested via
553 e.g. pdflatex-dev
554
555 As of writing, you can test the new format via e.g. pdflatex-dev if you have an
556 up to date LaTeX installation.
557
558 Details about the changes:
559
560 -- trimmarks are now added via the shipout/background hook, the added hook is
561 labeled "memoir/trimmarks"
562
563 See the ltshipout manual for more details.
564
565 -- \AtBeginFile{filename}{code} and \AtEndFile{filename}{code} are now
566 implemented via the file/before/filename and file/after/filename hooks.
567
568 **Breaking change:** In the old implementation of
569 \AtBegin/EndFile{file}: if file is a `.tex` file, then one could use
570 \AtEndFile{test}{code} to add code at the end of inputting
571 `test.tex`. Now you will have to use \AtEndFile{test.tex}{code}.
572
573 See the manual for ltfilehook for more details.
574
575 -- \AtBeginPackage{name}{code}, \AtEndPackage{name}{code} and
576 \RequireAtEndPackage{name}{code} are now implemented via the
577 package/before/name and package/after/name hooks.
578
579 -- \AtBeginClass{name}{code}, \AtEndClass{name}{code} and
580 \RequireAtEndClass{name}{code} are implemented via class/before/name and
581 class/after/name
582
583 -- the redefinition of \trimmarks inside the definition of \quarkmarks have been
584 removed
585
586 -- Whenever the caption package is loaded, memoir will reset it self
587 so the caption package can take over. We issue some information to
588 the user at this point. In this update we have changed this
589 information from a class warning to a class info as the warning
590 confused a ot of users.
591
592
593
594 Changed (2020/06/02)
595
596 o memoir v3.7l
597
598 -- Minute change in preparation for october kernel update (several
599 amsmath spacing functions will be moved to the kernel, we made
600 versions of these also usable in the text, so will the kernel).
601
602
603 Changed (2020/03/25)
604
605 o memoir v3.7k
606
607 -- Changed how glossaries are written to the glo file. Should now
608 support UTF8 just fine. This fixes
609 https://tex.stackexchange.com/q/529127/3929
610
611 -- typo in manual: for \subbottom the \label goes into the subtitle
612 part, aka \subbottom[...\label{...}]{...}. Text in example fixed
613
614 -- added a check for showkeys final-mode, and do nothing in that
615 case. This fixes https://tex.stackexchange.com/q/526922/3929
616
617 -- brought the class into sync with booktabs dated 2020/01/12
618
619 -- the provided .ins files will now just overwrite instead of asking
620 for permission.
621
622 -- various typos
623
624
625 Changed (2019/11/21)
626
627 o memoir v3.7j
628
629 -- Typo when textcase.sty is not found. The embedded fallback
630 (textcase v0.07, 2004) nedded # doubling, now fixed.
631
632 Changed (2019/11/15)
633
634 o memoir v3.7i
635
636 -- indexes now uses protection when being moved from the aux to the
637 idx file(s)
638
639 -- changed loading ifpdf, ifetex, ifxetex and ifluatex to just loading
640 the new iftex package. Suggested by The LaTeX Support Team.
641
642 -- new feature for \createmark: the <show> variable now accepts:
643 nonumber, shownumber and notitle (implies shownumber). The latter
644 enables chapter headers to be just of the form "Chapter <number>"
645
646 -- By request, added a7paper and b7paper options (plus \stockavii,
647 \stockbvii, \pageavii and \pagebvii)
648
649 -- changed the header construction for tableofcontents and
650 friends. The anchor that hyperref will use for TOC, LOF etc entries
651 in the TOC will now point above the header not below it.
652
653 -- changed a few things in \subbottom, which hopefully fixes an issue
654 with hypcap, https://tex.stackexchange.com/q/440399/3929 (and
655 https://github.com/ho-tex/oberdiek/issues/42)
656
657 -- the handling of \absindent, \absparsep is now correctly described in the
658 manual (any changes of these of use of them has to be delayed to the start of
659 the document via \AtBeginDocument)
660
661 -- Updated the patched \InputIfFileExists to match the one used in the
662 2019/10/01 format (if using that format, we use the old version)
663
664 -- Updated the embedded copy of the booktabs package, bringing it in ling with
665 booktabs v1.6180339.
666
667 -- Changed the warning emitted at the start of loading the caption
668 package. Apparently users got spooked by it. The caption package works just
669 fine with with memoir, the warning is just there to remind users that once
670 the caption package is loaded, all caption related configurations should go
671 through the caption package interface, not through the class interface.
672
673 -- Fixed a bug in \lofmark and \lotmark when using the oneside option. The
674 default headings style uses \markright for all marks under oneside, but due
675 to an ordering mistake, \lofmark and \lotmark would still be using \markboth
676 unless you explicitly issued \pagestyle{headings} in the preamble. This is
677 now fixed.
678
679 -- fixed bug in \newfootnoteseries, the included footnote type did not support
680 more than one paragraph. Is now long.
681
682 -- fixed bug in \pagenote[...]{...}. Under hyperref
683 \pagenote{.}\pagenote[.]{.}{\pagenote{.} did not add a separator as
684 expected. It does now.
685
686
687 o memhfixc v1.18
688
689 -- added a \par to \contcaption to get rid of a sporadic space coming
690 from \refstepcounter under hyperref
691
692 -- additionally added a patch when hypcap is loaded, now using
693 \contcaption is no longer an error (hypcap looks to see if \caption
694 has been used)
695
696
697
698 Changed (2018/12/12)
699
700 o memoir v3.7h
701
702 -- The following packages are no longer embedded into the class
703 sources: array, delarray, dcolumn and tabularx.
704
705 These are all part of the _tools_ section of every LaTeX
706 installation, thus there is no reason to embed it anymore (let
707 alone keep track of when they are updated). Instead we require them
708 from the LaTeX installation.
709
710 Note that the class still makes its own defaults for some of the
711 default settings for these packages.
712
713 Historical note: When the class was first created updating LaTeX
714 was not an easy task, often done by hand. Also there was no manual
715 requirements, or if there were a manual it might not be easy to
716 find. So it made sense to have it all in one place and their
717 manuals added to the class manual. This usage information in the
718 manual will stay, but might no longer be 100% up to date, so users
719 are always referred to the package manuals.
720
721 We may remove more embedded packages in the future and replace them
722 with just require the distribution provided ones.
723
724 -- remembered to note \pagerefname when dealing with page notes.
725
726 -- fixed bug in inline toc entries in the manual when there are subitem
727 that are not typeset and hyperref is in use (\endlinechar=-1 around
728 the toc), also noted in the manual that this problem may occur and
729 how to deal with it.
730
731 One might argue that \endlinechar=-1 should be the default thenever
732 the ToC are being typeset.
733
734 -- Added \SingleSpacing* which does *not* add a \vskip at the
735 end. Also adjusted \SingleSpacing such that it does not emit a
736 \vskip when used in the preamble. This fixes
737 <https://tex.stackexchange.com/q/298904/3929>
738
739
740 Changed (2018/04/04)
741
742 o memoir v3.7g
743
744 -- is now using colorlinks hyperref option in the manual. We switched
745 it off year ago because some users were printing the
746 manual. Nowadays most is reading the manual online, and thus
747 colorlinks brings a better reading experience.
748 -- under hyperref \index{... |)} now also adds `|)hyperpage` to the
749 idx file. This is needed for xindy to process the idx
750 file. Makeindex does not seem to mind. Reported via private email.
751 -- added examples of the nine much overlooked \setpageXX macros, these can
752 be used instead of \settrimmedsize and \settrims to place a trimmed
753 page on the stock in nine often used configurations.
754 -- the way the class writes the pagesize to the output have been
755 rewritten and should now work with lualatex. Therefore we no longer
756 auto load the luatex85 package. We have also canceled \fixpdflayout
757 and \fixdvipslayout (they now just emit a warning)
758 -- the class will truncate certain layout lengths to a whole number of
759 point (e.g. \textwidth). This can now be disabled using the
760 fullptlayout class option, reported via
761 https://tex.stackexchange.com/q/372381/3929
762 -- in as of the release of TeXLive 2018 \counterwithin/out will be
763 added to the LaTeX kernel, we changed our version to use
764 \providecommand accordingly
765 -- removed loading the mempatch.sty package, it has been empty for
766 many years
767 -- now requiring ifpdf, ifetex, ifxetex and ifluatex packages to exist.
768 Earlier we attempted to emulate them if missing, this does not make
769 sense any more
770 -- started adding "Recommended alternative" blocks to the
771 manual. These are just mentioning more modern alternatives to what
772 ever is mentioned in the manual. Fx using tcolorbox instead of the
773 buildin framed env. Suggestions are welcome (by email)
774 -- added \titlingpageend{}{} which can be used to set the clearing
775 code at the end of the titlingpage env.
776 -- clearified the interaction between 14pt and extrafontsizes options
777 -- updating the embedded array and tabularx copies fixes
778 https://tex.stackexchange.com/q/411862/3929 (an issue with bidi)
779 -- dumped the emulated date for delarray to 2014/10/28 (the code,
780 after the array update) is the same
781 -- fixed a bad interaction in \subbottom when the showkeys and
782 hyperref is loaded. Reported via
783 https://tex.stackexchange.com/q/374301/3929
784 -- removed unnecessary \phansomsection from the thebiblipgraphy
785 setup. Reported via https://tex.stackexchange.com/a/396303/3929
786 -- added \nobreak to \@vslnumleft and @vslnumright (internal to
787 verse), reported via https://tex.stackexchange.com/a/415939/3929
788 -- added \phansomsection to \startnoteentrystart, otherwise \label in
789 \pagenote does not work correctly.
790 -- fixed a typo in \@listii where \itemsep is not pointing towards
791 \itemsepii, similar to the other \@listK macros.
792 -- fixed problem with \setfloatadjustment, font size changes did not
793 come through
794
795
796 Changed (2016/05/16)
797
798 o memoir v3.7f
799
800 -- Sidecaption placement in oneside docs did not work as
801 advertised. Now left and inner will place it on the left side, and
802 right and outer will place it on the right.
803 -- fixed sporious spaces in \createmark
804 -- added loading luatex85 under certain conditions
805 -- updated the embedded booktabs code so we are back aligned with
806 latest booktabs version.
807
808
809 Changed (2015/07/08)
810
811 o memoir v3.7e
812
813 -- per request, memoir no longer auto load the etex package on newer
814 kernels (as the 2015+ kernels auto allocate the extra registers)
815
816
817 Changed (2015/04/23)
818
819 o memoir v3.7d
820
821 -- \end@dblfloat code reversion now only happens if fixltx2e has a
822 release date older than 2014/01/01. Newer versions of fixltx2e has
823 no problems with memoir
824 -- added \feetatbottom. Use it to force footnotes to be added
825 from the bottom up when in a \raggedbottom context. Has no effect
826 under \flushbottom
827 -- \twocolumnfootnotes, \threecolumnfootnotes, \paragraphfootnotes now
828 use \skip\footins<series>
829 -- added \setfootins, it will set \skip\footins and its minipage
830 counterpart, plus the \...v@r versions used by e.g.,
831 \twocolumnfootnotes
832 -- fixed a bug in page styles whereby one could not apply rule
833 prefixes to a copied style.
834 -- Fixed typo in manual about \newleadpage,
835 reported by Werner Grundlingh
836 -- updated our version of \@doclearpage to match fixltx2e v1.1s (which
837 will also be in the next ltx kernel). This will change float
838 placement in a twocolumn doc (for the better)
839
840
841 Changed (2015/03/05)
842
843 o memoir v3.7c
844
845 -- by request from LTX3, the \textsubscript definitions now only takes
846 place if \textsubscript is not already defined
847 -- fixed interaction between memoir and fixltx2e, we delay our
848 \baselinestretch adjustment, reported by Ulrike Fisher
849 -- provided \@textsuperscript instead of \newcommand, then fixltx2e
850 can be loaded before \documentclass, reported by Ulrike Fischer
851 -- fixed typo in pagestyle message, reported by Werner Grundlingh
852 -- fixed a few sporious spaces
853 -- made changes to the article option (reported by Victor Ivrii):
854 o it no longer sets \chaptername to be empty
855 (no idea why it did in the first place, certainly not a good idea
856 when using babel)
857 o under the article option, the headings page style now correctly
858 removes the term 'Chapter'
859 -- added a caveat about \tightlists vs. \small/\footnotesize
860 -- reimplemented the ell chapter style
861 -- various typos
862
863 Please note that there are still items on my TODO list that has not
864 yet been addressed. They will when time permits.
865
866
867
868 Changed (2013/05/30)
869
870 o memoir v3.7b
871
872 -- bugfix sidecontcaption
873
874 o memhfixc v1.17
875
876 -- bugfix sidecaption and sidecontcaption
877
878
879 Changed (2013/05/22)
880
881 o memoir v3.7
882
883 -- Emulated date for array package made to match the actual
884 package
885 -- When ever the caption package is loaded we now reset
886 \abovecaptionskip to 10pt and \belowcaptionskip to 0pt
887 as in the default classes
888 -- Typos in manual
889 -- Fixed bug in \subbottom[]{...}. If an empty argument is given,
890 we will automatically eat the space after the (a)-part
891 -- Fixed bug in \makeheadposition, the last two arguments was ignored,
892 now works as intended
893 -- Removed \thanksfootextra from manual
894 -- Factored the box part out of the various \<X>numberline macros
895 -- The \cftXfont can now end with a macro taking one argument,
896 say \MakeTextUppercase
897 -- Included a carbon copy of the textcase package by David Carlisle,
898 thus the class now provide the \MakeTextUppercase and
899 \MakeTextLowercase macros
900 -- Default casing macro for the header information is now
901 \MakeTextUppercase not \MakeUppercase
902 -- A hook is provided into \part, \book and \chapter which is executed
903 just before writing to the TOC. The hook is especially intended
904 when using the hyperref package and the layout dictates upper or
905 lower casing these titles in the TOC.
906 -- All use of \MakeUppercase and \MakeLowercase in page styles,
907 chapter styles etc. have been changes into \MakeTextUppercase
908 and \MakeTextLowercase
909 -- Added a sniplet showcasing an approach to auto adjust the numwidths
910 in the toc using calc and etoolbox
911 -- Added titlingpage* which does not reset the page counter after the
912 env
913 -- Added \mempreaddchaptertotochook and \mempostaddchaptertotochook
914 hooks, executed right before and right after \chapter writes to the
915 .toc file. It can be used to create a simple \chaptertoc command,
916 see sniplet appendix.
917 Added similarly named hooks to \part and \book, plus
918 \mempreaddapppagetotochook and \mempostaddapppagetotochook added to
919 \appendixpage
920 -- Clarification about \maxtocdepth (turns out, it is not used in memoir),
921 related to http://tex.stackexchange.com/a/97018/3929
922 -- Made sure \postchapterprecis include code such that the text after
923 \chapterprecis is indented in the same manner as it would just
924 after \chapter
925 -- Added a hook at the very end of \chapter, could be used to add a
926 \clearpage or similar
927 -- Added a remark about trimmarks vs. synctex.
928 -- Fixed bug in \foottopagenote, now it works with \continuousnotenums
929 -- Section on the \pagenotecommand moved to the chapter about page notes
930 (\footnote, \sidefootnote, \sidepar etc.)
931 -- documented \cftKformatpnumhook, which could be used to auto adjust pnumwidth
932 -- Added a hook enabling color change in the showlocs page style
933 -- Workaround for colors leaking into paragraph footnotes (a proper
934 solution would involve fixing the color stack problem as in bigfoot)
935 -- Subfloat counter reset factored out into macros, requested by Axel
936 Sommerfelt
937 -- split \@makecaption into two, and inner (\@@makecaption) which
938 handles the formatting, and an outer (\@makecaption) handling the
939 space before and after
940 -- longtable caption support, added only if the ltcaption package is
941 not loaded (either directly or indirectly).
942 -- Added an autoadjustment feature for \marginparwidth (suggested by
943 Steffen V. Petersen), thus unless the user has used \setmarginnotes
944 a suitable choice for \marginparwidth is made.
945 More of these auto adjusting macros may be added later.
946 -- rewritten how page notes are written to the .ent file
947 -- added hyperref support to page notes
948
949
950 o memhfixc v1.16
951
952 -- restore footnote comma separation, when hyperfootnotes option is
953 active (default in current hyperref)
954 -- make sure \@starttoc behave like ours, when running under hyperref
955
956
957 Changed (2011/03/06)
958
959 o memoir v3.6j
960
961 -- fixed typo in trimmarks
962 -- changed \chapter (and chapter like titles), \section's, \part
963 and \book such that a non-zero \parskip no longer interfer
964 with the title layout.
965 -- yet another fix for the reimplemented page notes. Now 'x x'
966 only results in one line break not several.
967
968
969
970 Changed (2011/02/18)
971
972 o memoir v3.6i
973
974 -- fixes two problems, one in \addtonotes and implemented the float
975 inner adjustment in a different manner such that \setfloatlocation
976 works again
977
978
979 Changes (2011/02/13)
980
981 o memoir v3.6h
982
983 -- provided marginfigure and margintable environments modelled after
984 tufte latex (work in progress) including special justification macro
985 to force content flush against the textblock
986 -- copied the contents of the placeins package, though under a
987 different name (\FloatBlock)
988 -- added \setfloatadjustment to allow users to globally add stuff to the
989 start of floats, e.g. make typeset floating tables using \small
990 -- added the possibility to change the color of the head/foot rule in
991 the pagestyle
992 -- reimplemented the page note construction. Note that the new
993 implementation does not rely on the same macros as the old
994 implementation
995 -- Manual: checked and verified the links in the bibliography and made
996 all the CTAN links active in the PDF version of the manual.
997 -- \namesubappendices and \anonsubappendices never existed,
998 their real names are \namedsubappendices and \unnamedsubappendices,
999 fixed in the manual.
1000 -- fixed bug in \pfbreak
1001 -- added hook/wrapper such that packages like bidi can control the
1002 typesetting direction of the headers/footers
1003 -- added footer and header measuring, inspired by similar feature in
1004 fancyhdr. Though we do not change, say, the \headheight we leave
1005 this to the user and simply warn about it.
1006 -- made sure that \footnote, \sidefootnote, \sidepar and \sidebar
1007 use the same baseline stretch setting (note that for now \marginpar
1008 is not covered)
1009 -- fixed a font problem inside \quarkmarks
1010 -- subsequent pagenotes are now separated in the same manner af footnotes
1011
1012 o mem12.clo
1013
1014 -- changed \headheight to 14.5pt, to match the pattern used by
1015 the other clo files.
1016
1017 o memhfixc.sty
1018
1019 -- now take care of using \printpagenoteshyperref to print back
1020 references for page notes using hyperlinks.
1021
1022
1023
1024 Changes (2010/09/19)
1025
1026 o memoir v3.6g
1027
1028 -- fixed a typo in the vplaces env
1029 -- made \needspace work better with \section and friends
1030 -- added \settypeoutlayoutunit such that users can choose in which
1031 unit the layout list should be written to the log file.
1032 -- removed the \footnoteA--C commands from the manual, they have
1033 never existed
1034 -- Added \OnehalfSpacing* and \DoubleSpacing* which will additionally
1035 also make floats and page notes have the same spacing. Macros to
1036 explicitly set these values have also been added
1037 -- made it more clear who the maintainer is
1038
1039
1040 Changes (2010/08/22)
1041
1042 o memoir v3.6f
1043
1044 -- fixed a typo in memoirs float handling which caused floats to
1045 become lost, this brings float handling back in line
1046
1047 Changes (2010/08/20)
1048
1049 o memoir v3.6e
1050
1051 -- changed \parnopar to make its changes inside a group
1052 -- some clarifications in the manual
1053
1054 o Memhfixc v1.15
1055
1056 - fixed typo introduced in v1.14
1057 (special thanks to Ian D. Leroux and meho_r on ctt for reporting this)
1058
1059
1060
1061
1062
1063 Earlier changes are noted at the end.
1064
1065 -------------------------------------------------------------------
1066 Author: Peter Wilson (Herries Press) herries dot press at earthlink dot net
1067 Copyright 2001--2010 Peter R. Wilson
1068 Copyright 2011-- Lars Madsen
1069 Maintainer: Lars Madsen daleif at math dot au dot dk
1070
1071 This work may be distributed and/or modified under the
1072 conditions of the LaTeX Project Public License, either
1073 version 1.3c of this license or (at your option) any
1074 later version.
1075 The latest version of the license is in
1076 http://www.latex-project.org/lppl.txt
1077 and version 1.3c or later is part of all distributions of
1078 LaTeX version 2008/05/04 or later.
1079
1080 This work has the LPPL maintenance status "maintained".
1081
1082
1083 This work consists of the files:
1084 README (this file)
1085 memoir.dtx
1086 memoir.ins
1087 mempatch.dtx
1088 mempatch.ins
1089 and the derived files
1090 memoir.cls
1091 mem9.clo
1092 mem10.clo
1093 mem11.clo
1094 mem12.clo
1095 mem14.clo
1096 mem17.clo
1097 mem20.clo
1098 mem25.clo
1099 mem30.clo
1100 mem36.clo
1101 mem48.clo
1102 mem60.clo
1103 memhfixc.sty
1104 basic.gst.
1105 -------------------------------------------------------------------
1106
1107
1108 The distribution consists of the following files:
1109 README (this file)
1110 memoir.(dtx|ins) Class source and installation files
1111 mempatch.(dtx|ins) Source and installation for patch files
1112 memhfixc.sty Patch file for hyperref package
1113 memman.tex LaTeX source for the user manual
1114 (requires the memoir class and the alltt,
1115 fixltx2e, layouts, graphicx, and url packages for
1116 processing)
1117 memman.pdf User manual in PDF
1118 memmanadd.pdf Addendum (in PDF) to the User Manual (if required)
1119 memsty.sty Style file for (memman|memmanadd).tex
1120 memnoidxnum.tex Some default indexed elements for memman.tex
1121 memfonts.sty Palatino/CMR(lmodern) font mix
1122 memlays.sty Additional diagrammatic layouts
1123 titlepages.sty Assorted title page definitions
1124 anvil2.mps Herries Press logo
1125 memman.ist MakeIndex style file for (memman|memmanadd).tex
1126 memman.gst MakeIndex style file for (memman|memmanadd) glossary
1127 trims-example.tex Example file showcasing the four types of trimmarks
1128 supported by memoir, a PDF version of this is needed
1129 to build the manual
1130
1131 To manually install the package:
1132 o run: latex memoir.ins (which will generate memoir.cls,
1133 a set of mem*.clo files,
1134 and basic.gst for MakeIndex glossary files)
1135 run: latex mempatch.ins (which will generate memhfixc.sty and mempatch.sty)
1136 o Move memoir.cls, the mem*.clo files and any mem*.sty file to locations
1137 where LaTeX will find them (typically in a local texmf tree at
1138 /tex/latex/memoir) and refresh the file database.
1139 See the https://texfaq.org/ for more information on this.
1140
1141 However, it is alway recommended that you update your LaTeX
1142 installation, instead of attempting to manually install a Package or
1143 Class. Nowadays both MikTeX and TeXLive based systems provide update
1144 facilities. (Though, note that LaTeX provided by a Linux distribution
1145 does not).
1146
1147 To read the commented source code
1148 o run: (pdf)latex memoir.dtx
1149 For an index run: makeindex -s gind.ist memoir
1150 o run: (pdf)latex memoir.dtx
1151 o Print the result for a hardcopy of the documented code (which consists
1152 of nearly 500 pages)
1153
1154 To process memman.tex (if you really want to do this and not just use
1155 memman.pdf as supplied)
1156 o Make sure you can use the memoir class and the alltt, fixltx2e,
1157 layouts, graphicx, comment, and url (and perhaps some more) packages.
1158 o Make sure you have memman.ist, and memman.gst, they are a part of the
1159 memoir documentation files
1160
1161 o Run: pdflatex trims-example.tex
1162 o Run (pdf)latex twice on memman.tex
1163 o For an index run: makeindex -s memman.ist memman
1164 o For an index of first lines run: makeindex lines
1165 o For a glossary run: makeindex -s memman.gst -o memman.gls memman.glo
1166 o Run (pdf)latex twice more on memman.tex
1167 o Print the manual
1168
1169 (it is preferable to use pdflatex as the graphics from
1170 trims-example.tex will otherwise be ignored)
1171
1172 -------------------------------------------------------------------
1173
1174
1175 Changes (2010/07/01)
1176
1177 o Memoir v3.6d
1178
1179 -- added \precistocformat, default \noindent, thus the toc precis text
1180 is no longer indented by default.
1181 -- Fixed some typos in the manual and in the class
1182 -- reorganized the manner by which we handle the memoir user
1183 manual. This enables us to add revision numbers and dates to the
1184 start of each chapter of the manual. Please note that these
1185 revision numbers do not appear if one attempts to compile
1186 memman.tex as it relies on a modified (and thus private) version of
1187 svn-multi and also relies on splitting memman.tex into separate
1188 files.
1189 -- If the 'article' class option is in effect we now use the plain
1190 page style by default instead of headings.
1191
1192 o Memhfixc v1.14
1193
1194 -- Brought memoir sections back in line with hyperref. Now a hyperlink
1195 to a section should end up above the section title, instead of below.
1196
1197
1198 Changes (2010/04/19)
1199
1200 o Memoir v3.6
1201
1202 -- reversioned memoir to version 3.6. The version number was tending
1203 towards the golden ratio, but apparently this numeric value is
1204 not widely known.
1205 -- fixed \marginparmargin{left} in twoside mode
1206 -- fixed a race condition in memhfixc
1207
1208
1209 Changes (2010/02/20)
1210
1211 o Memoir v1.618033988c
1212
1213 -- fixed sporadic space in regular \footnote command
1214
1215
1216 Changes (2010/02/17)
1217
1218 o Memoir v1.618033988b
1219
1220 -- fixed typo that broke \feetbelowfloat
1221
1222 Changes (2010/02/16)
1223
1224 o Memoir v1.618033988
1225
1226 -- changed internal toc handling, as not to open extra files if the
1227 TOC is being used several times.
1228 -- fixed bug in the emulation of ifpdf, ifxetex and ifluatex that
1229 might cause memoir to crash in certain cases
1230 -- added \clearmark and \clearplainmark to 'clear' mark commands when
1231 defining specialised page styles
1232 -- made \subcaptionref robust
1233 -- added \letcountercounter and \unletcounter to let one counter act
1234 as if it had another name
1235 -- add possibility to have \footnote write in the margin by internally
1236 use \marginpar
1237 -- added a separate bottom aligned side footnote feature
1238 -- added consistent interface for \marginpar, \sidepar, \sidebar,
1239 and \sidefootnote for specifying into which margin the note should go
1240 -- added feature that makes it easier for the side writing macros to
1241 determine whether they are on the left or right of the text. The
1242 defaults for \sidepar and \sidebar have been changed such that their
1243 text now comes out flush up against the text.
1244 -- added appendix about the picture environment. Apparently there is no
1245 extensive freely available information about this environment. There
1246 is now. The chapter stems from an abandoned book project.
1247 -- extended the pagestyle changing macros such that they now warn if
1248 the page style does not exist or if the page style is an alias
1249 (trying to change an alias might lead to odd results)
1250 -- added tocvsec2 to list of emulated packages (left out by mistake)
1251 -- some undocumented hooks have been added to the toc building macros,
1252 more about these later.
1253
1254
1255 Changes (2009/11/17)
1256
1257 o Memoir v1.61803398c
1258
1259 -- fixed typo that broke \flushbottom. Please note that this fix WILL
1260 change existing documents, potentially changing page breaks.
1261 -- fixed a problem that might cause the addition of trimmarks to shift
1262 the output box a bit downward. Thanks to Heiko Oberdiek for the
1263 analysis and fix
1264 -- fixed a typo in an example in the manual
1265 -- changed \tmarkml, \tmarkmr, \tmarktm and \tmarkbm to place markers
1266 for the middle parts of the text. Earlier they did nothing and had
1267 to be defined by the user. Now the user can simply define them to do
1268 nothing if needed.
1269 -- added visual example to the manual showing the four trim mark types
1270 -- changed the madsen chapter style such that it now has a better
1271 unnumbered look
1272
1273
1274 Changes (2009/09/21)
1275
1276 o Memoir v1.61803398b
1277
1278 -- fixed typo that broke \thanks
1279
1280
1281 Changes (2009/09/10)
1282
1283 o Memoir v1.61803398
1284
1285 -- fixed bug with the upquote package
1286 -- added support for the bidi package
1287 -- added a simple page style
1288 -- added feature to \newlistof such that \KeepFromToc will locally change say
1289 \tableofcontents into \tableofcontents*
1290 -- Fixed bug, such that XeLaTeX will get the correct pages sizes
1291
1292
1293 Changes (2009/08/23)
1294
1295 o Eighth edition of the User Manual covering memoir v1.61803398.
1296 The design Part is now in a separate document, memdesign, which
1297 should be available from CTAN in /info.
1298
1299
1300 Changes (2009/07/24)
1301
1302 o Memoir v1.6180339h fixes minor typos in memoir.dtx and mempatch.dtx
1303
1304 Changes (2009/07/21)
1305
1306 o Memoir v1.6180339g fixes minor bugs in memoir and mempatch
1307
1308 Changes (2009/07/12)
1309
1310 o Memoir v1.6180339f fixes minor bugs and adds new commands
1311
1312 -- \begin{labelled}{name} A description list where \name is the labelling macro
1313 -- \twocoltocetc - the ToC and friends will be set in two columns
1314 -- \onecoltocetc - the ToC and friends will be set in one column (the default)
1315 -- \doccoltocetc - the ToC and friends will be set according the class column option
1316 -- \frontmatter, \mainmatter and \backmatter have had their float counter change
1317 factored out such that users may now change these
1318
1319 o Memoir now automatically loads the etex package
1320
1321 o The manual includes a chapter giving some historical backround related
1322 to typesetting and further information about fonts. There is a new
1323 chapter describing an example implementation of a memoir-based package for
1324 a US University thesis.
1325
1326 Changes (2009/02/06)
1327
1328 o Memoir v1.6180339d,e fixes a bug introduced by v1.6180339c
1329
1330 -- \makeheadwidth, \makerunningheadwidth and \makerunningfootwidth no longer
1331 support the '+' syntax from the calc package.
1332
1333 -- under hyperref \nameref is now an alias for \titleref
1334
1335
1336 Changes (2009/01/26)
1337 o Memoir v1.6180339c released with minor bug fixes that could
1338 not be done via the patch file, plus some new functionality. The
1339 manual has NOT been updated and the changes are noted below.
1340
1341 -- New paper size options: `a0paper', `a1paper', `a2paper', `b0paper',
1342 `b1paper', and `b2paper' for A0, A1, A2, B0,B1, and B2 size stock paper.
1343
1344 -- Macro \memoirpostopthook{} which is called after the options are
1345 processed but before anything else is done (like setting the page layout).
1346 As an example, you may define it as (before the \documentclass}
1347 command):
1348 \newcommand*{\memoirpostopthook}{%
1349 \setlength{\stockwidth}{<wid>}\setlength{\stockheight}{<ht>}}
1350 \documentclass[...]{memoir}
1351 to specify a stock paper size of <wid> by <ht> that is not provided by the
1352 defined options.
1353
1354 -- New `portrait' option (default, the opposite of `landscape').
1355
1356 -- New command \setbinding{<length>} for a binding offset of <length>.
1357
1358 -- New commands: \setpagetm, \setpagetr, \setpagemr, \setpagebr, \setpagebm,
1359 \setpagecc to position a (smaller) page on a (larger) stock at the
1360 top-middle, top-right, middle-right, bottom-right, bottom-middle, and
1361 centered with respect to the stock.
1362
1363 The macros are to be used instead of \settrimmedsize taking the
1364 same arguments.
1365
1366 -- New optional parameter in \makeheadwidth{<style>}[<footerwidth>]{<headerwidth>}
1367 to set the width of the <style>'s headers to <headerwidth> and the footers
1368 to <headerwidth> or, if given, to <footerwidth>. The two widths can also
1369 be set individually using \makerunningheadwidth{<style>}{<length>}
1370 and similarly with \makerunningfootwidth. The lengths, if needed
1371 are stored in \styleheadrunwidth and \stylefootrunwidth.
1372
1373 -- New `showlocs' pagestyle, which is provided as an example of what can be
1374 done to show the positions of headers, footers, and the textblock (lines
1375 are drawn showing the header and footer vertical locations and a box is
1376 drawn around the text block. It is implemented by two zero-sized pictures:
1377 \framepichead which draws a line at the header location, and \framepictextfoot
1378 which draws a frame around the textblock and a line at the footer location.
1379 Following the declaration \showheadfootlocoff the header/footer lines
1380 will not be drawn (\showheadfootlocon turns them on again), and following
1381 the \showtextblocklocoff declaration the frame around the text block will
1382 not be drawn (\showtextblocklocon turns it on again). If you want a box
1383 around your text you could create your own pagestyle using \framepictextfoot
1384 and with the showlocs code as a starting point.
1385
1386 -- New command \centerfloat is a version of \centering which centers a wide
1387 float or other known width element with respect to the textblock. E.g.,
1388 \begin{table} \centerfloat \caption{A wide table} ... \end{table}
1389
1390 -- New command \sourceatright[<length>]{<short text>}. Use at the end of a
1391 paragraph to put <short text> flushright. If it is short enough it will
1392 go at the end of the last line preceded by at least <length> (default 2em)
1393 space, otherwise it is set (flushright) on the following line.
1394
1395 -- New macro \leftspringright{<lfrac>}{<rfrac>}{<ltext>}{<rtext>} sets
1396 <ltext> as a flushleft column, width <lfrac> of the textwidth, and <rtext>
1397 as a flushright column, width <rfrac> of the textwidth, with
1398 (1.0 - <lfrac> - <rfrac>) textwidth space between them. E.g.,
1399 \leftspringright{0.4}{0.5}{On the left}{Right stuff}
1400
1401 -- Following the declaration \linenottooshort[<length>] paragraphs will be set:
1402 As normal but the last line will not be shorter than <length> (default 4em)
1403
1404 -- Using \russianpar instead of \par to end a paragraph causes it to be set
1405 following Russian typographic rules
1406
1407 -- Using \lastlinerulefill instead of \par to end a paragraph will be
1408 cause any short line to be filled with a rule (\lastlineparrule) up to
1409 the righthand margin.
1410
1411 -- Following the declaration \leftcenterright paragraphs will be set:
1412 First line raggedright, the last line raggedleft, and the remainder
1413 centered. If you use this shape, set \everypar{} afterwards.
1414
1415 -- Following the declaration \justlastraggedleft paragraphs will be set:
1416 All lines normal except the last is raggedleft.
1417
1418 -- Following the declaration \raggedrightthenleft paragraphs will be set:
1419 First line raggedright and remainder raggedleft.
1420
1421 -- If you use the above unusual paragraph shapes then using \\ to break
1422 a line may give a surprising result. If so, you could try instead
1423 \atcentercr (a memoir macro) or \break (a standard LaTeX macro) to see
1424 if the result is any better for you. In addition, just in case, memoir
1425 stores the original definitions of \\ and \par as \memorigdbs and
1426 \memorigpar respectively.
1427
1428 -- \titleref have been extended with a \titleref*, which under
1429 hyperref will provide the title but no link. Without hyperref, it
1430 is the same as \titleref
1431
1432 -- added hooks around the internals used by sidecaption,
1433 sidecontcaption, sidenamedlegend and sidelegend. They do nothing by
1434 default but can be used for something like this
1435
1436 \makeatletter
1437 \newenvironment{sidecaption*}{
1438 \renewcommand\@mem@scap@beforehook{\checkoddpage\ifoddpage\else\raggedleft\fi}
1439 \renewcommand\@mem@scap@afterhook{\par}
1440 \begin{sidecaption}}
1441 {\end{sidecaption}}
1442 \makeatother
1443
1444 which, if the user has placed the sidecaption on the outside in an
1445 twosided layout, then the figure will automatically be pushed
1446 towards the spine margin.
1447
1448
1449
1450 Changes (2008/08/23)
1451 o memhfixc v1.10 released to fix problem with tex4ht
1452 o NO CHANGES TO ANYTHING ELSE
1453
1454 Changes (2008/08/07)
1455 o Memoir v1.6180339a released to fix extraneous spaces in footnotes
1456 o NO CHANGES TO ANYTHING ELSE
1457
1458 Changes (2008/07/23)
1459 o Memoir v1.6180339 released to cater for non-compatible changes in
1460 the hyperref package. It is highly unlikely that I will make any future
1461 changes to memoir with respect to hyperref modifications, instead hyperref
1462 can cater for memoir if necessary. All patches from mempatch v5.1 are
1463 folded in.
1464 o Mempatch package v6.0 released.
1465 o INSIGNIFICANT CHANGES TO THE MANUAL (corrected typo in Figure 8.1 caption,
1466 added two persons to the Acknowledgements)
1467
1468 Changes (2008/07/12)
1469 o Mempatch package v5.1 released with bug fixes for \DisemulatePackage
1470 and spacing of Part titles in the ToC.
1471 o There was a mismatch between the general version of memman.pdf and the
1472 tds version. These are now the same. I took the opportunity to fix
1473 some very minor typos (perhaps no more than half a dozen words) in the
1474 User Manual (if you have a printed copy of the seventh edition, it's not
1475 worth printing the update)
1476 o NO CHANGES TO THE CLASS
1477
1478 Changes (2008/06/02)
1479 o Memoir class v1.618033 released with bug fixes for \feetbelowfloat
1480 and sidebar layout for the larger font sizes.
1481 o NO CHANGES TO THE USER MANUAL
1482
1483 Changes (2008/05/27)
1484 o Memoir class v1.61803 released incorporating all patches and comments about
1485 v1.61803 beta. Major extensions are extended, or arbitrary, document font
1486 sizes and provision of several styles of section headings.
1487 o User Manual (memman), edition 7 released incorporating the contents of the
1488 Addendum. The part on typography has been extended and a glossary of memoir's
1489 commands and environments has been added.
1490 o New (empty) version of mempatch.sty.
1491
1492 This will be the last release for a considerable period of time. After 25
1493 years in the USA we are moving back to the UK where there are grandchildren.
1494 The process will probably involve at least 6 months in LaTeX limbo.
1495 My definition of `considerable period' may imply decades.
1496
1497 Changes (2008/04/25)
1498 o Beta version of memoir v1.61803 released incorporating all patches.
1499 No major comments received.
1500 o Beta version of the USER MANUAL released incorporating all of the
1501 ADDENDUM. Minor comments received.
1502
1503 Changes (2006/12/23)
1504 o New version (4.7) of mempatch.sty, fixing minor infelicities with v4.6
1505 o NO CHANGES TO THE USER MANUAL OR ADDENDUM
1506
1507 Changes (2006/12/11)
1508 o New version (1.9) of memhfixc.sty
1509 o New version (4.6) of mempatch.sty, adding spacing commands,
1510 about a dozen new built-in chapterstyles, new trimmarks,
1511 some minor new commands, and bug fixes.
1512 o New version of memmanadd.pdf
1513 o NO CHANGES TO THE USER MANUAL
1514
1515 Changes (2006/08/09)
1516 o New version 4.5 of mempatch.sty
1517 o New version memmanadd.pdf
1518
1519 Changes (2005/09/25)
1520 o New version of memoir.dtx which will generate the new
1521 version v1.618 of memoir.cls, the *.clo files (which are unchanged),
1522 and the basic.gst configuration file for MakeIndex to support
1523 memoir's glossary code.
1524 o Memoir.cls v1.618 incorporates all the patches from mempatch.sty
1525 v3.12, and includes a code set for making glossaries.
1526 o New version 4.0 of mempatch.sty (contains no code)
1527 o New version of memmanadd.pdf
1528 o NO CHANGES TO THE USER MANUAL
1529
1530
1531 Changes (2004/05/24)
1532 o New version (v1.6) of memhfixc.sty (fix for subappendices)
1533 o New version (v2.3d) of mempatch.sty (fix for boxedverbatim)
1534
1535 Changes (2004/04/26)
1536 o New release (2.3 again but with some code) of mempatch.sty
1537
1538 Changes (2004/04/05)
1539 o New version of memoir.dtx which will generate the new
1540 version v1.61 of memoir.cls and the *.clo files with minor
1541 fixes for extraneous spaces and footnotes. Incorporates
1542 the patches from mempatch 2.2.
1543 o New version 2.3 of mempatch.sty (contains no code)
1544 o NO CHANGES TO THE USER MANUAL
1545
1546 Changes (2004/03/01)
1547 o New version 2.2 of mempatch.sty (fix indent after verbatim)
1548 o APART FROM THIS FILE, NO CHANGES TO ANY OTHER DOCUMENTS
1549
1550 Changes (2004/02/11)
1551 o New version 2.1 of mempatch.sty (fix for use of \linespread)
1552 o APART FROM THIS FILE, NO CHANGES TO ANY OTHER DOCUMENTS
1553
1554
1555 Changes (2004/01/31)
1556 o New version of memoir.dtx which will generate the new
1557 version v1.6 of memoir.cls incorporating all earlier patches
1558 o New version v2.0 of mempatch.sty (which does nothing)
1559 o New edition of the manual, incorporating all the material from
1560 the Addendum, which is no more
1561
1562
1563 Changes (2003/11/16)
1564 o New version 1.9 of mempatch.sty (major extensions for typesetting
1565 arrays and tabulars; hung paragraphs; reduced moans about using
1566 deprecated font commands; bug fixes)
1567 o New version of the Addendum (memmanadd.pdf)
1568 o APART FROM THIS FILE, NO CHANGES TO ANY OTHER DOCUMENTS
1569
1570 Changes (2003/09/16)
1571 o New version 1.8 of mempatch.sty (major extensions to footnoting,
1572 e.g., multiple styles and multiple series; a `fixed marginpar';
1573 and bug fixes)
1574 o New version of the Addendum (memmanadd.pdf)
1575 o APART FROM THIS FILE, NO CHANGES TO ANY OTHER DOCUMENTS
1576
1577 Changes (2003/07/23)
1578 o New version 1.7 of mempatch.sty (improved odd/even page checking,
1579 spacing in the bibliography, minor tweaks with the article option,
1580 and bug fixes)
1581 o New version of the Addendum (memmanadd.pdf)
1582 o APART FROM THIS FILE, NO CHANGES TO ANY OTHER DOCUMENTS
1583
1584 Changes (2003/06/28)
1585 o New version 1.6 of mempatch.sty (improved odd/even page checking,
1586 page layout, and bug fixes)
1587 o New version of the Addendum (memmanadd.pdf)
1588 o APART FROM THIS FILE, NO CHANGES TO ANY OTHER DOCUMENTS
1589
1590 Changes (2003/04/28)
1591 o New version 1.5 of mempatch.sty (improved frame boxes, footnotes,
1592 and bug fixes)
1593 o New version of the Addendum (memmanadd.pdf)
1594 o APART FROM THIS FILE, NO CHANGES TO ANY OTHER DOCUMENTS
1595
1596 Changes (2003/02/20)
1597 o New version 1.3 of memhfixc.sty (fixes an appendices/hyperref problem)
1598 o New version of the Addendum (mammanadd.pdf) with description of footnote styling
1599 o NO CHANGES TO ANY OTHER DOCUMENTS
1600
1601 Changes (2003/02/13)
1602 o Reference sections, etc., by name as well as by number
1603 o Now 3 `need space' macros
1604 o New macros for `slash' fractions (fractions like 6/19)
1605 o Use of \footnote in titling macros (e.g., \author) ignored
1606 o New version 1.4 of mempatch.sty
1607 o New version 1.2 of memhfixc.sty
1608 o New version of the Addendum (memmanadd.pdf)
1609 o NO CHANGES TO ANY OTHER DOCUMENTS
1610
1611 Changes (2003/01/22)
1612 o Second optional argument to \section, etc, for page header text
1613 o Formatting of numbers --- cardinals and ordinals, numeric and spelled out
1614 o Better cooperation with natbib, chapterbib, nameref packages
1615 o New version 1.3 of mempatch.sty
1616 o New version 1.1 of memhfixc.sty
1617 o New version of the Addendum
1618
1619 Changes in version 1.3a of memoir.cls (2002/11/22)
1620 o Fixed nasty figure/table numbering gremlin that couldn't be done by
1621 the patch file
1622
1623 Changes in version 1.3 of memoir.cls (2002/11/14)
1624 o More flexibility in defining chapter styles, and the appearance of
1625 chapter and part listings in the ToC
1626 o \tableofcontents and friends can be used multiple times
1627 o Major extensions for indexing, including multiple indexes
1628 o Major extensions to the trim marks
1629 o Can do N of M page numbering
1630 o Added automatic inclusion of a patch file
1631 o No change to the User Manual, but the Addendum has been revised
1632
1633 Changes in version 0.2a of mem12.clo (2002/08/27)
1634 o Fixed scriptsize bug
1635
1636 Changes in version 1.2 (2002/08/10)
1637 o Incorporated all fixes from memfixb.sty that applied to version 1.1
1638 o Minor changes to *.clo files
1639 o Added 17pt class option
1640 o Boxes that break over pages and/or contain verbatim text
1641 o Several ways of dealing with verbatim text
1642 o Convenient methods for file input and output
1643 o Additional \provide... commands
1644 o User-specified footnote configuration, and footnotes that can include
1645 verbatim text
1646 o Additional optional argument to \chapter and \chapter* for short
1647 header texts
1648
1649
1650 Changes in version 1.1 (2002/03/28)
1651 o Incorporated all fixes from memfixa.sty that applied to version 1.0
1652 o Minor change to *.clo files
1653 o Native support for subfigures
1654 o Fixed incompatability with the natbib package
1655 o Additional facilities for verse typesetting
1656 o Experimental marginpar-like extensions
1657 o New edition of the user manual
1658
1659 Changes (2002/03/28)
1660 o Removed memfixa.sty
1661
1662 Changes (2002/01/23)
1663 o Added memfixa.sty to distribution to fix problem if the
1664 showtrims option and the calc package are used together.
1665
1666 Changes in version 1.0 (2001/11/17)
1667 o First public production release
1668 o Support for tipped in illustrations
1669 o Fine control over chapter pages
1670 o Support for continous page numbering even if switching between
1671 numbering systems (e.g., roman to arabic)
1672 o Minor change to *.clo files
1673 o Extended Part I of the manual, and more examples in Part II
1674
1675 Changes in version 0.33 (2001/08/31)
1676 o Added controllable chapter spacing in LoF and LoT
1677 o Fixed bug in \appendixpage
1678 o Provided dictionary style headers for the Index (memman.(tex|ist))
1679
1680 Changes in version 0.32 (2001/08/03)
1681 o Further fixes for old versions of the amsmath package
1682
1683 Changes in version 0.31 (2001/07/24)
1684 o Companion chapterstyle typesets correctly on verso pages
1685 o Fixed odd interaction with the amsmaths package
1686
1687 Changes in version 0.3 (2001/07/14)
1688 o Simulation of the article class
1689 o Addition of configurable titles
1690 o Addition of configurable abstract environment
1691 o Improved cooperation with the subfigure package
1692
1693 Changes in version 0.2 (2001/06/03)
1694 o First public beta release
1695 o Major improvements
1696
1697 Changes in version 0.1 (2001/05/20)
1698 o First public experimental alpha release
1699
1700 -------------------------------------------------------------------
1701
1702 2009/08/23
1703 Peter Wilson
1704 herries dot press at earthlink dot net
1705
1706 %%% Local Variables:
1707 %%% mode: text
1708 %%% End: