summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/warning/warning-doc.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/warning/warning-doc.tex
Initial commit
Diffstat (limited to 'macros/latex/contrib/warning/warning-doc.tex')
-rw-r--r--macros/latex/contrib/warning/warning-doc.tex78
1 files changed, 78 insertions, 0 deletions
diff --git a/macros/latex/contrib/warning/warning-doc.tex b/macros/latex/contrib/warning/warning-doc.tex
new file mode 100644
index 0000000000..d8b78dbdf6
--- /dev/null
+++ b/macros/latex/contrib/warning/warning-doc.tex
@@ -0,0 +1,78 @@
+\documentclass[pagesize=auto, parskip=half, fontsize=12pt, DIV=11]{scrartcl}
+
+\usepackage{fixltx2e}
+\usepackage{etex}
+\usepackage{lmodern}
+\usepackage[T1]{fontenc}
+\usepackage{textcomp}
+\usepackage[svgnames]{xcolor}
+\usepackage{listings}
+\usepackage{microtype}
+\usepackage{hyperref}
+
+\newcommand*{\mail}[1]{\href{mailto:#1}{\texttt{#1}}}
+\newcommand*{\pkg}[1]{\textsf{#1}}
+\newcommand*{\cs}[1]{\texttt{\textbackslash#1}}
+\makeatletter
+\newcommand*{\cmd}[1]{\cs{\expandafter\@gobble\string#1}}
+\makeatother
+\newcommand*{\meta}[1]{\textlangle\textsl{#1}\textrangle}
+\newcommand*{\marg}[1]{\texttt{\{}\meta{#1}\texttt{\}}}
+
+\addtokomafont{title}{\rmfamily}
+\deffootnote{1em}{1em}{\textsuperscript{\thefootnotemark}}
+
+\lstset{%
+ language=[LaTeX]TeX,%
+ columns=flexible,%
+ upquote=true,%
+ numbers=left,%
+ basicstyle=\ttfamily,%
+ keywordstyle=\color{Navy},%
+ commentstyle=\color{DimGray},%
+ stringstyle=\color{SeaGreen},%
+ numberstyle=\scriptsize\color{SlateGray}%
+}
+
+\title{The \pkg{warning} package\thanks{This manual corresponds to \pkg{warning.sty}~v0.01, dated~2001/08/17.}}
+\subtitle{Global warnings at the end of the screen output\\and the logfile}
+\author{Harald Harders\thanks{\mail{h.harders@tu-bs.de}}}
+\date{2001/08/17}
+
+
+\begin{document}
+
+\maketitle
+
+Sometimes a class or package has to make a global warning such as
+``Rerun for this or that reason'' or ``This is draft, change this
+before the final run''. If you are generating them with
+\verb+\AtEndDocument{\PackageWarningNoLine+\marg{packagename}\marg{warning}\verb+}+
+the warning appears very early before the filelist. Then the
+warning can easily be overseen. This package provides a command
+that surely puts the warning at the end near to the global
+warnings generated by \LaTeX\ itself.
+You can add a warning to a list of user defined warnings using the
+command \cmd{\addglobalwarning} as it can be seen in the example below.
+
+This package could be useful for the warnings generated e.\,g.\ by
+the packages \pkg{changebar.sty} or \pkg{longtable.sty}.
+
+Harald Harders
+
+
+\minisec{Example:}
+
+\begin{lstlisting}
+\documentclass{article}
+\usepackage{warning}
+\addglobalwarning{%
+ \ClassWarningNoLine{testclass}{This is a global warning}}
+\addglobalwarning{%
+ \PackageWarningNoLine{testpackage}{This is another global warning}}
+\begin{document}
+Hello
+\end{document}
+\end{lstlisting}
+
+\end{document}