Skip to content

Latest commit

 

History

History
102 lines (75 loc) · 6.22 KB

editing_policy.md

File metadata and controls

102 lines (75 loc) · 6.22 KB
Raw

この「指針」の位置付け

これは、あくまでも「指針」であり、強制力をもつものではありません。 なるべく従ったほうがいいと思いますが、臨機応変にやってください。

表記統一のための指針

括弧類

  • 引用は、「」で囲む。
  • 本文中の会話は「」で囲む。
  • 「」の中で「」を使用する場合、『』を使う。
  • 書籍の場合、『書名』「作品名」
  • 論文、『論文名』
  • 新聞・雑誌の記事、『掲載紙誌名』「記事のタイトル」
  • サイト上の記事、『サイト名』「記事のタイトル」。 *特に出典を明らかにして引用・要約する場合に使用する。 *リンクを貼って、「詳細は○○のサイトをごらんください」などのように書くときは括弧をつける必要はない。
  • 文中に注を入れたり、補足的な説明を加えたりする場合は、「 (」と「) 」で囲む。
    • 開き括弧は、半角スペース + 半角の左パーレン (「(」)、閉じ括弧は、半角の右パーレン (「)」) + 半角スペースにする。ただし、括弧の直前または直後が句読点や、かぎ括弧である場合はスペースは入れない。
    • 0010号は日本語文章中では全角パーレンを使う。(「[RubiMa-editors:2095] 表記規則（括弧の話）」からのスレッド。結論は[RubiMa-editors:2123])
    • 0011号以降は半角に戻すことになった。([RubiMa-editors:2235])
  • 文末で括弧を閉じる場合、「本文。(追加の文。)」または「本文 (追加の語句)。」のいずれかとする。「本文 (追加の文。)。」とはしない。

句読点

  • 日本語文脈中では、全角の「、」と「。」を使う。
  • 日本語文脈の中に欧文の単語を書く場合も、句読点は全角にする。
  • 疑問符 (「？」)・感嘆符 (「！」) は全角を使う。段落の途中で使う場合は後ろに全角のスペースを空ける。
  • 疑問符・感嘆符の後には、句読点はつけない。
  • 顔文字やそれに準ずるもの (「(^^;」、「:-)」、「orz」など) の後には句読点をつけない。

漢字と仮名、英数字

  • カタカナは全角で入力する。
    • 引用文中に存在する場合を含めて、半角カナは使用しない。
    • 引用文中の半角カナは全角に直し、出典とともにそのことを明記する。
    • 和文の句読点 (「、」「。」) 中黒 (「・」) かぎ括弧 (「」) が半角になってしまわないよう、特に注意する。
  • 助詞・副詞・連体詞・助動詞・補助用言・接続詞・接頭語・接尾語は、なるべく、ひらがなで書く。
  • 英数字は半角で入力し、前後に半角スペースを空ける。 *「ie_イベント名」や「int$名前」などのように半角スペースを入れない方が良いところは例外。

改行

Hiki では地の文中の改行はそのまま HTML に出力されるため、改行はブラウザに解釈される。 ほとんどのブラウザは半角文字間の改行は空白1文字に変換し、全角文字間の改行は無視するようだが、半角文字と全角文字の間の改行の扱いはブラウザによって異なるようである。つまり、うかつに文中で改行すると思いもよらない空白文字がブラウザによっては挿入されていることになりかねないので、編集段階ではなるべく文中の改行は取り除くべきである。

三点リーダ

  • 「……」と、2文字使う。
  • 三点リーダが文末となる場合は「……。」と句点を付加する。

その他の記号

  • 追加予定

URL について

[[これ|EditingPolicy]] のような、意味不明なリンクは貼らない。なるべく、リンク先の title 要素（または、それと著しく違うようなことがない表現）を載せる。

記事の体裁について

著者

  • 先頭には著者名などを、末尾には著者についてなどを掲載する。ただし、お知らせ的なもの、レポート的なものなど、記事の種類によっては一方あるいは両方を割愛してもよい。

タイトルについて

  • 本文中に「!」でタイトルを書くのではなく「タイトル」を設定する。
  • 巻頭言、編集後記は「XXXX号 巻頭言」「XXXX号 編集後記」という形式にする。(検討中)
  • RubyNews、RubyEventCheckは「XXXX-RubyNews」「XXXX-RubyEventCheck」というデフォルトの形式のタイトルのままにしておく。
  • リンクは出来るだけ [ [ページ名] ] だけにして [ [タイトル|ページ名] ]にはしない。
    • 目次の巻頭言、RubyNews、RubyEventCheck、編集後記は例外。(号数が自明なのでその部分を省くため)
    • SideMenuも例外。(長さ制限にあわせるため)

脚注

  • 脚注を使う場合は記事の末尾に水平線を入れて脚注を区別しやすくする。

バックナンバー

  • backnumberプラグインを使って未来の記事も含めたリンクを自動生成する。

書き方は

! 連載名 連載一覧

{{backnumber('ページ名のXXXX-を除いたもの')}}

のように連載名が英数字で終わっていなくても「連載一覧」の間は半角空白を入れる。([RubiMa-editors:2135])

  • 巻頭言、編集後記、RubyNews、RubyEventCheckは連載一覧をつけない。

目次について

  • 単発記事を前に、連載を後ろに。
  • 連載ものは「連載のタイトル 【第 n 回】 各回のタイトル」で統一する。各記事の見出しについても同様。
    • [[0009-YAML]]のように短期連載ものは例外を認める。

その他

作業の都合上後回しにしていることがあれば、そこに TODO と書いておくと、残作業の抽出に都合がよい。

役立つリンク集

文章の形式を整形するものです。

  • 全角英数を半角にする
  • 句読点を置き換える
  • 全角文字と半角文字の間に空白を入れる

といった機能があります。