Simple style rules
- Styling is not allowed in titles
- Semicolon is not allowed at the end of a list item
- Text in the link and the value of the @href are the same
- No empty titles
- Titles should not exceed a certain number of characters
- Text is not allowed directly in the section
- The figure element should always be wrapped in a paragraph
- The definition list element should be wrapped in a paragraph to make the output
look better
- Report possible cases where a codeblock contains XML that was not marked
appropriately
Editing consistency rules
- Topic ID must be equal to file name
- All sections should have an @id
- Consecutive lists are not allowed
- IDs must follow a pattern
- The list should have an ID attribute
- Consecutive notes of a same type are not allowed
- For sections with examples in the title, use a specialized element
- We should avoid using 'oXygen' inside index term elements
- Remove "(Optional)" text from step elements and add the attribute
@importance=”optional” instead.
Structure rules
- Check the number of cells on each row
- Check is there are too many nested lists
- List contains only one item
- Tables with more entries than number of columns
- No image referenced in the fig element
- XML Schema used instead of DTD
- The figure should have a title
- Menucascade element should have more than one uicontrol element
Output related rules
- Lines in codeblocks should not exceed 80 characters.
- Title contains quotes. This breaks the Java Help System.
- The indexterm element should be in a prolog
- The figure element should always be in a paragraph
- The definition list element should be wrapped in a paragraph to make the output
look better
- Text is not allowed directly in the section