Template:Py4vasp: Difference between revisions

Latest revision as of 10:02, 10 June 2024

Purpose

Create consistent links to the documentation of py4vasp.

{{py4vasp|<<text>>|<<url>>}}

where text will be used as link text (default: py4vasp) and url allows to select a page relative to the root directory. Arguments can be used with keyword or positional; where keyword arguments take precedent over positional ones.

Examples

{{py4vasp}} → py4vasp
{{py4vasp|''alternative text''}} → alternative text
{{py4vasp|text=''alternative text''}} → alternative text
{{py4vasp|positional argument|text=keyword argument}} → keyword argument has precedence
{{py4vasp|install py4vasp|#installation}} → install py4vasp
{{py4vasp|url=calculation}} → py4vasp

@@ Line 1: / Line 1: @@
-[https://vasp.at/py4vasp/latest/{{{2|index.html}}} {{{1|py4vasp}}}]
+<includeonly>[https://vasp.at/py4vasp/latest/{{{url|{{{2|index.html}}}}}} {{{text|{{{1|py4vasp}}}}}}]</includeonly><noinclude>
-<noinclude>
+== Purpose ==
-Hello, World!
+Create consistent links to the documentation of py4vasp.
+ <nowiki>{{py4vasp|<<text>>|<<url>>}}</nowiki>
+where ''text'' will be used as link text (default: py4vasp) and ''url'' allows to select a page relative to the root directory.
+Arguments can be used with keyword or positional; where keyword arguments take precedent over positional ones.
+== Examples ==
+* <nowiki>{{py4vasp}}</nowiki> → {{py4vasp}}
+* <nowiki>{{py4vasp|''alternative text''}}</nowiki> → {{py4vasp|''alternative text''}}
+* <nowiki>{{py4vasp|text=''alternative text''}}</nowiki> → {{py4vasp|text=''alternative text''}}
+* <nowiki>{{py4vasp|positional argument|text=keyword argument}}</nowiki> → {{py4vasp|positional argument|text=keyword argument}} has precedence
+* <nowiki>{{py4vasp|install py4vasp|#installation}}</nowiki> → {{py4vasp|install py4vasp|#installation}}
+* <nowiki>{{py4vasp|url=calculation}}</nowiki> → {{py4vasp|url=calculation}}
 </noinclude>