summaryrefslogtreecommitdiff
path: root/macros/xetex/latex/zbmath-review-template/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/xetex/latex/zbmath-review-template/README.md')
-rw-r--r--macros/xetex/latex/zbmath-review-template/README.md70
1 files changed, 53 insertions, 17 deletions
diff --git a/macros/xetex/latex/zbmath-review-template/README.md b/macros/xetex/latex/zbmath-review-template/README.md
index bce5bee86e..8918f2fa68 100644
--- a/macros/xetex/latex/zbmath-review-template/README.md
+++ b/macros/xetex/latex/zbmath-review-template/README.md
@@ -1,10 +1,37 @@
# zbmath-review-template
-This package contains a template for zbMATH Open reviews. It has to be compiled using XeLaTeX.
+This package contains the class zbMATH, which is used for reviews on [zbMATH Open](https://zbmath.org/). It has to be compiled using XeLaTeX.
## Instruction
-Delete all the text in **zb-review.tex** and write your own review into this file. If you want, you can change the metadata information at **zb-metadata.tex**. This is optional and just gives you a feeling how the final pdf at https://zbmath.org will look like. Finally, compile **zb-main.tex** using XeLaTeX.
+Load the class zbMATH via
+
+ \documentclass{zbMATH}
+
+Use the commands
+
+ \title{<title of the reviewed article>}
+ \author{<authors of the reviewed article>}
+
+to set the title and author information of the article under review.
+The title and footer of your review are generated via
+
+ \maketitle
+ \makefooter
+
+Afterwards, add the text of your review.
+At the end of your review you can add your name using the macro
+
+ \reviewer{<Your Name>}
+
+Optionally, you can add MSC Classes and keywords using
+
+ \msc{<MSC Classes>}
+ \keywords{<keywords>}
+
+where MSC classes are separated by space and keywords are separated by a semicolon ';'.
+
+Finally, compile your .tex file with XeLaTeX.
### Files
@@ -12,37 +39,46 @@ The package contains the following files:
* README.md
* zb-basics.sty
-* zb-main.tex
-* zb-metadata.tex
-* zb-review.tex
-* zb-manual.tex
-* zb-main.pdf (a sample review document)
+* zbMATH.cls
+* zb-example.pdf (a sample review document)
+* zb-example.tex (tex source of zb-example.tex)
* zb-manual.pdf (a short documentation)
-* figures/screenshot.png
+* zb-manual.tex (tex source of zb-manual.pdf)
+* figures/screenshot.png (picture used in zb-manual.tex)
### Packages
The following packages are used:
-* scrartcl
+* amsmath, amsfonts, amssymb
* babel
-* scrlayer-scrpage
-* geometry
-* graphicx
* enumitem
+* etoolbox
* fontspec
-* amsmath, amsfonts, amssymb
+* gensymb
+* geometry
+* graphicx
+* mathrsfs
* mathtools
+* scrartcl
+* scrlayer-scrpage
* stmaryrd
-* mathrsfs
* tikz-cd
* textcomp
-* gensymb
+* xcolor
+* xparse
### License
-GNU General Public License, Version 3.
+[GNU General Public License, Version 3](https://www.gnu.org/licenses/gpl-3.0.en.html), except of zb-example.tex and zb-example.pdf, which are distributed under [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
### Version History
-19 March 2021: Version 1.0 \ No newline at end of file
+24 June 2021: Version 2.1
+
+
+### Contact
+
+Isabel Beckenbach
+
+E-Mail: isabel.beckenbach at fiz-karlsruhe.de \ No newline at end of file