Settings Help
CTAN
Comprehensive TeX Archive Network
Home Upload Browse

Direc­tory tex-archive/macros/latex/contrib/etoc

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.

Files

Name Size Date Notes
README 4579 2013-04-06 01:56:39
etoc.dtx 194230 2013-04-06 01:58:31
etoc.ins 1086 2013-04-06 01:58:26
etoc.pdf 258205 2013-04-06 01:58:35

DOWNLOAD Down­load the com­plete con­tents of this di­rec­tory in one zip archive (298.7k).

etoc – Com­pletely cus­tomis­able TOCs

The pack­age gives the user com­plete con­trol of how the en­tries of the ta­ble of con­tents should be con­sti­tuted from the name, num­ber, and page num­ber of each sec­tion­ing unit. The lay­out is con­trolled by the def­i­ni­tion of ‘line styles’ for each sec­tion­ing level used in the doc­u­ment.
The pack­age pro­vides its own cus­tom line styles (which may be used as ex­am­ples), and con­tin­ues to sup­port the stan­dard for­mat­ting in­her­ited from the LaTeX doc­u­ment classes, but the pack­age can also al­low the user to del­e­gate the de­tails to pack­ages deal­ing with list mak­ing en­vi­ron­ments (such as en­u­mitem). The pack­age’s de­fault global style type­sets ta­bles of con­tents in a multi-col­umn for­mat, with ei­ther a stan­dard head­ing, or a ruled ti­tle (op­tion­ally with a frame around the ta­ble).
The \table­of­con­tents com­mand may be used ar­bi­trar­ily many times in the same doc­u­ment, while \lo­caltable­of­con­tents pro­vides a ‘lo­cal’ ta­ble of con­tents.

Doc­u­men­ta­tion Pack­age doc­u­men­ta­tion
Readme
Ver­sion1.07f
Li­censeThe LaTeX Project Public Li­cense 1.2
Copy­right2012 Jean-François Burnol
Main­tainerJean-François Burnol
Con­tained inTeXLive as etoc
MiKTeX as etoc
Topics deal with Tables of Con­tents, and of other such things
See also ti­tle­toc
Guest Book Sitemap Contact 2013-04-08 11:57