ルールの一覧へ

見出しの無い目次の項目

toc-heading-mismatch既定で動く日本語 / 英語

目次(「目次」「Contents」の見出しの下の箇条書き)の項目のうち、文書のどの見出しとも合わないもの

例

指摘される文
## 目次 - 1 概要 - 2 費用 - 3 日程 ## 1 概要 本書の概要です。 ## 2 料金 料金の説明です。 ## 3 日程 日程の説明です。
chaff の出力
4:3 目次の「2 費用」に合う見出しがありません
直した文
## 目次 - 1 概要 - 2 料金 - 3 日程 ## 1 概要 本書の概要です。 ## 2 料金 料金の説明です。 ## 3 日程 日程の説明です。
chaff の出力
指摘なし

直し方

目次を見出しに合わせて直すか、消えた節の項目を目次から消してください。

なぜ指摘するのか

目次に「3.2 費用」とあるのに本文にその見出しが無ければ、読み手は目次から探しても行き着けません。見出しを書き換えたり節を消したりしたあとに、目次だけが古いまま残ると起きます。目次の項目と見出しの言葉を突き合わせれば、機械で言えます。

指摘しないもの

項目と見出しは、空白・記号・大文字小文字を無視して比べ、頭の番号(1.2、2-1)と、ページ番号(…… 12)を外しても比べます。リンクの項目は字の部分を比べます(リンクの行き先は broken-link が見ます)。目次の項目の半分より多くが見出しに合わない文書は、本文と別の章立ての目次と読んで言いません。Markdown の見出しのある文書だけを見ます。

止める・ゆるめる

この一か所だけ黙らせる(文書に書く)
<!-- stet: toc-heading-mismatch — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax toc-heading-mismatch --why "理由"
チームで止める(chaff.yaml)
rules: toc-heading-mismatch: off
技術的な情報
層
L3
状態
安定
重さ
注意
対象の言語
日本語と英語
向いている文章
business, technical, blog, legal, docs, academic, literature, speech
文書から読み取るもの
markdown

強さ(段階)

chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。

normal注意
relaxed情報

このルールには数える上限がありません。段階は指摘の重さを変えます。relaxed にすると指摘は消えずに一段軽く出ます。

ジャンルごとの動き

既定で動くジャンル
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

ジャンル

指摘の文

目次の「{entry}」に合う見出しがありません

このページはルールの定義ファイルから作られています:packages/chaff/rules/toc-heading-mismatch.yaml