From 95bcc37793c60b5e75659e1d951af49532980b7e Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Fri, 27 Mar 2020 21:14:17 +0000 Subject: physunits (27mar20) git-svn-id: svn://tug.org/texlive/trunk@54588 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/physunits/CHANGELOG.md | 20 ++++++ .../texmf-dist/doc/latex/physunits/physunits.pdf | Bin 100908 -> 105018 bytes .../source/latex/physunits/physunits.dtx | 75 +++++++++++++++++---- .../texmf-dist/tex/latex/physunits/physunits.sty | 18 ++--- 4 files changed, 91 insertions(+), 22 deletions(-) diff --git a/Master/texmf-dist/doc/latex/physunits/CHANGELOG.md b/Master/texmf-dist/doc/latex/physunits/CHANGELOG.md index 5ccb30dc100..d61164e2633 100644 --- a/Master/texmf-dist/doc/latex/physunits/CHANGELOG.md +++ b/Master/texmf-dist/doc/latex/physunits/CHANGELOG.md @@ -36,4 +36,24 @@ - modify the makefile to include the new distrubution readme and makefile - give instructions on using makefile for distribution - Did a little more reformatting in the README. +## [1.0.3.d] - 2020/01/26 +- there was some issues and mixup with tags in github. This is just a version +number change to get the github tags to show up in the right order +## [1.0.3.e] - 2020/01/26 +### Changed +- add a section on just build instructions into readme +## [1.0.4] - 2020/03/26 +### Changes +- kcal appeared to accept a prefix, though it was ignored; remove option for the +macro +- Celcius, Fahrenheit, and Rankine had the ^\circ outside of the ensuremath, +causing problems for text mode. The degree symbol is also typically typeset +with the unit instead of with the number. Correct both of these issues. +- correct version number and file date in dtx and pdf documentation +- Make sure \micro macro is compatable with siunitx +### Added +- Add acknowledgements to documentation +- Add bug reporting section to documentation +- Add prerequisites section to documentation +- Give some explanation of differences to siunitx in introduction diff --git a/Master/texmf-dist/doc/latex/physunits/physunits.pdf b/Master/texmf-dist/doc/latex/physunits/physunits.pdf index 090dfa7d836..e6f2ad825a1 100644 Binary files a/Master/texmf-dist/doc/latex/physunits/physunits.pdf and b/Master/texmf-dist/doc/latex/physunits/physunits.pdf differ diff --git a/Master/texmf-dist/source/latex/physunits/physunits.dtx b/Master/texmf-dist/source/latex/physunits/physunits.dtx index 103f97c0c8b..5bb71b3fa62 100644 --- a/Master/texmf-dist/source/latex/physunits/physunits.dtx +++ b/Master/texmf-dist/source/latex/physunits/physunits.dtx @@ -22,7 +22,7 @@ %\NeedsTeXFormat{LaTeX2e}[1994/06/01] % \ProvidesPackage{physunits} %<*package> - [2020/01/26 v1.0.3 Physical units package] + [2020/03/26 v1.0.4 Physical units package] % %\ProcessOptions\relax %<*driver> @@ -41,7 +41,7 @@ % % \fi % -% \CheckSum{486} +% \CheckSum{490} % % \CharacterTable % {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z @@ -63,10 +63,12 @@ % \changes{v1.0.1}{2020/01/25}{Clean up formatting, fix index} % \changes{v1.0.2}{2020/01/25}{External changes in makefile} % \changes{v1.0.3}{2020/01/26}{External changes in makefile} +% \changes{v1.0.4}{2020/03/26}{Corrected version number and date in +% documentation} % % \GetFileInfo{physunits.dtx} -% \DeclareRobustCommand{\fileversion}{v1.0} -% \DeclareRobustCommand{\filedate}{2020/01/26} +% \DeclareRobustCommand{\fileversion}{v1.0.4} +% \DeclareRobustCommand{\filedate}{2020/03/26} % % \DoNotIndex{\DeclareRobustCommand,\newenvironment,\DeclareRobustCommand, % \left,\right,\textbf,\mathrm,\ensuremath,\units@separator,\expandafter,\,} @@ -86,6 +88,33 @@ % physical units that are commonly used in introductory level physics and % astronomy classes. % +% At present, this package provides some similar units to those in siunitx, but +% is uses slightly different macro names for each. This package also provides +% a number of non-SI units (e.g. erg, cm, BTU). +% +% +% \section{Prerequisites / Dependencies} +% \changes{v1.0.4}{2020/03/26}{Added section for dependencies.} +% +% \subsection{General} +% This package requires the \verb|physunits| package.% +% +% \subsection{Generating Documentation} +% The \verb|hyperref| package are required to generate the documentation +% (this file) for this package. +% +% \section{Acknowledgements} +% \changes{v1.0.4}{2020/03/26}{Added section for acknowledgements.} +% +% The author would like to thank Brian Dunn for catching bugs in the temperature +% units and kcal, leading to changes in v1.0.4. +% +% \section{Bug Reporting} +% \changes{v1.0.4}{2020/03/26}{Added section for bug reporting.} +% +% Please report bugs or issues in this package using github, at +% \url{https://github.com/astrobit/physunits/issues}.% +% % \section{Naming Convention} % % most macros consist of just the commonly used letter or unit, e.g. @@ -613,13 +642,17 @@ %\iffalse %<*package> %\fi -% \begin{macro}{\units@separator} -% |\units@separator| is a special macro used to set the spacing between a -% quantity and the associated units. +% \begin{macro}{\micro} +% \changes{v1.0.4}{2020/03/26}{Corrected version number and date in +% documentation} +% |\micro| is a special macro used to typeset the symbol \textbackslash mu. +% It is compatable with the \textbackslash micro in siunitx. % % \begin{macrocode} +\ifx\micro\undefined \DeclareRobustCommand{\micro}{\ensuremath{% \mu}} +\fi % \end{macrocode} % \end{macro} %\iffalse @@ -899,10 +932,12 @@ %<*package> %\fi % \begin{macro}{\kcal} +% \changes{v1.0.4}{2020/03/26}{kcal appeared to take a prefix, but the prefix +% was ignored; removed the prefix.} % |\kcal| is a macro for kilo-calories (kcal). % % \begin{macrocode} -\DeclareRobustCommand{\kcal}[1]{\ensuremath{% +\DeclareRobustCommand{\kcal}{\ensuremath{% \expandafter\units@separator\mathrm{kcal}}} % \end{macrocode} % \end{macro} @@ -1628,11 +1663,15 @@ %<*package> %\fi % \begin{macro}{\Celcius} +% \changes{v1.0.4}{2020/03/26}{had ${}^\circ$ outside of +% ensuremath, causing problems for text mode. It is also more common to typeset +% the $^\circ$ with the unit instead of the number. Corrects both of these +% issues} % |\Celcius| is a macro for degrees Celcius $(\Celcius)$. % % \begin{macrocode} -\DeclareRobustCommand{\Celcius}{^\circ\ensuremath{% -\expandafter\units@separator\mathrm{C}}} +\DeclareRobustCommand{\Celcius}{\ensuremath{\expandafter\units@separator{}% +^\circ\mathrm{C}}} % \end{macrocode} % \end{macro} %\iffalse @@ -1643,11 +1682,15 @@ %<*package> %\fi % \begin{macro}{\Rankine} +% \changes{v1.0.4}{2020/03/26}{had ${}^\circ$ outside of +% ensuremath, causing problems for text mode. It is also more common to typeset +% the $^\circ$ with the unit instead of the number. Corrects both of these +% issues} % |\Rankine| is a macro for degrees Rankine $(\Rankine)$. % % \begin{macrocode} -\DeclareRobustCommand{\Rankine}{^\circ\ensuremath{% -\expandafter\units@separator\mathrm{R}}} +\DeclareRobustCommand{\Rankine}{\ensuremath{% +\expandafter\units@separator{}^\circ\mathrm{R}}} % \end{macrocode} % \end{macro} %\iffalse @@ -1658,11 +1701,15 @@ %<*package> %\fi % \begin{macro}{\Fahrenheit} +% \changes{v1.0.4}{2020/03/26}{had ${}^\circ$ outside of +% ensuremath, causing problems for text mode. It is also more common to typeset +% the $^\circ$ with the unit instead of the number. Corrects both of these +% issues} % |\Fahrenheit| is a macro for degrees Fahrenheit $(\Fahrenheit)$. % % \begin{macrocode} -\DeclareRobustCommand{\Fahrenheit}{^\circ\ensuremath{% -\expandafter\units@separator\mathrm{F}}} +\DeclareRobustCommand{\Fahrenheit}{\ensuremath{% +\expandafter\units@separator{}^\circ\mathrm{F}}} % \end{macrocode} % \end{macro} %\iffalse diff --git a/Master/texmf-dist/tex/latex/physunits/physunits.sty b/Master/texmf-dist/tex/latex/physunits/physunits.sty index c84b78b9d9b..b463bcb81fa 100644 --- a/Master/texmf-dist/tex/latex/physunits/physunits.sty +++ b/Master/texmf-dist/tex/latex/physunits/physunits.sty @@ -22,14 +22,16 @@ %% \NeedsTeXFormat{LaTeX2e}[1994/06/01] \ProvidesPackage{physunits} - [2020/01/26 v1.0.3 Physical units package] + [2020/03/26 v1.0.4 Physical units package] \ProcessOptions\relax \makeatletter \DeclareRobustCommand{\units@separator}{\,} +\ifx\micro\undefined \DeclareRobustCommand{\micro}{\ensuremath{% \mu}} +\fi \DeclareRobustCommand{\V}[1][ ]{\ensuremath{% \expandafter\units@separator\mathrm{#1V}}} \DeclareRobustCommand{\Volt}[1][ ]{\ensuremath{% @@ -62,7 +64,7 @@ \expandafter\units@separator\mathrm{#1J}}} \DeclareRobustCommand{\erg}{\ensuremath{% \expandafter\units@separator\mathrm{erg}}} -\DeclareRobustCommand{\kcal}[1]{\ensuremath{% +\DeclareRobustCommand{\kcal}{\ensuremath{% \expandafter\units@separator\mathrm{kcal}}} \DeclareRobustCommand{\Cal}{\ensuremath{% \expandafter\units@separator\mathrm{Cal}}} @@ -161,12 +163,12 @@ \expandafter\units@separator\mathrm{#1K}}} \DeclareRobustCommand{\Kelvin}[1][ ]{\ensuremath{% \expandafter\units@separator\mathrm{#1K}}} -\DeclareRobustCommand{\Celcius}{^\circ\ensuremath{% -\expandafter\units@separator\mathrm{C}}} -\DeclareRobustCommand{\Rankine}{^\circ\ensuremath{% -\expandafter\units@separator\mathrm{R}}} -\DeclareRobustCommand{\Fahrenheit}{^\circ\ensuremath{% -\expandafter\units@separator\mathrm{F}}} +\DeclareRobustCommand{\Celcius}{\ensuremath{\expandafter\units@separator{}% +^\circ\mathrm{C}}} +\DeclareRobustCommand{\Rankine}{\ensuremath{% +\expandafter\units@separator{}^\circ\mathrm{R}}} +\DeclareRobustCommand{\Fahrenheit}{\ensuremath{% +\expandafter\units@separator{}^\circ\mathrm{F}}} \DeclareRobustCommand{\rpm}{\ensuremath{% \expandafter\units@separator\mathrm{rev}% -- cgit v1.2.3