<html><head><link rel="canonical" href="https://www.jetbrains.com/help/writerside/inspectopedia.html.md/" data-react-helmet="true"/></head><body># Inspections

&gt; **TL;DR**
&gt; Press `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS)) to open the IDE settings and go to `Editor | Inspections`

Inspections detect and highlight various problems in the file currently open in the editor, such as invalid markup, missing elements, duplicate IDs, and non-existent references. Inspections are a feature of the IntelliJ platform, so you can read about them in [IntelliJ IDEA Help: Inspections](https://www.jetbrains.com/help/idea/code-inspection.html).

Most inspections are enabled by default, and Writerside continuously scans the files in your project and shows the number of problems detected in the current file in the top-right corner of the editor:

![Problems widget](https://resources.jetbrains.com/help/img/writerside/problems-widget.png)

You can click this widget or press `Alt+6` (Windows), `⌘ 6` (macOS), `⌘ 6` (IntelliJ IDEA Classic (macOS)), `⌘ 6` (macOS System Shortcuts), `Alt+6` (XWin), `Alt+6` (GNOME), `Alt+6` (KDE), `Alt+6` (Emacs), `Alt+6` (Sublime Text), `⌘ 6` (Sublime Text (macOS)), `Alt+6` (NetBeans), `Alt+6` (Visual Studio), `⌘ 6` (Visual Studio (macOS)), `Alt+6` (Eclipse), `⌘ 6` (Eclipse (macOS)) to open the Problems tool window that lists all problems in the current file.

![Problems tool window](https://resources.jetbrains.com/help/img/writerside/problems_tool_window.png)

Inspections have different severity levels ranging from errors that are critical and will most likely break something, through warnings that should be addressed to avoid potential problems, to typos and considerations for improvement. For more information about severity levels, see [IntelliJ IDEA Help:
Change inspection severity](https://www.jetbrains.com/help/idea/configuring-inspection-severities.html).

When you see an inspection highlighting something in a file, hover over it to see the popup with the inspection name. Put the cursor at the highlighted element and press `Alt+Enter` (Windows), `⌥ ⏎` (macOS), `⌥ ⏎` (IntelliJ IDEA Classic (macOS)), `⌥ ⏎` (macOS System Shortcuts), `Alt+Enter` (XWin), `Alt+Enter` (GNOME), `Alt+Enter` (KDE), `Alt+Enter` (Emacs), `Alt+Enter` (Sublime Text), `⌥ ⏎` (Sublime Text (macOS)), `Alt+Enter` (NetBeans), `Alt+Enter` (Visual Studio), `⌥ ⏎` (Visual Studio (macOS)), `Ctrl+1` (Eclipse), `⌘ 1` (Eclipse (macOS)) to see the available context actions, including automatic quick-fixes.

![Show Context Actions](https://resources.jetbrains.com/help/img/writerside/show_context_actions.png)

Procedure: Run inspections on all project files

If you want to find and fix all issues in your project, you don't need to open every topic file manually. Instead, run Writerside inspections on the whole project and get a full report.

1. From the main menu, select `Code | Inspect Code`.

2. In the Specify Inspection Scope dialog, select Whole Project.

&gt; **Tip:**
&gt; You can also select a custom scope that includes only topics in the current help instance.

3. If necessary, change the inspection profile, that is, the set of inspections to use. There are many inspections in the default profile that are not relevant for you, so you can disable all inspections except the ones specific to Writerside.

4. Click Analyze and wait for the analysis to finish. Depending on the size of your project, it may take a while. You will see the results in the Problems tool window.

Writerside includes the following inspections that are specific to topic files, tree files, and various configuration files in a Writerside project.

##  Configuration 

Duplicate category sort order
: Detects non-unique sort order values of `<seealso>` categories in `c.list`.
:
:
:
:
:
: The `c.list` file defines categories for the `<seealso>` block at the end of topics. Use the `order` attribute to set the order in which Writerside renders the categories. Make sure that order values are unique within the `c.list` file to avoid conflicts.
:
:
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

##  Content validity 

Anchor is overridden
: Detects overridden anchors in XML `<a href>` links.
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Card tag with more than one media
: Checks if 'card' tag has more than one media.
:
:
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Combinable elements
: Detects elements that can be combined.
:
: Such elements as `<var>`, `<title>`, `&lt;web-file-name&gt;`, `&lt;show-structure&gt;`, `&lt;help-id&gt;`, `&lt;card-summary&gt;`, `&lt;link-summary&gt;`, and `&lt;web-summary&gt;` are generally one per topic or chapter. If you define them multiple times with overlapping scopes, they can usually be combined for clarity.
:
:
:
:
:
: For example:
:
:
:
:
:
:
: ```
: &lt;title instance="foo"&gt;Custom title</title>
: <title instance="bar">Custom title</title>
: ```
:
:
:
:
:
: Can be combined as:
:
:
:
:
:
:
: ```
: <title instance="foo,bar">Custom title</title>
: ```
:
:
:
:
:
: Enabled by default with severity ![Weak warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWeakWarningIcon.svg)  Weak warning  .

Element filter shadowed by ancestors
: Detects content filters that are shadowed by filters of parent elements.
:
:
:
: Example:
:
:
:
:
:
:
: ```
: <p instance="foo">Click <control instance="bar">OK</control>.</p>
: ```
:
:
:
:
:
: In this example, `bar` is shadowed by `foo`, meaning that it will never be included in any instance. Make sure that all parent elements include filters that you expect for the child elements. So in this case, you should add `bar` to the parent paragraph.
:
:
:
:
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Empty code block
: Detects empty code blocks and empty source code files.
:
:
:
: It detects literally empty `<code-block>` elements only if there is no source file specified in the `src` attribute. Otherwise, it checks the contents of the source file.
:
:
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

File glossary.xml not found
: Suggests creating `glossary.xml` when `tooltip` used, but `glossary.xml` not listed.
:
:
:
: Enabled by default with severity ![Weak warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWeakWarningIcon.svg)  Weak warning  .

Format element checker
: Checks the `<format>` element style and color validity. A valid `<format>` element must specify `color`, `style`, or both attributes, and they must contain valid values.
:
:
:
:
:
: `style` can be a valid combination of the following: `bold`, `italic`, `strikethrough`, `underline`, `superscript`, `subscript`.
:
:
:
:
:
: `color` can be a hexadecimal RGB code or a valid color name, such as `#ff0000` or `Red`.
:
:
:
:
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

GIF can be replaced with video
: Checks if there is an MP4 video to replace an animation with.
:
:
:
:
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Include uses 'filter' instead of 'use-filter'
: Detects includes with the `filter` attribute instead of `use-filter`.
:
:
:
: Usually, `filter` is used on elements inside snippets, and when you include the snippet, you specify `use-filter`.
:
:
:
:
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Incorrect build group path
: Detects an invalid path for build group.
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Incorrect label ID
: Detects incorrect references to `<primary-label>` and `<secondary-label>` identifiers.
:
:
:
: You can either select one of the existing labels, create a new one with the specified ID, or remove the label element.
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Invalid filter value
: Reports problematic filter declarations that may result in unexpected behavior:
:
: * Explicit `empty` values in `filter` attributes
:
: * Redundant or misplaced negation `!` operators
:
:
:
:
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Invalid line range value
: Detects invalid line range values in `emphasize-lines` and `include-lines` attributes of code blocks.
:
:
:
:
:
: The inspection reports problems such as:
:
:
:
: * Invalid format (for example, `1-2-3`)
:
: * Non-positive line numbers (e.g., `0-5`)
:
: * Inverted ranges (e.g., `5-1`)
:
: * Overlapping ranges (e.g., `1-3, 2-5`)
:
: * Ranges that reference lines outside the displayed snippet
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Large image without a thumbnail
: Detects large images without a thumbnail and suggests making them expandable.
:
:
:
:
:
: Thumbnails are small previews that you can use in place of large images. When the user clicks on the thumbnail, it expands to the full image.
:
:
:
: You can either set `thumbnail="true"` to make the original image expandable (optionally, also set the `width` to make the image thumbnail smaller), or use `preview-src` to specify a custom preview image as a thumbnail.
:
:
:
: You can set the maximum image width allowed by the inspection in Settings | Editor | Inspections.
:
:
:
:
:
: Disabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Link to topic not in current instance
: Detects links pointing to an existing topic that is not in the current help instance tree.
:
:
:
: 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
:
:
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Missing 'openapi-path' attribute
: Detects missing `openapi-path` attribute either in the `<api-endpoint>` element directly or in the parent `<api-doc>` element.
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Missing alt attribute inspection
: Detects `<img>` elements without the `alt` attribute.
:
:
:
:
:
: Always use the `alt` attribute to provide a textual alternative to non-text content (in our case, to screenshots and icons) on web pages.
:
:
:
:
:
: The purpose of using the `alt` attribute is to:
:
:
:
:
:
: * Make the page accessible to people who use screen readers.
:
: * Display information about non-textual page elements when they cannot be displayed.
:
: * Provide search engines with semantic information about the page contents.
:
:
:
:
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Missing entity reference
: Detects attribute values that reference non-existent entities.
:
:
:
:
:
: For example, there must be a topic file named `introduction.topic` with an existing anchor `my_anchor` to reference it like this:
:
:
:
:
:
:
: ```
: </api-doc></api-endpoint></secondary-label></primary-label></format></format></code-block></var></a><a href="introduction.topic" anchor="my_anchor">
: ```
:
:
:
:
:
: This also applies to `from`, `element-id`, `instance`, `use-filter`, and other similar attributes.
:
:
:
:
:
: Disabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Missing title
: Checks for missing `title` attribute in `chapter`, `def`, and `tab` elements.
:
:
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Non-empty code block uses source file
: Detects non-empty code blocks that also define a valid source file via the `src` attribute.
:
:
:
:
:
: By default, Writerside inserts the contents of the referenced source file into the code block. If you really want to use the contents of the source file, remove text inside the `<code-block>` element and collapse it. Otherwise, keep the text in the code block and remove the `src` reference to the source file.
:
:
:
:
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Redundant link text
: Detects links to topics where the topic title matches the link text.
:
:
:
:
:
: When you add a link to another topic, Writerside uses the topic title as the link text, unless you put some text inside the `</code-block></a><a>` tag. If this text matches the topic title, Writerside suggests removing the text and collapsing the `</a><a>` tag.
:
:
:
: Enabled by default with severity ![Weak warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWeakWarningIcon.svg)  Weak warning  .

The 'icon', 'icon-position', 'size', and 'mode' attributes are only allowed buttins
: Detects invalid use of the `as` attribute and related button styling attributes on `</a><a>` elements.
:
:
:
: This inspection reports two kinds of problems:
:
:
:
: * The `as` attribute is set to an unknown value. The only supported value is `button`, which renders the link as a button.
:
: * The button styling attributes `mode`, `size`, `icon`, or `icon-position` are used without `as="button"`. These attributes only have effect when the link is rendered as a button.
:
:
:
: Example of a valid button link:
:
:
:
:
: ```
: </a><a href="https://example.com" as="button" mode="primary" size="l">Download</a>
: ```
:
:
:
:
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Sortable attribute on non-header cell
: Reports `sortable="false"` used on a non-header cell.
:
:
:
: The `sortable="false"` attribute can only be placed on cells in the header row (the first row of a table with `style="header-row"` or `style="both"`). On any other cell, the attribute has no effect and will be ignored by the renderer.
:
:
:
:
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Title tag is ignored
: Detects `<title>` tags that do not affect the topic title.
:
:
:
: In Writerside XML topics, only the first `&lt;title&gt;` tag in the file defines the topic title. All subsequent `&lt;title&gt;` tags are ignored and can be removed.
:
:
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

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.
:
:
:
: In Writerside Markdown topics, the first top-level (level 1) header is interpreted as the topic title. All subsequent top-level headers are implicitly converted to chapter titles (level 2 Markdown headers).
:
:
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Topic title is missing
: Detects Markdown topics with a missing topic title. Every Markdown topic must have a first-level `#` header, which serves as the topic title. Alternatively, you can also use a YAML front matter block:
:
:
:
:
:
:
: ```
: ---
: title: Topic title
: ---
: ```
:
:
:
:
:
: There are two suggested quick fixes: adding a `# Topic title` to the very beginning of the topic or converting the first header of any other level to H1.
:
:
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Unexpected media file type
: Detects media references that do not match their expected media types, for example, image references in `&lt;video&gt;` tags and videos in image elements.
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Unreachable external image
: Detects unreachable URLs to external images.
:
:
:
:
:
: You can add an external image to your documentation by providing its URL in the `src` attribute. This inspection sends a request to the specified URL and reports a problem if the response status code is 400 or more.
:
:
:
:
:
: &gt; **Note:**
: &gt; This inspection sends a GET request to the specified URL, which may trigger unintended actions, for example, if the URL points to an endpoint of a service.
:
:
:
:
:
: Disabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Unreachable external link
: Detects unreachable external links.
:
:
:
:
:
: You can add an external link to your documentation by providing a URL in the `href` attribute. This inspection sends a request to the specified URL and reports a problem if the response status code is 400 or more.
:
:
:
:
:
: &gt; **Note:**
: &gt; This inspection sends a GET request to the specified URL, which may trigger unintended actions, for example, if the URL points to an endpoint of a service.
:
:
:
: Disabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Unreachable external video
: Detects unreachable URLs to external videos.
:
:
:
:
:
: You can add an external video to your documentation by providing its URL in the `src` attribute. This inspection sends a request to the specified URL and reports a problem if the response status code is 400 or more.
:
:
:
:
:
: &gt; **Note:**
: &gt; This inspection sends a GET request to the specified URL, which may trigger unintended actions, for example, if the URL points to an endpoint of a service.
:
:
:
:
:
: Disabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Unresolved reference
: Detects unresolved references to images, topics, resources, and other referencable objects.
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Unsupported language in code block
: Detects unsupported languages in code blocks.
:
:
:
: Such code blocks will be rendered as plain text, without syntax highlighting.
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Video has no preview image
: Detects videos without a preview image.
:
:
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Wide code block
: Detects code blocks with long lines.
:
:
:
:
:
: The frontend adds a horizontal scroll bar to code block elements with lines that don't fit inside the block. The maximum width of the code block element can fit lines up to 70 characters without a scroll bar. This inspection highlights code blocks with long lines: rearrange such code to avoid truncated examples for your readers.
:
:
:
:
:
: You can change the maximum line length for this inspection.
:
:
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

XML-like tags in code block
: Detects XML-like tags inside `&lt;code-block&gt;`.
:
:
:
: If you need to show XML-like markup in a code block, either wrap the contents of the code block with `CDATA` or use HTML character entities instead of angle brackets.
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

##  Element id problems 

Element id occurs more than once
: Detects duplicate element IDs.
:
:
:
: You can use IDs to set up links to topic elements or to reuse them in other topics, so element IDs must be unique within a file.
:
:
:
: Replace matching IDs and make sure that new IDs are easy to distinguish.
:
:
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Element id occurs more than once (Gist)
: Detects duplicate element IDs using gist-based duplicate search.
:
:
:
: This inspection mirrors the legacy duplicate-ID inspection and is intended for parity checks while both implementations coexist.
:
:
:
: Disabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Element id occurs more than once in Markdown file
: Detects duplicate element identifiers in Markdown Writerside topics.
:
:
:
: You can use IDs to set up links to topic elements or to reuse them in other topics, so element IDs must be unique within a file.
:
:
:
: Replace matching IDs and make sure that new IDs are easy to distinguish.
:
:
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

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`.
:
:
:
: Enabled by default with severity ![Weak warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWeakWarningIcon.svg)  Weak warning  .

Root file tag must have an 'id' attribute
: Detects missing or incorrect topic IDs in XML files. Every XML topic must have the `id` attribute in the root `&lt;topic&gt;` tag with the value equal to the topic file name without the extension.
:
:
:
:
:
:
:
: The quick fix either adds or corrects the ID to match the topic file name.
:
:
:
:
:
: For example, if the topic file name is `some_intro.topic`, then the root `&lt;topic&gt;` tag must have `id="some_intro"`.
:
:
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Unresolved anchor reference
: Reports unresolved references in Markdown links.
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

##  Style checks 

Missing space
: Detects the absence of whitespace characters around tags.
:
:
:
:
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Style guide violation
: Highlights violations of style rules defined in the .wrs-style-guide.yaml file. To create this file, right-click the root directory of your project and select New &gt; Writerside Style Guide File.

##  Table of contents 

Duplicate redirect
: Detects duplicate redirects.
:
:
:
: You can use the `accepts-web-file-names` attribute on a `&lt;toc-element&gt;` to specify HTML pages from which you want to redirect to this TOC entry. For example, when you remove a topic, you probably want to redirect its web filename to another topic. If you use the same web filename for multiple redirects, it will lead to a conflict. This inspection detects duplicate redirects and suggests removing the duplicates.
:
:
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Duplicate topic in TOC
: Detects topics that are added to the TOC more than once.
:
:
:
:
:
: Every entry in the table of contents references a specific topic. If you add a topic to the same help instance tree more than once, it will lead to conflicts. This inspection detects TOC elements that reference the same topic and suggests removing the TOC element.
:
:
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

External redirect
: Detects external redirects that violate their usage guidelines. If you use a `target-for-accept-web-file-names` on a `&lt;toc-element&gt;`, it must:
:
:
:
: * Be `hidden="true"`
:
: * Define `accepts-web-file-names` or `accepts-web-file-names-ref` from which to redirect
:
: * Not reference `topic`
:
:
:
: Example:
:
:
:
:
: ```
: &lt;toc-element target-for-accept-web-file-names="https://www.company.com/blog/post" accepts-web-file-names="some-removed-topic.html" hidden="true"/&gt;
: ```
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Library topic in tree file
: Detects TOC elements in tree files that reference library topics.
:
:
:
: A library topic is a topic with `is-library="true"`. Although you can re-use content from any topic file, it is better to keep reusable snippets in dedicated library topics, which are not meant to be published with any help instance.
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Missing start-page attribute
: Detects non-library instance-profile tag without 'start-page' attribute and offers to add it.
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

Redirect from existing topic
: Detects redirects from web filenames of existing topics.
:
:
:
: You can use the `accepts-web-file-names` attribute on a `&lt;toc-element&gt;` to specify HTML pages from which you want to redirect to this TOC entry. For example, when you remove a topic, you probably want to redirect its web filename to another topic. If you use a web filename of an existing topic, it will lead to a conflict. This inspection detects such conflicts and suggests removing the redirect.
:
:
:
:
:
: Enabled by default with severity ![Error icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsErrorIcon.svg)  Error  .

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 `&lt;toc-element&gt;`. 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.
:
:
:
: Enabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

Unreachable URL in TOC
: Detects external URLs in the table of contents that can't be reached.
:
:
:
: You can add a link to any URL to the table of contents with the `href` attribute. This inspection sends a request to the specified URL and reports a problem if the response status code is 400 or more. For values that start with `mailto:`, it ensures that the email has valid syntax.
:
:
:
:
:
: &gt; **Note:**
: &gt; This inspection sends a GET request to the specified URL, which may trigger unintended actions, for example, if the URL points to an endpoint of a service.
:
:
:
:
:
: Disabled by default with severity ![Warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWarningIcon.svg)  Warning  .

##  Unused symbols 

Topic not in current instance
: Warns you when the topic currently open in the editor is not in the current help instance.
:
:
:
:
:
:
:
: You can either add this topic to the current help instance or select a help instance with this topic.
:
:
:
:
:
: Enabled by default with severity ![Weak warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWeakWarningIcon.svg)  Weak warning  .

Unused snippet
: Detects snippets that are not included anywhere.
:
:
:
: For regular topics, Writerside suggests unwrapping the `</title><snippet>` element (preserving the content).
:
:
:
: For library topics, Writerside suggests removing the `<snippet>` element (preserving only descendant snippets that are used somewhere).
:
:
:
:
:
: Enabled by default with severity ![Weak warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWeakWarningIcon.svg)  Weak warning  .

Unused topic
: Warns you when the topic file is not used anywhere.
:
:
:
:
:
: If the topic file is not included in any table of contents and does not have anything from it included in other topics, consider removing it from the project.
:
:
:
:
:
: Enabled by default with severity ![Weak warning icon](https://resources.jetbrains.com/help/img/writerside/app.general.inspectionsWeakWarningIcon.svg)  Weak warning  .

</snippet></snippet></seealso></seealso></body></html>