summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2021-07-05 20:50:36 +0000
committerKarl Berry <karl@freefriends.org>2021-07-05 20:50:36 +0000
commit9715f1527c5152cccd38f7064161def1f06d9446 (patch)
treebb2998f5d25823ac1358db86d068cda721ea4891 /Master/texmf-dist/doc/latex
parent9b590bc743e1f2c75697633735ddffb1008f2c8f (diff)
tableof (5jul21)
git-svn-id: svn://tug.org/texlive/trunk@59837 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r--Master/texmf-dist/doc/latex/tableof/README.md85
-rw-r--r--Master/texmf-dist/doc/latex/tableof/tableof.pdfbin56333 -> 58824 bytes
-rw-r--r--Master/texmf-dist/doc/latex/tableof/tableoftest.tex190
3 files changed, 234 insertions, 41 deletions
diff --git a/Master/texmf-dist/doc/latex/tableof/README.md b/Master/texmf-dist/doc/latex/tableof/README.md
index 16bf9ca2d30..fa5ea8d72ba 100644
--- a/Master/texmf-dist/doc/latex/tableof/README.md
+++ b/Master/texmf-dist/doc/latex/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 <jfbu at free dot fr>
-
-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 <jfbu at free dot fr>
- \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 -> <TDS>/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 -> <TDS>/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
<http://www.latex-project.org/lppl/lppl-1-3c.txt>
diff --git a/Master/texmf-dist/doc/latex/tableof/tableof.pdf b/Master/texmf-dist/doc/latex/tableof/tableof.pdf
index fe26b7b1240..f04fc964a07 100644
--- a/Master/texmf-dist/doc/latex/tableof/tableof.pdf
+++ b/Master/texmf-dist/doc/latex/tableof/tableof.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/tableof/tableoftest.tex b/Master/texmf-dist/doc/latex/tableof/tableoftest.tex
new file mode 100644
index 00000000000..f8ddc8a2420
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/tableof/tableoftest.tex
@@ -0,0 +1,190 @@
+%%
+%% This is file `tableoftest.tex',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% tableof.dtx (with options: `test')
+%%
+%% IMPORTANT NOTICE:
+%%
+%% For the copyright see the source file.
+%%
+%% Any modified versions of this file must be renamed
+%% with new filenames distinct from tableoftest.tex.
+%%
+%% For distribution of the original source see the terms
+%% for copying and modification in the file tableof.dtx.
+%%
+%% This generated file may be distributed as long as the
+%% original source files, as listed above, are part of the
+%% same distribution. (The sources need not necessarily be
+%% in the same archive or directory.)
+%%
+%% Package: tableof
+%% Version: 1.4c (2021/07/05)
+%% License: LPPL 1.3c
+%% Copyright (C) 2012, 2013, 2015, 2018, 2021 Jean-Francois Burnol <jfbu at free dot fr>
+%%
+%% This file `tableoftest.tex' serves to demontrate the use of the
+%% commands from the package `tableof'.
+%%
+%% (run on it `latex' or `pdflatex' twice.)
+%%
+\documentclass{article}
+\usepackage[T1]{fontenc}
+\usepackage[colorlinks,linkcolor=blue]{hyperref}
+\usepackage{tableof}
+%%\usepackage{etoc} % for testing
+\DeclareRobustCommand\lowast{\raisebox{-.25\height}{*}}
+\begin{document}
+%% \etoctoclines % (if using package etoc)
+%%
+%% we don't need here \tofOpenTocFileForWrite
+%% as the document has \tableofcontents a few lines down.
+%%
+\section*{\string\tableof\{\}}
+\tableof{}
+\section*{\string\tableof\lowast\{A,B,C,D,E,F\}}
+\tableof*{ A, B,C , D , E, F }
+\section*{\string\tableof\{A\}}
+\tableof{A}
+\section*{\string\tableof\lowast\{A\}}
+\tableof*{A}
+\section*{\string\tableof\{A,C\}}
+\tableof{ A ,C }
+\section*{\string\tableof\lowast\{A,C\}}
+\tableof*{A, C }
+\section*{\string\tableoftaggedcontents\lowast\{A,D\}\{B,F\}}
+\tableoftaggedcontents*{ A,D}{B, F}
+\renewcommand\contentsname{\string\nexttocwithtags\lowast\{A,D\}\lowast\{B,F\}\string\tableofcontents}
+\nexttocwithtags*{ A , D}*{B ,F}
+\tableofcontents
+%% requires package etoc
+%% \etoctocstyle{1}{with A and D and without B and without F}
+%% \nexttocwithtags{A,D}{B,F}\tableofcontents
+%% \etoctocstyle{1}{with (A or D) and without B and without F}
+%% \nexttocwithtags*{A,D}{B,F}\tableofcontents
+%% \etoctocstyle{1}{with A and D and (without B or without F)}
+%% \nexttocwithtags{A,D}*{B,F}\tableofcontents
+\section*{with B or with C (using \string\tableoftaggedcontents)}
+\tableoftaggedcontents*{B, C}{}
+\section*{with B or with C (using \string\tableof\lowast)}
+\tableof*{B, C}
+\section*{with A and with B and with C}
+\tableof{A, B, C}
+\section*{with A or with B or with C}
+\tableof*{ A,B ,C }
+\section*{without B (and) (using \string\tableoftaggedcontents)}
+\tableoftaggedcontents{}{B}
+\section*{without A and without B (using \string\tableoftaggedcontents)}
+\tableoftaggedcontents{}{A , B}
+\section*{without A or without C}
+\tablenotof*{ A, C}
+\section*{without A and without B and without C}
+\tablenotof{ A , B , C}
+\section*{without A or without B or without C}
+\tablenotof*{A, B,C }
+\section*{with D and with E}
+\tableof{D,E}
+\section*{with E}
+\tableof{E}
+\section*{without D}
+\tablenotof{D}
+\section*{ecology and rabbits}
+\tableof{ ecology , rabbits }
+\section*{rabbits and not ecology}
+\tableoftaggedcontents{ rabbits }{ ecology }
+\section*{kitchenware and not rabbits}
+\tableoftaggedcontents{ kitchenware }{ rabbits}
+\clearpage
+\section{no tag}
+nothing
+\begin{verbatim}
+\toftagstart{D,E,F}
+\toftagthis{A}
+\end{verbatim}
+\toftagstart{ D, E, F }
+\toftagthis{A}
+\section{A,D,E,F}
+A,D,E,F
+\begin{verbatim}
+\toftagthis{B}
+\end{verbatim}
+\toftagthis{B}
+\section{B,D,E,F}
+B,D,E,F
+\begin{verbatim}
+\toftagthis{C}
+\end{verbatim}
+\toftagthis{ C }
+\section{C,D,E,F}
+C,D,E,F
+\begin{verbatim}
+\toftagstop{F}
+\toftagthis{A,B}
+\end{verbatim}
+\toftagstop{F}
+\toftagthis{ A,B}
+\section{A,B,D,E}
+A,B,D,E
+\begin{verbatim}
+\toftagthis{B,C}
+\end{verbatim}
+\toftagthis{B, C}
+\section{B,C,D,E}
+B,C,D
+\begin{verbatim}
+\toftagthis{A,C}
+\toftagstop{E}
+\end{verbatim}
+\toftagthis{ A, C}
+\toftagstop{ E}
+\section{A,C,D}
+A,C,D
+\begin{verbatim}
+\toftagstop{D}
+\toftagthis{A,B,C}
+\end{verbatim}
+\toftagstop{D }
+\toftagthis{A,B,C }
+\section{A,B,C}
+A,B,C
+\begin{verbatim}
+\toftagstop{A,B,C,D,E,F}
+\toftagstart{kitchenware,rabbits}
+\end{verbatim}
+\toftagstop{A,B, C,D,E,F}
+\toftagstart{ kitchenware,rabbits}
+\section{Knives and rabbits}
+\begin{verbatim}
+\tofuntagthis{kitchenware}
+\end{verbatim}
+\tofuntagthis{kitchenware}
+\subsection{Hunting rabbits}
+\begin{verbatim}
+\tofuntagthis{rabbits}
+\end{verbatim}
+\tofuntagthis{rabbits}
+\subsection{Best knives for cooking}
+\subsection{Eating rabbits}
+\begin{verbatim}
+\toftagstart{ecology}\tofuntagthis{rabbits}
+\end{verbatim}
+\toftagstart{ecology}\tofuntagthis{ rabbits}
+\section{Knives and global climate}
+\begin{verbatim}
+\toftagstop{kitchenware}
+\end{verbatim}
+\toftagstop{kitchenware }
+\section{The rabbit in the wild}
+\subsection{Impact of the rabbit on global climate}
+\begin{verbatim}
+\toftagstop{rabbits}
+\end{verbatim}
+\toftagstop{ rabbits}
+\section{Other species of interest for cooking}
+\end{document}\endinput
+\endinput
+%%
+%% End of file `tableoftest.tex'.