2 # This is a meta scheme defining the format of uci schemes.
7 #-------------------------------------------------------------------------------
8 # Central package definition
12 #-------------------------------------------------------------------------------
14 # Section definition (schema.@package)
17 option title 'Definition of uci package'
18 option package 'schema'
24 # Section title (schema.@package.title)
27 option title 'Title of the defined package'
28 option section 'schema.package'
29 option type 'variable'
30 option datatype 'string'
33 # Section description (schema.@package.description)
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'
43 #-------------------------------------------------------------------------------
44 # Central section definition
48 #-------------------------------------------------------------------------------
50 # Section definition (schema.@section)
53 option title 'Definition of uci section'
54 option package 'schema'
60 # Section name (schema.@section.name)
63 option title 'Name of the defined section'
64 option section 'schema.section'
65 option type 'variable'
66 option datatype 'string'
69 # Section package (schema.@section.package)
72 option title 'Parent package of the defined section'
73 option section 'schema.section'
74 option type 'variable'
75 option datatype 'string'
78 # Section title (schema.@section.title)
81 option title 'Title of the defined section'
82 option section 'schema.section'
83 option type 'variable'
84 option datatype 'string'
87 # Section description (schema.@section.description)
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'
96 # Section dependencies (schema.@section.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
105 # Section required flag (schema.@section.required)
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
114 # Section unique flag (schema.@section.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
123 # Section named flag (schema.@section.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
132 # Section dynamic flag (schema.@section.dynamic)
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
142 #-------------------------------------------------------------------------------
143 # Central variable definition
147 #-------------------------------------------------------------------------------
149 # Variable definition (schema.@variable)
151 option name 'variable'
152 option title 'Definition of uci variable'
153 option package 'schema'
154 option required false
159 # Variable name (schema.@variable.name)
162 option title 'Name of the defined variable'
163 option section 'schema.variable'
164 option type 'variable'
165 option datatype 'string'
168 # Variable section (schema.@variable.section)
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'
177 # Variable title (schema.@variable.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
186 # Variable description (schema.@variable.description)
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
195 # Variable dependencies (schema.@variable.depends)
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
204 # Variable required flag (schema.@variable.required)
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
213 # Variable type (schema.@variable.type)
216 option title 'Type of this variable'
217 option section 'schema.variable'
219 option datatype 'string'
220 option required false
222 # Plain variable type (schema.@variable.type=variable)
224 option value 'variable'
225 option title 'This is a plain variable'
226 option variable 'schema.variable.type'
228 # Enum variable type (schema.@variable.type=enum)
231 option title 'This is a enum variable'
232 option variable 'schema.variable.type'
234 # List variable type (schema.@variable.type=list)
237 option title 'This is a list variable'
238 option variable 'schema.variable.type'
240 # List-or-Option variable type (schema.@variable.type=lazylist)
242 option value 'lazylist'
243 option title 'This is a list or option variable'
244 option variable 'schema.variable.type'
246 # Reference variable type (schema.@variable.type=reference)
248 option value 'reference'
249 option title 'This is a reference (valueof) variable'
250 option variable 'schema.variable.type'
252 # Variable datatype (schema.@variable.datatype)
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
261 # Variable validators (schema.@variable.validator)
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
270 # Variable value references (schema.@variable.valueof)
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
280 #-------------------------------------------------------------------------------
281 # Central enum definition
285 #-------------------------------------------------------------------------------
287 # Enum definition (schema.@enum)
290 option title 'Definition of uci enum value'
291 option package 'schema'
292 option required false
297 # Enum value (schema.@enum.value)
300 option title 'Name of the defined variable'
301 option section 'schema.enum'
302 option type 'variable'
303 option datatype 'string'
306 # Enum variable (schema.@enum.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'
315 # Enum value title (schema.@enum.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
324 # Enum value description (schema.@enum.description)
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
333 # Enum value dependencies (schema.@enum.depends)
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
342 # Enum value default flag (schema.@enum.default)
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