yade-dev team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 3743
committer: Bruno Chareyre <bruno.chareyre@xxxxxxxxxxx>
timestamp: Fri 2015-11-20 01:42:30 +0100
message:
  update the webpage about citation with 2nd edition, add 1st edition as an external reference, update pdf metadata
modified:
  doc/references.bib
  doc/sphinx/citing.rst
  doc/sphinx/conf.py


--
lp:yade
https://code.launchpad.net/~yade-pkg/yade/git-trunk

Your team Yade developers is subscribed to branch lp:yade.
To unsubscribe from this branch go to https://code.launchpad.net/~yade-pkg/yade/git-trunk/+edit-subscription

=== modified file 'doc/references.bib'
--- doc/references.bib	2015-03-05 20:44:30 +0000
+++ doc/references.bib	2015-11-20 00:42:30 +0000
@@ -831,3 +831,55 @@
   url = {http://adsabs.harvard.edu/abs/1985A%26A...149..135M}
 }
 
+
+@Book{ yade:doc,
+	PUBLISHER = "{The {Y}ade Project}",
+	TITLE = "{Y}ade {D}ocumentation",
+	YEAR = "2010",
+	AUTHOR = "V. Šmilauer and E. Catalano and B. Chareyre and S. Dorofeenko and J. Duriez and A. Gladky and J. Kozicki and C. Modenese and L. Scholtès and L. Sibille and J. Stránský and K. Thoeni",
+	ALTEDITOR = "Václav Šmilauer",
+	EDITION = "{1st}",
+	NOTE = "{http://yade-dem.org/doc/}";,
+	ALTNOTE = "\\url{http://yade-dem.org/doc/}";
+}
+
+@incollection{ yade:manual,
+	author={V. Šmilauer and A. Gladky and J. Kozicki and C. Modenese and J. Stránský},
+	booktitle={Yade {D}ocumentation},
+	editor={V. Šmilauer},
+	publisher={The Yade Project},
+	title={Yade, Using and Programming},
+	year={2010},
+	edition={1st},
+	url={https://yade-dem.org/w/images/0/09/YadeManuals.pdf},
+	note={http://yade-dem.org/doc/}
+}
+
+@incollection{ yade:background,
+	title = "{Y}ade DEM Formulation",
+	author = "V. Šmilauer and B. Chareyre",
+	booktitle = "{Y}ade {D}ocumentation",
+	editor = "V. Šmilauer",
+	publisher = "{The {Y}ade Project}",
+	year = "2010",
+	edition = "{1st}",
+	note = "http://yade-dem.org/doc/formulation.html";,
+	altnote = "\\url{http://yade-dem.org/doc/formulation.html}";,
+	url={https://yade-dem.org/w/images/e/e0/YadeFormulation.pdf}
+}
+
+@incollection{ yade:reference,
+	author = "V. Šmilauer and E. Catalano and B. Chareyre and S. Dorofeenko and J. Duriez and A. Gladky and J. Kozicki and C. Modenese and L. Scholtès and L. Sibille and J. Stránský and K. Thoeni",
+	booktitle = "{Y}ade {D}ocumentation",
+	editor = "V. Šmilauer",
+	publisher = "{The {Y}ade Project}",
+	title = "{Y}ade {R}eference {D}ocumentation",
+	year = "2010",
+	edition = "{1st}",
+	note = "http://yade-dem.org/doc/";,
+	altnote = "\\url{http://yade-dem.org/doc/}";,
+	url= {https://yade-dem.org/w/images/9/98/YadeRefDoc.pdf}
+}
+
+
+

=== modified file 'doc/sphinx/citing.rst'
--- doc/sphinx/citing.rst	2014-01-13 17:49:25 +0000
+++ doc/sphinx/citing.rst	2015-11-20 00:42:30 +0000
@@ -12,20 +12,20 @@
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 If it is not possible to choose the right chapter (but please try), you may cite the documentation [yade:doc]_ as a whole:
 
-	V. Šmilauer, E. Catalano, B. Chareyre, S. Dorofeenko, J. Duriez, A. Gladky, J. Kozicki, C. Modenese, L. Scholtès, L. Sibille, J. Stránský, and K. Thoeni, Yade Documentation (V. Šmilauer, ed.), The Yade Project, 1st ed., 2010. http://yade-dem.org/doc/.
+	V. Šmilauer et al. (2015), Yade Documentation 2nd ed. The Yade Project. DOI 10.5281/zenodo.32409 (http://yade-dem.org/doc/)
 
 Citing chapters of Yade Documentation
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The first edition of Yade documentation is seen as a collection with the three volumes (or "chapters") listed below, also provided as `bibtex entries <https://github.com/yade/trunk/blob/master/doc/citing_yade.bib>`_. Please cite the chapter that is the most relevant in your case. For instance, a paper using one of the documented contact laws will cite the reference documentation [yade:reference]_; if programing concepts are discussed, Yade's manual [yade:manual]_ will be cited; the theoretical background [yade:background]_ can be used as the refence for contact detection, time-step determination, or periodic boundary conditions.
-
-* The reference documentation includes details on equations and algorithms found at the highest levels of Yade (contact laws, boundary conditions controllers, pre- and post-processing modules,...) `(pdf version) <https://yade-dem.org/w/images/9/98/YadeRefDoc.pdf>`__:
-	V. Šmilauer, E. Catalano, B. Chareyre, S. Dorofeenko, J. Duriez, A. Gladky, J. Kozicki, C. Modenese, L. Scholtès, L. Sibille, J. Stránský, and K. Thoeni, “Yade Reference Documentation,” in Yade Documentation (V. Šmilauer, ed.), The Yade Project, 1st ed., 2010. http://yade-dem.org/doc/.
-
-* Software design, user's and programmer's manuals are in `(pdf version) <https://yade-dem.org/w/images/0/09/YadeManuals.pdf>`__:
-	V. Šmilauer, A. Gladky, J. Kozicki, C. Modenese, and J. Stránský, “Yade Using and Programming,” in Yade Documentation (V. Šmilauer, ed.), The Yade Project, 1st ed., 2010. http://yade-dem.org/doc/.
-
-* Fundamentals of the DEM as implemented in Yade are explained in `(pdf version) <https://yade-dem.org/w/images/e/e0/YadeFormulation.pdf>`__:
-	V. Šmilauer and B. Chareyre, “Yade Dem Formulation”, in Yade Documentation (V. Šmilauer, ed.), The Yade Project, 1st ed., 2010. http://yade-dem.org/doc/formulation.html.
-
-
+The second edition of Yade documentation is seen as a collection with the three volumes (or "chapters") listed below, and edited by V. Šmilauer, B. Chareyre, and A. Gladky. Please cite the chapter that is the most relevant in your case. For instance, a paper using one of the documented contact laws will cite the reference documentation [yade:reference2]_; if programing concepts are discussed, Yade's manual [yade:manual2]_ will be cited; the theoretical background [yade:background2]_ can be used as the refence for contact detection, time-step determination, or periodic boundary conditions.
+
+* The reference documentation includes details on equations and algorithms found at the highest levels of Yade (contact laws, boundary conditions controllers, pre- and post-processing modules,...) `(pdf version) <https://www.yade-dem.org/publi/documentation_2nd_ed/YadeReference.pdf>`__:
+	V. Šmilauer et al. (2015), Reference manual. In Yade Documentation 2nd ed. The Yade Project , DOI 10.5281/zenodo.34045 (http://yade-dem.org/doc/)
+
+* Software design, user's and programmer's manuals are in `(pdf version) <https://www.yade-dem.org/publi/documentation_2nd_ed/YadeManuals.pdf>`__:
+	V. Šmilauer et al. (2015), Using and programming. In Yade Documentation 2nd ed. The Yade Project , DOI 10.5281/zenodo.34043 (http://yade-dem.org/doc/)
+
+* Fundamentals of the DEM as implemented in Yade are explained in `(pdf version) <https://www.yade-dem.org/publi/documentation_2nd_ed/YadeTheory.pdf>`__:
+	V. Šmilauer et al. (2015), Dem formulation. In Yade Documentation 2nd ed. The Yade Project , DOI 10.5281/zenodo.34044 (http://yade-dem.org/doc/)
+
+Plain bibtex items can be `found here <https://github.com/yade/trunk/blob/master/doc/citing_yade.bib>`_.
 

=== modified file 'doc/sphinx/conf.py'
--- doc/sphinx/conf.py	2015-10-27 01:50:32 +0000
+++ doc/sphinx/conf.py	2015-11-20 00:42:30 +0000
@@ -447,7 +447,8 @@
 
 % Metadata of the pdf output
 \hypersetup{pdftitle={Yade Documentation}}
-\hypersetup{pdfauthor={V. Smilauer, E. Catalano, B. Chareyre, S. Dorofeenko, J. Duriez, A. Gladky, J. Kozicki, C. Modenese, L. Scholtes, L. Sibille, J. Stransky, K. Thoeni}}
+\hypersetup{pdfauthor={Smilauer, V., et al.}}
+\hypersetup{pdfkeywords={Discrete element method, granular materials, contact law, hydromechanical coupling}}
 
 % symbols
 \let\mat\boldsymbol % matrix
@@ -760,7 +761,7 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index-toctree', 'Yade.tex', u'Yade Documentation',
+   ('index-toctree', 'Yade.tex', u'Yade Documentation',
    u'Václav Šmilauer', 'manual'),
    ('index-toctree_manuals', 'YadeManuals.tex', u'Yade Tutorial and Manuals',
    u'Václav Šmilauer', 'manual'),