Inspectopedia Help

Element without an 'id' attribute

Highlights elements that don't have the id attribute.

All elements in the generated help instance get random unique hash IDs, unless an element has the id attribute. By default, id is mandatory for structural elements, such as chapters and procedures, for elements with titles and anchor links, such as tabs and definition list items, and for snippets that are expected to be referenced by their ID. Use this inspection's settings to define a comma-separated list of elements that should have an id.

Locating this inspection

By ID

Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.

WrsTopicContentElementWithoutIdInspection
Via Settings dialog

Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.

Settings or Preferences | Editor | Inspections | Writerside | Element id problems

Inspection options

Here you can find the description of settings available for the Element without an 'id' attribute inspection, and the reference of their default values.

Elements that should have an id

[chapter, procedure, def, tab, snippet]

Availability

By default bundled with

Writerside 2024.1

Can be installed with plugin

Writerside, 2024.04.241.15989.11

Last modified: 18 June 2024