summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/register
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-01-02 22:39:10 +0000
committerKarl Berry <karl@freefriends.org>2019-01-02 22:39:10 +0000
commit0955ea412309e785f88d6833a4770482c4fd1960 (patch)
tree7ac313f19db54c162d0927ccd14ecbb1fa757421 /Master/texmf-dist/source/latex/register
parente057511ee0bd3ecc87a47be76805cf26e8936d9b (diff)
register (2jan19)
git-svn-id: svn://tug.org/texlive/trunk@49581 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/register')
-rw-r--r--Master/texmf-dist/source/latex/register/register.dtx48
1 files changed, 32 insertions, 16 deletions
diff --git a/Master/texmf-dist/source/latex/register/register.dtx b/Master/texmf-dist/source/latex/register/register.dtx
index 6f629cae934..2c2b41cf6de 100644
--- a/Master/texmf-dist/source/latex/register/register.dtx
+++ b/Master/texmf-dist/source/latex/register/register.dtx
@@ -4,7 +4,7 @@
% Register diagrams with field descriptions
%
% Author: Matthew Lovell (lovells@gmail.com)
-% Copyright 2001-2018 by Matthew B. Lovell
+% Copyright 2001-2019 by Matthew B. Lovell
%
% Run LaTeX on the file `register.ins' to get a .sty-file and
% then on `register.dtx' to obtain instructions.
@@ -20,10 +20,10 @@
\ProvidesFile{register.dtx}
%</dtx>
% \fi
-% \CheckSum{776}
+% \CheckSum{785}
%
-% \def\fileversion{v1.8}
-% \def\filedate{2018/11/10}
+% \def\fileversion{v1.9}
+% \def\filedate{2019/01/01}
% \title{Register diagrams with field descriptions}
% \author{Matthew Lovell\\
% \texttt{lovells@gmail.com}
@@ -542,6 +542,7 @@
% \item [\textbf{v1.6.1}] (2018/05/19) Published with updated email address; no functional changes
% \item [\textbf{v1.7}] (2018/08/18) Added color option to package, suggested by Marco Stolba
% \item [\textbf{v1.8}] (2018/11/10) Added unnumbered |register*| environment, suggested and written by Stephan Bauroth
+% \item [\textbf{v1.9}] (2019/01/01) Switched to a re-definable macro to provide default float name and LoR name, suggested by Benyuan Liu.
% \end{itemize}
%
%
@@ -561,7 +562,7 @@
%
% Announce the name and unconditionally load most of the required packages:
% \begin{macrocode}
-\ProvidesPackage{register} [2018/11/10 v1.8 Register macros with
+\ProvidesPackage{register} [2019/01/01 v1.9 Register macros with
hyperref/LyX support]
\RequirePackage{ifthen}[1997/11/02]
@@ -599,6 +600,7 @@ hyperref/LyX support]
\ProcessOptions\relax % Process package options
% \end{macrocode}
%
+%
% If the |color| package option has been specified, go ahead and
% load the |xcolor| package as well.
% \begin{macrocode}
@@ -615,6 +617,25 @@ hyperref/LyX support]
\setboolean{RegisterContext}{false}
% \end{macrocode}
%
+% \begin{macro}{\regFloatName}
+% \begin{macro}{\regListName}
+% \begin{macro}{\regResetName}
+% Below are some macros that support a little internationalization, expanded
+% upon a suggestion from Benyuan Liu.
+% The |\regFloatName| provides the default string used to label each register diagram.
+% The string with which to label reset values is |\regResetName|.
+% The font size for field names and for the |\regResetName| is controlled by |\regLabelSize|, defined further below.
+% \end{macro}
+% \end{macro}
+% \end{macro}
+%
+% \begin{macrocode}
+\newcommand{\regFloatName}{Register}
+\newcommand{\regListName}{List of Registers}
+\newcommand{\regResetName}{Reset}
+% \end{macrocode}
+
+
% \subsection{Float Declaration \& Lengths} \label{sec:float}
%
% Declare the new register float type and the lengths which the
@@ -627,7 +648,7 @@ hyperref/LyX support]
\floatstyle{plaintop} \@ifundefined{chapter}
{\newfloat{Regfloat}{tbp}{rdf}[section]}
{\newfloat{Regfloat}{tbp}{rdf}[chapter]}
-\floatname{Regfloat}{Register}
+\floatname{Regfloat}{\regFloatName}
% \end{macrocode}
%
% \subsection{Style Parameters} \label{sec:style}
@@ -641,19 +662,16 @@ hyperref/LyX support]
% \end{macro}
% \end{macro}
%
-% \begin{macro}{\regResetName}
% \begin{macro}{\regBitSize}
% \begin{macro}{\regBitFamily}
% \begin{macro}{\regResetSize}
% \begin{macro}{\regLabelSize}
% \begin{macro}{\regLabelFamily}
% \begin{macro}{\regDescFamily}
-% The string with which to label reset values is
-% |\regResetName|. The |\regBitSize| command controls the font size
+% The |\regBitSize| command controls the font size
% used for bit values, |\regResetSize| controls the font size used
% for reset values, and |\regBitFamily| controls which font family
-% is used to denote bit positions. The font size for field names
-% and for the |\regResetName| is controlled by |\regLabelSize|.
+% is used to denote bit positions.
% Finally, |\regDescFamily| controls the appearance of field names
% within register descriptions.
% \end{macro}
@@ -662,7 +680,6 @@ hyperref/LyX support]
% \end{macro}
% \end{macro}
% \end{macro}
-% \end{macro}
%
% \begin{macrocode}
\newlength{\regWidth}
@@ -677,7 +694,6 @@ hyperref/LyX support]
\newlength{\regFboxSep}
\setlength{\regWidth}{0.95\textwidth}
\newcommand{\regBitWidth}{32}
-\newcommand{\regResetName}{Reset}
\newcommand{\regBitSize}{\tiny}
\newcommand{\regBitFamily}{\sffamily}
\newcommand{\regResetSize}{\scriptsize}
@@ -1189,9 +1205,9 @@ hyperref/LyX support]
\@ifundefined{ext@Regfloat}{\float@error{Regfloat}}{%
\@ifundefined{chapter}{\def\@tempa{\section*}}%
{\def\@tempa{\chapter*}}%
- \@tempa{List of Registers\@mkboth{\uppercase{List of Registers}}%
- {\uppercase{List of Registers}}}%
- \addcontentsline{toc}{chapter}{List of Registers}%
+ \@tempa{\regListName\@mkboth{\uppercase{\regListName}}%
+ {\uppercase{\regListName}}}%
+ \addcontentsline{toc}{chapter}{\regListName}%
\@starttoc{\@nameuse{ext@Regfloat}}}}
\newcommand\l@Regfloat{\@dottedtocline{1}{1.5em}{2.3em}}
% \end{macrocode}