developers:abivars.yml
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:abivars.yml [2017/08/08 08:05] – [Specifications for the abinit_vars.yml file] Xavier Gonze | developers:abivars.yml [2018/05/26 22:44] – [Specifications for the abinit_vars.yml file] Xavier Gonze | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Specifications for the abinit_vars.yml file ====== | + | ====== Specifications for the abinit_vars.yml file (Obsolete) |
+ | |||
+ | ** THE INFORMATION ABOUT THE MANAGEMENT OF THE DOCUMENTATION HAS BEEN TRANSFERRED TO THE MAIN ABINIT SITE, AT | ||
+ | https:// | ||
As values in the ~abinit/ | As values in the ~abinit/ | ||
Line 5: | Line 8: | ||
* [[http:// | * [[http:// | ||
* [[http:// | * [[http:// | ||
+ | |||
+ | ===== Strings ===== | ||
+ | |||
+ | Pay attention to strings, as YAML is used. If a chain of character is recognized directly to be a string by YAML, you don't need ticks (' '). | ||
+ | Otherwise, you need to put ticks. | ||
+ | |||
+ | For example, if you want to use a link as a value, use a link shortcut like < | ||
+ | |||
+ | ===== Types ===== | ||
Several " | Several " | ||
Line 22: | Line 34: | ||
* requires : the input variable is relevant only if this condition is fulfilled | * requires : the input variable is relevant only if this condition is fulfilled | ||
* text : free text describing the input variable | * text : free text describing the input variable | ||
- | * topics : a string, specified in [[developers: | + | * topics : a string, specified in [[developers: |
* varset : a unique "set of variables" | * varset : a unique "set of variables" | ||
* vartype : to be chosen among integer, real or string | * vartype : to be chosen among integer, real or string | ||
Line 92: | Line 104: | ||
If a varname has as " | If a varname has as " | ||
- | ===== Strings ===== | ||
- | |||
- | Pay attention to strings. If it is recognized as string directly, you don't need ticks (' '). | ||
- | Otherwise, you need to put ticks. | ||
- | For example, if you want to use a link as a value, use a link shortcut like < | ||