summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/shadethm/shadethm-doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/shadethm/shadethm-doc.tex')
-rw-r--r--macros/latex/contrib/shadethm/shadethm-doc.tex38
1 files changed, 28 insertions, 10 deletions
diff --git a/macros/latex/contrib/shadethm/shadethm-doc.tex b/macros/latex/contrib/shadethm/shadethm-doc.tex
index 26e1af15ad..8bdd9af96d 100644
--- a/macros/latex/contrib/shadethm/shadethm-doc.tex
+++ b/macros/latex/contrib/shadethm/shadethm-doc.tex
@@ -7,6 +7,13 @@
\usepackage{textcomp}
\usepackage{microtype}
\usepackage{hyperref}
+ \hypersetup{
+ colorlinks=true, % false: boxed links; true: colored links
+ linkcolor=blue, % color of internal links (change box color with linkbordercolor)
+ citecolor=blue, % color of links to bibliography
+ filecolor=blue, % color of file links
+ urlcolor=blue % color of external links
+ }
\newcommand*{\mail}[1]{\href{mailto:#1}{\texttt{#1}}}
\newcommand*{\pkg}[1]{\textsf{#1}}
@@ -24,14 +31,21 @@
\title{The \pkg{shadethm} package}
\subtitle{ Shaded theorem environments in \LaTeX,\\with \cmd{\newshadetheorem} in addition to \cmd{\newtheorem}}
-\author{Jim Hefferon\thanks{\mail{hefferon@smcvax.smcvt.edu}}}
-\date{1999/11/23}
+\author{Jim Hef{}feron\thanks{\mail{jhefferon@smcvt.edu}}}
+\date{2020/01/08}
\begin{document}
\maketitle
+\section{This package is obsolete}
+New projects should not use this package.
+There are a number of newer and more powerful packages that are available.
+
+This material only remains available for people supporting existing
+projects.
+
\section{Usage}
@@ -84,8 +98,8 @@ gives color shading.
but this one drops that requirement. If you didn't use the old version,
forget about it.
-\item Uses the \pkg{graphics} package. Look for it in the \href{http://ctan.org/}{CTAN} \TeX-archive nearest
- you, for instance at \href{http://tug.ctan.org/}{\texttt{tug.ctan.org}}.
+% \item Uses the \pkg{graphics} package. Look for it in the \href{http://ctan.org/}{CTAN} \TeX-archive nearest
+% you, for instance at \href{http://tug.ctan.org/}{\texttt{tug.ctan.org}}.
\item Works with \pkg{amsthm.sty}.
@@ -123,15 +137,15 @@ first).
looks good out of my printer, while a darker shade like~.92 is needed
to make it copy well. (Black is~0, white is~1.)
-\item[(\ref{item:i}*)] \desc{\texttt{shaderulecolor}}
+\item \desc{\texttt{shaderulecolor}}
The shading color of the border of the shaded box.
See (\ref{item:i}). If \cmd{\shadeboxrule} is set to 0\,pt then this won't print anyway.
-\item[(\ref{item:i}**)] \desc{\cmd{\shadeboxrule}}
+\item \desc{\cmd{\shadeboxrule}}
The width of the border around the shading. Set it to
0\,pt (not just 0) to make it disappear.
-\item[(\ref{item:i}***)] \desc{\cmd{\shadeboxsep}}
+\item \desc{\cmd{\shadeboxsep}}
The length by which the shade box surrounds the text.
\item \desc{\cmd{\shadesetinsideminipage}}
@@ -162,17 +176,20 @@ under N\TeX.
\section{Bugs}
+Note that this material is obsolete.
+The bug listed will not be fixed.
+
\begin{enumerate}
\item Page breaks are a problem since it sets the theorem before it is shaded.
The theorem is put into a \env{minipage} in order to have the right line breaks
- put in, but then can't be broken across pages. I'd be interested in any
- fixes for this. DA?
+ put in, but then can't be broken across pages.
\end{enumerate}
\section{License}
-Copyright 1999 Jim Hefferon \mail{jim@joshua.smcvt.edu}\\
+Copyright 1999-2020 Jim Hefferon \mail{jhefferon@smcvt.edu}.
+
This program can redistributed and/or modified under the terms
of the \LaTeX\ Project Public License Distributed from CTAN
archives in directory \href{http://ctan.org/macros/latex/base/lppl.txt}{\nolinkurl{macros/latex/base/lppl.txt}}; either
@@ -184,6 +201,7 @@ version~1 of the License, or (at your option) any later version.
\section{History}
\begin{description}
+\item[\texttt{20I08} jh \mail{jhefferon@smcvt.edu}] Declare package obsolete to keep people from mistakenly starting new projects with it.
\item[\texttt{99XI23} jh] Redid the parsing to stick to \cmd{\newcommand}-style calls. Needed
to put in some oppresive \cmd{\expandafter} strings.
\item[\texttt{99VII09} jh \mail{tex@joshua.smcvt.edu}] Fixed the number within situation. LPPL