Inspectopedia Help

Link to topic not in current instance

Detects links pointing to an existing topic that is not in the current help instance tree.

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.

WrsLinkToTopicOutsideProduct
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 | Content validity

It ignores such links if the current topic itself is not in the current help instance tree.

You have several options to deal with this issue:

  • Mark the link with nullable="true", which will render it as plain text if the target is not available

  • Exclude the containing element (such as the paragraph with the problematic link) from the current help instance

  • Include the target topic into the current help instance

Availability

By default bundled with

Writerside 2024.1

Can be installed with plugin

Writerside, 2024.04.241.15989.11

Last modified: 18 June 2024