summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/minitoc/minitoc.bug
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/minitoc/minitoc.bug')
-rw-r--r--Master/texmf-dist/doc/latex/minitoc/minitoc.bug260
1 files changed, 248 insertions, 12 deletions
diff --git a/Master/texmf-dist/doc/latex/minitoc/minitoc.bug b/Master/texmf-dist/doc/latex/minitoc/minitoc.bug
index 0e8467b1750..55817e6a166 100644
--- a/Master/texmf-dist/doc/latex/minitoc/minitoc.bug
+++ b/Master/texmf-dist/doc/latex/minitoc/minitoc.bug
@@ -1,6 +1,13 @@
-%%%%%%%%%%%%%%%%%% minitoc.bug #43 2005/09/16
+%%%%%%%%%%%%%%%%%% minitoc.bug #45 2006/06/08
There is a list of problems and frequently asked questions about
-minitoc.sty. If your version is < 43, please upgrade.
+minitoc.sty. If your version is < 45, please upgrade.
+
+If a problem arises, it is often wise to: a) use the hints option,
+and b) read the DOCUMENT.log file, which may contain pertinent
+messages. If you do not find a solution, ask a question on an adequate
+news group (fr.comp.text.tex or comp.text.tex preferably, which I try
+to follow), or send me a mail in last ressort (please join a minimal
+but complete example reproducing the problem).
(1) How to avoid a page break near the rules before and after
the mini-table?
@@ -51,8 +58,8 @@ minitoc.sty. If your version is < 43, please upgrade.
(7) Supported document classes.
> The minitoc package is restricted to document classes which
- > define chapters in the standard way, like `book' and `report',
- > or sections in the standard way, like `article'.
+ > define chapters in the standard way, like ``book'' and ``report'',
+ > or sections in the standard way, like ``article''.
> There are ``parttocs'' if the document class defines
> the \part command.
@@ -101,6 +108,8 @@ minitoc.sty. If your version is < 43, please upgrade.
> Moreover, since version #35, empty minitocs (and co.) can
> be automatically detected and skipped. It would not be
> easy to do with one big auxiliary file.
+ > Since version #44, the listfiles package option is available
+ > to create a list of these auxiliary files.
> But, since version #38, minitoc is able to detect and
> skip empty minitoc files (and co.) to avoid ugly titles
> with just two thin rules.
@@ -200,16 +209,16 @@ minitoc.sty. If your version is < 43, please upgrade.
(20) Use with the appendix package.
> If you use the appendix package (by Peter R.~Wilson,
- > pandgwilson@earthlink.net), you will observe a serious
+ > herries.press@earthlink.net), you will observe a serious
> problem with minitocs in the appendices environment (and
> after it): they do not match with their appendix. In fact,
> the environnement opening \begin{appendices} hides a
> \addcontentsline command for a chapter or a section, putting
- > trouble in the numbering of minitocs or secttocs. Two solutions
- > are available. The first one is to add a \adjustmtc or
- > \adjuststc command (depending if the appendices are at the
+ > trouble in the numbering of minitocs or secttocs. Several
+ > solutions are available. The first one is to add a \adjustmtc
+ > or \adjuststc command (depending if the appendices are at the
> chapter or section level) after EACH \begin{appendices} command.
- > The other is to add the following commands in the
+ > An other solution is to add the following commands in the
> preamble after the loading of the appendix package:
> \usepackage[...]{appendix} command:
> \let\oldappendices\appendices
@@ -218,6 +227,19 @@ minitoc.sty. If your version is < 43, please upgrade.
> \let\oldappendices\appendices
> \def\appendices{\oldappendices\adjuststc}
> if appendices are at the section level.
+ >
+ > These two solutions may be modified by replacing
+ > \adjustmtc by the sequence:
+ > \addtocontents{toc}{\chapterend}
+ > OR
+ > \addtocontents{toc}{\sectend}
+ > when it is necessary to delimit the end of the preceeding
+ > chapter or section.
+ >
+ > A rather elegant solution is to add an entry into the TOC via
+ > the \addappheadtotoc offered by the appendix package. As this
+ > entry is a chapter-level (or section-level) entry, it delimits
+ > correctly the end of the preceeding chapter or section.
(21) Use with the tocloft package.
> The tocloft and minitoc packages have an unfortunate interaction,
@@ -246,9 +268,34 @@ minitoc.sty. If your version is < 43, please upgrade.
(22) Use with the memoir class.
- > The memoir class offers the functionnalities of the tocbibind and tocloft
- > packages, hence it has the same problems; see above the available
- > solutions.
+ > The memoir class offers the functionnalities of the tocbibind, appendix,
+ > and tocloft packages, hence it has the same problems; see above the
+ > available solutions (points 5, 20, and 21, respectively).
+ > If your version of the memoir class is recent, the syntax of the
+ > \chapter command is different and the memoir class COULD BE NO MORE
+ > COMPATIBLE with the minitoc package, but a patch is inserted to fix
+ > the problem. Hopefully, if your version of the memoir is more recent
+ > than 2005/09/25, the patch is no more necessary.
+ >
+ > If you are using the memoir class (or the tocloft package), the
+ > \mtcsetfont command has no effect (\mtcsettitlefont works); you should
+ > use the font commands which are specific of the memoir class (or of the
+ > \texttt{tocloft} package).
+ >
+ > If you still want to use the \mtcsetfont commands while using the
+ > memoir class (or of the tocloft package), you must disable the
+ > memoir/tocloft font commands. This is done by the following commands:
+ > \let\cftpartfont\relax
+ > \let\cftchapterfont\relax
+ > \let\cftsectionfont\relax
+ > \let\cftsubsectionfont\relax
+ > \let\cftsubsubsectionfont\relax
+ > \let\cftparagraphfont\relax
+ > \let\cftsubparagraphfont\relax
+ > \let\cftfigurefont\relax
+ > \let\cftsubfigurefont\relax
+ > \let\cfttablefont\relax
+ > \let\cftsubtablefont\relax
(23) There are too many commands for fonts.
> Since version #41, the commands \mtcsetfont and \mtcsettitlefont are
@@ -282,9 +329,18 @@ minitoc.sty. If your version is < 43, please upgrade.
>
> This environment accepts an optional numeric argument, which is the
> depth of hiding in the main toc (default: -1, complete hiding).
+ > Look at the apx.tex example file.
>
> Of course, the environments ``mtchideinmainlof'' and
> ``mtchideinmainlot'' are also available.
+ >
+ > Note that the position of the end of these environments must be
+ > adjusted to include a page break (like the one done by a \chapter
+ > command), else the restore command might be inserted to early
+ > into the .toc, .lof or .lot file. More details are given in the
+ > documentation. Look att the hide1.tex and hide2.tex example files
+ > (the second gives better results).
+
(26) How to define your own .mld file?
> First, you should not directly modify one of the distributed .mld files.
> The simplest way to alter some title is to redefine the corresponding
@@ -295,6 +351,7 @@ minitoc.sty. If your version is < 43, please upgrade.
> It is eventually possible to add the corresponding option in minitoc.sty,
> but it would make it not portable, but you can always send me this new
> .mld file.
+
(27) Use with the abstract package.
> If the abstract package (by Peter R. Wilson),
> is used with its `addtotoc' option, a ``Abstract'' entry is added
@@ -350,4 +407,183 @@ minitoc.sty. If your version is < 43, please upgrade.
> in the minitocs, using the \mtcsetfont command or
> redefining the \mtcSfont, \mtcSSfont, \mtcSSSfont,
> \mtcPfont and \mtcSPfont commands.
+(30) Some useful precautions with starred sectionning commands:
+ > - The headers are not modified by \part*, \chapter* or \section*;
+ > it is necessary to use \markboth or \markright to get correct
+ > page headers for the current and following pages.
+ > - If you need an entry in the table of contents for a \chapter*
+ > or a \section* command, you must use \mtcaddchapter[title] or
+ > \mtcaddsection]title] AFTER the starred sectionning command.
+ > If you need an entry in the table of contents for a \part* command,
+ > the page number in the table of contents would be wrong, because
+ > \part* implies a \clearpage or a \cleardoublepage before the first
+ > page of the part. Use the sequence
+ > \cleardoublepage % \clearpage if openany option.
+ > \mtcaddpage[title]
+ > \part*[title]
+(31) Use with packages for captions.
+ > If one of the caption, caption2 (both by Axel Sommerfeldt), ccaption
+ > (by Peter R. Wilson), or mcaption (by Stephan Hennig), is used,
+ > it must be loaded BEFORE the minitoc package, because such packages
+ > alter (redefine) the commands listing figures and tables.
+ > Of course, the hints option detects this problem.
+(32) Bad interaction minitoc/huperref/memoir. > When the minitoc and hyperref packages are used in a document of
+ > class memoir, the chapter header ``Chapter'' does not appear on the
+ > first page of the chapter.
+ > This problem is fixed in version #44 of minitoc.
+(33) Use with the varsects package.
+ > If the varsects package (by Daniel Taupin) is used,
+ > it must be loaded BEFORE the minitoc package.
+(34) Initial font settings
+ > The setting of the fonts in the mini-tables is a rather
+ > complex problem. If we take the parttocs as an example,
+ > there is a \ptcfont font-command which is used for two purposes:
+ > - First, to be used as default value for some other
+ > font-commands (like \ptcSPfont). As its default value is used
+ > in the initialization of the minitoc package, the value
+ > of these other commands is NOT ALTERED if you modify \ptcfont.
+ > You must modify these commands one at a time.
+ > - Second, it is invoked at the beginning of each parttoc,
+ > partlof or partlot to set an initial font command.
+ > Then each entry of the mini-table calls its own font command
+ > (like \ptcSPfont). Thus, if you modify \ptcfont, you can
+ > obtain a global effect on the fonts in the parttocs, partlofs,
+ > and partlots. So you can play with the various parameters of
+ > the fonts (family, shape, series, size), if you want fancy
+ > mini-tables; but it is rather difficult.
+ > The same remarks apply to the other mini-tables.
+ >
+ > In the initialization of the minitoc package, we have a sequence
+ > of commands:
+ > \let\ptcSSfont\ptcfont % (subsections)
+ > \let\ptcSSSfont\ptcfont % (subsubsections)
+ > \let\ptcPfont\ptcfont % (paragraphs)
+ > \let\ptcSPfont\ptcfont % (subparagraphs)
+ > \let\plffont\ptcfont % (figures)
+ > \let\plfSfont\ptcfont % (subfigures)
+ > \let\pltfont\ptcfont % (tables)
+ > \let\pltSfont\ptcfont % (subtables)
+ > to define some default fonts. But this sequence is executed
+ > only once. If you alter \ptcfont, the modification is not
+ > applied to these font commands. The command \ptcfont is invoked
+ > at the beginning of each parttoc. \ptcCfont is invoked for
+ > each chapter entry in a parttoc (\ptcSfont for each section
+ > entry, etc.). So \ptcfont can be used to define some global
+ > characteristics for the fonts in the partocs, while \ptcCfont
+ > (etc.) can be used to customize the fonts for each level of
+ > entries.
+ >
+ > Note that if you say:
+ > \def\ptcSSfont{\ptcfont} % (subsections)
+ > \def\ptcSSSfont{\ptcfont} % (subsubsections)
+ > \def\ptcPfont{\ptcfont} % (paragraphs)
+ > \def\ptcSPfont{\ptcfont} % (subparagraphs)
+ > \def\plffont{\ptcfont} % (figures)
+ > \def\plfSfont{\ptcfont} % (subfigures)
+ > \def\pltfont{\ptcfont} % (tables)
+ > \def\pltSfont{\ptcfont} % (subtables)
+ > after loading the minitoc package, these font commands will
+ > be ``associated'' to \ptcfont, hence if you modify \ptcfont
+ > (by a \renewcommand or via \mtcsetfont{parttoc}{*}{...}), they
+ > will follow the modification. But if you modify one of these
+ > commands via or \mtcsetfont{parttoc}{subsection}{...} or
+ > \renewcommand (subsection is an example), the association is
+ > broken. But you could be more clever by saying something like
+ > \mtcsetfont{parttoc}{subsection}{\ptcfont\itshape} to preserve
+ > the association and modify only some parameters of a minitoc
+ > font command.
+ >
+ > For levels above subsection (part, chapter and section),
+ > the fonts a more specific in general, but you can, of course,
+ > say something like \def\ptcCfont{\ptcfont} to make a similar
+ > association. You can even make other associations, like this:
+ > % for high sectionning levels:
+ > \def\highlevelsfont{\rmfamily\bfseries\normalsize\upshape}
+ > % for low sectionning levels:
+ > \def\lowlevelsfont{\rmfamily\mdseries\smallsize\upshape}
+ < % then for each level:
+ > \def\ptcCfont{\highlevelsfont}
+ > \def\ptcSfont{\highlevelsfont}
+ > \def\ptcSSfont{\lowlevelsfont}
+ > \def\ptcSSSfont{\lowlevelsfont}
+ > \def\ptcPfont{\lowlevelsfont\itshape}
+ > \def\ptcSPfont{\lowlevelsfont\itshape}
+ > Then you can redefine \highlevelsfont or \lowlevelsfont to act
+ > on several fonts in one step, but you must use \renewcommand.
+ > You cannot act on \highlevelsfont or \lowlevelsfont with
+ > \mtcsetfont.
+ > Note that only the fonts for parttocs are used in the examples
+ > above; but, of course, the situation is the same for minitocs
+ > and secttocs. \highlevelsfont and \lowlevelsfont are macro names
+ > that you can choice, they are not part of the minitoc package.
+(35) Use with the KOMAScript classes
+ > If a KOMAScript class, compatible with minitoc (scrbook, scrreprt
+ > or scrartcl), is used, some class options may cause problems with
+ > the minitoc package, because these options add chapter or section
+ > entries in the table of contents. See section ``Special Entries
+ > for TOC, LOF, LOT, Bibliography and Index''. Of course, the hints
+ > option detects this problem.
+(36) Use with the jura class or the alphanum package
+ > The jura class loads the alphanum package, which redefines the
+ > sectionning structure in a non-standard way, after the loading
+ > of the report class. This class and this package are
+ > incompatible with minitoc.
+
+(37) Use of the .mld files with the babel package
+ > If you are using the babel package, you can automatize the loading of
+ > the .mld file by adding some code in the preamble of your document,
+ > like this:
+ > \AtBeginDocument{%
+ > \addto\captionsLANGUAGE1{\mtcselectlanguage{LANGUAGE2}}}}
+ > where LANGUAGE1 is the language name for babel and LANGUAGE2 the
+ > language name for minitoc; there are often identical, but there are
+ > exceptions (when you use a locally customized .mld file, by example).
+
+(38) Use with the fncychap package
+ > If the fncychap package (by Ulf A. Lindgren) is used,
+ > it must be loaded BEFORE the minitoc package, because
+ > it alters (redefines) the sectionning commands. Of course,
+ > the hints option detects this problem.
+
+(39) Use with the quotchap package
+ > If the quotchap package (by Karsten Tinnefeld) is used,
+ > it must be loaded BEFORE the minitoc package, because
+ > it alters (redefines) some sectionning commands. Of course,
+ > the hints option detects this problem.
+
+(40) Use with the romannum package
+ > If the romannum package (by Peter R. Wilson) is used,
+ > it must be loaded BEFORE the minitoc package, because
+ > it alters (redefines) the numbering of sectionning commands.
+ > Of course, the hints option detects this problem.
+
+(41) Use with the sfheaders package
+ > If the sfheaders package (by Maurizio Loreti) is used,
+ > it must be loaded BEFORE the minitoc package, because
+ > it alters (redefines) the sectionning commands.
+ > Of course, the hints option detects this problem.
+
+(42) Use with the alnumsec package
+ > If the alnumsec package (by Frank Küster) is used,
+ > it must be loaded BEFORE the minitoc package, because
+ > it alters (redefines) the sectionning commands.
+ > Of course, the hints option detects this problem.
+
+(43) Use with the captcont package
+ > If the captcont package (by Steven Douglas Cochran) is used,
+ > it must be loaded BEFORE the minitoc package, because
+ > it alters (redefines) the caption commands.
+ > Of course, the hints option detects this problem.
+(44) Vertical space before and after parttoc, partlof,
+ and partlot titles
+ > These vertical gaps were hard-coded like for the chapter
+ > heads in the book and report document classes.
+ > The values were 50pt and 40pt, but some users want
+ > to adjust them for the titles of the part-level mini-tables.
+ > Since version #45, these gaps are given by \mtcgapbeforeheads
+ > and \mtcgapafterheads, with these defaults values. They apply
+ > globaly to parttocs, partlofs and partlots.
+ > These are commands, NOT dimensions, so they must be modified
+ > via \renewcommand (NOT via \setlength). Look at the gaps.tex
+ > example file.