User Tools

Site Tools


developers:link_shortcuts

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
Last revisionBoth sides next revision
developers:link_shortcuts [2017/08/18 13:29] – [Simple allowed internal links] Xavier Gonzedevelopers: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://docs.abinit.org/developers/abimkdocs **
  
 This page concerns the YAML files in ~abinit/doc/*/origin_files, This page concerns the YAML files in ~abinit/doc/*/origin_files,
Line 76: Line 79:
   [[topic:PIMD#1|Introduction]] becomes <a href="../../topics/generated_file/topic_PIMD.html#1>Introduction</a>   [[topic:PIMD#1|Introduction]] becomes <a href="../../topics/generated_file/topic_PIMD.html#1>Introduction</a>
      
-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 namespace.+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 namespace.
  
   [[lesson_gw1]] becomes <a href="../../tutorial/generated_files/lesson_gw1.html>lesson_gw1</a>   [[lesson_gw1]] becomes <a href="../../tutorial/generated_files/lesson_gw1.html>lesson_gw1</a>
Line 107: Line 110:
 [[http://docs.mathjax.org/en/latest/mathjax.html|MathJax]] on-the-flight processor. For the ABINIT documentation, the conventions are : [[http://docs.mathjax.org/en/latest/mathjax.html|MathJax]] on-the-flight processor. For the ABINIT documentation, the conventions are :
   * \$...\$  yields an "onlinecite" translation of the LaTeX formula;   * \$...\$  yields an "onlinecite" translation of the LaTeX formula;
-  * \$\$...\$\$ yields display mode, the LaTeX formula being rendered on one dedicated line; +  * \$\$...\$\$ yields "displaymode, the LaTeX formula being rendered on one dedicated line (moreover, centered)
-  * to have your equations numbered, use the display mode above, and (inside the markers) declare your equation with the standard %%\b%%egin{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> ... </pre> HTML section, MathJax does not interpret it   * when a \$ sign is inside a <pre> ... </pre> HTML section, MathJax does not interpret it
   * to prevent a real \$ to be interpreted, use \\\$   * to prevent a real \$ to be interpreted, use \\\$