Directory macros/latex/contrib/undolabl

README for undolabl package, 2024-12-05, v1.0n


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

1 Introduction
2 Download
3 Installation
4 Additional Packages
5 Package Compatibility
6 Authors/Maintainer
7 Bug Reports
8 Known Problems


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

This LaTeX package allows to override existing labels,
especially automatically generated ones.

The main code of this package was invented by
Ulrich Diez (eu_angelion AT web DOT de)
and first published in the
comp.text.tex newsgroup at Sun, 20 Apr 2008 16:39:26 +0200, with subject:
Re: How to undefine/overwrite a label? (see e.g.
https://groups.google.com/g/comp.text.tex/c/MBiR-EpPceo/m/2pdwkZP-bK8J
). While Ulrich Diez neither wanted to create a package himself yet
nor have one published under his name, he granted the
publication of his code. Therefore: Thanks!
I (H.-Martin Münch) submitted this package to CTAN
(after some updates of the documentation, mainly layout,
 typos and such things.)

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
==========

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

Also a ZIP file is provided that contains the files:
the manual (undolabl.pdf), the example (undolabl-example.tex),
the compiled example (undolabl-example.pdf),
driver (undolabl.drv), undolabl.dtx,
installation file (undolabl.ins),
the style file (undolabl.sty),
and this README, already sorted in a TDS tree:
https://mirror.ctan.org/install/macros/latex/contrib/undolabl.tds.zip


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

Installation with ZIP file in TDS format
----------------------------------------
The ZIP file "undolabl.tds.zip" contains the files
sorted in a TDS tree. Thus you can directly unpack the
ZIP file inside a TDS tree.
See https://www.ctan.org/TDS-guidelines for an explanation
of TDS.
Example:
  cd /...somewhere.../texmf
  unzip /...downloadpath.../undolabl.tds.zip
Do not forget to refresh the file name database of this
TDS tree.
Example:
  texhash /...somewhere.../texmf

Manual installation
-------------------
a) Download the undolabl files from CTAN.
   If necessary, unpack them.
b) Generate the package and driver files:
     tex undolabl.dtx
c) Install the file "undolabl.sty" in your TDS tree:
     cp undolabl.sty TDS:tex/latex/undolabl/
   Replace "TDS:" by the prefix of your TDS tree
   (texmf directory).
d) Create the documentation, if necessary, e.g.
     pdflatex undolabl.dtx
     makeindex -s gind.ist undolabl.idx
     pdflatex undolabl.dtx
     makeindex -s gind.ist undolabl.idx
     pdflatex undolabl.dtx
e) Update the databases if necessary, e.g. for TeXLive
     texhash or mktexlsr.
f) Create the undolabl-example.pdf, if necessary, e.g.
     pdflatex undolabl-example.tex
     pdflatex undolabl-example.tex
     pdflatex undolabl-example.tex
g) Copy the documentation files to
   "TDS:doc/latex/undolabl/":
   README, undolabl.pdf, undolabl-example.tex,
   undolabl-example.pdf.


4 ADDITIONAL PACKAGES
=====================

undolabl itself does not load other packages,
but working with labels usually means using
* hyperref, https://www.ctan.org/pkg/hyperref
which again loads other packages
(see the result of the \listfiles command in the log-file
of the example).
Also the undolabl.dtx loads other packages
(for unpacking and constructing the documentation),
see "5.1 Downloads" in the manual
https://mirror.ctan.org/macros/latex/contrib/undolabl/undolabl.pdf


5 PACKAGE COMPATIBILITY
=======================

undolabl is not compatible with versions of the acronym package
older than 2015/03/21 v1.41. The recent version of acronym is
available at https://www.ctan.org/pkg/acronym.


6 AUTHORS/MAINTAINER
=====================

* Author of the original main code:
   Ulrich Diez (Thanks!)
* Author of the recent package and current maintainer:
   H.-Martin Münch


7 BUG REPORTS
==============

A bug report should contain:
* Comprehensive problem description. This includes error or
  warning messages.
* \errorcontextlines=\maxdimen can be added in the
  TeX code to get more information in TeX error messages.
* Minimal test file that shows the problem,
  but does not contain any unnecessary packages and code.
* Used drivers/programs.
* Version information about used packages and programs.
* If you are using LaTeX, then add "\listfiles" to the document.
  Then a list of version information is printed at the end
  of the LaTeX run.
* Please no other files than the minimal test file.
  The other files .log, .dvi, .ps, .pdf are seldom
  necessary, so send them only on request.
* Please .zip or .tar.gz your file(s) before sending them!

Bug address
-----------
Bug reports can be send to the maintainer:
  H.-Martin Münch
  <Martin [dot] Muench [at] Uni-Bonn [dot] de>


8 KNOWN PROBLEMS
=================

* as yet: none.