Merge pull request #101 from quantum-journal/develop

Release of v5.0

.gitignore

@@ -1,3 +1,6 @@
+## Specific files
+quantum-lyx-template.pdf
+
 ## Core latex/pdflatex auxiliary files:
 *.aux
 *.lof

.travis.yml

@@ -34,5 +34,6 @@ script:
     - mkdir _build
     - cd _build
     - cp ../quantum-template.tex .
+    - cp ../example-plot.pdf .
     - pdflatex -interaction=nonstopmode -halt-on-error quantum-template.tex
     - pdflatex -interaction=nonstopmode -halt-on-error quantum-template.tex

README.md

@@ -2,10 +2,15 @@
 
 # LaTeX document class for Quantum
 
-`quantumarticle` is the document class for typsetting articles in Quantum.
+This is version 5.0 of `quantumarticle`, the document class for typesetting articles in Quantum - the open journal for quantum science.
 
 [Click here](https://raw.githubusercontent.com/quantum-journal/quantum-journal/master/quantumarticle.cls) to download the latest stable version.
 
+[More information](https://raw.githubusercontent.com/quantum-journal/quantum-journal/master/quantum-template.pdf) on using quantumarticle and on typesetting manuscripts for Quantum can be found in the accompanying template.
+
+[Documentation](https://raw.githubusercontent.com/quantum-journal/quantum-journal/master/quantumarticle.pdf) of all class options is also provided. 
+
+
 ## Installation and usage
 
 To use the `quantumarticle` document class with LaTeX simply start your document with the line:
@@ -31,27 +36,62 @@ Before you can do this however, you must make `quantumarticle.cls` accessible to
 
 3. To manually install `quantumarticle`, you can either clone this git repository or download `quantumarticle.cls` directly via [this link](https://raw.githubusercontent.com/quantum-journal/quantum-journal/master/quantumarticle.cls) and then copy the `quantumarticle.cls` file to `texmf/tex/latex/quantumarticle` within your home directory (under Linux, macOS, and OS X `~/`, or under Windows typically `C:\Users\[your username]`) and run `texhash` (TeX Live) or `initexmf --update-fndb` (MiKTeX).
 
-4. Finally, you can use `quantumarticle.cls` without even downloading it at all on the collaborative writing platform [overleaf](https://www.overleaf.com/) by starting your project from the `quantumarticle` [template](https://www.overleaf.com/latex/templates/template-for-submission-to-quantum-journal/gsjgyhxrtrzy) as well as with the [ShareLaTeX](https://www.sharelatex.com/project) online LaTeX editor by using the `quantumarticle` [template](https://www.sharelatex.com/templates/5912bce26aad110026f11697) there.
+4. Finally, you can use `quantumarticle.cls` without even downloading it at all on the collaborative writing platform [overleaf](https://www.overleaf.com/) by starting your project from the `quantumarticle` [template](https://www.overleaf.com/latex/templates/template-for-submission-to-quantum-journal/gsjgyhxrtrzy).
 
 ## Dependencies
 
-`quantumarticle.cls` should work with any reasonably recent LaTeX distribution. It further requires the following packages: `xkeyval`, `etoolbox`, `geometry`, `xcolor`, `fancyhdr`, `tikz`, `hyperref`, ltxgrid and ltxcmds (often distributed along with revtex, in texlive for example as part of `texlive-publishers`), as well as at least either `lmodern` or `type1ec`. We recommend to have `natbib` and at least one of `bbm` or `dsfont` installed. All of these should be included in the full install variant of your LaTeX distribution (for example `texlive-full`).
+`quantumarticle.cls` should work with any reasonably recent LaTeX distribution. It further requires the following packages: `xkeyval`, `etoolbox`, `geometry`, `xcolor`, `fancyhdr`, `tikz`, `hyperref`, `ltxgrid` and `ltxcmds` (often distributed along with revtex, in texlive for example as part of `texlive-publishers`), as well as at least either `lmodern` or `type1ec`. We recommend to have `natbib` and at least one of `bbm` or `dsfont` installed. All of these should be included in the full install variant of your LaTeX distribution (for example `texlive-full`).
 
 ## Compatibility
 
 The `quantumarticle` class tries to be **maximally compatible** with existing document classes, such as, `article`, `revtex`, `iopart`, and `elsarticle`. It supports all standard options, like `twocolumn`, `onecolumn`, `titlepage`, as well as the standard syntax for defining the title page with the `\author`, `\address`, and `\affiliation` commands and the `abstract` environment.
 
+## Beta features
+
+In addition, this document class come bundled with two new extras (currently in beta phase):
+
+1. The quantum-plots.ipynb Jupyter notebook and matplotlib style for effortlessly producing professional looking plots in python.
+
+2. The quantum-lyx-template.lyx LxY layout, which allow you to generate the LaTeX source of your quantumarticle manuscript with the LyX document processor.
+
+## Changelog
+
+### New in v5.0:
+
+* force users to specify a paper size to prevent unexpected behavior
+* option processing is now done exclusively by means of xkeyval
+* improved compatibility with frequently used LaTeX document classes
+* improved/added options for using this document class for manuscripts not intended for submission to Quantum
+* documents not intended for submission to Quantum can now be compiled with compilers different from PdfLaTeX (e.g. LuaLaTeX)
+* use https in links when possible
+* prevent usage of the `\today` macro in `\date` to avoid changing dates in documents when they are re-compiled on the arXiv
+* enforce that users put `\pdfoutput=1` (as recommended by the arXiv) to prevent problems with multi-line hyper links
+* improved error messages
+* fixed a bug that lead to the title not being centered with the `titlepage` option
+* better layout of titles 
+* fixed various bugs in option processing
+* the document class is now documented in `quantumarticle.pdf`
+* introduced the plotting notebook `quantum-plots.ipynb` as a beta feature
+* introduced the LyX template `quantum-lyx-template.lyx` as a beta feature
+
+
+## Contributors
+
+Developed by: Christian Gogolin, Christopher Granade, Johannes J. Meyer, and Victor V. Albert
+
+With contributions from: Shahnawaz Ahmed, Andrey Rakhubovsky, liantze, and Abhinav Deshpande
+
 ## Contributing
 
-In case you encounter problems using the article class please consider opening a bug report in our [bug-tracker on github](https://github.com/cgogolin/quantum-journal/issues).
+In case you encounter problems using the article class please consider opening a bug report in our [bug-tracker on GitHub](https://github.com/quantum-journal/quantum-journal/issues).
 You can also contact us via email under latex@quantum-journal.org, but it may take significantly longer to get a response.
 In any case we need the full source of a document that produces the problem and the log file showing the error to help you.
 
-Improvements submitted as pull requests against the `development` branch are very much appreciated!
+Improvements submitted as pull requests against the `develop` branch are very much appreciated!
 
 ## Copyright
 
-Copyright 2017
+Copyright 2017, 2018, 2019
 Verein zur Förderung des Open Access Publizierens in den Quantenwissenschaften
 (http://quantum-journal.org/about/)
 
@@ -65,3 +105,5 @@ The latest version of this license is in
 http://www.latex-project.org/lppl.txt
 and version 1.3c or later is part of all distributions of LaTeX
 version 2005/12/01 or later.
+
+[comment]: # (To submit to the overleaf galary: push, open the project, go to Journals and Services and click Submit to Overleaf Gallery. To submit to sharelatex: write them an email)

install.ps1

@@ -47,7 +47,7 @@
 .LINK
     http://quantum-journal.org
 .LINK
-    https://github.com/cgogolin/quantum-journal
+    https://github.com/quantum-journal/quantum-journal
 .PARAMETER CTAN
     If present, this script will also build a ZIP archive suitable
     for uploading {quantumarticle} to CTAN.
@@ -215,5 +215,5 @@ if ($CTAN) {
     #endregion
 
     # Once we have PoShTeX, we can then directly invoke Export-CTANArchive.
-    Export-CTANArchive -ArchiveLayout Simple quantumarticle.cls, quantum-template.pdf, quantum-template.tex, README.md, install.sh, install.ps1
+    Export-CTANArchive -ArchiveLayout Simple quantumarticle.cls, quantum-template.pdf, quantum-template.tex, README.md, quantumarticle.tex, quantumarticle.pdf
 }