Checking XML Well-Formedness

A Well-formed XML document is a document that conforms to the XML syntax rules. A Namespace Well-Formed XML document is a document that is Well-formed XML and is also Namespace-wellformed and Namespace-valid.

Well-Formedness Rules

The XML Syntax rules for Well-formed XML include:

The Namespace-wellformed rules include:

The Namespace-valid rules include:

Check for Well-Formedness

To check if a document is Namespace Well-Formed XML and Namespace-valid:
  • Select the Check Well-Formedness (Alt + Shift + V, W (Command + Option + V, W on macOS)) action from the Validation drop-down menu on the toolbar (or the XML menu).
  • A selection of files can be checked for well-formedness by selecting the Check Well-Formedness action from the Validate submenu when invoking the contextual menu in the Project Explorer view.

Result: If any errors are found, the result is displayed in the message panel at the bottom of the editor. Each error is displayed as one record in the result list and is accompanied by an error message. Clicking the record will open the document containing the error and highlight its approximate location.

Example: A non Well-formed XML Document
<root><tag></root>
When the Check Well-Formedness action is performed, the following error is displayed:
The element type "tag" must be terminated by the matching end-tag "</tag>"

To resolve the error, click the record in the resulting list and it will locate and highlight the approximate position of the error. In this case, identify the tag that is missing an end tag and insert </tag>.

Example: A non Namespace-wellformed Document
<prefix:elem></prefix:elem>
When the Check Well-Formedness action is performed, the following error is displayed:
The prefix "prefix" for element "prefix:elem" is not bound.
Example: A non Namespace-valid Document
<x:y></x:y>
When the Check Well-Formedness action is performed, the following error is displayed:
The prefix "x" for element "x:y" is not bound.