manual:config:items:item:key

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
manual:config:items:item:key [2018/02/02 07:48]
dimir re-format heading to enable links to sections
manual:config:items:item:key [2021/01/27 20:27] (current)
Line 1: Line 1:
-===== 1 Item key ===== +===== 1 Item key format ​=====
- +
-==== - Flexible and non-flexible parameters ==== +
- +
-A flexible parameter is a parameter which accepts an argument. For example, in vfs.fs.size[*] the asterisk symbol '​*'​ indicates a flexible parameter. +
-'​*'​ is any string that will be passed as an argument to the parameter. Correct definition examples: +
-  * vfs.fs.size[/​] +
-  * vfs.fs.size[/​opt] +
- +
-==== - Key format ​====+
  
 Item key format, including key parameters, must follow syntax rules. The following illustrations depict the supported syntax. Allowed elements and characters at each point can be determined by following the arrows - if some block can be reached through the line, it is allowed, if not - it is not allowed. Item key format, including key parameters, must follow syntax rules. The following illustrations depict the supported syntax. Allowed elements and characters at each point can be determined by following the arrows - if some block can be reached through the line, it is allowed, if not - it is not allowed.
  
-{{manual:​config:​item_key.png|}}+{{manual:​config:​item_key_2.png?600|}}
  
 To construct a valid item key, one starts with specifying the key name, then there'​s a choice to either have parameters or not - as depicted by the two lines that could be followed. To construct a valid item key, one starts with specifying the key name, then there'​s a choice to either have parameters or not - as depicted by the two lines that could be followed.
Line 44: Line 35:
 === Parameter - quoted string === === Parameter - quoted string ===
  
-If the key parameter is a quoted string, any Unicode character is allowed, and included double quotes must be backslash ​escaped.+If the key parameter is a quoted string, any Unicode character is allowed
 + 
 +If the key parameter string contains commathis parameter has to be quoted. 
 + 
 +If the key parameter string contains quotation mark, this parameter has to be quoted ​and each quotation mark which is a part of the parameter string has to be escaped ​with a backsplash (''​\''​) character.
  
 {{manual:​config:​key_param_quoted_string.png|}} {{manual:​config:​key_param_quoted_string.png|}}
Line 52: Line 47:
 === Parameter - unquoted string === === Parameter - unquoted string ===
  
-If the key parameter is an unquoted string, any Unicode character is allowed except comma and right square bracket (]).+If the key parameter is an unquoted string, any Unicode character is allowed except comma and right square bracket (]). Unquoted parameter cannot start with left square bracket ([).
  
 {{manual:​config:​key_param_unquoted_string.png|}} {{manual:​config:​key_param_unquoted_string.png|}}
Line 61: Line 56:
  
 {{manual:​config:​key_param_array.png|}} {{manual:​config:​key_param_array.png|}}
 +
 +<note important>​Multi-level parameter arrays, e.g. ''​[a,​[b,​[c,​d]],​e]'',​ are not allowed.</​note>​