Content validity
- Anchor is overridden
Detects overridden anchors in XML <a href> links.
- Combinable elements
Detects elements that can be combined.
- Element filter shadowed by ancestors
Detects content filters that are shadowed by filters of parent elements.
- Empty code block
Detects empty code blocks and empty source code files.
- File glossary.xml not found
Suggests creating glossary.xml when tooltip used, but glossary.xml not listed.
- Format element checker
Checks the <format> element style and color validity.
- GIF can be replaced with video
Checks if there is an MP4 video to replace an animation with.
- Include uses 'filter' instead of 'use-filter'
Detects includes with the filter attribute instead of use-filter.
- Incorrect label ID
Detects incorrect references to <primary-label> and <secondary-label> identifiers.
- Invalid filter value
Reports problematic filter declarations that may result in unexpected behavior: Explicit empty values in filter attributes Redundant or misplaced negation ! operators.
- Large image without a thumbnail
Detects large images without a thumbnail and suggests making them expandable.
- Link to topic not in current instance
Detects links pointing to an existing topic that is not in the current help instance tree.
- Missing 'openapi-path' attribute
Detects missing openapi-path attribute either in the <api-endpoint> element directly or in the parent <api-doc> element.
- Missing alt attribute inspection
Detects <img> elements without the alt attribute.
- Missing title
Checks for missing title attribute in chapter, def, and tab elements.
- Non-empty code block uses source file
Detects non-empty code blocks that also define a valid source file via the src attribute.
- Non-latin characters in attribute values
Detects non-Latin characters in attribute values.
- Redundant link text
Detects links to topics where the topic title matches the link text.
- Title tag is ignored
Detects <title> tags that do not affect the topic title.
- Top-level header is implicitly converted to a chapter
Detects top-level headers in Writerside Markdown topics that will be converted to chapter headers in the generated documentation.
- Unexpected media file type
Detects media references that do not match their expected media types, for example, image references in <video> tags and videos in image elements.
- Unreachable external image
Detects unreachable URLs to external images.
- Unreachable external link
Detects unreachable external links.
- Unreachable external video
Detects unreachable URLs to external videos.
- Unresolved reference
Detects unresolved references to images, topics, resources, and other referencable objects.
- Unsupported language in code block
Detects unsupported languages in code blocks.
- Video has no preview image
Detects videos without a preview image.
- Wide code block
Detects code blocks with long lines.
- XML-like tags in code block
Detects XML-like tags inside <code-block>.