日本語版執筆基準

日本語版執筆基準

• https://github.com/NEKOGET/FuelPHP_docs_jp/wiki/FuelPHP-Documentation-日本語版執筆基準/ を参考にしています
• ライセンスの問題もありますので、ユーザ会などの翻訳をそのままコピペして翻訳したものは pull requestしないでください。

ファイル形式

• 文字コードは UTF-8 を使う。
• 改行コードは LF (Unix) を使う。
• 行数は原文と合わせる。これは、原文の追加/削除のマージ漏れがないことを行数で確認できるようにするためである。よって、文の途中で改行されている場合の改行位置まで厳密に合わせる必要はない。

表記

• 日本語の句点は全角の「。」を、読点は全角の「、」を使う。
• 日本語には全角文字を使う。
• 英数字、符号には半角文字 (いわゆる 1 バイト文字) を使う。
• 数字は、慣習的に使われている場合を除いて、算用数字 (1、2、3) を使う。
• 半角文字と全角文字の間には、半角文字 1 字分のスペースを入れる。
• 丸括弧 ( ) の外側には、全角文字がきても半角文字がきても間に半角文字 1 文字分のスペースを入れる。
  • 丸括弧 ( ) の内側には、全角文字がきても半角文字がきても間にスペースを入れない。
  • 丸括弧 ( ) 内には句点は付けない。複数の文がある場合は、各文の間にだけ句点を付ける。
  • 丸括弧が末尾にくる場合は、括弧の外に句点を付ける。

外部リンク

• PHP マニュアルへのリンクなど、外部へのリンクで、日本語版がある場合は、リンク先を日本語版へ変更する。

訳語

• 原則として、php.net の PHP マニュアル http://php.net/manual/ja/ の訳語に合わせる。

グロッサリー

• namespace -> 名前空間
• requirements -> 要件
• array -> 配列 (キーワードとして使用されているところでは array)
• parameters -> パラメータ
• static -> 静的
• returns -> 返り値
• example -> 例
• browser -> ブラウザ
• request -> リクエスト (HTTP リクエストの場合)
• default -> デフォルト
• note -> 注意
• folder -> フォルダ
• usage -> 使用法
• web -> Web
• we -> 私たち
• requirement -> 要件
• Fuel -> Fuel
• user -> ユーザ
• webserver -> Web サーバ
• encoding -> エンコーディング
• introduction -> はじめに
• prefix -> プレフィックス
• permission -> パーミッション
• action -> アクション
• role -> ロール
• parenthesis -> 丸括弧
• bracket -> 角括弧
• brace -> 波括弧

日本語翻訳データのライセンスについて

• 翻訳データはMITライセンスです
  • http://opensource.org/licenses/MIT