diff options
author | Karl Berry <karl@freefriends.org> | 2008-02-18 00:22:07 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2008-02-18 00:22:07 +0000 |
commit | e2041bab726766a5193e515f8a7e1761613d1222 (patch) | |
tree | f757513bdd2ecb46dec6a6160b3bccfd1e75b0d4 /Master/texmf-dist/doc/latex/thmtools | |
parent | 957aeb141e1e62fc19b0aedb3bc36ad058226250 (diff) |
new latex package thmtools (17feb08)
git-svn-id: svn://tug.org/texlive/trunk@6667 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/thmtools')
-rw-r--r-- | Master/texmf-dist/doc/latex/thmtools/README | 16 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/thmtools/TODO | 11 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/thmtools/demo.tex | 71 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/thmtools/thmtools.pdf | bin | 0 -> 84987 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/thmtools/thmtools.tex | 99 |
5 files changed, 197 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/thmtools/README b/Master/texmf-dist/doc/latex/thmtools/README new file mode 100644 index 00000000000..7fe0ec979f3 --- /dev/null +++ b/Master/texmf-dist/doc/latex/thmtools/README @@ -0,0 +1,16 @@ + The \thmtools\ bundle provides several packages for commonly-needed + features for theorems. As designed, the bundle should work with kernel + theorems, the theorem package and the amsthm package. + + WARNING: Currently, things might still be a bit rough. You + might want to consider not relying on \thmtools\ for your Ph.D. thesis + masterpiece. + +Provided features: +a keyval interface to \newtheorem +a \listoftheorem command +hyperref/autoref compatibility +a way of restating entire theorems with a single macro call + +License: LPPL 1.3a; maintained by ulmi@absatzen.de +$Id: README,v 1.1 2008/02/17 21:13:58 ulmi Exp ulmi $ diff --git a/Master/texmf-dist/doc/latex/thmtools/TODO b/Master/texmf-dist/doc/latex/thmtools/TODO new file mode 100644 index 00000000000..f41779340f3 --- /dev/null +++ b/Master/texmf-dist/doc/latex/thmtools/TODO @@ -0,0 +1,11 @@ +- ref close-by/far-away +- complex refs + (these two are very similar) + + +- starred theorems and number in list-of-theorems + FIXED by empty \thefoo macro for starred theorems. +- getting envname via currenvir is unsafe for theorems (think restatable) + FIXED by manually changing \@currenvir in restatable. + FIXED by new hooks that def\thmt@thmname et al. in the theorem itself. + diff --git a/Master/texmf-dist/doc/latex/thmtools/demo.tex b/Master/texmf-dist/doc/latex/thmtools/demo.tex new file mode 100644 index 00000000000..31e0adc524d --- /dev/null +++ b/Master/texmf-dist/doc/latex/thmtools/demo.tex @@ -0,0 +1,71 @@ +\documentclass{article} + +\usepackage{amsmath, amsthm} + + +\usepackage{ + thm-listof, + thm-restate, + thm-autoref, + thm-kv, + } + +\usepackage{hyperref} + +\declaretheorem[unnumbered, + title={Zorn's Lemma}]{zl} +%\newtheorem*{zl}{Zorn's Lemma} +\declaretheorem[numberwithin=section]{theorem} +%\newtheorem{theorem}{Theorem}[section] +\declaretheorem[sibling=theorem]{lemma} +%\newtheorem{lemma}[theorem]{Lemma} +\declaretheorem[numberlike=lemma]{axiom} +%\newtheorem{axiom}[lemma]{Axiom} + + +\begin{document} + \section{Introduction} + + In this dummy document, we will show important things. One very important + insight is + \begin{lemma}[Zorn] + If every chain in $X$ is bounded, $X$ has a maximal element. + + (Here, $X$ is a set system.) + \end{lemma} + + This lemma is so important that it's a fixed name: + \begin{restatable}{zl}{zornslemma} + If every chain in $X$ is bounded, $X$ has a maximal element. + + (Here, $X$ is a set system.) + \end{restatable} + + We will conclude in important theorem from this: + \begin{restatable}[Well-ordering]{theorem}{wohlordnung}\label{thm:order} + Every set is well-ordered. + \end{restatable} + + %\show\wohlordnung + + \section{Main} + + Here, we will prove \wohlordnung which first appeared + as~\autoref{thm:order} on page~\pageref{thm:order} and is + actually equivalent to + \zornslemma + + Another equivalent formulation is + \begin{axiom}[Axiom of Choice] + If you have a non-empty set, you can take an element out of it. + \end{axiom} + + \section{Conclusion} + + To remind you, these are the theorems that occur in this document, + ignoring Lemmas: + + \ignoretheorems{lemma} + \listoftheorems + +\end{document} diff --git a/Master/texmf-dist/doc/latex/thmtools/thmtools.pdf b/Master/texmf-dist/doc/latex/thmtools/thmtools.pdf Binary files differnew file mode 100644 index 00000000000..08a7eb8bcbb --- /dev/null +++ b/Master/texmf-dist/doc/latex/thmtools/thmtools.pdf diff --git a/Master/texmf-dist/doc/latex/thmtools/thmtools.tex b/Master/texmf-dist/doc/latex/thmtools/thmtools.tex new file mode 100644 index 00000000000..6b8bef7ce29 --- /dev/null +++ b/Master/texmf-dist/doc/latex/thmtools/thmtools.tex @@ -0,0 +1,99 @@ +%$Id: thmtools.tex,v 1.3 2008/02/17 21:08:04 ulmi Exp ulmi $ +\documentclass[a4paper, abstracton]{scrartcl} + +\usepackage[T1]{fontenc} +\usepackage{fourier} +\usepackage[scaled]{helvet} + +\addtokomafont{sectioning}{\fontseries{bc}\selectfont} + +\newcommand\thmtools{\textsf{thmtools}} + +\title{The \thmtools\ bundle\thanks{% + This is a beta version. If you want to slightly ahead of your time, + new development versions are availably from http://www.absatzen.de/thmtools.html +}} +\author{Ulrich M. Schwarz\thanks{ulmi@absatzen.de}} + +\begin{document} + \maketitle + + \begin{abstract} + The \thmtools\ bundle provides several packages for commonly-needed + features for theorems. As designed, the bundle should work with kernel + theorems, the theorem package and the amsthm package. + + \textbf{Warning:} Currently, things might still be a bit rough. You + might want to consider not relying on \thmtools\ for your Ph.D. thesis + masterpiece. + \end{abstract} + + + \section{thm-autoref} + + Fixes cooperation with hyperref's \verb|\autoref|. No further intervention + on part of the user needed. (Loads aliasctr, thm-patch.) + + \section{thm-listof} + + Provides a \verb|\listoftheorems| command that works like + \verb|\listoffigures|. Also provided: a \verb|\ignoretheorems| command that + lets you exempt certain kinds: + \begin{verbatim} + \ignoretheorems{example,exercise,remark} + \end{verbatim} + There's currently no user interface to customize the appearance of the + LoTheorems. (Loads thm-patch.) + + \section{thm-kv} + + Provides a key-value alternative to \verb|\newtheorem|, because I keep + forgetting which optional argument goes where. Example: + \begin{verbatim} + \declaretheorem[unnumbered, title={Zorn's Lemma}]{zl} + %\newtheorem*{zl}{Zorn's Lemma} + \declaretheorem[numberwithin=section]{theorem} + %\newtheorem{theorem}{Theorem}[section] + \declaretheorem[sibling=theorem]{lemma} + %\newtheorem{lemma}[theorem]{Lemma} + \declaretheorem[numberlike=lemma]{axiom} + %\newtheorem{axiom}[lemma]{Axiom} + \end{verbatim} + Supported keywords (several for the same functionality, because if you + need to remember the keyword, you can just as well remember the order): + parent, numberwithin, within; sibling, numberlike, sharenumber; + unnumbered, starred\footnote{works only with amsthm}; title, name, + heading. + + Note: it's actually optional to give a title, in that case, the default is + the name of the environment, with first letter uppercased. + + \section{thm-restate} + + Provides an environment \verb|restatable| that essentially puts the entire + theorem into a single macro command for later re-statement: + \begin{verbatim} + \begin{restatable}[Well-ordering]{theorem}{wohlordnung}\label{thm:order} + Every set is well-ordered. + \end{restatable} + And again: \wohlordnung + \end{verbatim} + Note that the label will be handled correctly (i.e. not re-defined). + Limitation: verbatim-like things will not work. There's no handling for + other counters, so it's not advisable to put floats inside a restatable. + + \section{aliasctr} + + Helper package, see separate doc. + + \section{unique} + + Helper package, see separate doc. Not used yet. + + \section{thm-patch} + Helper package: redefines \verb|\newtheorem| so the defined theorems have + hooks we can use. Note that the redefinition will always allow + \verb|\newtheorem*| and giving contradicting optional arguments, but the + backend original \verb|\newtheorem| will complain. + +\end{document} |