summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/minitoc/INSTALL
blob: f60b55eeb7631cb7f12ad48ef424c9df3dec4fd6 (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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
Installation of the minitoc package (version #48 2006/09/13).

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, mtcmess.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) Example files:
	      mtc-2c.tex, mtc-2nd.tex, mtc-add.tex, mtc-ads.tex,
              mtc-amm.tex, mtc-apx.tex, mtc-art.tex, mtc-bk.tex,
              mtc-bo.tex, mtc-ch0.tex, mtc-cri.tex, mtc-fo1.tex,
              mtc-fo2.tex, mtc-gap.tex, mtc-hi1.tex, mtc-hi2.tex,
              mtc-hia.tex, mtc-hir.tex, mtc-hop.tex, mtc-liv.tex,
              mtc-mem.tex, mtc-mm1.tex, mtc-mu.tex, mtc-sbf.tex,
              mtc-scr.tex, mtc-syn.tex, mtc-tbi.tex, mtc-tlc.tex,
              mtc-tsf.tex, are example files, to play with.
              The associated .pdf files are provided.
(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,
              en-mtc.bst, are the source of the documentation
              in (non perfect) english. 
              The files lamed.eps and lamed.pdf are images to include,
              lamed.tex is the source code.
(6) fminitoc.dtx, fminitoc.bib, fminitoc.ist, frbib.sty,
    fr-mtc.bst, fminitoc.lan
              are the source (and tools) of the documentation in french.
(7) minitoc.pdf
              is the documentation in (non perfect) english,
              in PDF format.
(8) fminitoc.pdf
              is the documentation in french, in PDF format.

(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; note that imk must be run before emk or
                 fmk; it creates also some .sty files necessary
                 to prepare the documentation but that are not to be
                 installed;
              -- 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);
              -- xmk, which typesets the example files (into PDF).
              These scripts are currently written in C-shell, but there
              are very simple, and should be easy to convert in another
              classic shell. The documentation in PostScript format is
              no more distributed on the CTAN sites, but these scripts
              prepare it (using the duplex2v.pro PostScript Header file
              to try printing recto-verso).

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 documentation files may be printed recto-verso
on some printers. They are no more distributed on the CTAN archive but
the scripts prepare it.

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