summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/tools/bm.dtx
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2023-11-01 20:13:49 +0000
committerKarl Berry <karl@freefriends.org>2023-11-01 20:13:49 +0000
commita776d572cfd8fa24365dbc0cc22bbd856fbbe97b (patch)
tree849f92803a749fc1bc8aecd7ba910bd723ec4095 /Master/texmf-dist/source/latex/tools/bm.dtx
parentd090e61f0bea55cb371aeb790140dbcb6c5d7d36 (diff)
latex2e (1nov23)
git-svn-id: svn://tug.org/texlive/trunk@68720 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/tools/bm.dtx')
-rw-r--r--Master/texmf-dist/source/latex/tools/bm.dtx63
1 files changed, 32 insertions, 31 deletions
diff --git a/Master/texmf-dist/source/latex/tools/bm.dtx b/Master/texmf-dist/source/latex/tools/bm.dtx
index 51ae53f041a..a608c6aeb58 100644
--- a/Master/texmf-dist/source/latex/tools/bm.dtx
+++ b/Master/texmf-dist/source/latex/tools/bm.dtx
@@ -36,7 +36,7 @@
%<driver>\ProvidesFile{bm.drv}
% \fi
% \ProvidesFile{bm.dtx}
- [2022/01/05 v1.2f Bold Symbol Support (DPC/FMi)]
+ [2023/07/08 v1.2f Bold Symbol Support (DPC/FMi)]
%
% \iffalse
%<*driver>
@@ -97,7 +97,7 @@
%
% If there is a `heavy' math version defined (usually accessed by a
% user-command |\heavymath|) then a similar command |\hm|
-% is defined which access these `ultra bold' fonts. Currently this is
+% is defined which accesses these `ultra bold' fonts. Currently this is
% probably only useful with the `mathtime plus' font collection.
% Definitions of commands that use these fonts may be made by
% specifying the optional argument `heavy' to |\DeclareBoldMathCommand|.
@@ -140,7 +140,7 @@
% your font set.
%
% \section{Features}
-% In most cases this package should work in a fairly self explanatory
+% In most cases this package should work in a fairly self-explanatory
% way, but there are some things that might not be obvious.
%
% \subsection{Interaction with Math Alphabet Commands}
@@ -209,7 +209,7 @@
% Normally if a command takes arguments the full command, including
% any arguments, should be included in |\bm|.
%
-% So |\bm{\overbrace{abc}}| (producing \smash{$\bm{\overbrace{abc}}$})
+% So |\bm{\overbrace{abc}}| (producing \smash{$\bm{\overbrace{abc}}$}),
% not
% |\bm{\overbrace}{abc}|. If you do not include all the arguments you
% will typically get the error message:\\
@@ -245,7 +245,7 @@
% allocations.
%
% If no bold font appears to be available for a particular symbol,
-% |\bm| will use `poor man's bold' that is, overprinting the same
+% |\bm| will use `poor man's bold', which will overprint the same
% character in slightly offset
% positions to give an appearance of boldness.
%
@@ -255,8 +255,8 @@
% font set there are suitable fonts for bold and heavy math setting,
% and so |\bm| and |\hm| work well. Similarly in the basic Lucida
% New Math font set there are no bold math fonts, so |\bm| will
-% use `poor man's bold. However if the Lucida Expert set is used,
-% Then |\bm| will detect, and use the bold math fonts that are
+% use `poor man's bold'. However, if the Lucida Expert set is used,
+% then |\bm| will detect, and use, the bold math fonts that are
% available.
%
% As discussed above, one may set |\bmmax| higher or lower than its
@@ -310,7 +310,7 @@
% ``poor man's bold''. That is, over-printing the character with slight offsets.
% Since version 1.2e, the package now warns if a font is set up to use this over-printing and
% the package option |nopbm| is available which prevents its use in which case |\bm| will
-% use the non-bold for characters from the affected font,
+% use the non-bold for characters from the affected font.
%
% \MaybeStop{}
%
@@ -339,7 +339,7 @@
%
% \changes{v1.2e}{2021/04/25}
% {Package options gh/71}
-% Options to use or not use poor mans bold (over-printing)
+% Options to use or not use poor man's bold (over-printing)
% and level of warning messages.
% \begin{macrocode}
%<*package>
@@ -399,7 +399,7 @@
% code, which is temporarily defined to |\bm|, to save wasting a csname.
% Similarly |\bm@pmb|\ldots\ (which will be defined later) are used
% as scratch macros.
-% (This csname saving no longer used, setup command is |\bm@setup| not |\bm|).
+% (This csname saving no longer used, setup command is |\bm@setup|, not |\bm|.)
%
% The general plan. Run through the fonts allocated to the normal math
% version. Ignore \meta{math alphabet} allocations\footnote{For now?}
@@ -505,11 +505,11 @@
\ifx\bm@pmb@\@firstofone\else, using \string\pmb\fi}%
\else
% \end{macrocode}
-% Else make a new name by adjoining |#1| to the name of the symbol font
+% Else make a new name by adjoining |#1| to the name of the symbol font,
% eg, |\symboldsymbols| to match |\symsymbols|. If that font has already
% been allocated, or if |\@tempcnta| is positive so we can allocate a
% new slot for this font, then the table will be
-% set with the offset between the two fonts. otherwise set the offset to
+% set with the offset between the two fonts. Otherwise set the offset to
% zero (so |\boldmath| will be used to access the font).
% \begin{macrocode}
\edef\@tempa{sym#1\expandafter\@gobblefour\string##1}%
@@ -673,8 +673,8 @@
\fi
% \end{macrocode}
%
-% If there is no bold math version, It is very easy to set up
-% the table, no need to use all the tricky code above.
+% If there is no bold math version, it is very easy to set up
+% the table since there is no need to use all the tricky code above.
% Also, at the end of the package redefine the internal macro
% that |\bm| uses to call |\boldmath|, to use poor man's bold
% instead.
@@ -711,7 +711,7 @@
%
% \begin{macro}{\hmmax}
%
-% Same for heavy (but default to three this time (enough for mathtime
+% Same for heavy, but default to three this time (enough for mathtime
% plus, as no heavy operators font).
% \begin{macrocode}
\ifx\hmmax\@undefined
@@ -777,7 +777,7 @@
\let\protect\@empty
\let\@typeset@protect\@empty
% \end{macrocode}
-% Set up either bold or heavy
+% Set up either bold or heavy.
% \begin{macrocode}
\def\bm@mathchoice{\bm@m@thchoice#1}%
\def\bm@group{\bm@gr@up#1}%
@@ -848,9 +848,9 @@
\let\next@\copy
\global\let\bm@first\@empty
% \end{macrocode}
-% For AMS version of |\sqrt|: don't expand just wrap in brace group
-% so that it can be made bold in a safe but slow way. Do the same for
-% internal accent command
+% For AMS version of |\sqrt|: don't expand, just wrap it in a brace
+% group so that it can be made bold in a safe but slow way. Do the same
+% for internal accent command.
% \changes{v1.1b}{2003/10/05}{AMS \cs{sqrt} not working}
%
% \changes{v1.1c}{2004/02/26}{\cs{accentV} made safe (pr/3625)}
@@ -886,7 +886,7 @@
% |\mv@bold| or |\mv@heavy| and we execute that after redefining
% |\install@mathalphabet| and |\getanddefine@fonts| suitably.
% The definitions are reverted back to their original the moment
-% the scanning is done
+% the scanning is done.
% \changes{v1.0h}{2002/11/22}{Get math alphabets right (pr/3476)}
% \begin{macrocode}
\let\install@mathalphabet\def
@@ -972,7 +972,7 @@
% |\bm| is empty within the definition, so that either\\
% |\bmdefine\balpha{\bm\alpha}| or |\bmdefine\balpha{\alpha}| \\
% may be used. (The former just for compatibility with the original
-% version for plain \TeX).
+% version for plain \TeX.)
% \begin{macrocode}
\def\bmdefine{\DeclareBoldMathCommand[bold]}
% \end{macrocode}
@@ -1092,8 +1092,8 @@
% \begin{macro}{\bm@gr@up}
% \changes{v1.0c}{1997/10/09}
% {Extra brace around argument for \cs{over}}
-% If faced with a group,
-% If we are in math mode, stick it in a |\boldsymbol| like construct
+% If faced with a group
+% when we are in math mode, put it in a |\boldsymbol|-like construct
% and then recurse on |\bm@expand|.
% Otherwise just use |\bfseries\boldmath|.
% The actual test is deferred till `run time'.
@@ -1131,7 +1131,7 @@
% Other things just copy straight over to the command being built.
% (Anything inside a |\mathop| or similar will end up being made bold
% as the |\mathop| will be copied over, but its argument will be made
-% bold by the group code above.
+% bold by the group code above.)
% \begin{macrocode}
\def\bm@test@token#1{%
\let\bm@next\@empty
@@ -1139,7 +1139,7 @@
%
% Stop here. Note that it is vital that the terminating token
% is non-expandable and defined, rather than the usual \LaTeX\
-% terminators |\@nil| or |\@@|. (Worse still would be a `quark'
+% terminators |\@nil| and |\@@|. (Worse still would be a `quark'
% like |docstrip|'s |\qStop|.)
% \begin{macrocode}
\ifx#1\@@end
@@ -1166,7 +1166,7 @@
\afterassignment\bm@radical\count@
% \end{macrocode}
%
-% Need to trap spaces otherwise digits will get turned to bold
+% Need to trap spaces, otherwise digits will get turned to bold
% mathchars.
% \changes{v1.1a}{2003/09/01}{Forgotten to check for \cs{hskip} (pr/3572)}
% \begin{macrocode}
@@ -1451,7 +1451,7 @@
% \begin{macro}{\bm@pmb@}
% \changes{v0.10}{1997/01/04}
% {Macro added}
-% |\pmb| variant. (See \TeX{}Book, or AMS \textsf{amsbsy} package).
+% |\pmb| variant. (See \TeX{}book, or AMS \textsf{amsbsy} package.)
% This one takes a bit more care to use smaller offsets in subscripts.
% \begin{macrocode}
\ifx\bm@pmb@\@firstofone\else
@@ -1544,7 +1544,7 @@
\def\bm@mathaccent{%
\bm@changefam{}%
% \end{macrocode}
-% The next four lines were added a v1.0e. Without them |\bm{\hat{A}}|
+% The next four lines were added in v1.0e. Without them |\bm{\hat{A}}|
% makes the accent bold using |\bm| but the group |{A}| is made bold
% via a |\mathchoice| construction as for any other group, as |\bm|
% does not attempt to parse inside brace groups. While that produces
@@ -1674,9 +1674,10 @@
% \begin{macro}{\bm@changefam}
% \changes{v0.10}{1997/01/04}
% {Rewrite for new \cs{bm@table} system}
-% Pull out one specified hex digit and passes
-% it to |\bm@modify| to change. argument is empty normally but |000| to
-% access the second math group in a delimiter code.
+% Pull out one specified hex digit and pass
+% it to |\bm@modify| to change. Its one argument is normally empty,
+% but it will be |000| when necessary to access the second math group
+% in a delimiter code.
% \begin{macrocode}
\def\bm@changefam#1{%
\@tempcnta\count@