ドキュメントファイル形式XML タグ各マニュアルのファイル先頭に、下記の XML 宣言がなければなりません。
翻訳した言語の XML ファイルには、 対応する翻訳元の英語ファイルのリビジョンに等しいリビジョン・タグもなければなりません。
行の最大長The maximum line length, including tags, attributes, and indentation, is not to exceed 100 characters. There is only one exception to this rule: attribute and value pairs are allowed to exceed the 100 chars as they are not allowed to be separated. インデントインデントは、空白文字4つで構成されなければなりません。タブは許されません。 同じレベルにあるタグは、同じインデントを持たなければなりません。
前のタグの1つ下のレベルのタグは、さらに4つの空白文字でインデントされなければなりません。
複数のブロック・タグは、同一行の中では許されません。 しかしながら、インライン・タグは複数許されます。
行の終端行の終端は、Unixテキスト・ファイル規約に従います。 行は、単一のラインフィード(LF)文字で終わらなければなりません。 ラインフィード文字は、序数10または16進の0x0Aとして表現されます。 注意: Apple OS で規約となっているキャリッジ・リターン (CR;0x0D) または、Windows OS で標準となっているキャリッジ・リターンと ラインフィード (CRLF) の組合せ (0x0D, 0x0A) を使用してはいけません。 空のタグ空のタグは認められません。タグは全てテキストまたは子供タグを含まなければいけません。
ドキュメント内での空白の利用タグ内での空白Opening block tags should have no whitespace immediately following them other than line breaks (and indentation on the following line).
開始のインライン・タグの直後に空白文字を置いてはいけません。
Closing block tags may be preceded by whitespace equivalent to the current indentation level, but no more than that amount.
終わりのインライン・タグの前に空白文字を置いてはいけません。
複数行の切断複数行内での、またはタグの間での切断は認められません。
タグの間の分離読みやすくするために、同じレベルのタグは空行で分離しなければいけません。
最初の子タグは、空行を置かずに親タグの直下に開かなければいけません。 最後の子タグは、親タグが閉じる直前で閉じなければいけません。
プログラム・リスティングThe opening <programlisting> tag must indicate the appropriate "language" attribute and be indented at the same level as its sibling blocks.
CDATA should be used around all program listings. <programlisting> sections must not add linebreaks or whitespace at the beginning or end of the section, as these are then represented in the final output.
Ending CDATA and <programlisting> tags should be on the same line, without any indentation.
The <programlisting> tag should contain the "language" attribute with a value appropriate to the contents of the program listing. Typical values include "css", "html", "ini", "javascript", "php", "text", and "xml".
For program listings containing only PHP code, PHP tags (e.g., "<?php", "?>") are not required, and should not be used. They simply clutter the narrative, and are implied by the use of the <programlisting> tag.
Line lengths within program listings should follow the coding standards recommendations. Refrain from using require_once(), require(), include_once(), and include() calls within PHP listings. They simply clutter the narrative, and are largely obviated when using an autoloader. Use them only when they are essential to the example.
特殊なインラインタグの注意classnameThe tag <classname> must be used each time a class name is represented by itself; it should not be used when combined with a method name, variable name, or constant, and no other content is allowed within the tag.
varnameVariables must be wrapped in the <varname> tag. Variables must be written using the "$" sigil. No other content is allowed within this tag, unless a class name is used, which indicates a class variable.
methodnameMethods must be wrapped in the <methodname> tag. Methods must either include the full method signature or at the least a pair of closing parentheses (e.g., "()"). No other content is allowed within this tag, unless a class name is used, which indicates a class method.
constantUse the <constant> tag when denoting constants. Constants must be written in UPPERCASE. No other content is allowed within this tag, unless a class name is used, which indicates a class constant.
filenameFilenames and paths must be wrapped in the <filename> tag. No other content is allowed in this tag.
commandCommands, shell scripts, and program calls must be wrapped in the <command> tag. If the command includes arguments, these should also be included within the tag.
codeUsage of the <code> tag is discouraged, in favor of the other inline tasks discussed previously. 特殊なブロックタグの注意title<title> タグで他のタグを保持してはいけません。
|