Document validation panel

The document validation panel runs Schematron on your document to determine whether it is valid.

When viewing a document, click the icon in the right sidebar to open this panel. If your document has a default schema, the icon in the sidebar also indicates:

• No errors – the icon has a icon in a green circle.
• Some errors – the icon has a red badge indicating the number of errors.

The panel refreshes after every time the document is saved, so the results are “live”.

How Schematron works

Schematron is a rule-based schema language that lets you

• Make assertions about a document – for example, checking that a heading is specified.
• Report any useful information about a document – for example, counting the words.

When you validate a document, you have a list of failed assertions (errors) and successful reports. In both cases, the message is written in plain language so that it is more useful to you.

Selecting a schema

By default, the default schema for your document is used to validate your document.

You can select a different schema using the Available schemas drop-down box, then click the Validate button.

PageSeeder provides several built-in schemas to help you write quality documents:

• Best practice – to follow the recommendations applying to most generic documents.
• Old psml – to help you identify old markup in legacy PSML document, this is mostly useful for developers in legacy system.
• Orphan images – to help you identify images which aren’t used in any document, this schema is best used for batch or folder validations.
• References – to help you identify linking issues with xrefs and images such as references to/from the archives and unresolved references.

Validation results

If there are no reports or errors

You see a message in a blue box with an icon indicating there are no reports or errors.

If there are reports or errors

You see , , or icons followed by the total number of each type. To filter the types, click the icon.

A list of reports or errors follows, with a short description of each. To the right, you can click the Add note button to add an edit note to the fragment that contains the report. You can hold the pointer over the icon to highlight the fragment containing the error, or you can click the icon to go to the fragment. If there are many errors, use the scroll bar on the right.

Quickfix button

If validation rules have been written to support quick fixes, the quickfix button shows to the right of the Add note button.