developers:link_shortcuts
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
developers:link_shortcuts [2017/08/18 13:21] – [MathJax] Xavier Gonze | developers:link_shortcuts [2018/05/26 22:44] – [Shortcuts for Web links] Xavier Gonze | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Shortcuts for Web links ====== | + | ====== Shortcuts for Web links (Obsolete) |
+ | |||
+ | ** THE INFORMATION ABOUT THE MANAGEMENT OF THE DOCUMENTATION HAS BEEN TRANSFERRED TO THE MAIN ABINIT SITE, AT | ||
+ | https:// | ||
This page concerns the YAML files in ~abinit/ | This page concerns the YAML files in ~abinit/ | ||
Line 40: | Line 43: | ||
* the name of a bibliographical reference (provided it is mentioned in abiref.bib); | * the name of a bibliographical reference (provided it is mentioned in abiref.bib); | ||
* the path to a file in a ~abinit/ | * the path to a file in a ~abinit/ | ||
- | * the path to a reference output file in a ~abinit/ | + | * the path to a reference output file in a ~abinit/ |
+ | * the label of a section inside the own file. | ||
Examples : | Examples : | ||
Line 53: | Line 57: | ||
| | ||
[[tests/ | [[tests/ | ||
+ | | ||
+ | and also | ||
+ | | ||
+ | [[# | ||
| | ||
The script generate_doc.py does a bit of formatting in these examples: it keeps one pair of square brackets in the case of a bibliographic reference, and add " | The script generate_doc.py does a bit of formatting in these examples: it keeps one pair of square brackets in the case of a bibliographic reference, and add " | ||
Line 71: | Line 79: | ||
[[topic: | [[topic: | ||
| | ||
- | Actually, using the real name of the file without suffix, e.g. lesson_gw1 will also be recognized, although this real name is echoed, instead of the name withouth | + | Actually, using the real name of the file without suffix, e.g. lesson_gw1 will also be recognized, although this real name is echoed, instead of the name without |
[[lesson_gw1]] becomes <a href=" | [[lesson_gw1]] becomes <a href=" | ||
Line 102: | Line 110: | ||
[[http:// | [[http:// | ||
* \$...\$ | * \$...\$ | ||
- | * \$\$...\$\$ yields display mode, the LaTeX formula being rendered on one dedicated line; | + | * \$\$...\$\$ yields |
- | * to have your equations numbered, use the display mode above and (inside the markers) declare your equation with the standard %%\begin%%{equation} and %%\end%%{equation} | + | * to have the equations numbered, use the display mode above, and (inside the markers) declare your equation with the standard %%\b%%egin{equation} and %%\ %%end{equation} |
* when a \$ sign is inside a <pre> ... </ | * when a \$ sign is inside a <pre> ... </ | ||
* to prevent a real \$ to be interpreted, | * to prevent a real \$ to be interpreted, |