Inspectopedia Help

Redundant TOC title

Detects TOC titles that match the topic title.

By default, Writerside renders the topic title in the TOC. If the topic title is too long for the TOC, you can assign a shorter TOC title for it by specifying the toc-title attribute in <toc-element>. The TOC title is used only for the corresponding TOC entry and does not change the topic title.

If the TOC title matches the topic title, this inspection highlights the redundant toc-title attribute and suggests removing it.

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.

WrsTocElementsTocTitleRedundant
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 | Table of contents

Availability

By default bundled with

Writerside 2024.1

Can be installed with plugin

Writerside, 2024.04.241.15989.11

Last modified: 18 June 2024