Check for errors in the Validation pane

FAQs

What does it mean for an XML document to be well-formed?

It follows the basic syntax rules of XML, which are the same for all XML documents. Examples of common rules are:

• XML documents must have a root element
• XML elements must have a closing tag
• XML tags are case sensitive
• XML elements must be properly nested
• XML attribute values must be quoted

The Validation pane not only lists errors but provides actions for you to take by clicking the link text in blue. You can use these suggestions to quickly fix any errors.

How do I know if my XML document is valid?

Your documents contain elements and attributes that are used to exchange data between applications and organizations. To specify the allowable structure and content of an XML document, you can write a Document Type Definition (DTD), or a schema. When you validate your document in the editor, it checks your elements and attributes against the DTD or schema to make sure they follow the defined structure.

To help you understand an element and how to correctly use it, you have easy access to a reference guide. In the editor pane, right click the element and select About element. From here you can choose to Browse DITA Style Guide or Browse a reference manual.

Know at a glance

A quick way to see if your XML is valid is to look in the Validation pane's title bar.

• If you see a green circle with a check mark that means there are no errors.
• If you see a number , that tells you how many errors you need to correct. An example is shown below:

  

Are maps validated differently?

The same process is used to validate references in a map, but you'll see different errors.

For help with validating maps, read:

• Validate a map in Oxygen
• Fix map validation errors