developers:generate_doc
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
developers:generate_doc [2017/08/04 08:24] – [The ABINIT HTML doc] Xavier Gonze | developers:generate_doc [2017/12/15 16:18] – ↷ Links adapted because of a move operation 37.9.113.186 | ||
---|---|---|---|
Line 14: | Line 14: | ||
The expansion of special strings is documented in [[developers: | The expansion of special strings is documented in [[developers: | ||
- | It can be used in all the YAML files mentioned below. | + | It can be used in all the YAML files mentioned below. For equations/ |
+ | [[http:// | ||
+ | to process and visualize LaTeX formulas, see also [[developers: | ||
===== Input variables : How to add/modify ? ===== | ===== Input variables : How to add/modify ? ===== | ||
Line 23: | Line 25: | ||
| | ||
A window should open, and you can fill the requested information ...\\ | A window should open, and you can fill the requested information ...\\ | ||
- | To add a new variable, click on " | + | To add a new variable, click on " |
- | After having edited the info related to one input variable (see the infos at [[developers: | + | |
- | Then, build the HTML using generate_doc.py. | + | |
+ | Note that input variables for the executables other than the main abinit (e.g. anaddb, aim, optic) are | ||
+ | denoted " | ||
+ | |||
+ | After having edited the info related to one input variable (see the infos at [[developers: | ||
+ | Then, build the HTML using generate_doc.py. | ||
===== Bibliographic reference : how to add/modify ? ===== | ===== Bibliographic reference : how to add/modify ? ===== | ||
Edit the file ~abinit/ | Edit the file ~abinit/ | ||
Note that the ID must be of the form " | Note that the ID must be of the form " | ||
- | then lower case, then four-digit year). Possibly, a letter might be added in case of ambiguity: there exists also | + | then lower case, then four-digit year). Possibly, a letter might be added in case of ambiguity: |
" | " | ||
Then, build the HTML using generate_doc.py. | Then, build the HTML using generate_doc.py. | ||
Line 46: | Line 51: | ||
At variance, the other sections of the topic_NAME.html are created from other sources. The list of input variables that are relevant to this topics is assembled from the information | At variance, the other sections of the topic_NAME.html are created from other sources. The list of input variables that are relevant to this topics is assembled from the information | ||
- | given for these inputvariables, see [[#input variableshow_to_add_modify|Input variables : how_to_add_modify]], | + | given for these input variables, see [[#input variableshow_to_add_modify|Input variables : how_to_add_modify]], as well as [[developers: |
- | is assembled from the information in each of these input files (see the line " | + | is assembled from the information in each of these input files (add a line "#%% topics |
from the references cited in the " | from the references cited in the " | ||
Line 53: | Line 58: | ||
in the more specific file topic_NAME.yml.\\ | in the more specific file topic_NAME.yml.\\ | ||
- | The list of topics is found in the file list_of_topics.yml . | + | The list of topics is found in the file ~abinit/ |
+ | |||
+ | Thus, if you want to a modify " | ||
+ | |||
+ | To add a new topic, add the name in list_of_topics.yml, | ||
+ | The different components are used by the script generate_doc.py as follows: | ||
+ | * name : must be the name of the topics, also used in the name of file (topic_name.yml) | ||
+ | * keyword : will be inserted in the HTML header to create the Web name of the HTML page, if the default header is used | ||
+ | * authors : will be inserted in the copyright, if the default copyright is used | ||
+ | * howto : will be inserted in the subtitle of the Web page "How to ... ?" if the default subtitle is used | ||
+ | * header : the HTML header (usually, take the default, that uses the component " | ||
+ | * title : the title that will be echoed in the HTML page | ||
+ | * subtitle : the subtitle (usually, take the default, that uses the component " | ||
+ | * copyright : the copyright (usually, take the default, that uses the component " | ||
+ | * links : list of links to other pages (usually, take the default) | ||
+ | * introduction : see above | ||
+ | * tutorials : see above | ||
+ | * end : final tags, take the default | ||
+ | |||
+ | Then, build the HTML using generate_doc.py. | ||
===== Lessons of the tutorial : how to add/modify ? ===== | ===== Lessons of the tutorial : how to add/modify ? ===== | ||
Line 60: | Line 84: | ||
although selected high-level information (name, keyword, author and subtitle) | although selected high-level information (name, keyword, author and subtitle) | ||
is contained in ~abinit/ | is contained in ~abinit/ | ||
- | that gives a default value for each component of a lesson file that would not be specified in | + | that gives a default value for each component of a lesson file that would not have been specified in |
either lesson_NAME.yml or the specific section of lessons.yml .\\ | either lesson_NAME.yml or the specific section of lessons.yml .\\ | ||
Line 75: | Line 99: | ||
In order to add a new lesson, introduce a new section in lessons.yml, | In order to add a new lesson, introduce a new section in lessons.yml, | ||
~abinit/ | ~abinit/ | ||
+ | |||
+ | Then, build the HTML using generate_doc.py. | ||
===== Help files : how to add/modify ? ===== | ===== Help files : how to add/modify ? ===== | ||
Line 82: | Line 108: | ||
although selected high-level information (name, keyword, author and subtitle) | although selected high-level information (name, keyword, author and subtitle) | ||
is contained in ~abinit/ | is contained in ~abinit/ | ||
+ | |||
+ | Do not forget to build the HTML using generate_doc.py. | ||
Line 91: | Line 119: | ||
although selected high-level information (name, keyword, author and subtitle) | although selected high-level information (name, keyword, author and subtitle) | ||
is contained in ~abinit/ | is contained in ~abinit/ | ||
+ | |||
+ | Do not forget to build the HTML using generate_doc.py. | ||