summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/etoc/README
blob: 10931fa788c79c847fd55abedfbd2e2f328e2083 (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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

            Package `etoc' (v1.07b, 2013/02/02)
            Copyright (C) 2012, 2013 by Jean-Francois Burnol

    The source file etoc.dtx and its derived files may be
    distributed and/or modified under the conditions of the
    LaTeX Project Public License, either version 1.3 of this
    license or (at your option) any later version. 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 2003/12/01 or later.  
  

                         Installation

 `latex etoc.dtx' creates the  file `etoc.sty'.
 `latex etoc.dtx' (twice more) finishes producing the documentation.

  Put `etoc.sty' in a suitable location within the TeX installation:
          etoc.sty -> ..suitable..path..to../tex/latex/etoc/

  The other generated files may be discarded.

                            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 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 apart from the usual .toc file.

   Change log

   v1.02 [2012/11/18]

   initial version


   v1.04 [2012/11/24]

   a (possibly local) table of contents can be labeled:
 
       \tableofcontents \label{toc:1}

   and reproduced elsewhere in the document (with a possibly
   completely different layout):
 
       \tableofcontents \ref{toc:1}

   
   v1.05 [2012/12/01]

   \localtableofcontents replaces \tableofcontents* (for
   compatibility with the memoir class)

   compatibility with KOMA-script and memoir document
   classes.


   v1.06 [2012/12/07]

   the standard macros \l@section etc... are modified only
   during the calls to \tableofcontents; they can thus be
   customized as will by the user (with the help of a
   package like tocloft) and this will be taken into account
   by etoc for the TOCs typeset in compatibility mode.


   v1.07 [2013/01/29]

   new commands:

      \etocthename, \etocthenumber, \etocthepage, \etoclink, 

      \etoctoccontentsline, \etoctoccontentsline*

      \etocnopar, \etocaftercontentshook

   modified command: \etocmulticolstyle

   new documentation section `surprising uses of etoc' which
   explains how to do `lists of arbitrary things', in
   addition to the tables of contents.


   v1.07b [2013/02/02]

   decision is made to remove the \xspace from the
   macros \etocname, \etocnumber, \etocpage.

   additional examples in the documentation.