TKYTEL COMMENT 3
東京広域電話網
2025-05-01
TKYTEL COMMENT の体裁について
1. 概要
本文書では、TKYTEL COMMENT(以下、文書とする)の好ましいスタイルに
ついて言及する。
2. 体裁
文書は UTF-8 で符号化される。ファイルの先頭に BOM を配置しない。ま
た、文字集合には Unicode を用いる。
文書にページ区切りのための改頁文字(U+000C, FORM FEED)を含めな
い。文書は印刷されることを考慮して編集されない。
文書における一行の長さは 72 文字である。世の中のほとんどの端末の幅
は 80 文字分であるから、72 文字に制限された行はほとんどの端末で折り
返されることなく表示される。行の先頭を 1 文字目としたとき、72 文字目
には文字があっても良いが、73 文字目には文字があってはならない。全て
の行末には改行文字(U+000A, LINE FEED)のみを置き、改行文字の直前に
復帰文字(U+000D, CARRIAGE RETURN)を置かない。また、行末に余計な空
白文字の類を取り残さない。
ファイルの末尾に余計な空行を取り残さない。無駄な行送りは画面の無駄
遣いである。ただし、ファイルの最後の文字は改行文字である。
後退文字(U+0008, BACKSPACE)や ANSI escape code の類を利用した重
ね打ちや下線等によって語句や文章を強調しない。そのような強調は高度な
機能を持たない端末では十分に機能しない。
文書を整形するために水平タブ文字(U+0009, HORIZONTAL TAB)を用いな
い。水平タブ文字の挙動は端末によってまちまちである。代わりに空白文字
を用いる。
3. 書式
文書の冒頭部分は次のようにする。
一行目には「TKYTEL COMMENT XX」を左揃えで配置する。ただし、XX は文
書番号である。文書番号は必要最低限の桁数で表示する。
続く行には発行者名を右揃えで配置する。発行者名がわからなければ「東
京広域電話網」とする。発行者が複数である場合には、発行者毎に行を改め
る。
続く行には発行年月日を右揃えで配置する。年月日の書式は YYYY-mm-dd
であり、YYYY は西暦年を必要最低限の桁数(通常は 4 桁)で、mm は月を
ゼロ埋めして 2 桁で、dd は日とゼロ埋めして 2 桁で表示する。
続く行は空行である。
続く行には文書の表題を中央揃えで配置する。表題が長い場合や行を改め
た方が読みやすい場合には複数行に渡ってもよい。
続く行は空行である。
続く行から本文を配置する。本文は次の書式に従う。
見出しには連番を振り、左に揃える。見出しの名前が長く、複数行に渡る
場合、二行目以降をぶら下げ、一行目と同じ位置に揃える。また、見出しの
前後の行は空行とする。ただし、空行が他の空行と連続する場合はこれを省
略する。見出しの名前の開始位置は全ての項目で揃える。4 章の順序ありリ
ストを参照せよ。
本文は左右両側に空白文字 2 文字分の余白を設ける。また、本文は左に
揃えられる。余分な空白文字を用いて両端揃えを実現しない。
本文の段落の前後の行は空行とする。ただし、空行が他の空行と連続する
場合はこれを省略する。また、段落の先頭の行は空白文字 2 文字分の字下
げを行う。
文書の末尾には「以上」を右揃えで配置する。
3. 人間が気をつけること
文書は原則として日本語で書かれる。常体か敬体かは問わないが、文書で
一貫させる。仮名遣いは原則として現代仮名遣いを用いる。
句読点は、原則として読点(U+3001, IDEOGRAPHIC COMMA)及び句点
(U+3002, IDEOGRAPHIC FULL STOP)を用いる。
括弧は、邦文中のものは原則として全角のものを用い、欧文中のものは半
角のものを用いる。また、引用符は原則として curly なもの(U+201C や
U+2019 など)を用いる。
邦文において、適当な禁則処理を行う。例えば、行頭に句読点や捨て仮
名、閉じ括弧の類を置かず、行末に開き括弧の類を置かない。
ハイフネーションを禁ずる。語が行に入り切らない場合、その直前で行を
改める。語のスペルが大変長く、72 文字を超える場合は、その語を折り返
さずに一行で表示する。例えば、
λοπαδοτεμαχοσελαχογαλεοκρανιολειψανοδριμυποτριμματοσιλφιοκαραβομελιτοκατακεχυμενοκιχλεπικοσσυφοφαττοπεριστεραλεκτρυονοπτοκεφαλλιοκιγκλοπελειολαγῳοσιραιοβαφητραγανοπτερύγων
のような具合である。
邦文文字と欧文文字とが隣接する部分には空白文字を置く。ただし、句読
点や括弧と欧文文字とが隣接する部分には空白文字を置かない。また、数と
単位の間のように改行されるべきではない箇所において、空白文字の代わり
に改行禁止の空白文字(U+00A0, NO-BREAK SPACE)を用いることは良い考え
である。
曖昧幅の文字は半角として扱う。
図を描画する場合、可能な限り U+0020 から U+007E までの文字で描画す
る。これらの文字は多くの環境で描画可能である。また、図全体をなるべく
中央に揃える。
URL を記載する場合、それを不等号(U+003C, LESS-THAN SIGN 及び
U+003E, GREATER-THAN SIGN)の対で積極的に囲むと良い。また、これは一
単語として扱うと良い。例えば、
のような具合である。
4. Markdown 記法との互換性
文書の書式と Markdown 記法とは関連している部分がある。
強調の手段としてアスタリスクで囲むことは正式な手段ではない。通常の
引用符や括弧を用いて強調するほうが良い。
当然、インラインな HTML は認められない。表や図を表示したい場合は、
アスキーアートを用いる。また、文字参照を用いる必要はない。
見出しのための等号(U+003D, EQUAL SIGN)やハイフンマイナス
(U+002D, HYPHEN-MINUS)による下線は必要ない。また、行頭に番号記号
(U+0023, NUMBER SIGN)を置く必要もない。
引用を表すために不等号を用いる。引用部分の全ての行の冒頭部分に不等
号を配置し、左右に余白を追加する。例えば、次のようにする。
> 引用文にも通常の段落と同様の書式を適用する。あのイーハトーヴォ
> のすきとおった風、夏でも底に冷たさをもつ青いそら、うつくしい森で
> 飾られたモリーオ市、郊外のぎらぎらひかる草の波。
>
> > 引用文中の引用文にはさらに追加の余白を設ける。吾輩は猫であ
> > る。名前はまだ無い。
> >
> > どこで生れたかとんと見当がつかぬ。何でも薄暗いじめじめした
> > 所でニャーニャー泣いていた事だけは記憶している。吾輩はここで
> > 始めて人間というものを見た。
順序なしリスト項目を列挙する場合、積極的にハイフンマイナスを用い
る。これは多くのキーボードで装飾キーを伴わずに入力できる。リスト項目
が複数行に渡る場合、二行目以降をぶら下げ、一行目と同じ位置に揃える。
複数行に渡る項目がある場合、項目と項目との間に空行を置く。第二レベル
以降の項目がある場合、左右に追加の余白を設ける。
順序ありリスト項目を列挙する場合も順序なしリストと同様である。ただ
し、同レベルの全ての項目で開始位置を揃える。例えば、次のようにする。
I. ほげ
i. foo
ii. bar
II. ふが
i. baz
ii. qux
iii. quux
III. ぴよ
コードブロックは基本の位置から 4 文字下げる。フリーフォーマットな
言語である場合、コードの見栄えが悪くならない程度に適当なところで折り
返し、なるべく余白の内側に収める。フリーフォーマットでない言語である
場合、余白を超過して表示する。例えば、次のようにする。
/* "hello, world" in C */
main(void) {
printf("hello, world\n");
}
水平線は原則として利用を禁ずる。
文章中で文献を引用したり、ハイパーリンクを記述したい場合は、角括弧
(U+005B, LEFT SQUARE BRACKET 及び U+005D, RIGHT SQUARE BRACKET の
対)に適当なラベルを記述し、文書の最後に文献リストを列挙する。例え
ば、[Markdown] のようにする。
5. 文献
[Markdown]: John Gruber. “Markdown”. Daring Fireball.
.
(accessed 2025-05-01)
以上