Merge pull request #83 from IMAGINARY/master

merge with master for v1.0.0 release

.gitignore

@@ -5,3 +5,7 @@
 *.log
 *.gz
 *.pdf
+*.bbl
+*.blg
+template.bib
+

README.md

@@ -0,0 +1,42 @@
+LaTeX document class for the snapshots of modern mathematics from Oberwolfach
+=============================================================================
+
+Snapshots of modern mathematics from Oberwolfach' is a project run by the
+Mathematisches Forschungsinstitut Oberwolfach (MFO) and funded by the Klaus
+Tschira Foundation. The snapshots give an accessible introduction into
+different aspects of modern mathematics and mathematical research.
+
+For more information, please see http://www.mfo.de/math-in-public/snapshots. 
+
+snapshotmfo.cls
+---------------
+
+The LaTeX document class. Place this file somewhere LaTeX can find it, e.g. into
+the same folder as your main LaTeX file. It is released under the LaTeX Project
+Public License.
+
+template.tex
+------------
+
+A template document illustrating the usage of `snapshotmfo.cls`. The file is
+dedicated to the public domain, i.e. you can start writing your snapshot by
+modifying and extending the template.
+
+mfo.jpg
+-------
+
+Picture of the "Mathematisches Forschungsinstitut Oberwolfach" (Source: Archives
+of the Mathematisches Forschungsinstitut Oberwolfach, http://www.mfo.de, 2004)
+used to illustrate the inclusion of images in `template.tex`.
+
+maya.pdf
+--------
+
+Schematic of the Maya numerals (Source: "Maya" by Bryan Derksen - Image:Maya.png.
+Licensed under Creative Commons Attribution-Share Alike 3.0 via Wikimedia
+Commons - http://commons.wikimedia.org/wiki/File:Maya.svg#mediaviewer/File:Maya.svg,
+converted to PDF). Used to illustrate proper attribution of images from Wikimedia
+Commons.
+
+
+For the legal codes of the licenses that apply to the above files see the `LICENSE` file.

template.tex

@@ -1,103 +1,153 @@
-%%% Template for a snapshot of modern mathematics from Oberwolfach. Please use pdflatex for compiling this file.
+%% template.tex - Template for a snapshot of modern mathematics from Oberwolfach.
+%
+% The following authors contributed to this work (alphabetical order):
+%   Carla Cederbaum (concept, testing)
+%   Konrad Renner (design)
+%   Christian Stussak (programming)
+%
+% with additional support by
+%   Sophia Jahns (testing)
+%   Christoph Knoth (design)
+%   Andreas Daniel Matt (concept)
+%   Lea Renner (testing)
+%
+% To the extent possible under law, the author(s) have dedicated all copyright
+% and related and neighboring rights to this software to the public domain worldwide.
+% This software is distributed without any warranty. 
+%
+% You should have received a copy of the CC0 Public Domain Dedication along with
+% this file. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. 
+%
+%%
+
+%%% Please use pdflatex for compiling this file.
 \documentclass{snapshotmfo}
 
-%%%%%%%%%%%%%%%% WILL BE FILLED OUT BY EDITORS ACCORDING TO YOUR SPECIFICATIONS ON IMAGINARY %%%%%%%%%%%%%
+%%%%%%%%%%%%%%%% WILL BE FILLED OUT BY EDITORS ACCORDING TO YOUR SPECIFICATIONS %%%%%%%%%%%%%%%%%%%%%%%%%%
 %\categorizationmath{algebra and number theory,analysis,discrete mathematics and foundations,geometry and topology,numerics and scientific computing,probability theory and statistics} %at least one must be chosen. 
 %\categorizationconnect{chemistry and earth science,computer science,engineering and technology,finance,humanities and social sciences,life science,physics,reflections on mathematics} %can be void.
 %\license{CC-BY-NC-SA-3.0} %recommended
 %\license{CC-BY-NC-ND-3.0}
 %\license{CC-BY-SA-3.0}
 %\snapshotid{id}{year}
-%\organizer{Main Organizer}
+%\translator{german}{Trans Lator}
 \junioreditor{will be filled out by editors}{[email protected]}
-\senioreditor{Dr.\;Carla Cederbaum}{cederbaum@mfo.de}
-\director{Prof.\;Dr.\;Gerhard Huisken}
+\senioreditor{Carla Cederbaum}{senior-editor@mfo.de}
+\director{Gerhard Huisken}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
 %%%%%%%%%%%%%%%% PLEASE FILL OUT THE FOLLOWING ITEMS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
+%%% Optional recommended packages
+%%% Encoding
+\usepackage[utf8]{inputenc}
+%%% AMS mathematical facilities:
+\usepackage{amsmath,amssymb}
+%%% Consistent quotation marks and citations:
+%\usepackage{csquotes}
+%%% Enhanced typesetting of units:
+%\usepackage{siunitx}  
+%\sisetup{per-mode=fraction,fraction-function=\nicefrac}
+
 % Please feel free to use your own macros but please do not change the layout of the snapshot.
 
-%%% Please select 'ngerman' if you want to submit your snapshot in German. If you do choose 'ngerman', please run your LaTeX compiler *twice* or delete the .aux file.
+%%% Please select 'ngerman' instead of 'USenglish' if you want to submit your snapshot in German. If you do choose 'ngerman', please run your LaTeX compiler *twice* or delete the .aux file.
 %\usepackage[ngerman]{babel}
 \usepackage[USenglish]{babel}
 
 
 %%% Please separate your names by \and if there are several authors.
-\author{Author One \and Author Two}
+\author{Author One\thanks{Author One is supported by the Mathematical Dreams Come True Foundation.} \and Author Two}
 
 %%% Please insert the title of your snapshot.
 \title{Your title}
 
 %%% Please provide some information on the author(s).
-\authorinfo{\authorname{Author One} is professor for pure mathematics at the First University.\\\mailtoref{author.one@first.edu}}
-\authorinfo{\authorname{Author Two} is lecturer for applied mathematics at the Second Institution.\\\mailtoref{author.two@uni-second.de}}
+\authorinfo{\authorname{Author One} is a professor of pure mathematics at the First University.}
+\authorinfo{\authorname{Author Two} is a lecturer in applied mathematics at the Second Institution.}
 
 
 %%% Please provide your references here or as a .bib file. If you use a .bib file, please replace the bibliography name 'yourbibfile' with the name of your .bib file in the \bibliography command at the bottom of this file. If you prefer to use \bibitems, you will need to silence the \bibliography command at the end of this file (see below). 
 \usepackage{filecontents}
 \begin{filecontents}{\jobname.bib}
-@book{knuth1986texbook,
-  keywords = {book},
-  title={The texbook},
-  author={Knuth, D.E. and Bibby, D.},
-  volume={1993},
-  year={1986},
-  publisher={Addison-Wesley}
+@book{knuth1984texbook,
+  title = {The TeXbook},
+  author = {Knuth, D. E.},
+  year = {1984},
+  edition={1},
+  publisher = {Addison-Wesley},
+  isbn = {978-0201134483}
 }
+
 @article{snapshot,
-  title={The first snapshot},
-  author={Jahns, S. and Renner, L.},
-  journal={Snapshots of modern mathematics},
-  volume={1},
-  number={1},
-  pages={1--10},
-  year={2014},
-  publisher={MFO}
+  title = {The first snapshot},
+  author = {Jahns, S. and Renner, L.},
+  journal = {Snapshots of modern mathematics},
+  volume = {1},
+  number = {1},
+  pages = {1--10},
+  year = {2014},
+  publisher = {MFO}
 }
 
-@misc{ wikiMath,
-   author = "Wikipedia",
-   title = "Mathematics --- {W}ikipedia{,} The Free Encyclopedia",
-   year = "2014",
-   howpublished = "\url{https://en.wikipedia.org/wiki/Mathematics}",
-   note = "[Online; accessed 19-May-2014]"
- }
+@misc{wikiMath,
+  author = {Wikipedia},
+  title = {Mathematics --- {W}ikipedia{,} The Free Encyclopedia},
+  year = {2014},
+  url = {https://en.wikipedia.org/wiki/Mathematics},
+  urldate = {2014-05-19}
+}
 
+@misc{sample13,
+  author = {Sample, J.},
+  howpublished = {\href{http://arxiv.org/abs/8765.4321v1}{arxiv:8765.4321v1}},
+  title = {Interesting facts in mathematics},
+  year = {2013}
+}
 
-\end{filecontents}
+@incollection{sample12,
+  author = {Sample, J.},
+  title = {Things you don't know about mathematics},
+  booktitle = {A bookseries about mathematics},
+  publisher = {Some publisher},
+  year = {2012}
+}
 
-%%% Optional recommended packages
-%%% Encoding
-\usepackage[utf8]{inputenc}
-%%% AMS mathematical facilities:
-\usepackage{amsmath,amssymb}
-%%% Consistent quotation marks and citations:
-%\usepackage{csquotes}
-%%% Enhanced typesetting of units:
-%\usepackage{siunitx}  
-%\sisetup{per-mode=fraction,fraction-function=\nicefrac}
+@inproceedings{sample11,
+  author={Example, C.},
+  title={A new perspective on mathematics},
+  booktitle={New perspectives on arts and sciences},
+  year={2011}
+}
+
+@phdthesis{sample14,
+  author={Candidate, A.},
+  title={Thesis title},
+  school={MFO},
+  year={2014}
+}
+\end{filecontents}
 
 %%%
 %%%%%%%%%%%%%%%% If your latex file does not compile, please delete all .aux and .log files and try again. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \begin{document}
 
-%%% Please insert your abstract, here. 
-\begin{abstract}
-This is your abstract. It should give a brief overview of your snapshot. If possible, please do not use formulas in your abstract. Please do not use more than 300 symbols. You will be asked to copy your abstract into the upload form on \href{http://www.imaginary.org}{www.imaginary.org}. 
+%%% Please insert your abstract here. 
+\begin{abstract}[Plain text abstract used as PDF meta data (optional)]
+This is your abstract. It should give a brief overview of your snapshot. If possible, please do not use formulas in your abstract. Please do not use more than 500 symbols. You will be asked to copy your abstract into the upload form on \href{http://www.imaginary.org}{www.imaginary.org}. 
 \end{abstract}
 
 %%% Please insert the main body of your snapshot, here.
 \section{A heading}
-Your actual snapshot.\footnote{This is a footnote.} As usual, you can give references such as \cite{snapshot, knuth1986texbook, wikiMath} via the \verb+\cite+ command.\\
+Your actual snapshot.\footnote{This is a footnote.} As usual, you can give references such as \cite{snapshot, knuth1984texbook, wikiMath, sample13, sample12, sample11, sample14} via the \verb+\cite+ command.\\
 
 We appreciate if you include images or other graphics that illustrate your snapshot. However, please do keep in mind the copyright issues explained in our email in case you include images and graphics you have not produced yourself.
 
 %%% Please use this format to include images. Supported image formats: jpg, pdf, png. Please convert your images to those formats.
-\begin{figure}[h]
+\begin{figure}[ht]
         \centering 
-        \includegraphics[width= 0.33 \textwidth]{sample-image.jpg}
+        \includegraphics[width= 0.33 \textwidth]{mfo.jpg}
         \caption{An image scaled to 33\% of the textwidth.}
 \label{fig:sample-image}
 \end{figure}
@@ -110,9 +160,28 @@ \subsection{A subsection}
 \end{align}
 Formula \eqref{real} refers to $\mathbb{R}$, formula \eqref{char.2} does not.
 
-\section{More Information}
+\section{More information}
 We have composed guidelines to help you write a beautiful and accessible snapshot which you can download here: \href{http://www.mfo.de/math-in-public/snapshots/guidelines-for-snapshots}{www.mfo.de/math-in-public/snapshots/ guidelines-for-snapshots}. For more information on the snapshot project (including example snapshots), please see \href{http://www.mfo.de/math-in-public/snapshots}{www.mfo.de/math-in-public/snapshots}.
 
+%%% Please use this format to include images. Supported image formats: jpg, pdf, png. Please convert your images to those formats.
+\begin{figure}[h]
+        \centering 
+        \includegraphics[width= 0.33 \textwidth]{maya.pdf}
+        \caption{Exemplary image: Maya numerals.}
+\label{fig:maya}
+\end{figure}
+
+If you download an image from Wikipedia or similar sources, please always check the applicable license terms. Most licenses require an adequate attribution. For Wikipedia, you can find the correct reference by clicking on the image and then clicking on the button saying 'use this file‘. Some licenses may have further restrictions, such as 'modifications are not allowed'. If modifications are allowed you may still have to mark those modifications. Please verify that you comply with all license requirements.
+
+If you use your own images, please check if you still have the rights of use. The images may be copyrighted by your institution or a publisher of your previous publications.
+\clearpage
+
+%%% Image credits: If you download an image form Wikipedia or similar sources, please always check the applicable license terms. Most licenses require an adequate attribution. For Wikipedia, you can find the correct reference by clicking on the image and then clicking on the button saying 'More details' and then on the link 'use this file' or similar. Some licenses may have further restrictions, such as 'modifications are not allowed'. If modifications are allowed you may still have to mark those modifications. Please verify that you comply with all license requirements. If you use your own images, please check if you still have the rights of use. The images may be copyrighted by your institution or a publisher of your previous publications.
+\begin{imagecredits}
+  \item[Fig. \ref{fig:sample-image}] Archives of the Mathematisches Forschungsinstitut Oberwolfach,\\\url{http://www.mfo.de}, 2004.
+  \item[Fig. \ref{fig:maya}] ``Maya''. Author: Bryan Derkson. Licensed under Creative Commons Attribution-Share Alike 3.0 via Wikimedia Commons, \url{http://commons.wikimedia.org/wiki/File:Maya.svg}, visited on September 5, 2014.
+\end{imagecredits}
+
 %%%%%%%%%%%% Bibliography via BibTeX %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%% Please use this command in case you prefer to use the filecontents environment and edit your BibTeX entries above. If you prefer to use \bibitems, you will need to silence the \bibliography following command with a % symbol.
 \bibliography{\jobname}