見出しの大文字化が揃っていない
title-case-consistency既定で動く(情報)英語
英語の見出しで、Title Case と sentence case が混ざっている所
例
指摘される文
# User guide
## Getting started
Install the app.
## Changing your settings
Open the menu.
## Sharing Files With Your Team
Press share.
chaff の出力
11:32 This heading's capitalisation differs from the rest (1 in this document)
直した文
# User guide
## Getting started
Install the app.
## Changing your settings
Open the menu.
## Sharing files with your team
Press share.
chaff の出力
指摘なし
直し方
多いほうに揃えてください。
なぜ指摘するのか
Title Case と sentence case のどちらが正しいかは決めません。1 つの文書で混ざっていると、見出しの階層が変わったように見えます。文書の題名(最初の見出しで、それより浅い・同じ深さの見出しがほかに無いとき)は名前なので比べません。節の見出しが同数に割れたときだけ、題名の流儀に合わせます。頭の番号の札(Section 3. / Day 1:)と、曜日・月の名と、本文が文の途中で大文字で書く名前(どれもどちらの流儀でも大文字)は、どちらの流儀の証拠にも数えません。
指摘しないもの
文書の題(最初の見出しで、それより浅い・同じ深さの見出しがほかに無いもの)は名前なので比べません。どちらの流儀が正しいかは決めません。
止める・ゆるめる
この一か所だけ黙らせる(文書に書く)
<!-- stet: title-case-consistency — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax title-case-consistency --why "理由"
チームで止める(chaff.yaml)
rules:
title-case-consistency: off
技術的な情報
- 層
- L3
- 状態
- 安定
- 重さ
- 情報
- 対象の言語
- en
- 向いている文章
- blog, business, technical, legal, docs, academic, literature, speech
強さ(段階)
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。
| strict | 少ないほうの流儀の見出しが 3 個以下のとき指摘 |
|---|---|
| normal | 少ないほうの流儀の見出しが 2 個以下のとき指摘 |
| relaxed | 少ないほうの流儀の見出しが 1 個以下のとき指摘 |
ジャンルごとの動き
- 既定で動くジャンル
- 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
指摘の文
この見出しだけ他と大文字化の流儀が違います(文書の中で {count} 個)
このページはルールの定義ファイルから作られています:packages/chaff/rules/title-case-consistency.yaml