summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2023-10-26 19:51:23 +0000
committerKarl Berry <karl@freefriends.org>2023-10-26 19:51:23 +0000
commitb66bd3a5caabdc161472f405cc70b07d337d65e9 (patch)
treecc73a46968c522e82a5bad8f286eba686a3550ea /Master/texmf-dist/doc/latex
parentb8c0ca7ca9c7632373df1fc82eebcf425b3933f7 (diff)
physics2 (26oct23)
git-svn-id: svn://tug.org/texlive/trunk@68657 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r--Master/texmf-dist/doc/latex/physics2/README.md3
-rw-r--r--Master/texmf-dist/doc/latex/physics2/phy2docdef.tex8
-rw-r--r--Master/texmf-dist/doc/latex/physics2/physics2-code.pdfbin0 -> 137994 bytes
-rw-r--r--Master/texmf-dist/doc/latex/physics2/physics2-legacy.pdfbin82817 -> 82674 bytes
-rw-r--r--Master/texmf-dist/doc/latex/physics2/physics2-legacy.tex42
-rw-r--r--Master/texmf-dist/doc/latex/physics2/physics2.pdfbin87994 -> 88146 bytes
-rw-r--r--Master/texmf-dist/doc/latex/physics2/physics2.tex52
7 files changed, 58 insertions, 47 deletions
diff --git a/Master/texmf-dist/doc/latex/physics2/README.md b/Master/texmf-dist/doc/latex/physics2/README.md
index f8efc731241..6cdfe86e8aa 100644
--- a/Master/texmf-dist/doc/latex/physics2/README.md
+++ b/Master/texmf-dist/doc/latex/physics2/README.md
@@ -24,4 +24,5 @@ either version 1.3c of this license or (at your option) any later version.
This work has the LPPL maintenance status `maintained`.
The Current Maintainer of this work is
-[Zhang Tingxuan](https://www.ctan.org/author/zhang-tx). \ No newline at end of file
+[Zhang Tingxuan](https://www.ctan.org/author/zhang-tx).
+
diff --git a/Master/texmf-dist/doc/latex/physics2/phy2docdef.tex b/Master/texmf-dist/doc/latex/physics2/phy2docdef.tex
index 53fb2f9deab..25908230979 100644
--- a/Master/texmf-dist/doc/latex/physics2/phy2docdef.tex
+++ b/Master/texmf-dist/doc/latex/physics2/phy2docdef.tex
@@ -22,8 +22,8 @@
\hypersetup{colorlinks,urlcolor=magenta,linkcolor=black,filecolor=blue,
pdfstartview=FitH,pdfview=FitH,pdfcreator=XeTeX output}
\def\s@pkg#1{\texorpdfstring{\textcolor{pkgcolor}{\textsf{#1}}}{“#1”}}
-\def\@pkg#1{\texorpdfstring{\hyperref{https://www.ctan.org/pkg/#1}%
- {}{}{\textcolor{pkgcolor}{\textsf{#1}}}}{“#1”}}
+\def\@pkg#1{\texorpdfstring{\href{https://www.ctan.org/pkg/#1}%
+ {\textcolor{pkgcolor}{\textsf{#1}}}}{“#1”}}
\DeclareRobustCommand\pkg{\@ifstar\@pkg\s@pkg}
\def\modu#1{\texorpdfstring{\textcolor{moducolor}{\textsf{#1}}}{“#1”}}
\def\opt#1{\texorpdfstring{\texttt{#1}}{“#1”}}
@@ -64,7 +64,7 @@
\newenvironment{example}
{\stepcounter{example}\example@start}{\example@end}
\author{Zhang Tingxuan}
-\date{2023/04/02\quad Version 0.2.1\thanks{%
+\date{2023/10/24\quad Version 1.0.0\thanks{%
\url{https://www.github.com/AlphaZTX/physics2}}}
\makeatother
-\endinput \ No newline at end of file
+\endinput
diff --git a/Master/texmf-dist/doc/latex/physics2/physics2-code.pdf b/Master/texmf-dist/doc/latex/physics2/physics2-code.pdf
new file mode 100644
index 00000000000..ea4d90cd319
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/physics2/physics2-code.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/physics2/physics2-legacy.pdf b/Master/texmf-dist/doc/latex/physics2/physics2-legacy.pdf
index cee629a6761..5406b3d7481 100644
--- a/Master/texmf-dist/doc/latex/physics2/physics2-legacy.pdf
+++ b/Master/texmf-dist/doc/latex/physics2/physics2-legacy.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/physics2/physics2-legacy.tex b/Master/texmf-dist/doc/latex/physics2/physics2-legacy.tex
index d1b64a43740..fe3dcb1ce25 100644
--- a/Master/texmf-dist/doc/latex/physics2/physics2-legacy.tex
+++ b/Master/texmf-dist/doc/latex/physics2/physics2-legacy.tex
@@ -10,7 +10,12 @@
\usepackage{unicode-math}
\setmainfont{Libertinus Serif}
\setsansfont{Libertinus Sans}
-\setmonofont{Noto Sans Mono}[Scale=MatchLowercase]
+\setmonofont{NotoSansMono}[
+ Scale=MatchLowercase,
+ Extension=.ttf,
+ UprightFont=*-Light,
+ BoldFont=*-Medium
+]
\setmathfont{Libertinus Math}
\usepackage{physics2}
\usephysicsmodule{ab}
@@ -35,7 +40,7 @@ manual for:
\item Users who failed to use \pkg*{unicode-math} with \pkg{physics}.
\end{itemize}
It seems no reason for any other user to read \emph{this} document instead of
-the \hyperref{./physics2.pdf}{}{}{package documentation} of \pkg{physics2},
+the \href{./physics2.pdf}{package documentation} of \pkg{physics2},
because this document cannot describe the package in detail.
In this document, the modules of \pkg{physics2} will be introduced in
@@ -85,9 +90,9 @@ command we mentioned in the first paragraph.
Moreover, the code of \texttt{physics.sty} ``abuses'' the \texttt{g}-type
arguments of \pkg*{xparse} package. Therefore the syntax of \pkg{physics} package
-looks kind of weird. See \hyperref{https://tex.stackexchange.com/questions/%
+looks kind of weird. See \href{https://tex.stackexchange.com/questions/%
470819/macros-dv-and-pdv-eat-the-subsequent-parenthesis-argument/470842#470842}%
-{}{}{here} for more.
+{here} for more.
\subsection{Loading \pkg{physics2}}
The \pkg{physics2} package includes different modules, among which every module
@@ -97,9 +102,8 @@ Write the following line in the preamble to load \pkg{physics2}:
\begin{Verbatim}
\usepackage{physics2}
\end{Verbatim}
-But this is not enough. \pkg{physics2} contains different modules, among which,
-only the \modu{common} module would be loaded automatically by the package.
-If you want to load other modules of \pkg{physics2}, write this after loading
+But this is not enough. \pkg{physics2} contains different modules.
+If you want to load any module of \pkg{physics2}, write this line after loading
\pkg{physics2} package:
\begin{displayed}
\cs{usephysicsmodule}\marg{module list}
@@ -241,7 +245,7 @@ The \cs{boldsymbol} command requires the \pkg*{amsmath} or \pkg*{bm} package.
If you prefer to use \pkg{bm}, you can also use the \cs{bm} command.
What's more, if you tried the commands above, you might find that,
the result of \cs{va} above is different from that of \pkg{physics}.
-This is beacuse, if you choose to present a vector in bold, it's alomost
+This is because, if you choose to present a vector in bold, there's almost
no need to put a \cs{vec} ($\vec{\mskip9mu}$) sign above it.
However, the method above may not work well with \pkg*{unicode-math}
@@ -274,7 +278,7 @@ after these commands can be delimited with \verb|()|, \verb|[]| and \verb|\{\}|.
The \modu{nabla.legacy} requires the \pkg*{fixdif} package at least
version 2.0 (file date: 2023/01/31 or after 2023/01/31).
-By the way, if you are used to write \cs{bm} for a vector but interested in
+By the way, if you are used to writing \cs{bm} for a vector but interested in
\pkg{unicode-math}, the \modu{bm-um.legacy} module would be a passable
alternative to \pkg{bm} package. Notice that the \cs{bm} command from the
\modu{bm-um.legacy} module can only take \emph{one} letter (or \emph{one} digit)
@@ -294,7 +298,7 @@ log-like functions.
The \pkg{physics} package provides a bundle of commands for log-like functions
that have not been defined in the \LaTeXe\ kernel. Those log-like functions
-can be used with the \modu{op.legacy} module; this module do not support
+can be used with the \modu{op.legacy} module; this module does not support
the syntax of \pkg{physics} either. For example:
\begin{example}
% \usephysicsmodule{op.legacy}
@@ -303,7 +307,7 @@ the syntax of \pkg{physics} either. For example:
The \cs{Re} and \cs{Im} commands are redefined as operators ``$\Re$'' and
``$\Im$'', while $\Resymbol$ and $\Imsymbol$ are reserved as \cs{Resymbol} and
\cs{Imsymbol}. $\Resymbol$ and $\Imsymbol$ are ordinary symbols but $\Re$ and
-$\Im$ are opetators.
+$\Im$ are operators.
\subsection{Quick quad text}\label{subsec:qtext}
The \modu{qtext.legacy} module provides the \cs{q}\meta{foo} commands
@@ -317,9 +321,9 @@ for \cs{quad}-wrapped texts. These commands have the same syntax as
\[ F \qif G \qthen H \]
\end{example}
All the commands described in \S2.4 of
-\hyperref{http://mirrors.ctan.org/macros/latex/contrib/physics/physics.pdf}{}{}%
+\href{http://mirrors.ctan.org/macros/latex/contrib/physics/physics.pdf}%
{\textsf{physics} documentation} are supported when using \modu{qtext.legacy}
-module, but I don't recommend to use this module unless you are maintaining a
+module, but I don't recommend using this module unless you are maintaining a
document written with \pkg{physics}'s \cs{q}\meta{foo} commands.
\subsection{Derivatives}
@@ -334,10 +338,10 @@ together. For example,
Math ($\d x$) v.s.\ Text (\d x)
\end{example}
Here are the documentations of
-\hyperref{http://mirrors.ctan.org/macros/latex/contrib/fixdif/fixdif.pdf}%
-{}{}{\textsf{fixdif}} and
-\hyperref{http://mirrors.ctan.org/macros/latex/contrib/derivative/derivative%
-.pdf}{}{}{\textsf{derivative}}.
+\href{http://mirrors.ctan.org/macros/latex/contrib/fixdif/fixdif.pdf}%
+{\textsf{fixdif}} and
+\href{http://mirrors.ctan.org/macros/latex/contrib/derivative/derivative%
+.pdf}{\textsf{derivative}}.
\pkg{fixdif}'s commands behave better in superscripts and subscripts.
@@ -401,7 +405,7 @@ extensible vertical bar. For example,
\end{example}
The argument of \cs{ketbra} should be delimited with \opt{|} and \opt{|}.
In the argument, \opt{>} and \opt{<} will be regarded as extensible $\rangle$
-and $\langle$. that is,
+and $\langle$. That is,
\begin{center}
\cs{ketbra} \opt{|} \meta{subformula$_1$} \opt{>} \meta{optional}
\opt{<} \meta{subformula$_2$} \opt{|}
@@ -456,7 +460,7 @@ The \cs{braket} command, in default, can take two arguments.
\braket[big] {\0} {\psi} \]
\end{example}
If you want \cs{braket} to take one or three arguments, you can write the
-number of arguments in the sqare bracket. If you need to specify the size
+number of arguments in the square bracket. If you need to specify the size
of bra-ket simultaneously, you need to separate the number and the size with
a comma:
\begin{example}
diff --git a/Master/texmf-dist/doc/latex/physics2/physics2.pdf b/Master/texmf-dist/doc/latex/physics2/physics2.pdf
index 5a56e39b673..d8a1f3a3760 100644
--- a/Master/texmf-dist/doc/latex/physics2/physics2.pdf
+++ b/Master/texmf-dist/doc/latex/physics2/physics2.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/physics2/physics2.tex b/Master/texmf-dist/doc/latex/physics2/physics2.tex
index f567d5219c0..c643ab72f92 100644
--- a/Master/texmf-dist/doc/latex/physics2/physics2.tex
+++ b/Master/texmf-dist/doc/latex/physics2/physics2.tex
@@ -10,7 +10,12 @@
\usepackage{unicode-math}
\setmainfont{Libertinus Serif}
\setsansfont{Libertinus Sans}
-\setmonofont{Noto Sans Mono}[Scale=MatchLowercase]
+\setmonofont{NotoSansMono}[
+ Scale=MatchLowercase,
+ Extension=.ttf,
+ UprightFont=*-Light,
+ BoldFont=*-Medium
+]
\setmathfont{Libertinus Math}
\usepackage{physics2}
\usephysicsmodule{ab,ab.braket}
@@ -31,7 +36,7 @@ modularized package, each module provides its own function.
This document describes the \pkg{physics2} package in more detail.
But if you are a user of the legacy \pkg{physics} package, you can click
-\hyperref{./physics2-legacy.pdf}{}{}{here} to see the documention for
+\href{./physics2-legacy.pdf}{here} to see the documentation for
\pkg{physics} users before you start. If you never used \pkg{physics} package
before, just read \emph{this} documentation.
\end{abstract}
@@ -55,17 +60,17 @@ be explained in the following sections that which module requires which package.
The \pkg{physics2} package requires \LaTeXe\ kernel released after 2020/10.
Please make sure that your \LaTeX\ distribution is not too old.
-\subsection{Loading the \pkg{physics2} package}
+\subsection{Loading \pkg{physics2} and its modules}
Just like loading any package, write
\begin{Verbatim}
\usepackage{physics2}
\end{Verbatim}
-in the preamble to load the \pkg{physics2} package. In this version,
+in the preamble to load the \pkg{physics2} package. In the current version,
\pkg{physics2} doesn't provide a package option.
-However, \pkg{physics2} itself only provides very few functions. Actually, it
-just provides a method to load modules. You need to load different modules of
-\pkg{physics2} to have different kinds of functions applied to your document.
+\pkg{physics2} itself doesn't provide many features.
+You need to load different modules of \pkg{physics2} to have different
+features applied to your document.
\subsection{Loading a module of \pkg{physics2}}
You can load a module of \pkg{physics2} only \emph{after} you write
@@ -75,7 +80,7 @@ like this:
\cs{usephysicsmodule}\marg{module}
\end{center}
The usage of \cs{usephysicsmodule} is similar to \cs{usepackage}, so you can
-load more than one modules in one line. For example,
+load several modules in one line. For example,
\begin{Verbatim}
\usephysicsmodule{ab,ab.braket}
\end{Verbatim}
@@ -91,19 +96,12 @@ These two lines load the \modu{ab} module with option
\opt{tightbraces\:=\:true} and load \modu{ab.braket} and \modu{doubleprod}
modules.
-\pardanger
-The \modu{common} module will be loaded automatically when you load the
-\pkg{physics2} package and \emph{only} the \modu{common} module will be
-loaded automatically. Any other module should be loaded manually by writing
-\cs{usephysicsmodule}\marg{module} after you loaded \pkg{physics2} in the
-preamble.
-
The following sections introduce all the user-level modules of \pkg{physics2}.
View back to the table of contents to see the names of user-level modules.
\section{Modules of \pkg{physics2}}
-\subsection{The automatically loaded \modu{common} module}
-The \modu{common} module provides the following commands:
+\subsection{Features of the bare \pkg{physics2} package}
+The following commands are available once you load \pkg{physics2} in preamble.
\cs{delopen} and \cs{delclose}, followed by a math delimiter. They can be
regarded as abbreviations of ``open delimiter'' and ``close delimiter''. If
@@ -127,6 +125,14 @@ an example,
\cs{bigggl}, \cs{bigggm}, \cs{bigggr}, \cs{Bigggl}, \cs{Bigggm} and \cs{Bigggr}
are also supported.
+\textbf{Note:}
+If you had heard version $0.x.y$ of \pkg{physics2}, you might know the
+\modu{common} module. Now the \modu{common} module is included in
+\pkg{physics2}.sty --- the source file of \modu{common} module is deleted
+but all the features of \modu{common} are reserved. Those commands above
+used to be provided by \modu{common} module, but now they are provided by
+\pkg{physics2}.
+
\subsection{The \modu{ab} module --- automatic braces}
This module provides the command \cs{ab}. The \cs{ab} command, as a shorthand
of ``automatic braces'', would specify the size of the following pair of
@@ -237,7 +243,7 @@ extensible vertical bar. For example,
\end{example}
The argument of \cs{ketbra} should be delimited with \opt{|} and \opt{|}.
In the argument, \opt{>} and \opt{<} will be regarded as extensible $\rangle$
-and $\langle$. that is,
+and $\langle$. That is,
\begin{center}
\cs{ketbra} \opt{|} \meta{subformula$_1$} \opt{>} \meta{optional}
\opt{<} \meta{subformula$_2$} \opt{|}
@@ -298,7 +304,7 @@ The \cs{braket} command, in default, can take two arguments.
\braket[big] {\0} {\psi} \]
\end{example}
If you want \cs{braket} to take one or three arguments, you can write the
-number of arguments in the sqare bracket. If you need to specify the size
+number of arguments in the square bracket. If you need to specify the size
of bra-ket simultaneously, you need to separate the number and the size with
a comma:
\begin{example}
@@ -454,7 +460,7 @@ to use a new entry format. For example,
\]
\end{example}
In the value of \opt{format} key, \verb|#1| stands for the common entry,
-or the first mandotary \meta{entry} argument of \cs{xmat}; \verb|#2|
+or the first mandatory \meta{entry} argument of \cs{xmat}; \verb|#2|
stands for the row index and \verb|#3| stands for the column index.
This module requires \pkg{amsmath}.
@@ -467,14 +473,14 @@ Only \opt{showtop} and \opt{showleft} can be used as module options.
\section{The ``legacy'' modules}
The legacy modules have similar names like \meta{module}\opt{.legacy}. Most of
them are designed to provide solutions to maintain documents written with the
-legacy \pkg{physics} package. It's not suggest to use them in a new document.
+legacy \pkg{physics} package. It's not suggested to use them in a new document.
\subsection{The \modu{ab.legacy} module}
This module provides the following commands:
\begin{Verbatim}[fontsize=\small]
\abs \norm \eval (\peval \beval) \order
\end{Verbatim}
-They shares the same syntax as \meta{cmd}\opt{*}\oarg{biggg}\marg{subformula}.
+They share the same syntax as \meta{cmd}\opt{*}\oarg{biggg}\marg{subformula}.
Star and \meta{biggg} are optional. Star stands for ``use the default size''.
For example,
\begin{example}
@@ -564,6 +570,6 @@ redefine \cs{Re} and \cs{Im}. If you want to reserve the definition of
\subsection{The \modu{qtext.legacy} module}
This module was written just to offer a method to maintain documents written
with the legacy \pkg{physics} package. See \S\ref*{lega-subsec:qtext} of
-\hyperref{./physics2-legacy.pdf}{}{}{physics2-legacy} for more information.
+\href{./physics2-legacy.pdf}{physics2-legacy} for more information.
\end{document} \ No newline at end of file