From 109a435244c29109322bcd46386301f6c62d4061 Mon Sep 17 00:00:00 2001 From: Norbert Preining Date: Tue, 6 Jul 2021 03:00:52 +0000 Subject: CTAN sync 202107060300 --- macros/latex/contrib/tableof/README.md | 85 ++++++++++++++++++---------------- 1 file changed, 44 insertions(+), 41 deletions(-) (limited to 'macros/latex/contrib/tableof/README.md') diff --git a/macros/latex/contrib/tableof/README.md b/macros/latex/contrib/tableof/README.md index 16bf9ca2d3..fa5ea8d72b 100644 --- a/macros/latex/contrib/tableof/README.md +++ b/macros/latex/contrib/tableof/README.md @@ -1,56 +1,40 @@ -Abstract -======== +tableof +======= - Package: tableof (Tables of tagged contents) -- Version: 1.4b (2018/10/02) +- Version: 1.4c (2021/07/05) - License: LPPL 1.3c -- Copyright (C) 2012-2018 Jean-Francois Burnol - -The commands `\toftagstart`, `\toftagstop`, `\toftagthis`, `\tofuntagthis` -are used to tag chapters, sections or any other sectioning units destined -to end up in the table(s) of contents. Then: - - \nexttocwithtags{req. 1, req. 2, ... }{excl. 1, excl. 2, ... } - \tableofcontents % or equivalent command - -specifies which tags are to be required and which ones are to be -excluded from the typeset TOC. - -For documents with classes where `\tableofcontents` is only single-use, -the package provides: +- Copyright (C) 2012, 2013, 2015, 2018, 2021 Jean-Francois Burnol - \tableoftaggedcontents{req. 1, req. 2, ... }{excl. 1, excl. 2, ... } +Provides `\toftagstart{}`, `\toftagstop{}`, `\toftagthis{}`, `\tofuntagthis{}` +to tag chapters, sections or any other sectioning units destined to end up in +the table(s) of contents. Then each one of -which does not have this restriction. + \tableof{required tags} + or \tablenotof{excluded tags} + or \tableoftaggedcontents{required tags}{excluded tags} +typesets a table of contents (with no heading) obeying the conditions. These +macros can each be used multiple times in the document with varying arguments. -Installation -============ - -For extracting the style file: - - latex tableof.dtx - -Files `tableof.sty`, `tableof.ins` and `tableoftest.tex` are generated on -the first latex run. Move `tableof.sty` to a suitable location within the -TeX installation: - - tableof.sty -> /tex/latex/tableof/ - -To produce the documentation: - - latex tableof.dtx (a second time) - dvipdfmx tableof.dvi +If the document contains no usage of `\tableofcontents`, the preamble should +also contain an additional `\AtBeginDocument{\tofOpenTocFileForWrite}`. -`tableof.ins` is for TeX distributions expecting it. +The main `\tableofcontents` can also be influenced by tags like this: -`tableoftest.tex` is an example of use of the package commands. Run -latex twice on it to see examples of tagged tables of contents. + \nexttocwithtags{required tags}{excluded tags} + \tableofcontents +Depending on the document class and packages `\tableofcontents` however may be +usable only once, contrarily to the `\tableof{}` et al. package macros. Change History ============== +* v1.4c (2021/07/05) additional efforts for `biblatex` compatibility. + Allow style file extraction via `etex`, reword the abstract. Use utf8 + source encoding. + * v1.4b (2018/10/02) fix to bug when a document ended with `\clearpage` before the `\end{document}`. `tableof` now requires `atveryend` package. @@ -67,12 +51,31 @@ Change History * v1.0 (2012/12/06) first release. +Installation +============ + +Extractions: + + etex tableof.dtx + +Move `tableof.sty` to a suitable location within the TeX installation: + + tableof.sty -> /tex/latex/tableof/ + +The `tableoftest.tex` file is provided as an example of use of the package. + +To generate the documentation, execute: + + latexmk tableof.dtx + dvipdfmx tableof.dvi + + License ======= This Work may be distributed and/or modified under the - conditions of the LaTeX Project Public License, - version 1.3c. This version of this license is in + conditions of the version 1.3c of the LaTeX Project Public License. + This version of this license is in -- cgit v1.2.3