A reference to a topic its target never mentions
reference-topic-missingon by default (info)Japanese / English
A reference that names a topic ("see Section 2 for pricing") never found there
Example
How to fix
Find the section that covers the topic and correct the number. If the section words it differently, using the same word lets the reader find it.
Why it matters
When the text says "see Section 2 for pricing" and Section 2 never mentions pricing, the reader looks and finds nothing. It happens when sections are reordered or a topic moves elsewhere. The words right after "for" (or 「で述べた」) are looked for in the target's heading and text, and it is pointed out when they are not there.
What it does not flag
Words that fit any section ("details", "more information"), references whose target has no heading or cannot be told apart, and references to another document are left alone. A synonym (price and fee) is not recognised, so a different word is pointed out.
Turning it off or relaxing it
Technical details
- Layer
- L3
- Status
- stable
- Severity
- info
- Languages
- Japanese and English
- Suited to
- business, technical, blog, legal, docs, academic, literature, speech
- Reads from the document
- structure
Levels
Set a level for this rule under rules in chaff.yaml. With nothing set, it runs at the level its genre gives it (see By genre below).
| strict | warning |
|---|---|
| normal | info |
| relaxed | info |
This rule has no limit to count to. A level sets how a finding is marked: relaxed keeps the finding and marks it a step lower.
By genre
- Runs by default in
- technical/spec, technical/readme, blog/tech, blog/essay, blog/owned-media, business/proposal, business/report, business/email, business/press-release, business/meeting-notes, legal/contract, legal/statute, legal/judgment, legal/patent, docs/manual, docs/faq, docs/glossary, academic/paper, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript
Message
"{topic}" does not appear in {label} ({heading})
Rewrite depth (chaff fix-plan --depth): light — words and sentences; the structure and the voice stay
This page is built from the rule's definition file:packages/chaff/rules/reference-topic-missing.yaml