summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/etoc/README
blob: 7ae6716ecdf8e7d35e96b44fc4890702aed94f79 (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
%
% Package: etoc
% Version: 2013/10/13 v1.07g
% Copyright (C) 2012-2013 by Jean-Francois Burnol <jfbu at free dot fr>
%
     This Work may be distributed and/or modified under the
     conditions of the LaTeX Project Public License, either
     version 1.3c of this license or (at your option) any later
     version. This version of this license is in 
          http://www.latex-project.org/lppl/lppl-1-3c.txt
     and the latest version of this license is in
          http://www.latex-project.org/lppl.txt
     and version 1.3 or later is part of all distributions of
     LaTeX version 2005/12/01 or later. 

 This Work has the LPPL maintenance status Author-Maintained.

 The Author of this Work is Jean-Francois Burnol <jfbu at free dot fr>. 
 
 This Work consists of the main source file etoc.dtx and the 
 derived files etoc.sty, etoc.ins, etoc.tex, etoc.dvi, etoc.pdf


ABSTRACT
========

  The etoc package gives to the user complete control on how
  the entries of the table of contents should be constituted
  from the {name}, {number}, and {page number}
  of each sectioning unit. This goes via the definition of
  {line styles} for each sectioning level used in the
  document. The package provides its own custom line styles.
  Simpler ones are given as examples in the documentation. The
  simplest usage will be to take advantage of the layout facilities
  of packages dealing with list environments.

  The \tableofcontents command may be used arbitrarily
  many times and it has a variant \localtableofcontents
  which prints tables of contents `local' to the current
  surrounding document unit. An extension of the
  \label/\ref syntax allows to reproduce (with another
  layout) a TOC defined somewhere else in the document.

  The formatting inherited (and possibly customized by other
  packages) from the document class may also be used in
  {compatibility mode}. Regarding the {global toc
    display}, etoc provides pre-defined styles based on a
  multi-column format, optionally with a frame or a ruled
  title.

  As the assignment of levels to the sectioning units can be
  changed at any time, etoc can be used in a quite general
  manner to also create custom ``lists of'', additionally to
  the tables of contents related to the document sectioning
  units. No auxiliary file is used additionally to the
  standard .toc file.


INSTALLATION
============

 Extraction of the package (.sty) and driver (.tex) files:
  - if etoc.ins is present:   tex etoc.ins
  - without etoc.ins:         tex etoc.dtx 

 It is also possible to run latex/pdflatex directly on etoc.dtx

 At least three ways to produce etoc.pdf:
  (1) latex etoc.dtx (three times), then dvips, then ps2pdf
  (2) pdflatex etoc.dtx (three times)
  (3) latex etoc.tex (three times), then dvipdfmx

 Method (3) produces the smallest pdf files.
 Options can be set in etoc.tex:
  - scrdoc class options (paper size, font size, ...) 
  - with or without source code, 
  - with dvipdfmx or with latex/pdflatex. 

 Installation: 

   etoc.sty->TDS:tex/latex/etoc/etoc.sty
   etoc.dtx->TDS:source/latex/etoc/etoc.dtx
   etoc.pdf->TDS:doc/latex/etoc/etoc.pdf

 etoc.tex, etoc.ins, etoc.aux, etoc.toc, etc... may be discarded