Debian Codegraph @

texmf-dist/doc/xelatex/zbmath-review-template/zb-manual.tex

raw
1 % Copyright 2021 by FIZ-Karlsruhe
2 %
3 % This file is part of the ctan package zbmath-review-template
4 % and may be distributed and/or modified under the
5 % conditions of the GNU General Public License, version 3:
6 %
7 % https://www.gnu.org/licenses/gpl-3.0.en.html
8 %
9 % It contains the manual for zbmath-review-template.
10 %
11
12
13 \documentclass{zbMATH}
14 \usepackage{hyperref}
15
16 \hypersetup{colorlinks=true,allcolors=[rgb]{0,.289,.6}}
17
18
19 \begin{document}
20
21 \makefooter
22
23
24 \blue{\LARGE{\textbf{LaTeX-Template for zbMATH Open Reviews}}}
25
26 \vspace{4ex}
27
28 This package contains the class zbMATH, which is used for reviews on zbMATH Open.
29 With the class zbMATH you can see how your review will look like at zbMATH Open and you can test whether your LaTeX-code will compile properly on our system.
30
31 Be aware that we add further information to your review, for example the list of references of the reviewed article, and there might be manual changes to your review. Thus, the published version of your review on zbMATH Open will look different than on this template.
32
33 \section*{How to use the class zbMATH}
34
35 First, load the class zbMATH
36 \begin{verbatim}
37 \documentclass{zbMATH}
38 \end{verbatim}
39
40 Then, use
41 \begin{verbatim}
42 \title{<title of the reviewed article>}
43 \author{<authors of the reviewed article>}
44 \end{verbatim}
45 to set the title and author information of the article under review. This can be set before or after \verb|\begin{document}|. The title and footer of your review are generated via
46 \begin{verbatim}
47 \maketitle
48 \makefooter
49 \end{verbatim}
50 After these two commands, add the text of your review. At the end, you can add your name (and your location) using
51 \begin{verbatim}
52 \reviewer{<your name (location)>}
53 \end{verbatim}
54 Optionally, you can add MSC Classes and keywords
55 \begin{verbatim}
56 \msc{<MSC Classes>}
57 \keywords{<keywords>}
58 \end{verbatim}
59 where MSC classes are separated by space and keywords are separated by ';'.
60
61 Finally, compile your \texttt{.tex} file using XeLaTeX. An example is given in zb-example.tex.
62
63 \section*{LaTeX Format}
64
65 Please prepare your review in standard LaTeX. You might use functions and macros from the following packages:
66 \begin{itemize}[nosep]
67 \item \href{https://www.ams.org/arc/resources/amslatex-about.html}{amsmath, amsfonts, amssymb}
68 \item \href{https://ctan.org/pkg/stmaryrd}{stmaryrd}
69 \item \href{https://ctan.org/pkg/mathrsfs}{mathrsfs}
70 \item \href{https://ctan.org/pkg/tikz-cd}{tikz-cd}
71 \item \href{https://ctan.org/pkg/mathtools}{mathtools}
72 \item \href{https://ctan.org/pkg/gensymb}{gensymb}
73 \item \href{https://ctan.org/pkg/textcomp}{textcomp}
74 \end{itemize}
75 Furthermore, you might use the macros defined in zbMATH.cls, that are:
76 \begin{itemize}[nosep]
77 \item \verb|\Im| and \verb|\Re| for the imaginary and real part of a complex number, for example, \(\Re(x+iy)=x\) and \(\Im(x+iy)=y\).
78 \item \verb|\Aut| for the automorphism group of a set, e.g., \(\Aut(X)\) for a set \(X\).
79 \item \verb|\Hom| for the hom-Functor, e.g., \(\Hom(A,B)\) stands for the set of homomorphisms from a set \(A\) to a set \(B\).
80 \item \verb|\ran| for the range or image of a vector space, e.g., \(\ker A = \left(\ran A^*\right)^\bot\).
81 \item \verb|\1| for the indicator function of a set, e.g.
82 \[\1_A = \begin{cases}1 &\text{if }x\in A\\
83 0 &\text{if }x\notin A
84 \end{cases}.\]
85 \item \verb|\fint| for \(\fint\), e.g.,
86 \[\fint_A u(y)\,d\mu(y)=\frac{1}
87 {\mu(A)}\int_A u(y)\,d\mu(y)\]
88 \item \verb|\Sha| for the Tate–Shafarevich group $\Sha(A/K)$ of an abelian variety \(A\) defined over a number field \(K\).
89 \end{itemize}
90 Please do not use any self-defined macros or packages not listed above. If you feel that there is a missing package that we should add, please let us know.
91
92 Our PDFs are compiled using XeLaTeX, which supports unicode characters in the source files.
93 Unicode allows the user to include accents and special characters coming from different Asian and European languages. For example, you may enter accented characters directly (e.g., \verb|Lévy| instead of \verb|L\'evy|).
94 However, please avoid including unicode characters in mathematical mode.
95 In particular, when you type Greek characters for variables please use \verb|\(\beta\)| or \verb|$\beta$| obtaining \(\beta\), instead of typing the unicode character directly.
96
97 Please do not include tables, large diagrams, drawings or formulas of minor importance. Use alternative fonts (bold, italics etc.) only if necessary, e.g., in formulas or for highlighting the authors of cited publications.
98
99 \section*{Mathematical Typesetting}
100
101 When writing equations or diagrams please avoid the automatic numbering environments and replace them with their * analogues. For example, use
102
103 \verb|\begin{equation*} \end{equation*}|
104
105 instead of
106
107 \verb|\begin{equation} \end{equation}|.
108
109 The numbers on equations, definitions, diagrams, etc. should be set manually. You can do this by typing, for instance, \verb|\tag{1}| or \verb|\tag{*}|.
110
111 For example
112 \begin{verbatim}
113 \begin{equation*}
114 \sum_{n=1}^\infty \frac{1}{n^2} = \frac{\pi^2}{6} \tag{1}\label{eq:1}
115 \end{equation*}
116 \end{verbatim}
117 gives
118 \begin{equation*}
119 \sum_{n=1}^\infty \frac{1}{n^2}=\frac{\pi^2}{6} \tag{1}\label{eq:1}
120 \end{equation*}
121 An equation can be referenced via \verb|\ref{key}| if it is labeled by \verb|\label{key}|. The formula above can be referenced via \verb|\ref{eq:1}|:
122
123 Equation~\ref{eq:1} was proven by Leonhard Euler in his paper \textit{De summis serierum reciprocarum}.
124
125 For inline mathematical formula we prefer to use \verb|\(...\)| over \verb|$...$|. Similarly, we recommend to use \verb|\[...\]| instead of \verb|$$...$$|.
126
127 \subsection*{Matrices}
128
129 We give a short description how to type matrices with \texttt{amsmath}. For more details we refer to the documentation of \href{https://www.ams.org/arc/resources/amslatex-about.html}{amsmath} on ctan.
130
131 \texttt{amsmath} provides several environments for matrices using different brackets. For example the code
132 \begin{verbatim}
133 \[
134 \begin{pmatrix} a & b \\ c & d \end{pmatrix}\quad
135 \begin{matrix} a & b \\ c & d \end{matrix}\quad
136 \begin{bmatrix} a & b \\ c & d \end{bmatrix}\quad
137 \begin{Bmatrix} a & b \\ c & d \end{Bmatrix}\quad
138 \begin{vmatrix} a & b \\ c & d \end{vmatrix} \quad
139 \begin{Vmatrix} a & b \\ c & d \end{Vmatrix}
140 \]
141 \end{verbatim}
142
143 generates these four matrices
144 \[
145 \begin{pmatrix} a & b \\ c & d \end{pmatrix}\quad
146 \begin{matrix} a & b \\ c & d \end{matrix}\quad
147 \begin{bmatrix} a & b \\ c & d \end{bmatrix}\quad
148 \begin{Bmatrix} a & b \\ c & d \end{Bmatrix}\quad
149 \begin{vmatrix} a & b \\ c & d \end{vmatrix} \quad
150 \begin{Vmatrix} a & b \\ c & d \end{Vmatrix}.
151 \]
152
153 If you want to use a matrix in inline math mode, then you might use \verb|\smallmatrix|, e.g. \(\left(\begin{smallmatrix} 1&2\\ 3&4 \end{smallmatrix}\right)\) is typed via
154 \begin{verbatim}
155 \(\left(\begin{smallmatrix} 1&2\\ 3&4 \end{smallmatrix}\right)\).
156 \end{verbatim}
157 Observe that you have to add your own deliminator to the smallmatrix environment, here we use \verb|\left(| and \verb|\right)|.
158
159 \subsection*{Commutative Diagrams}
160
161 The package \texttt{tikz-cd} is designed to draw commutative diagrams. They are constructed inside the environment \verb|\begin{tikzcd}...\end{tikzcd}|. Its usage is similar to the one of tables (\verb|&| for columns and \verb|\\| for rows). Arrows are drawn using the command \verb|\arrow[options]|. The direction of an arrow is specified by a string of characters \texttt{r}, \texttt{l}, \texttt{u}, \texttt{d} (right, left, up, down) and labels are added using quotes \texttt{"<label>"}. We give examples of some commutative diagrams that occur regularly.
162
163 A short exact sequence
164 \(
165 \begin{tikzcd}
166 0\arrow[r] & A \arrow[r, "f"] & B\arrow[r, "g"] & C\arrow[r] & 0
167 \end{tikzcd}
168 \)
169 can be easily typed using \texttt{tikz-cd} by
170 \begin{verbatim}
171 \begin{tikzcd}
172 0\arrow[r] & A \arrow[r, "f"] & B\arrow[r, "g"] & C\arrow[r] & 0
173 \end{tikzcd}
174 \end{verbatim}
175 The option \texttt{column sep} specifies the space between two consecutive columns. If we set this option to small
176 \begin{verbatim}
177 \begin{tikzcd}[column sep=small]
178 0\arrow[r] &A \arrow[r, "f"] &B\arrow[r, "g"] &C\arrow[r] &0,
179 \end{tikzcd}
180 \end{verbatim}
181 the arrows of the short exact sequence
182 \(
183 \begin{tikzcd}[column sep=small]
184 0\arrow[r] & A \arrow[r, "f"] & B\arrow[r, "g"] & C\arrow[r] & 0
185 \end{tikzcd}
186 \)
187 are shorter.
188
189 Next, we give an example of a classical "square" commutative diagram, where we use \verb|column sep| and \verb|row sep| to specify the space between consecutive columns and rows, respectively. The diagram
190 \[
191 \begin{tikzcd}[column sep=large, row sep=large]
192 A \arrow[r, "f"] \arrow[d, "g"] & B \arrow[d, "h"]\\
193 C \arrow[r, "k"]& D
194 \end{tikzcd}
195 \]
196 is generated by
197 \begin{verbatim}
198 \[
199 \begin{tikzcd}[column sep=large, row sep=large]
200 A \arrow[r, "f"] \arrow[d, "g"] & B \arrow[d, "h"] \\
201 C \arrow[r, "k"] & D
202 \end{tikzcd}
203 \].
204 \end{verbatim}
205
206 A "triangular" diagram as
207 \[
208 \begin{tikzcd}[row sep = large]
209 A\arrow[d, "\pi" ']\arrow[r, "f"] & B \\
210 A/\ker(f)\arrow[ru, dashrightarrow, "\tilde f" '] &
211 \end{tikzcd}
212 \]
213 can be drawn using
214 \begin{verbatim}
215 \[
216 \begin{tikzcd}[row sep = large]
217 A\arrow[d, "\pi" ']\arrow[r, "f"] & B \\
218 A/\ker(f)\arrow[ru, dashrightarrow, "\tilde f" '] &
219 \end{tikzcd}
220 \].
221 \end{verbatim}
222
223 For more details on the use of \href{https://ctan.org/pkg/tikz-cd}{tikz-cd} we refer to its documentation on ctan where examples of more complicated diagrams are given.
224
225 \section*{Citations}
226
227 Citations to related work are always appreciated. You only need to cite the related work inside your review and do not have to add a reference section at the end of your text.
228
229 Please try to be as specific and accurate as possible so that the citation can be identified unambiguously. You may use the \href{https://zbmath.org/}{zbMATH Document Search} or the \href{https://zbmath.org/citationmatching/}{zbMATH Citation Matcher} to look up citations. The Cite Button for the respective zbMATH item gives the citation in the proper format for a zbMATH Open review, see Figure~\ref{fig:cite}.
230
231 Example 1: Book article (\href{https://zbmath.org/?q=an\%3A0970.90052}{Zbl 0970.90052}).
232
233 {[\textit{A. Schrijver}, Theory of linear and integer programming. Repr. Chichester: Wiley (1998; Zbl 0970.90052)]}
234
235 Example 2: Journal article (\href{https://zbmath.org/?q=an\%3A0239.05111}{Zbl 0239.05111}).
236
237 {[\textit{L. Lovász}, Discrete Math. 2, 253--267 (1972; Zbl 0239.05111)]}
238
239 If you want to cite an article, which does not have a zbl number, you can use the following format:
240
241 Example 3: Journal article without zbl umber.
242
243 {[\textit{Authors}, "Title", Journal Volume, Issue, pages (year)]}
244
245 \begin{figure}[bth]
246 \centering
247 \includegraphics[width=\textwidth]{figures/screenshot.png}
248 \caption{Cite Button at zbmath.org.}
249 \label{fig:cite}
250 \end{figure}
251
252 If a Preprint should be cited, first check if there already exists a published version and cite the published article if it exists. Otherwise, cite the Preprint with as much information as possible, e.g. which University produced the Preprint, on which Preprint server did it appear together with a unique persistent identifier, if one exists.
253
254 Example 4: A Preprint from arXiv
255
256 {[\textit{S. G. Hermosillo de la Maza} et al., “Vertex arboricity of cographs”, Preprint, \href{https://arxiv.org/abs/1907.07286}{arXiv:1907.07286}]}
257
258 \section*{Review Submission}
259
260 We prefer to receive your review electronically via our \href{https://zbmath.org/reviewer-service/}{Web Submission Form}. Just copy the text of your review into the field for the review text, please do not copy any of the macros \verb|\title|, \verb|\author|, \verb|\maketitle|, \verb|\makefooter|, \verb|\reviewer|, \verb|\msc|, \verb|\keywords|. There are two extra fields for keywords and MSC codes, respectively.
261
262 Alternatively, you may send your review by e-mail to [email protected] or via mail to our \href{https://zbmath.org/contact/}{postal address}.
263
264 For more information on the zbMATH Open Reviewer Service we refer to our \href{https://zbmath.org/reviewer-service/info_texts/guide_for_reviewers}{guide for reviewers}.
265
266 \section*{License}
267
268 The ctan package zbmath-review-template is distributed under the \href{https://www.gnu.org/licenses/gpl-3.0.en.html}{GNU General Public License, version 3}, except of zb-example.tex and zb-example.pdf, which are distributed under \href{https://creativecommons.org/licenses/by-sa/4.0/}{CC-BY-SA 4.0}.
269
270 \end{document}