参照に添えた名前が、参照先の見出しと違う
reference-title-mismatch既定で動く(情報)日本語 / 英語
「第5条(秘密保持)」のように参照に添えた名前が、その条や章の見出しと違う所
例
指摘される文
# 規約
## 第1章 総則
料金は第2章「返金」を見てください。
## 第2章 料金
月額です。
chaff の出力
5:8 第2章に「返金」と添えていますが、第2章の見出しは「料金」です
直した文
# 規約
## 第1章 総則
料金は第2章「料金」を見てください。
## 第2章 料金
月額です。
chaff の出力
指摘なし
直し方
番号と名前のどちらが正しいかを確かめて、もう一方を直してください。番号がずれたのなら、ほかの参照も同じようにずれていないかを見てください。
なぜ指摘するのか
「第5条(秘密保持)」の第5条が、実は「第5条(損害賠償)」だと、読み手は番号と名前のどちらを信じればよいか分かりません。条や章を足したり消したりして番号がずれたのに、参照を直し忘れると起きます。参照のすぐ後ろの括弧か引用符の中の名前を、参照先の見出しと比べます。どちらかがどちらかを含めば合っているとみなします。
指摘しないもの
参照先が見出しを持たないとき、参照先が一つに決まらないとき、他の文書の条(民法第709条)、括弧の中が数字を含むか「前述」「参照」のような語のとき、句点で終わる断り(「第七項を除く。」)のときは見ません。
止める・ゆるめる
この一か所だけ黙らせる(文書に書く)
<!-- stet: reference-title-mismatch — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax reference-title-mismatch --why "理由"
チームで止める(chaff.yaml)
rules:
reference-title-mismatch: off
技術的な情報
- 層
- L3
- 状態
- 安定
- 重さ
- 情報
- 対象の言語
- 日本語と英語
- 向いている文章
- business, technical, blog, legal, docs, academic, literature, speech
- 文書から読み取るもの
- structure
強さ(段階)
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
指摘の文
{label}に「{name}」と添えていますが、{label}の見出しは「{heading}」です
書き直しの深さ(chaff fix-plan --depth): light — 語と文を直す。構成と文体は残す
このページはルールの定義ファイルから作られています:packages/chaff/rules/reference-title-mismatch.yaml