summaryrefslogtreecommitdiff
path: root/examples/cxx/tree/wildcard/README
diff options
context:
space:
mode:
Diffstat (limited to 'examples/cxx/tree/wildcard/README')
-rw-r--r--examples/cxx/tree/wildcard/README34
1 files changed, 34 insertions, 0 deletions
diff --git a/examples/cxx/tree/wildcard/README b/examples/cxx/tree/wildcard/README
new file mode 100644
index 0000000..d451509
--- /dev/null
+++ b/examples/cxx/tree/wildcard/README
@@ -0,0 +1,34 @@
+This example shows how to use the optional wildcard mapping provided
+by C++/Tree to parse, access, modify, and serialize the XML data
+matched by XML Schema wildcards (any and anyAttribute). For an
+alternative approach that employes type customization see the
+custom/wildcard example.
+
+The example consists of the following files:
+
+email.xsd
+ XML Schema which describes a simple email format with the
+ extensible envelope type.
+
+email.xml
+ Sample email message.
+
+email.hxx
+email.ixx
+email.cxx
+ C++ types that represent the given vocabulary, a set of parsing
+ functions that convert XML instance documents to a tree-like in-memory
+ object model, and a set of serialization functions that convert the
+ object model back to XML. These are generated by XSD from email.xsd.
+ Note that the --generate-wildcard option is used to request the
+ wildcard mapping.
+
+driver.cxx
+ Driver for the example. It first calls one of the parsing functions
+ that constructs the object model from the input file. It then prints
+ the content of the object model to STDERR. Next the driver creates a
+ reply email which is then serialized to XML.
+
+To run the example on the sample XML instance document simply execute:
+
+$ ./driver email.xml