summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/etoc/README
blob: d18d48202952a4816e7e8fcd9d01e36b2d5d69a9 (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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
version 1.07f of 2013/03/07
documentation of 2013/04/06

Package `etoc'
Completely customisable TOCs
Copyright (C) 2012, 2013 by Jean-Francois Burnol

LICENSE
=======

  The copyright and license statement applies to `etoc.dtx' and to
  its derived files.
  
      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. 
 
  The author of this work is Jean-Francois Burnol <jfbu at free dot fr>. 
  This work has the LPPL maintenance status `author-maintained'.
  
INSTALLATION
============
 
  `latex etoc.dtx' --> this extracts the style file `etoc.sty'
 
  `latex etoc.dtx' (twice more) finishes producing the documentation
 
   Move `etoc.sty' to a suitable location within the TeX installation:
           etoc.sty -> <TDS>/tex/latex/etoc/etoc.sty
 
   The generated auxiliary 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 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 apart from the usual .toc file.


Change log
==========

   v1.07f [2013/03/07]

   new macros \etocthelinkedname, \etocthelinkednumber,
   \etocthelinkedpage, and \etocthelink.


   v1.07e [2013/03/01]

   improvements in the package own line styles with
   regards to penalties and vertical spaces. 

   addition to the documentation of an example of
   a tree-like table of contents (uses tikz).

   more such examples added 2013/03/03.


   v1.07d [2013/02/24]

   minor code improvements and new documentation 
   section "Another compatibility mode".


   v1.07b [2013/02/02]

   removal of the \xspace from the macros \etocname, 
   \etocnumber, \etocpage.

   additional examples in the documentation.

   
   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.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.05 [2012/12/01]

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

   compatibility with KOMA-script and memoir document
   classes.


   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.02 [2012/11/18]

   initial version.