summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/minitoc/INSTALL
blob: 61bec09a83802fbe7ce9c33732f6612d55a29ef0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
Installation of the minitoc package (version #43 2005/09/16).

This package contains a lot of files. The list of all files
is given in minitoc.l.

The files are sorted into ``classes'' below (a file can
appear in more than one class). Each class specifies
the function and the placement of its files.

(0) The files minitoc.ins and minitoc.dtx are the basic source files
    of this package. The file fminitoc.dtx loads minitoc.dtx but
    selects the french documentation. The language selection is done
    by using \ifcase ... \or ... \fi constructs.

(1) The files minitoc.sty, mtcoff.sty, and ALL *.mld and *.mlo files are
    the package itself. They must be all installed in a directory
    where LaTeX finds the .sty files.
    mtcmempatch.sty is a temporary fix for compatibility with
    the memoir class.

(2) INSTALL   is a file describing the installation of the package.
              You are reading it.
    minitoc.l contains the list of all files of the minitoc
              distribution.
    README    is a file describing briefly the minitoc package,
	      plus some useful infos.
    catalog   contains basic infos about the minitoc package
              (abstract, date, author, version, licence).
    TODO      lists some suggested developments of the package. Comments
              and suggestions are welcome.
(3) minitoc-ex.tex, mini-art.tex, add.tex, add.bib
              are example files, to play with.
(4) minitoc.bug, minitoc.sum
              are plain text documentation: list of problems (faq)
              and summary of commands.
(5) minitoc.dtx, minitoc.ins, minitoc.bib, minitoc.ist, minitoc.lan
              are the source of the documentation in (non perfect)
              english.
(6) fminitoc.dtx, fminitoc.ins fminitoc.bib, fminitoc.ist, frbib.sty,
    frplain1.bst, fminitoc.lan
              are the source (and tools) of the documentation in french.
(7) minitoc.pdf, minitoc.ps
              are the documentation in (non perfect) english,
              in PDF and PostScript formats.
(8) fminitoc.pdf, fminitoc.ps
              are the documentation in french, in PDF and
              PostScript formats.

(9) pmk       is a shell script to prepare the package and its
              documentation; it should be adapted to your
              needs.
              There are also four partial scripts (to be adapted):
              -- imk, which prepares the package from minitoc.ins and
                 minitoc.dtx;
              -- emk, which prepares the english documentation from
                 minitoc.dtx;
              -- fmk, which prepares the french documentation from
                 fminitoc.dtx and minitoc.dtx;
              -- rmk, which sorts the files into classes (one directory
                 for each class).
              These scripts are currently written in C-shell, but there
              are very simple, and should be easy to convert in another
              classic shell.

The files of (1) must be installed in a directory where LaTeX
finds .sty files.

The files of (2), (3), (4), (5), (6) and (9) must be installed
in a separate directory, but must not be omitted.

The files of (7) and (8) must be installed as on-line documentation.
Note that the PostScript files may be printed recto-verso
on some printers.

Note that minitoc.dtx and fminitoc.dtx are (not so trivial) examples
of using minitoc (with hyperref).