CTAN Comprehensive TeX Archive Network

Directory macros/latex/contrib/warning

README
README for warning package, 2023-03-18, v0.10


TABLE OF CONTENTS
=================

1 Introduction
2 Download
3 Installation


1 INTRODUCTION
==============

Note 1: This package is obsolete. For LaTeX-format 2020-10-01 and newer:
Instead of \addglobalwarning{ something } use
\AddToHook{enddocument/info}{ something } and do not load the warning package.

Note 2: The package author, Harald Harders, is inactive.


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
\AtEndDocument{\PackageWarningNoLine{<packagename>}{<warning>}}
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 \addglobalwarning as it can be seen in
the example below.

This material is published under the LPPL 1.3c: This work may be
distributed and/or modified under the conditions of the LaTeX Project
Public License, either version 1.3c of this license or (at your option)
any later version. This version of this license is in
https://www.latex-project.org/lppl/lppl-1-3c.txt
and the latest version of this license is in
https://www.latex-project.org/lppl.txt
and version 1.3c or later is part of all distributions of
LaTeX version 2005-12-01 or later.


2 DOWNLOAD
==========

"warning" is available on CTAN:
https://ctan.org/pkg/warning

Also a ZIP file is provided that contains the files:
the manual (warning-doc.tex and warning-doc.pdf,
including examples),
the style file (warning.sty),
and this README:
https://mirrors.ctan.org/macros/latex/contrib/warning.zip


3 INSTALLATION
==============

a) Download the warning files from CTAN.
   If necessary, unpack them.
b) Install the file "warning.sty" in your TDS tree:
     cp warning.sty TDS:tex/latex/warning/
   Replace "TDS:" by the prefix of your TDS tree
   (texmf directory).
c) Create the documentation, if necessary, e.g.
     pdflatex warning.tex
     pdflatex warning.tex
d) Update the databases if necessary, e.g. for TeX Live
     texhash or mktexlsr.
e) Create the warning-example.pdf, if necessary,
     by copying the example code from the documentation
     into (a) separate .tex file(s) and compiling that (those).
f) Copy the documentation files to
   "TDS:doc/latex/warning/":
   README, warning.pdf, warning.tex,
   and the example(s), if you created any.

Download the contents of this package in one zip archive (279.1k).

warning – Global warnings at the end of the logfile

This package is obsolete. For -format 2020-10-01 and newer: Instead of \addglobalwarning{ something } use \AddToHook{enddocument/info}{ something } and do not load the warning package.

For older formats this package provides a command that generates a list of warnings that are printed out at the very end of the logfile. This is useful for warnings such as ‘Rerun for this or that reason’ or ‘This is a draft, change it before the final run’.

Packagewarning
Version0.10 2023-03-18
LicensesThe Project Public License 1.3c
Copyright2001 Harald Harders
MaintainerHarald Harders (inactive)
Contained inTeX Live as warning
MiKTeX as warning
TopicsComp supp
...
Guest Book Sitemap Contact Contact Author