nomencl (30dec18)

git-svn-id: svn://tug.org/texlive/trunk@49548 c570f23f-e606-0410-a88d-b1316a301751

13 files changed, 203 insertions, 62 deletions

diff --git a/Master/texmf-dist/doc/latex/nomencl/Makefile b/Master/texmf-dist/doc/latex/nomencl/Makefile
new file mode 100644
index 00000000000..74c49a80b18
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/nomencl/Makefile
@@ -0,0 +1,65 @@
+
+PACKAGE=nomencl
+
+SAMPLES = sample01.tex sample02.tex sample03.tex sample04.tex sample05.tex 
+
+CFG = sample04.cfg sample05.cfg sample06.cfg
+
+
+SAMPLEPDF = ${SAMPLES:%.tex=%.pdf}
+
+PDF = $(PACKAGE).pdf ${SAMPLEPDF}
+
+all:  ${PDF} ${SAMPLES} ${CFG} ${PACKAGE}.sty
+
+
+%.sty:  %.ins %.dtx
+	pdflatex $*.ins
+
+sample%.tex:  nomencl.ins nomencl.sty
+	pdflatex nomencl.ins
+
+sample%.cfg: nomencl.ins nomencl.dtx
+	pdflatex nomencl.ins
+
+
+%.pdf:  %.dtx ${PACKAGE}.sty 
+	pdflatex $<
+	- bibtex $*
+	pdflatex $<
+	- makeindex -s gind.ist -o $*.ind $*.idx
+	- makeindex -s gglo.ist -o $*.gls $*.glo
+	pdflatex $<
+	while ( grep -q '^LaTeX Warning: Label(s) may have changed' $*.log) \
+	do pdflatex $<; done
+
+
+sample%.pdf: sample%.tex ${CFG} ${PACKAGE}.sty
+	pdflatex sample$*.tex
+	makeindex sample$*.nlo -s nomencl.ist -o sample$*.nls
+	pdflatex sample$*.tex
+	pdflatex sample$*.tex
+
+
+
+clean:
+	$(RM)  ${PACKAGE}.sty *.log *.aux \
+	*.cfg *.glo *.idx *.toc \
+	*.ilg *.ind *.out *.lof \
+	*.lot *.bbl *.blg *.gls *.cut *.hd \
+	*.dvi *.ps *.thm *.tgz *.zip *.rpi *.drv *.ist \
+	*.nlo *.nls ${SAMPLES} ${CFG}
+
+distclean: clean
+	$(RM) $(PDF) 
+
+#
+# Archive for the distribution. Includes typeset documentation
+#
+archive:  all clean
+	COPYFILE_DISABLE=1 tar -C .. -czvf ../$(PACKAGE).tgz --exclude '*~' --exclude '*.tgz' --exclude '*.zip'  --exclude CVS --exclude '.git*' $(PACKAGE); mv ../$(PACKAGE).tgz .
+
+zip:  all clean
+	zip -r  $(PACKAGE).zip * -x '*~' -x '*.tgz' -x '*.zip' -x CVS -x 'CVS/*'
+
+.PRECIOUS: ${SAMPLES} ${CFG}
diff --git a/Master/texmf-dist/doc/latex/nomencl/README b/Master/texmf-dist/doc/latex/nomencl/README
index 1329904b5f2..42b11bc6373 100644
--- a/Master/texmf-dist/doc/latex/nomencl/README
+++ b/Master/texmf-dist/doc/latex/nomencl/README
@@ -1,5 +1,4 @@
-This is the README file for the nomencl package. Please read the
-license information at the end of this file.
+			   NOMENCL PACKAGE
 
 
 PURPOSE
@@ -8,65 +7,12 @@ The nomenclature package can be used to generate and format a
 nomenclature using MakeIndex.
 
 
-INSTALLATION
-
-To install the nomencl package you need:
-  nomencl.ins
-  nomencl.dtx
-  docstrip.tex (part of the standard LaTeX2e distribution)
-               (I think you need at least version 2.4)
-
-Run LaTeX on the file nomencl.ins to strip the comments from nomencl.dtx and 
-produce the style file nomencl.sty, the index format file nomencl.ist and some
-sample configuration files. Put the file nomencl.sty somewhere LaTeX can find 
-it and nomencl.ist somewhere MakeIndex can find. Read the documentation of 
-your LaTeX system to find out where this might be. 
-
-If you're new to this, see
-http://www.tex.ac.uk/cgi-bin/texfaq2html?label=instpackages for more
-information on installing packages.
-
-
-DOCUMENTATION
-
-To produce the documentation you also need:
-  ltxdoc.cls (part of the standard LaTeX2e distribution)
-  doc.sty (part of the standard LaTeX2e distribution)
-  url.sty (part of almost all LaTeX2e distributions)
-
-If you want the standard documentation, run LaTeX on nomencl.dtx.
-If you want a more detailed documentation with the code and an index,
-use nomencl.drv and modify it according to the following notes.
-
-To get documentation of the code, put a percent sign in front of the
-\OnlyDescription.
-
-If you additionally want to know about the change history, uncomment the
-indicated lines in nomencl.drv and use the following commands:
-    latex nomencl.drv
-    makeindex -s gglo.ist -o nomencl.gls nomencl.glo
-    latex nomencl.drv
-Then the change history should appear at the end of the documentation.
-Note that this list is only complete if you include the code (see above).
-
-If you want to have an index of all the new and redefined macros and
-environments, uncomment the indicated lines and use the following 
-commands:
-    latex nomencl.drv
-    makeindex -s gind.ist nomencl.idx
-    latex nomencl.drv
-
 
 COPYING AND MODIFICATION
 
-Copyright 1996 Boris Veytsman
-Copyright 1999-2001 Bernd Schandl
-
-The nomencl package consists of the following files:
+Copyright 1996-2018 Boris Veytsman, Bernd Shandl, Lee Netherton, CV
+Radhakrishnan, Brian Elmegaard
 
-  README       Instructions on installation and documentation.
-  nomencl.ins  The installation driver.
-  nomencl.dtx  The documentation and the documented source code.
 
 This package can be redistributed and/or modified under the terms
 of the LaTeX Project Public License distributed from CTAN
@@ -78,9 +24,10 @@ backup, or in case you want to pass the nomencl package on to someone
 else.
 
 
-HELP
-
-CV Radhakrishnan
-Lee Netherton
-www   http://sarovar.org/projects/nomencl/
+VERSION HISTORY
 
+  v5.0 2018/12/29   New maintainer:  Boris Veytsman
+       		    Cleaned code and documentation
+		    Incorporated nomentbl code
+		    New options:  stdsubgroups, nomentbl,
+		    	user selectable configuratuon file
\ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/nomencl/nomencl.pdf b/Master/texmf-dist/doc/latex/nomencl/nomencl.pdf
index 6b8e6262919..d96ae01c21d 100644
--- a/Master/texmf-dist/doc/latex/nomencl/nomencl.pdf
+++ b/Master/texmf-dist/doc/latex/nomencl/nomencl.pdf
diff --git a/Master/texmf-dist/doc/latex/nomencl/sample01.pdf b/Master/texmf-dist/doc/latex/nomencl/sample01.pdf
new file mode 100644
index 00000000000..85dddbf53c1
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/nomencl/sample01.pdf
diff --git a/Master/texmf-dist/doc/latex/nomencl/sample01.tex b/Master/texmf-dist/doc/latex/nomencl/sample01.tex
new file mode 100644
index 00000000000..6c756d37eef
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/nomencl/sample01.tex
@@ -0,0 +1,17 @@
+\documentclass{article}
+\usepackage[nocfg]{nomencl}
+\makenomenclature
+\begin{document}
+\section*{Main equations}
+\begin{equation}
+  a=\frac{N}{A}
+\end{equation}%
+\nomenclature{$a$}{The number of angels per unit area}%
+\nomenclature{$N$}{The number of angels per needle point}%
+\nomenclature{$A$}{The area of the needle point}%
+The equation $\sigma = m a$%
+\nomenclature{$\sigma$}{The total mass of angels per unit area}%
+\nomenclature{$m$}{The mass of one angel}
+follows easily.
+\printnomenclature
+\end{document}
diff --git a/Master/texmf-dist/doc/latex/nomencl/sample02.pdf b/Master/texmf-dist/doc/latex/nomencl/sample02.pdf
new file mode 100644
index 00000000000..1cde472f907
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/nomencl/sample02.pdf
diff --git a/Master/texmf-dist/doc/latex/nomencl/sample02.tex b/Master/texmf-dist/doc/latex/nomencl/sample02.tex
new file mode 100644
index 00000000000..dee73cea935
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/nomencl/sample02.tex
@@ -0,0 +1,34 @@
+\documentclass{article}
+\usepackage[stdsubgroups,nocfg]{nomencl}
+\usepackage{setspace}
+    \makenomenclature
+\begin{document}
+\section*{Main equations}
+Here an equation
+    \begin{equation}\label{eq:heatflux}
+        \dot{Q} = k \cdot A \cdot \Delta T
+    \end{equation}%
+    \nomenclature[aQ]{$\dot{Q}$}{heat flux}%
+    \nomenclature[ak]{$k$}{overall heat transfer
+      coefficient}%
+    \nomenclature[aA]{$A$}{area}%
+    \nomenclature[aL]{$L$}{length}%
+    \nomenclature[aT]{$T$}{temperature}%
+    \nomenclature[aT]{$\Delta T$}{temperature difference}%
+or another one
+    \begin{equation}\label{eq:ohtc}
+        \frac{1}{k} = \left[\frac{1}{\alpha _{\mathrm{i}}\,r_{\mathrm{i}}} +
+        \sum^n_{j=1}\frac{1}{\lambda _j}\,
+        \ln \frac{r_{\mathrm{a},j}}{r_{\mathrm{i},j}} +
+        \frac{1}{\alpha _{\mathrm{a}}\,
+          r_{\mathrm{a}}}\right] \cdot r_{\mathrm{reference}}
+    \end{equation}%
+    \nomenclature[ga]{$\alpha$}{convection heat transfer coefficient}%
+    \nomenclature[zi]{i}{in}%
+    \nomenclature[gl]{$\lambda$}{thermal conductivity}%
+    \nomenclature[za]{a}{out}%
+    \nomenclature[zn]{$n$}{number of walls}%
+    \nomenclature[zj]{$j$}{running parameter}%
+\onehalfspacing
+\printnomenclature
+\end{document}
diff --git a/Master/texmf-dist/doc/latex/nomencl/sample03.pdf b/Master/texmf-dist/doc/latex/nomencl/sample03.pdf
new file mode 100644
index 00000000000..32ac6818e53
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/nomencl/sample03.pdf
diff --git a/Master/texmf-dist/doc/latex/nomencl/sample03.tex b/Master/texmf-dist/doc/latex/nomencl/sample03.tex
new file mode 100644
index 00000000000..f06ad3f196b
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/nomencl/sample03.tex
@@ -0,0 +1,37 @@
+\documentclass{article}
+\usepackage[nomentbl,stdsubgroups]{nomencl}
+\usepackage{setspace}
+\makenomenclature
+\begin{document}
+\section*{Main equations}
+Here an equation
+    \begin{equation}\label{eq:heatflux}
+        \dot{Q} = k \cdot A \cdot \Delta T
+    \end{equation}%
+    \nomenclature[aQ]{$\dot{Q}$}{heat flux}{W}{}%
+    \nomenclature[ak]{$k$}{overall heat transfer
+      coefficient}{\watt\per(\square\meter\kelvin)}{see
+      eq.~(\ref{eq:ohtc})}%
+    \nomenclature[aA]{$A$}{area}{\square\meter}{}%
+    \nomenclature[aL]{$L$}{length}{\meter}{SI base quantity}%
+    \nomenclature[aT]{$T$}{temperature}{\kelvin}{SI base quantity}%
+    \nomenclature[aT]{$\Delta T$}{temperature difference}{\kelvin}{SI base quantity}%
+or another one
+    \begin{equation}\label{eq:ohtc}
+        \frac{1}{k} = \left[\frac{1}{\alpha _{\mathrm{i}}\,r_{\mathrm{i}}} +
+        \sum^n_{j=1}\frac{1}{\lambda _j}\,
+        \ln \frac{r_{\mathrm{a},j}}{r_{\mathrm{i},j}} +
+        \frac{1}{\alpha _{\mathrm{a}}\,
+          r_{\mathrm{a}}}\right] \cdot r_{\mathrm{reference}}
+    \end{equation}%
+    \nomenclature[ga]{$\alpha$}{convection heat transfer
+      coefficient}{\watt\per(\square\meter\kelvin)}{}%
+    \nomenclature[zi]{i}{in}{}{}%
+    \nomenclature[gl]{$\lambda$}{thermal conductivity}{\watt\per\kelvin}{}%
+    \nomenclature[za]{a}{out}{}{}%
+    \nomenclature[zn]{$n$}{number of walls}{}{}%
+    \nomenclature[zj]{$j$}{running parameter}{}{}%
+
+\onehalfspacing
+\printnomenclature
+\end{document}
diff --git a/Master/texmf-dist/doc/latex/nomencl/sample04.pdf b/Master/texmf-dist/doc/latex/nomencl/sample04.pdf
new file mode 100644
index 00000000000..85db6b9e159
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/nomencl/sample04.pdf
diff --git a/Master/texmf-dist/doc/latex/nomencl/sample04.tex b/Master/texmf-dist/doc/latex/nomencl/sample04.tex
new file mode 100644
index 00000000000..0d806fd18ec
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/nomencl/sample04.tex
@@ -0,0 +1,21 @@
+\documentclass{article}
+\usepackage[cfg=sample04.cfg]{nomencl}
+\usepackage{siunitx}
+\makenomenclature
+\begin{document}
+\section*{Main equations}
+\begin{equation}
+  a=\frac{N}{A}
+\end{equation}%
+\nomenclature{$a$}{The number of angels per unit
+  area\nomunit{\per\square\meter}}%
+\nomenclature{$N$}{The number of angels per needle point}%
+\nomenclature{$A$}{The area of the needle
+  point\nomunit{\square\meter}}%
+The equation $\sigma = m a$%
+\nomenclature{$\sigma$}{The total mass of angels per unit
+  area\nomunit{\kilogram\per\square\meter}}%
+\nomenclature{$m$}{The mass of one angel\nomunit{\kilogram}}
+follows easily.
+\printnomenclature
+\end{document}
diff --git a/Master/texmf-dist/doc/latex/nomencl/sample05.pdf b/Master/texmf-dist/doc/latex/nomencl/sample05.pdf
new file mode 100644
index 00000000000..bb65d3572d0
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/nomencl/sample05.pdf
diff --git a/Master/texmf-dist/doc/latex/nomencl/sample05.tex b/Master/texmf-dist/doc/latex/nomencl/sample05.tex
new file mode 100644
index 00000000000..1a46233909c
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/nomencl/sample05.tex
@@ -0,0 +1,20 @@
+\documentclass{article}
+\usepackage[cfg=sample05.cfg]{nomencl}
+\makenomenclature
+\begin{document}
+\section*{Main equations}
+\begin{equation}
+  a=\frac{N}{A}
+\end{equation}%
+\newcommand{\magritte}{Not the number }
+\nomenclature{$a$}{\magritte of angels per unit area}%
+\nomenclature{$N$}{\magritte of angels per needle point}%
+\nomenclature{$A$}{The area of the needle point}%
+The equation $\sigma = m a$%
+\nomenclature{$\sigma$}{The total mass of angels per unit area}%
+\nomenclature{$m$}{The mass of one angel}
+follows easily.
+
+\renewcommand{\magritte}{The number }
+\printnomenclature
+\end{document}