summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/minitoc/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/minitoc/INSTALL')
-rw-r--r--Master/texmf-dist/doc/latex/minitoc/INSTALL82
1 files changed, 65 insertions, 17 deletions
diff --git a/Master/texmf-dist/doc/latex/minitoc/INSTALL b/Master/texmf-dist/doc/latex/minitoc/INSTALL
index 177e5c2f4b9..566b90a32d5 100644
--- a/Master/texmf-dist/doc/latex/minitoc/INSTALL
+++ b/Master/texmf-dist/doc/latex/minitoc/INSTALL
@@ -1,4 +1,4 @@
-Installation of the minitoc package (version #49 2006/11/13).
+Installation of the minitoc package (version #50 2006/11/29).
This package contains a lot of files. The list of all files
is given in minitoc.l.
@@ -28,7 +28,7 @@ the function and the placement of its files.
(abstract, date, author, version, licence).
TODO lists some suggested developments of the package.
Comments and suggestions are welcome.
-(3) Example files:
+(3) Examples of documents:
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,
@@ -38,6 +38,7 @@ the function and the placement of its files.
mtc-scr.tex, mtc-syn.tex, mtc-tbi.tex, mtc-tlc.tex,
mtc-tlo.tex, mtc-tsf.tex, are example files,
to play with. The associated .pdf files are provided.
+ Another (short) examples are welcome.
(4) minitoc.bug, minitoc.sum
are plain text documentation: list of problems (faq)
and summary of commands.
@@ -56,39 +57,86 @@ the function and the placement of its files.
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):
+ documentation; the pmk script uses the /tmp/`whoami`.imk
+ and /tmp/`whoami`.tmk directories to not waste disk space
+ under your home directory; there are also six 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;
+ to prepare the documentation but they must be
+ installed with it; the imk script uses the
+ /tmp/`whoami`.imk directory to not waste disk space
+ under your home directory;
-- emk, which prepares the english documentation from
minitoc.dtx;
-- fmk, which prepares the french documentation from
fminitoc.dtx and minitoc.dtx;
+ -- xmk, which typesets the example files (into PDF).
-- rmk, which sorts the files into classes (one directory
for each class);
- -- xmk, which typesets the example files (into PDF).
+ -- tmk, which creates a TDS-conformant hierarchy
+ (to be tailored for your system); this
+ hierarchy is saved in minitoc-texmf.zip.
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).
+(10) minitoc-texmf.zip is a ZIP-archive file containing a
+ TDS-compliant hierarchy with all the files of the
+ minitoc package.
-The files of (1) must be installed in a directory where LaTeX
-finds .sty files.
+Some remarks about the rmk, tmk and pmk scripts (which you should tailor
+to your needs):
+* with rmk:
+ -- 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;
+ -- the directories created by the rmk script are under
+ /tmp/`whoami`.rmk to not waste disk space under your home
+ directory.
+* with tmk:
+ -- the hierarchy is TDS-compliant;
+ -- each file appears only once in the hierarchy;
+ -- the installation is much easier: you only need a .zip or a .tar
+ (or .tgz} dump file of the hierarchy to be deployed into the
+ installed TDS hierarchy; you should examine VERY CAREFULLY (by
+ comparison with you TDS installation) and tailor the tmk script
+ before using it;
+ -- the directories created by the \texttt{tmk} script are under
+ /tmp/`whoami`.tmk to not waste disk space under your home
+ directory;
+ -- the file minitoc-texmf.zip (10) should not be installed;
+ it is just a method to help making a TDS-compliant installation.
+* with pmk:
+ -- the pmk script performs the actions of imk (preparation of the
+ basic files), emk and fmk (preparation of the english and french
+ documentation), xmk (preparation of the examples of documents),
+ rmk and tmk (repartition of files into classes and in a
+ TDS-compliant hierarchy);
+ -- the directories created by the pmk script are under the
+ /tmp/`whoami`.rmk and /tmp/`whoami`.tmk directories to not waste
+ disk space under your home directory.
+ -- the SAME PRECAUTIONS as for tmk are needed.
-The files of (2), (3), (4), (5), (6) and (9) must be installed
-in a separate directory, but must not be omitted.
+The file minitoc-texmf.zip contains a ZIP archive of a TDS-compliant
+hierarchy of all files of the minitoc package. It has been prepared by
+the pmk or tmk scripts.
-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 the PostScript documentation files may be printed
+recto-verso on some printers. They are no more distributed on
+the CTAN archives but the scripts prepare them.
Note that minitoc.dtx and fminitoc.dtx are (not so trivial) examples
-of using minitoc (with hyperref).
+of using minitoc with hyperref. They show how the combinaison of
+these two packages may be useful.
+
+For a more detailed description of the installation of the
+minitoc package, see the ``Installation'' chapter in
+minitoc.pdf (in english) ou in fminitoc.pdf (in french).