OSS Message Pedia

編集画面ヘルプ

コンテンツ編集

コンテンツとは、メッセージに対する付加情報のことを指します。付加情報には、メッセージ(書式付)、変数、説明、区分、対処、その他、出力例というフィールドを用意しています。それぞれの内容については、以下の項目で説明します。

フィールドの説明
Wikiフォーマット
記述例
編集画面

フィールドの説明

*がついているフィールドは、コンテンツ入力には必須となっています。

メッセージ(書式付)

ソースコードのメッセージ文字列のフォーマット演算子部分を人間が分かる文字列で置き換えたものを記述します。例えば、%sにあたる変数名がhostnameであれば、HOSTNAMEのようにします。ここには、デフォルト値として、ソースコードに記述されているメッセージ本体部分が入ってます。

変数

フォーマット演算子の部分の説明をします。フォーマット演算子がなければ、記述する必要はありません。フォーマット演算子の部分は、環境によって可変であることが多いため、実際のシステムログなどに表示されるメッセージも可変です。そのあたりを考慮して、コンテンツを閲覧するユーザのために、分かりやすく記述しましょう。

説明*

必須フィールドです。そのメッセージの説明をしてください。以下の項目にあてはまるものを記述しましょう。

メッセージの意味
どういう現象が発生したときに表示されるか
なぜメッセージに書かれているような現象が発生したのか

[注意点]
　　　　*調査するときに以下のコメントを挿入します。xxxには完了予定日を年月日で記入します。
 
    ★★★このメッセージはxxxまでに作成する予定です。★★★
 
　　　　*調査結果を登録するときに上記のコメントを以下のコメントで置き換えます。xxxには完了予定日を年月日で記入します。
 
    ★★★このメッセージは現在作成中です。xxxまでに完成する予定です。★★★
 
　　　　*メッセージの調査結果の登録が完了したら上記のコメントを削除します。
 　　　　　　
　　作成する予定コメントのついたメッセージは他の人により更新されることがあります。
 
　　作成中コメントのついたメッセージは他の人は更新しないでください。

区分*

必須フィールドです。このメッセージの区分を選択項目が選んでください。区分は、システムログのプライオリティフィールドと同様の内容であり、ソースコードに記述してあるプライオリティの値がデフォルトとして選択されています。もし、そのプライオリティ値が誤っている場合は、ここを変更してください。(誤っている場合は、ソフトウェアのバグということにもなります)

対処

このメッセージが発生した場合、どのように対処すればよいかを記述します。このメッセージとともに表示されるメッセージで対処方法が分かる場合は、そのことにも言及するととても親切です。また、メッセージが情報を提供するだけのものである場合は、対処の必要はないと思いますが、なぜ対処の必要がないかの記述があるとユーザは納得すると思います。

その他

説明、対処のフィールドで記述できなかったことを補足します。用語の説明や技術的なことの説明に使っても構いません。

出力例

実際に出力される、または出力されると思われる例を記述します。可変部などに秘匿したい内容が含まれる場合は、別の表現で記述してください。

Wikiフォーマット

ここではメッセージペディアでよく使われるWikiフォーマットを紹介します。全てのWiki記法は、Trac WikiFormatting(trac.edgewall.org)を参照してください。

メッセージペディアでは、Wiki記法にTracというソフトウェアで定義しているものを使用しています。Tracは、プロジェクト管理のために利用されているWikiとバグやTODOなどのトラッキングの機能を持っています。

ボールド体表記

'''bold'''

シングルクォーテーション3つで囲みます。boldと表示されます。

イタリック体表記

''italic''

シングルクォーテーション2つで囲みます。italicと表示されます。

見出し

==== Heading4 ====

イコール(=)で囲みます。=の数で見出しのレベルが変わります。

Heading4

と表示されます。

定義リスト

 Word1::
   fooです
 Word2::
   barです

空白とセミコロン2つを使います。定義の説明文の先頭には空白3つが必要です。

Word1: fooです
Word2: barです

と表示されます。

整形済テキスト

{{{
void hello_world() {
    printk("Hello World\n");
}
}}}

ソースコードやメッセージの例の表記に使用します。かぎ括弧3つを使います。括弧は独立した行にしてください。

void hello_world() {
    printk("Hello World\n");
}

のように表示されます。

強制改行

line1[[BR]]line2

line1
line2

プロセッサ

現在、サポートしていません。

記述例

メッセージ

整形されたメッセージを入れる
フォーマット演算子を、変数に対応するキーワード名に変換する
そのキーワード名をシングルクォーテーション2つで囲む(Wikiフォーマット)
必須フィールドではないで、記述しなくてもよい

OK

device error: ''device_name''

NG

device error: %s\n

printk("device error: %s\n", device->name);

変数

変数の説明を行う
変数に対応したキーワード名はメッセージ欄で記述したものを使用する

整形には以下のTrac Wikiフォーマットを使用する

 param1::
   パラメータ1の説明 
 param2:: 
   パラメータ2の説明

- 1行目は、先頭空白一文字、末尾にコロン二つ
- 2行目は、先頭空白3文字

実際の記述例

コンテンツの記述の例をまとめたものは、ここを参照ください。

編集画面

ここでは、編集画面の簡単な説明をします。

編集中のメッセージID(コンテンツID)
現在、編集の画面がアクティブになっています。他にも
- マニュアル: マニュアル表記
- 履歴: このコンテンツの編集履歴
- ヘルプ: このページ
などのページがあります。
「説明」フィールドです。必須です。
「Update Content」ボタンを押すことで、コンテンツを登録することができます。コンテンツデータの更新後は、「マニュアル」タブでリンクされているページが表示されます。

コンテンツを編集するためには、サインインする必要があります。