libs/uvl/root/lib/uci/schema/meta/schema

   1 # UVL - Reference-Spec
   2 # This is a meta scheme defining the format of uci schemes.
   3 # $Id$
   4
   5 package schema
   6
   7 #-------------------------------------------------------------------------------
   8 # Central package definition
   9 #
  10 #       config package
  11 #               option ...
  12 #-------------------------------------------------------------------------------
  13
  14 # Section definition (schema.@package)
  15 config section
  16         option name             'package'
  17         option title    'Definition of uci package'
  18         option package  'schema'
  19         option required false
  20         option named    false
  21         option unique   true
  22         option dynamic  false
  23
  24 # Section title (schema.@package.title)
  25 config variable
  26         option name             'title'
  27         option title    'Title of the defined package'
  28         option section  'schema.package'
  29         option type             'variable'
  30         option datatype 'string'
  31         option required false
  32
  33 # Section description (schema.@package.description)
  34 config variable
  35         option name             'description'
  36         option title    'Description of the defined package'
  37         option section  'schema.package'
  38         option type             'lazylist'
  39         option datatype 'string'
  40         option required false
  41
  42
  43 #-------------------------------------------------------------------------------
  44 # Central section definition
  45 #
  46 #       config section
  47 #               option ...
  48 #-------------------------------------------------------------------------------
  49
  50 # Section definition (schema.@section)
  51 config section
  52         option name             'section'
  53         option title    'Definition of uci section'
  54         option package  'schema'
  55         option required false
  56         option named    false
  57         option unique   false
  58         option dynamic  false
  59
  60 # Section name (schema.@section.name)
  61 config variable
  62         option name             'name'
  63         option title    'Name of the defined section'
  64         option section  'schema.section'
  65         option type             'variable'
  66         option datatype 'string'
  67         option required true
  68
  69 # Section package (schema.@section.package)
  70 config variable
  71         option name             'package'
  72         option title    'Parent package of the defined section'
  73         option section  'schema.section'
  74         option type             'variable'
  75         option datatype 'string'
  76         option required true
  77
  78 # Section title (schema.@section.title)
  79 config variable
  80         option name             'title'
  81         option title    'Title of the defined section'
  82         option section  'schema.section'
  83         option type             'variable'
  84         option datatype 'string'
  85         option required false
  86
  87 # Section description (schema.@section.description)
  88 config variable
  89         option name             'description'
  90         option title    'Description of the defined section'
  91         option section  'schema.section'
  92         option type             'lazylist'
  93         option datatype 'string'
  94         option required false
  95
  96 # Section dependencies (schema.@section.depends)
  97 config variable
  98         option name             'depends'
  99         option title    'List of dependencies within and between defined sections'
 100         option section  'schema.section'
 101         option type             'lazylist'
 102         option datatype 'string'
 103         option required false
 104
 105 # Section required flag (schema.@section.required)
 106 config variable
 107         option name             'required'
 108         option title    'Specify whether at least one instance of this section type must be defined in config'
 109         option section  'schema.section'
 110         option type             'variable'
 111         option datatype 'boolean'
 112         option required false
 113
 114 # Section unique flag (schema.@section.unique)
 115 config variable
 116         option name             'unique'
 117         option title    'Specify whether only one instance of this section type is allowed in config'
 118         option section  'schema.section'
 119         option type             'variable'
 120         option datatype 'boolean'
 121         option required false
 122
 123 # Section named flag (schema.@section.named)
 124 config variable
 125         option name             'named'
 126         option title    'Specify whether sections of this type must have a name set (are not anonymous)'
 127         option section  'schema.section'
 128         option type             'variable'
 129         option datatype 'boolean'
 130         option required false
 131
 132 # Section dynamic flag (schema.@section.dynamic)
 133 config variable
 134         option name             'dynamic'
 135         option title    'Specify whether sections of this type may contain arbitary, not specified options'
 136         option section  'schema.section'
 137         option type             'variable'
 138         option datatype 'boolean'
 139         option required false
 140
 141
 142 #-------------------------------------------------------------------------------
 143 # Central variable definition
 144 #
 145 #       config variable
 146 #               option ...
 147 #-------------------------------------------------------------------------------
 148
 149 # Variable definition (schema.@variable)
 150 config section
 151         option name             'variable'
 152         option title    'Definition of uci variable'
 153         option package  'schema'
 154         option required false
 155         option named    false
 156         option unique   false
 157         option dynamic  false
 158
 159 # Variable name (schema.@variable.name)
 160 config variable
 161         option name             'name'
 162         option title    'Name of the defined variable'
 163         option section  'schema.variable'
 164         option type             'variable'
 165         option datatype 'string'
 166         option required true
 167
 168 # Variable section (schema.@variable.section)
 169 config variable
 170         option name             'section'
 171         option title    'Parent section of the defined variable'
 172         option section  'schema.variable'
 173         option type             'variable'
 174         option datatype 'string'
 175         option required true
 176
 177 # Variable title (schema.@variable.title)
 178 config variable
 179         option name             'title'
 180         option title    'Title of the defined variable'
 181         option section  'schema.variable'
 182         option type             'variable'
 183         option datatype 'string'
 184         option required false
 185
 186 # Variable description (schema.@variable.description)
 187 config variable
 188         option name             'description'
 189         option title    'Description of the defined variable'
 190         option section  'schema.variable'
 191         option type             'lazylist'
 192         option datatype 'string'
 193         option required false
 194
 195 # Variable dependencies (schema.@variable.depends)
 196 config variable
 197         option name             'depends'
 198         option title    'List of dependencies between defined variables'
 199         option section  'schema.variable'
 200         option type             'lazylist'
 201         option datatype 'string'
 202         option required false
 203
 204 # Variable required flag (schema.@variable.required)
 205 config variable
 206         option name             'required'
 207         option title    'Specify whether this variable must be set in config'
 208         option section  'schema.variable'
 209         option type             'variable'
 210         option datatype 'boolean'
 211         option required false
 212
 213 # Variable type (schema.@variable.type)
 214 config variable
 215         option name             'type'
 216         option title    'Type of this variable'
 217         option section  'schema.variable'
 218         option type             'enum'
 219         option datatype 'string'
 220         option required false
 221
 222 # Plain variable type (schema.@variable.type=variable)
 223 config enum
 224         option value    'variable'
 225         option title    'This is a plain variable'
 226         option variable 'schema.variable.type'
 227
 228 # Enum variable type (schema.@variable.type=enum)
 229 config enum
 230         option value    'enum'
 231         option title    'This is a enum variable'
 232         option variable 'schema.variable.type'
 233
 234 # List variable type (schema.@variable.type=list)
 235 config enum
 236         option value    'list'
 237         option title    'This is a list variable'
 238         option variable 'schema.variable.type'
 239
 240 # List-or-Option variable type (schema.@variable.type=lazylist)
 241 config enum
 242         option value    'lazylist'
 243         option title    'This is a list or option variable'
 244         option variable 'schema.variable.type'
 245
 246 # Reference variable type (schema.@variable.type=reference)
 247 config enum
 248         option value    'reference'
 249         option title    'This is a reference (valueof) variable'
 250         option variable 'schema.variable.type'
 251
 252 # Variable datatype (schema.@variable.datatype)
 253 config variable
 254         option name             'datatype'
 255         option title    'Datatype of this variable'
 256         option section  'schema.variable'
 257         option type             'variable'
 258         option datatype 'string'
 259         option required false
 260
 261 # Variable validators (schema.@variable.validator)
 262 config variable
 263         option name             'validator'
 264         option title    'Datatype of this variable'
 265         option section  'schema.variable'
 266         option type             'lazylist'
 267         option datatype 'string'
 268         option required false
 269
 270 # Variable value references (schema.@variable.valueof)
 271 config variable
 272         option name             'valueof'
 273         option title    'Reference to section or option to read values from'
 274         option section  'schema.variable'
 275         option type             'lazylist'
 276         option datatype 'string'
 277         option required false
 278
 279
 280 #-------------------------------------------------------------------------------
 281 # Central enum definition
 282 #
 283 #       config enum
 284 #               option ...
 285 #-------------------------------------------------------------------------------
 286
 287 # Enum definition (schema.@enum)
 288 config section
 289         option name             'enum'
 290         option title    'Definition of uci enum value'
 291         option package  'schema'
 292         option required false
 293         option named    false
 294         option unique   false
 295         option dynamic  false
 296
 297 # Enum value (schema.@enum.value)
 298 config variable
 299         option name             'name'
 300         option title    'Name of the defined variable'
 301         option section  'schema.enum'
 302         option type             'variable'
 303         option datatype 'string'
 304         option required true
 305
 306 # Enum variable (schema.@enum.variable)
 307 config variable
 308         option name             'variable'
 309         option title    'Parent variable of the defined enum value'
 310         option section  'schema.enum'
 311         option type             'variable'
 312         option datatype 'string'
 313         option required true
 314
 315 # Enum value title (schema.@enum.title)
 316 config variable
 317         option name             'title'
 318         option title    'Title of the defined enum value'
 319         option section  'schema.enum'
 320         option type             'variable'
 321         option datatype 'string'
 322         option required false
 323
 324 # Enum value description (schema.@enum.description)
 325 config variable
 326         option name             'description'
 327         option title    'Description of the defined enum value'
 328         option section  'schema.enum'
 329         option type             'lazylist'
 330         option datatype 'string'
 331         option required false
 332
 333 # Enum value dependencies (schema.@enum.depends)
 334 config variable
 335         option name             'depends'
 336         option title    'List of dependencies on defined variables'
 337         option section  'schema.enum'
 338         option type             'lazylist'
 339         option datatype 'string'
 340         option required false
 341
 342 # Enum value default flag (schema.@enum.default)
 343 config variable
 344         option name             'default'
 345         option title    'Specify whether this value is the default value of the parent enum'
 346         option section  'schema.enum'
 347         option type             'variable'
 348         option datatype 'boolean'
 349         option required false