summaryrefslogtreecommitdiffstats
path: root/Schemas
diff options
context:
space:
mode:
authorDavid Wagner <david.wagner@intel.com>2014-03-06 14:58:29 +0100
committerDavid Wagner <david.wagner@intel.com>2014-09-10 12:04:36 +0200
commitf811b7b53c0c2f0d4320c70230e609619c5087c1 (patch)
treee96266eb13098f5a82aef2d3079b626653706dd2 /Schemas
parente8088d0f60d895a733c00953c0fdd4e9daf0b279 (diff)
downloadexternal_parameter-framework-f811b7b53c0c2f0d4320c70230e609619c5087c1.zip
external_parameter-framework-f811b7b53c0c2f0d4320c70230e609619c5087c1.tar.gz
external_parameter-framework-f811b7b53c0c2f0d4320c70230e609619c5087c1.tar.bz2
More README files
- More details in the root README.md file; add a nice diagram - Add a lot of README files in subdirectories Signed-off-by: David Wagner <david.wagner@intel.com>
Diffstat (limited to 'Schemas')
-rw-r--r--Schemas/README.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/Schemas/README.md b/Schemas/README.md
new file mode 100644
index 0000000..3563b4b
--- /dev/null
+++ b/Schemas/README.md
@@ -0,0 +1,48 @@
+# parameter-framework configuration file XML Schemas
+
+These are W3C Schemas for the various configuration files.
+
+`xmllint` may be used to check for correctness, e.g:
+
+ xmllint --xinclude --noout --schema ParameterFrameworkConfiguration.xsd /path/to/your/ParameterFrameworkConfiguration.xml
+
+See `tools/xmlValidator` for a custom alternative tool.
+
+Only `ParameterFrameworkConfiguration.xsd`, `SystemClass.xsd`, `Subsystem.xsd` and
+`ConfigurableDomains.xsd` are relevant for use with xmllint: the others are
+included by these 4 XSDs.
+
+You may refer to samples at
+<https://github.com/01org/parameter-framework-samples>.
+
+## ParameterFrameworkConfiguration.xsd
+
+Schema for the top-level configuration. It contains:
+
+- A reference to the `SystemClass` (aka StructureDescription) XML file (see
+ below);
+- The list of plugins to be used;
+- Optionally, a reference to the `Settings`.
+
+Attributes of `ParameterFrameworkConfiguration` are:
+
+- The `SystemClass` name (for consistency check)
+- The `TuningMode` (whether the parameter-framework listens for commands)
+- The `ServerPort` on which the parameter-framework listens if
+ `TuningMode=true`.
+
+## SystemClass.xsd
+
+Schema for the SystemClass associated with the top-level configuration. It
+points to all the "Subsystem" files (see below).
+
+## Subsystem.xsd
+
+Schema for all Subsystem files (aka Structure files). These files describe the
+content and structure of the system to be managed by the parameter-framework
+and also indicate which plugin is to be used.
+
+## ConfigurableDomains.xsd
+
+Schema for the ConfigurableDomains (aka Settings files). These files contain
+the rules for applying values to parameters.