yade-dev team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 2726
committer: Bruno Chareyre <bruno.chareyre@xxxxxxxxxxx>
branch nick: yade
timestamp: Fri 2011-02-11 19:26:51 +0100
message:
  - Include Yade citation page in doc, and add links in different places.
  - Add 'InCollection' keyword in bib2rst 
modified:
  doc/sphinx/bib2rst.py
  doc/sphinx/conf.py
  doc/sphinx/index-toctree.rst
  doc/sphinx/publications.rst.in
  doc/sphinx/templates/index.html
  doc/sphinx/yadeSphinx.py


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

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

=== modified file 'doc/sphinx/bib2rst.py'
--- doc/sphinx/bib2rst.py	2010-07-13 19:58:14 +0000
+++ doc/sphinx/bib2rst.py	2011-02-11 18:26:51 +0000
@@ -54,6 +54,11 @@
 			if i.has_key('publisher'): line+=' %s.'%i['publisher']
 		elif type=='inproceedings':
 			line+='%s (%s), **%s**. In *%s*.'%(author,i['year'],i['title'],i['booktitle'] if i.has_key('booktitle') else i['journal'])
+		elif type=='incollection':
+		 	line+='%s (%s), **%s**. In *%s* '%(author,i['year'],i['title'],i['booktitle'] if i.has_key('booktitle') else i['journal'])
+			if i.has_key('editor'): line+='( %s'%i['editor']+', ed.),'
+			if i.has_key('publisher'): line+=' %s'%i['publisher']+' ,'
+			if i.has_key('edition'): line+=' %s ed.'%i['edition']
 		elif type=='phdthesis':
 			line+='%s (%s), **%s**. PhD thesis at *%s*.'%(author,i['year'],i['title'],i['school'])
 		elif type=='mastersthesis':

=== modified file 'doc/sphinx/conf.py'
--- doc/sphinx/conf.py	2011-02-07 09:00:07 +0000
+++ doc/sphinx/conf.py	2011-02-11 18:26:51 +0000
@@ -630,6 +630,93 @@
 
 # -- Options for LaTeX output --------------------------------------------------
 
+my_maketitle=r'''
+\begin{titlepage}
+
+\begin{flushright}
+\hrule{}
+
+% Upper part of the page
+\begin{flushright}
+\includegraphics[width=0.15\textwidth]{yade-logo.png}\par
+\end{flushright}
+\vspace{20 mm}
+\text{\sffamily\bfseries\Huge Yade Documentation}\\
+\vspace{5 mm}
+\textit{\sffamily\huge Release '''\
++yade.config.revision\
++r'''}\\
+\vspace{40 mm}
+\textit{\sffamily\LARGE Editor}\\
+\text{\sffamily\bfseries\LARGE Václav Šmilauer}\\
+\vspace{30 mm}
+\textit{\sffamily\LARGE Authors}\\
+%\begin{tabular}{>{\raggedleft}p{110mm}@{}} %replace "\\" by "," for the table form
+\text{\sffamily\bfseries\Large Václav Šmilauer}\\
+\text{\sffamily\bfseries\Large Emanuele Catalano}\\
+\text{\sffamily\bfseries\Large Bruno Chareyre}\\
+\text{\sffamily\bfseries\Large Sergei Dorofenko}\\
+\text{\sffamily\bfseries\Large Jerome Duriez}\\
+\text{\sffamily\bfseries\Large Anton Gladky}\\
+\text{\sffamily\bfseries\Large Janek Kozicki}\\
+\text{\sffamily\bfseries\Large Chiara Modenese}\\
+\text{\sffamily\bfseries\Large Luc Scholtès}\\
+\text{\sffamily\bfseries\Large Luc Sibille}\\
+\text{\sffamily\bfseries\Large Jan Stránský}\\
+\text{\sffamily\bfseries\Large Klaus Thoeni}
+%\end{tabular}
+\vspace{20 mm}
+\hrule{}
+
+\vfill
+% Bottom of the page
+{\large \today}
+\end{flushright}
+
+\end{titlepage}
+
+\text{\sffamily\bfseries\LARGE Authors}\\
+\\
+\text{\sffamily\bfseries\Large Václav Šmilauer}\\
+\text{\sffamily\Large CVUT Prague - lab. 3SR Grenoble University }\\
+\\
+\text{\sffamily\bfseries\Large Emanuele Catalano}\\
+\text{\sffamily\Large Grenoble INP, UJF, CNRS, lab. 3SR}\\
+\\
+\text{\sffamily\bfseries\Large Bruno Chareyre}\\
+\text{\sffamily\Large Grenoble INP, UJF, CNRS, lab. 3SR}\\
+\\
+\text{\sffamily\bfseries\Large Sergei Dorofenko}\\
+\text{\sffamily\Large IPCP RAS, Chernogolovka}\\
+\\
+\text{\sffamily\bfseries\Large Jerome Duriez}\\
+\text{\sffamily\Large Grenoble INP, UJF, CNRS, lab. 3SR}\\
+\\
+\text{\sffamily\bfseries\Large Anton Gladky}\\
+\text{\sffamily\Large TU Bergakademie Freiberg}\\
+\\
+\text{\sffamily\bfseries\Large Janek Kozicki}\\
+\text{\sffamily\Large Gdansk University of Technology - lab. 3SR Grenoble University }\\
+\\
+\text{\sffamily\bfseries\Large Chiara Modenese}\\
+\text{\sffamily\Large University of Oxford}\\
+\\
+\text{\sffamily\bfseries\Large Luc Scholtès}\\
+\text{\sffamily\Large Grenoble INP, UJF, CNRS, lab. 3SR}\\
+\\
+\text{\sffamily\bfseries\Large Luc Sibille}\\
+\text{\sffamily\Large University of Nantes, lab. GeM}\\
+\\
+\text{\sffamily\bfseries\Large Jan Stránský}\\
+\text{\sffamily\Large CVUT Prague}\\
+\\
+\text{\sffamily\bfseries\Large Klaus Thoeni}
+\text{\sffamily\Large University of Newcastle (Australia)}\\
+
+\text{\sffamily\bfseries\large Citing this document}\\
+In order to let users cite Yade consistently in publications, we provide a list of bibliographic references for the different parts of the documentation. This way of acknowledging Yade is also a way to make developments and documentation of Yade more attractive for researchers, who are evaluated on the basis of citations of their work by others. We therefore kindly ask users to cite Yade as accurately as possible in their papers, as explained in http://yade-dem/doc/citing.html.
+
+'''
 
 latex_elements=dict(
 	papersize='a4paper',
@@ -643,7 +730,8 @@
 	preamble=my_latex_preamble,
 	footer='',
 	inputenc='',
-	fontenc=''
+	fontenc='',
+	maketitle=my_maketitle,
 )
 
 # The paper size ('letter' or 'a4').
@@ -657,11 +745,13 @@
 latex_documents = [
   ('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'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+latex_logo = 'fig/yade-logo.png'
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.

=== modified file 'doc/sphinx/index-toctree.rst'
--- doc/sphinx/index-toctree.rst	2011-01-20 16:35:46 +0000
+++ doc/sphinx/index-toctree.rst	2011-02-11 18:26:51 +0000
@@ -19,24 +19,26 @@
 .. toctree::
   :maxdepth: 2
 
-  installation.rst
-
   introduction.rst
 
   tutorial.rst
 
-  formulation.rst
-
   user.rst
 
   prog.rst
 
+  installation.rst
+
+  formulation.rst
+
   yade.wrapper.rst
 
   modules.rst
 
   external.rst
 
+  citing.rst
+
   publications.rst
 
   references.rst

=== modified file 'doc/sphinx/publications.rst.in'
--- doc/sphinx/publications.rst.in	2010-07-05 08:16:58 +0000
+++ doc/sphinx/publications.rst.in	2011-02-11 18:26:51 +0000
@@ -1,23 +1,28 @@
 Publications on Yade
 =====================
-
 This page should be a relatively complete list of publications on Yade itself or done with Yade. If you publish something, do not hesitate to add it on the list. If PDF is freely available, add url for direct fulltext downlad. If not, consider uploading fulltext in PDF, either to `Yade wiki <https://www.yade-dem.org/wiki/>`_ or to other website, if legally permitted.
 
-.. note:: This file is generated from :ysrc:`doc/yade-articles.bib`, :ysrc:`doc/yade-conferences.bib` and :ysrc:`doc/yade-theses.bib`.
+The last section gives the references that we recommend to use for citing Yade in publications, as explained in the `"Acknowledging Yade" <citing.html>`_ section.
+
+.. note:: This file is generated from :ysrc:`doc/yade-articles.bib`, :ysrc:`doc/yade-conferences.bib`, :ysrc:`doc/yade-theses.bib` and :ysrc:`doc/yade-docref.bib`.
 
 Journal articles
 -----------------
-
 @bib2rst.bib2rst('../yade-articles.bib')@
 
 
 Master and PhD theses
 -----------------------
-
 @bib2rst.bib2rst('../yade-theses.bib')@
 
 
 Conference materials
 ---------------------
-
 @bib2rst.bib2rst('../yade-conferences.bib')@
+
+
+Citing Yade
+---------------------
+Corresponding bibtex entries `here <wiki/Yadebibtex>`_. See also `"Acknowledging Yade" <citing.html>`_.
+
+@bib2rst.bib2rst('../yade-docref.bib')@

=== modified file 'doc/sphinx/templates/index.html'
--- doc/sphinx/templates/index.html	2011-01-20 16:35:46 +0000
+++ doc/sphinx/templates/index.html	2011-02-11 18:26:51 +0000
@@ -3,11 +3,14 @@
 {% block body %}
   <h1>Welcome to Yade</h1>
   <p>
-	Yade is an extensible open-source framework for discrete numerical models, focused on Discrete Element Method. The computation parts are written in c++ using flexible object model, allowing independent implementation of new alogrithms and interfaces. Python is used for rapid and concise scene construction, simulation control, postprocessing and debugging.
+	Yade NOT is an extensible open-source framework for discrete numerical models, focused on Discrete Element Method. The computation parts are written in c++ using flexible object model, allowing independent implementation of new alogrithms and interfaces. Python is used for rapid and concise scene construction, simulation control, postprocessing and debugging.
   <p>
    Yade is located at <a href="https://www.yade-dem.org";>www.yade-dem.org</a>, which contains <a href="https://www.yade-dem.org/sphinx/";>this documentation</a> and <a href="https://www.yade-dem.org/wiki/";>wiki</a>. Development is kindly hosted at <a href="http://www.launchpad.net/yade";>launchpad</a>; it is used for <a href="http://code.launchpad.net/yade";>source code</a>, <a href="http://bugs.launchpad.net/yade";>bug tracking</a>, <a href="http://blueprints.launchpad.net/yade";>planning</a>, <a href="https://launchpad.net/~yade-users/+archive/ppa";>package downloads</a> and more.
   </p>
   <p>
+   Please make sure you read the <a href="{{ pathto("citing") }}">"Acknowledging Yade"</a> section if you plan to cite Yade in publications.
+  </p>
+  <p>
    This documentation decribes Yade version {{ release }} / {{ version }}.
   </p>
   <h2>Documentation</h2>
@@ -51,6 +54,8 @@
            <span class="linkdescr">search the documentation</span></p>
         <p class="biglink"><a class="biglink" href="{{ pathto("index-toctree") }}">Full contents</a><br/>
            <span class="linkdescr">with all the details</span></p>
+        <p class="biglink"><a class="biglink" href="{{ pathto("citing") }}">Acknowledging Yade</a><br/>
+           <span class="linkdescr">How to cite Yade in publications</span></p>
       </td>
     </tr>
   </table>

=== modified file 'doc/sphinx/yadeSphinx.py'
--- doc/sphinx/yadeSphinx.py	2011-01-23 23:12:43 +0000
+++ doc/sphinx/yadeSphinx.py	2011-02-11 18:26:51 +0000
@@ -203,7 +203,7 @@
 sys.path.append('.') # for bib2rst
 
 genReferences()
-for bib in ('references','yade-articles','yade-theses','yade-conferences'):
+for bib in ('references','yade-articles','yade-theses','yade-conferences','yade-docref'):
 	shutil.copyfile('../%s.bib'%bib,outDir+'/latex/%s.bib'%bib)
 
 global writer