Tips for ABINIT users and developers

User Tools

Site Tools

Trace:
beauty:2018

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
beauty:2018 [2018/06/02 17:35] – [What should be done ?] Xavier Gonzebeauty:2018 [2018/06/03 23:11] (current) – [What should be done ?] Xavier Gonze
Line 29: Line 29:
  
   * A. There are still MANY isolated bibliographical references in the descriptions of input variables or lessons of the tutorial (or other files), [[https://docs.abinit.org/developers/abimkdocs/#how-to-add-a-bibliographic-reference|to be ported inside the bibliography database]].   * A. There are still MANY isolated bibliographical references in the descriptions of input variables or lessons of the tutorial (or other files), [[https://docs.abinit.org/developers/abimkdocs/#how-to-add-a-bibliographic-reference|to be ported inside the bibliography database]].
-  * B. Equations might still be in "text" style, while [[https://docs.abinit.org/developers/markdown/#mathjax|they should be now in "LaTex" style]] (interpreted using MathJax) +  * B. Many line breaks have disappeared in the input variable descriptions (so, one big paragraph appears instead of several paragraphs) 
-  * C. specific improvements of lessons of the tutorials and other files could be made, thanks to the new mkdocs infrastructure. +  * C. Equations might still be in "text" style, while [[https://docs.abinit.org/developers/markdown/#mathjax|they should be now in "LaTex" style]] (interpreted using MathJax) 
-  * D. it remains to be checked that no inadvertent deterioration of the documentation has occurred. +  * D. Specific improvements of lessons of the tutorials and other files could be made, thanks to the new mkdocs infrastructure. 
-  * E. one might also check the correctness of links and other information (like the coherence between the sections of output files pasted in the text, and the output files themselves, available from the links)+  * E. It remains to be checked that no inadvertent deterioration of the documentation has occurred. 
 +  * F. One might also check the correctness of links and other information (like the coherence between the sections of output files pasted in the text, and the output files themselves, available from the links)
      
 As an indication, each contributor might have to dedicate about three hours to this work (including, if not yet done, reading the mkdocs documentation and possibly training a bit with the mksite script). By the way, suggestions for improvements of the mkdocs infrastructure is also welcome, see the dedicated page.  As an indication, each contributor might have to dedicate about three hours to this work (including, if not yet done, reading the mkdocs documentation and possibly training a bit with the mksite script). By the way, suggestions for improvements of the mkdocs infrastructure is also welcome, see the dedicated page. 
Line 40: Line 41:
 Check first whether it exists already in the bibliographical database Check first whether it exists already in the bibliographical database
 (file doc/abiref.bib), and if so, simply refer to it using a "cite" wikilink. (file doc/abiref.bib), and if so, simply refer to it using a "cite" wikilink.
-Otherwise, introduce the adequate bibtex information, following +Otherwise, 
-[[https://docs.abinit.org/developers/abimkdocs/#how-to-add-a-bibliographic-reference]]+[[https://docs.abinit.org/developers/abimkdocs/#how-to-add-a-bibliographic-reference|introduce the adequate bibtex information]]
  
 ==== I have not yet familiarized myself with abimkdocs / markdown  ==== ==== I have not yet familiarized myself with abimkdocs / markdown  ====
beauty/2018.1527953735.txt.gz · Last modified: 2018/06/02 17:35 by Xavier Gonze