summaryrefslogtreecommitdiff
path: root/macros/xetex/latex/zbmath-review-template/zb-manual.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/xetex/latex/zbmath-review-template/zb-manual.tex')
-rw-r--r--macros/xetex/latex/zbmath-review-template/zb-manual.tex139
1 files changed, 88 insertions, 51 deletions
diff --git a/macros/xetex/latex/zbmath-review-template/zb-manual.tex b/macros/xetex/latex/zbmath-review-template/zb-manual.tex
index e6334c6cb2..1075bba5aa 100644
--- a/macros/xetex/latex/zbmath-review-template/zb-manual.tex
+++ b/macros/xetex/latex/zbmath-review-template/zb-manual.tex
@@ -1,47 +1,66 @@
-\documentclass[a4paper,10pt,leqno]{scrartcl}
-\usepackage{zb-basics}
-\usepackage{scrlayer-scrpage}
+% Copyright 2021 by FIZ-Karlsruhe
+%
+% This file is part of the ctan package zbmath-review-template
+% and may be distributed and/or modified under the
+% conditions of the GNU General Public License, version 3:
+%
+% https://www.gnu.org/licenses/gpl-3.0.en.html
+%
+% It contains the manual for zbmath-review-template.
+%
+
+
+\documentclass{zbMATH}
\usepackage{hyperref}
\hypersetup{colorlinks=true,allcolors=[rgb]{0,.289,.6}}
\begin{document}
-% display copyright in footer
-\pagestyle{scrheadings}
-\setkomafont{pageheadfoot}{
- \rmfamily
- \footnotesize
- \color[rgb]{.5,.5,.5}
-}
-\lofoot{%
- \copyright{} \the\year{} FIZ Karlsruhe GmbH
-}
-\cofoot{}
-\rofoot{Page \thepage}
-\setlength{\parindent}{0cm}
-\setlength{\parskip}{1ex}
-\setlength{\parfillskip}{0pt plus 1fill}
-\setlength{\footheight}{19pt}
+\makefooter
-\newsavebox{\citationbox}
-\newdimen{\msclen}
-\frenchspacing
+\blue{\LARGE{\textbf{LaTeX-Template for zbMATH Open Reviews}}}
-\section*{LaTeX-Template for zbMATH Open Reviews}
+\vspace{4ex}
-\subsection*{Purpose of this template}
+This package contains the class zbMATH, which is used for reviews on zbMATH Open.
+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.
-This template shows how your review will look like at zbMATH Open. You can test whether your LaTeX-code will compile properly on our system. However, be aware that there might be manual changes to your review and its published version on zbMATH Open will look slightly different than on this template.
+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.
-\subsection*{How to use this template}
+\section*{How to use the class zbMATH}
-Delete all the text in \texttt{zb-review.tex} and write your review into this file. If you want, you can change the metadata information at \texttt{zb-metadata.tex}. This is optional and just gives you a feeling how the final pdf at zbmath.org will look like. Finally, compile \texttt{zb-main.tex} using XeLaTeX.
+First, load the class zbMATH
+\begin{verbatim}
+ \documentclass{zbMATH}
+\end{verbatim}
+
+Then, use
+\begin{verbatim}
+ \title{<title of the reviewed article>}
+ \author{<authors of the reviewed article>}
+\end{verbatim}
+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
+\begin{verbatim}
+ \maketitle
+ \makefooter
+\end{verbatim}
+After these two commands, add the text of your review. At the end, you can add your name (and your location) using
+\begin{verbatim}
+ \reviewer{<your name (location)>}
+\end{verbatim}
+Optionally, you can add MSC Classes and keywords
+\begin{verbatim}
+ \msc{<MSC Classes>}
+ \keywords{<keywords>}
+\end{verbatim}
+where MSC classes are separated by space and keywords are separated by ';'.
-\vspace{2ex}
-\subsection*{LaTeX Format}
+Finally, compile your \texttt{.tex} file using XeLaTeX. An example is given in zb-example.tex.
+
+\section*{LaTeX Format}
Please prepare your review in standard LaTeX. You might use functions and macros from the following packages:
\begin{itemize}[nosep]
@@ -53,7 +72,7 @@ Please prepare your review in standard LaTeX. You might use functions and macros
\item \href{https://ctan.org/pkg/gensymb}{gensymb}
\item \href{https://ctan.org/pkg/textcomp}{textcomp}
\end{itemize}
-Furthermore, you might use the macros defined in zb-basics.sty, that are:
+Furthermore, you might use the macros defined in zbMATH.cls, that are:
\begin{itemize}[nosep]
\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\).
\item \verb|\Aut| for the automorphism group of a set, e.g., \(\Aut(X)\) for a set \(X\).
@@ -70,13 +89,16 @@ Furthermore, you might use the macros defined in zb-basics.sty, that are:
\end{itemize}
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.
-Our PDFs are compiled using XeLaTeX, which supports unicode characters in the source files. 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|). However, please avoid including unicode characters in mathematical mode. For example, when you type Greek characters for variables please use \verb|\(\beta\)| or \verb|$\beta$| obtaining \(\beta\), instead of typing the unicode character directly.
+Our PDFs are compiled using XeLaTeX, which supports unicode characters in the source files.
+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|).
+However, please avoid including unicode characters in mathematical mode.
+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.
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.
-\subsection*{Mathematical Typesetting}
+\section*{Mathematical Typesetting}
-When writing equations or diagrams please avoid the automatic numbering environments and replace them with their "*" analogues. For example, use
+When writing equations or diagrams please avoid the automatic numbering environments and replace them with their * analogues. For example, use
\verb|\begin{equation*} \end{equation*}|
@@ -102,7 +124,7 @@ Equation~\ref{eq:1} was proven by Leonhard Euler in his paper \textit{De summis
For inline mathematical formula we prefer to use \verb|\(...\)| over \verb|$...$|. Similarly, we recommend to use \verb|\[...\]| instead of \verb|$$...$$|.
-\paragraph{Matrices}
+\subsection*{Matrices}
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,13 +152,13 @@ generates these four matrices
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
\begin{verbatim}
-\(\left(\begin{smallmatrix} 1&2\\ 3&4 \end{smallmatrix}\right)|\).
+\(\left(\begin{smallmatrix} 1&2\\ 3&4 \end{smallmatrix}\right)\).
\end{verbatim}
Observe that you have to add your own deliminator to the smallmatrix environment, here we use \verb|\left(| and \verb|\right)|.
-\paragraph{Commutative Diagrams}
+\subsection*{Commutative Diagrams}
-The package \texttt{tikz-cd} is designed to draw commutative diagrams. They are constructed inside \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.
+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.
A short exact sequence
\(
@@ -200,34 +222,49 @@ can be drawn using
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.
-\paragraph{References}
+\section*{Citations}
-References to related work are always appreciated. When giving references, please try to be as specific and accurate as possible so that the references 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 references. The Cite Button for the respective zbMATH item gives the reference in the proper format for a zbMATH Open review, see Figure~\ref{fig:cite}.
+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.
-\begin{figure}
- \centering
- \includegraphics[width=\textwidth]{figures/screenshot.png}
- \caption{Cite Button at zbmath.org.}
- \label{fig:cite}
-\end{figure}
-Example 1: Book Article (\href{https://zbmath.org/?q=an\%3A0970.90052}{Zbl 0970.90052})
+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}.
+
+Example 1: Book article (\href{https://zbmath.org/?q=an\%3A0970.90052}{Zbl 0970.90052}).
{[\textit{A. Schrijver}, Theory of linear and integer programming. Repr. Chichester: Wiley (1998; Zbl 0970.90052)]}
-Example 2: Journal Article (\href{https://zbmath.org/?q=an\%3A0239.05111}{Zbl 0239.05111})
+Example 2: Journal article (\href{https://zbmath.org/?q=an\%3A0239.05111}{Zbl 0239.05111}).
{[\textit{L. Lovász}, Discrete Math. 2, 253--267 (1972; Zbl 0239.05111)]}
-\subsection*{Review Submission}
+If you want to cite an article, which does not have a zbl number, you can use the following format:
+
+Example 3: Journal article without zbl umber.
+
+{[\textit{Authors}, "Title", Journal Volume, Issue, pages (year)]}
+
+\begin{figure}[bth]
+ \centering
+ \includegraphics[width=\textwidth]{figures/screenshot.png}
+ \caption{Cite Button at zbmath.org.}
+ \label{fig:cite}
+\end{figure}
+
+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.
+
+Example 4: A Preprint from arXiv
+
+{[\textit{S. G. Hermosillo de la Maza} et al., “Vertex arboricity of cographs”, Preprint, \href{https://arxiv.org/abs/1907.07286}{arXiv:1907.07286}]}
+
+\section*{Review Submission}
-We prefer to receive your review electronically via our \href{https://zbmath.org/reviewer-service/}{Web Submission Form}. Just copy the text of \texttt{zb-review.tex} into the field for the review text, please do not copy anything from \texttt{zb-main.tex} or \texttt{zb-basics.sty} into this field. There are two extra fields for keywords and MSC codes, respectively.
+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.
Alternatively, you may send your review by e-mail to review-submission@zbmath.org or via mail to our \href{https://zbmath.org/contact/}{postal address}.
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}.
-\subsection*{License}
+\section*{License}
-The package zbmath-review-template is distributed under the GNU General Public License, Version 3.
+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}.
\end{document} \ No newline at end of file