Documentation Center

Overview of S1000D Validate in the XML editor

This topic describes how Validate works when used in the XML editor. One important difference between Validate in Contenta and Validate in the editor is that Validate in the editor also validates internal references.

From the editor, you can run the Validate tool to check the following items:
Data module
  • If the target of an external reference exists in the Contenta database
  • If the data module that is being edited is BREX compliant
  • If the internal references in a data module are valid
Publication module or SCORM content package
  • If the target of an external reference exists in the Contenta database
Consider the following points:
  • The validation results reflect changes that the user has made in the document since checking it out from Contenta.
  • Links that are invalid when applicability is applied are not detected.
  • Xlink attributes in link tags are not processed. Xlinks are processed by the publishing engine but are treated as additional information by Contenta during editing. Other tags/attributes that are part of links are still required when creating links.
  • The XML markup for hotspots are validated as part of internal reference checking. However, the presence of the hotspots in the actual graphic are not validated.
  • applicRefId (refapplic) attributes in internal references are validated.

External references

Contenta S1000DValidate lists a status for the following types of references:
  • References to other modules (Modules referenced by the module)
  • References from other modules (Modules that reference the module)
Contenta checks for the existence of the modules in the common source database (CSDB). One of the following statuses is reported for each object:
OK
The object exists in the CSDB.
OK/Not Accessible
The object exists in the CSDB, but the user does not have permission to view it. This status only applies to references from the validated object, not references to it.
Missing
The object does not exist in the Contenta database.
No References/Not Referred
The validated object does not refer to anything or has no references to it.
Blank
The object was not selected to be validated.

Internal references

Contenta S1000D Validate displays a list of targets and references with ID, element name/type, number of references to the target ID, and the status, as follows:
OK
The source/target tag id and idtype matches the xref id and xidtype and/or when the source tag with id exists.
Missing
The XRef tag with id exists but source/target tag does not.
MisMatch
The source/target idtype does not match with the corresponding XRef idtype.
Duplicate
The source/target exists more than one time.
No ID
The existing Xref is missing the attribute id.
Unknown Type
The existing Xref is missing the attribute 'idtype'.

To locate and select the corresponding reference inside the open document (Goto reference functionality) double-click the table row that contains the reference.

BREX compliance

Contenta S1000D Validate displays the Name, Status, and Detailed Results for the DM that was validated for BREX compliance. The Status may be:
OK
The DM is in compliance with its BREX rules.
Not compliant with N rules. See details below.
In this case, the Detailed Results lists the BREX rules with which the DM does not comply.
Not validated - reason
The reasons why the DM could not be validated are explained in Understanding BREX compliance reports and error messages.

To run S1000D Validate from the editor, see Validating References and BREX in the XML editor.

To run S1000D Validate from Contenta, see Validating references and BREX from Contenta Explorer or Contenta Web.

For an overview of S1000D Validate in Contenta, see Overview of S1000D Validate.

For an overview of BREX validation, see BREX Validation Overview.