The
Validate and Check for
Completeness action allows you to validate a DITA map and configure the
options for the validation process. You can find the
Validate and Check for
Completeness action in the toolbar of the DITA Maps Manager
view or in the DITA Maps
menu. Invoking this action opens the DITA Map Completeness Check
dialog box, which allows you to configure the DITA map validation.
Validation Process
The validation process of a DITA map includes the
following:
- Verifies that the file paths of the topic references are valid. For example, if an
href attribute points to an invalid file path, it is reported as an
error in the message panel at the bottom of the editor.
- Validates each referenced topic and map. Each topic file is opened and validated against
the appropriate DITA DTD. If another DITA map is referenced in the main one, the
referenced DITA map is verified recursively, applying the same algorithm as for the main
map.
- If errors or warnings are found, they are displayed in a separate message pane at the
bottom of the editor and clicking them takes you to the location of the error or warning
in the file where it was found.
DITA Map Completeness Check Dialog Box
You can configure the validation process with the following options that are available
in the
DITA Map Completeness Check dialog box:
- Batch validate referenced DITA resources - This option decides
the level of validation that applies to referenced DITA files:
- If the check box is left unchecked (which is the default setting), the DITA files
will be validated using the rules defined in the DTD or XML Schema declared in the
document.
- If the check box is checked, the DITA files will be validated using rules defined in
their associated validation scenario.
- Check the existence of non-DITA references resources - Extends
the validation of referenced resources to non-DITA files.
- Include remote resources - Enable this option if you want to
check that remote referenced binary resources (like images, movie clips, ZIP archives)
exist at the specified location.
- Use DITAVAL filters - The content of the map is filtered by
applying a profiling condition set before validation. You can choose between
the following options:
- From the current condition set - The map is filtered using
the condition set applied currently in the DITA Maps Manager
view. Clicking the
Details icon opens a topic in the Oxygen XML Editor user guide
that explains how to create a profiling condition set.
- From all available condition sets - For each available
condition set, the map content is filtered using the condition set before
validation.
- From the associated transformation scenario - The filtering
condition set is specified explicitly as a DITAVAL file in the current transformation
scenario associated with the DITA map.
- Other DITAVAL files -For each DITAVAL file from this list,
the map content is filtered using the DITAVAL file before validation. Use the
Add or Remove buttons to configure the
list.
- Check for duplicate topic IDs within the DITA map context -
Checks for multiple topics with the same ID in the context of the entire map.
- Report links to topics not referenced in DITA maps - Checks that
all referenced topics are linked in the DITA map.
- Identify possible conflicts in profile attribute values - When
the profiling attributes of a topic contain values that are not found in parent topic
profiling attributes, the content of the topic is overshadowed when generating profiled
output. This option reports these possible conflicts.
- Report attributes and values that conflict with profiling
preferences - Looks for profiling attributes and values not defined in the
Profiling / Conditional Text preferences page (you can click the
button to open this preferences page). It also
checks if profiling attributes defined as single-value have multiple values set in
the searched topics.
- Additional schematron checks - Allows you to select a Schematron
schema that Oxygen XML Editor uses for the validation of DITA resources.