Changes between Initial Version and Version 1 of FAQs/ModelGlue32XMLSchema

Timestamp:

10/22/11 16:06:46 (14 years ago)

Author:

dskaggs (IP: 38.103.85.197)

Comment:

--

FAQs/ModelGlue32XMLSchema

@@ +1 @@
+= Overview =
+Among the productivity enhancements added to !ModelGlue 3.2 is a feature designed to make working with your !ModelGlue XML config files much easier. !ModelGlue now includes an XML schema file that allows your IDE to provide node proposals as you are building your XML files and validation to ensure that your XML files are structured correctly.
+
+== Node Insight ==
+Because XML is a structured language, configuring your IDE to apply the schema to your XML configuration files will allow it to offer suggestions for nodes allowed based on where you are in your XML file. This can be especially helpful to remind you what nodes are allowed to be inserted inside the node where you are currently working. 
+
+In figure 1, the IDE is displaying the list of child nodes that are allowed inside an <event-handler> node. Selecting a suggested node from the popup reduces the amount of typing required which in turn reduces the opportunities for a misspelling in your config file that will have to be debugged later.
+
+== Validation ==
+Once you have edited your XML file, you can have your IDE validate its structure against the schema to ensure that there are no syntactic or structural errors.
+
+In figure 2, the IDE is alerting us to a syntax error in our <controller> node (note the additional set of double quotes at the end). 
+
+Figure 3 shows a validation error resulting from incorrect structure within our XML file. A <view> node is not valid inside a <broadcasts> node. When XML file is validated, the IDE draws our attention to this right away, saving time trying to run the application and then having to debug the error.
+
+= Getting Started =
+The first step to using the XML schema is to tell your XML editor that it should be used. This is done by changing the top level node of the !ModelGlue XML config file slightly. The root <modelglue> node should be changed to look like this:
+
+{{{
+<modelglue xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+    xsi:noNamespaceSchemaLocation="http://www.model-glue.com/schema/gesture/ModelGlue.xsd" >
+}}}
+
+The latest version of the schema file for !ModelGlue 3 (Gesture) is hosted on the !ModelGlue web site at the address listed in the noNamespaceSchemaLocation attribute above.
+
+Each IDE has its own configuration method for enabling XML files to be validated by the schema files. Since they are both built on top of Eclipse, !ColdFusion Builder (1 or 2) and CFEclipse can be configured the same way. 
+
+'''NOTE: The XML editor bundled with !ColdFusion Builder does not recognize XML schema files. You MUST use an alternate XML editor such as the one provided in the [http://www.eclipse.org/webtools/ Eclipse Web Tools Project] in order to take advantage of this feature'''