Vimperator

ドキュメントを書く

documentation writing-docs

新機能のパッチにの採用につきましては、ドキュメントを用意していただくことが必須要件です。ドキュメントはasciidocの8.xまたは以降のバージョンで書かれています。これらはmake docでコンパイルして、ディレクトリ src/locale/en-US/ に置いてあります。上記についての詳細はasciidoc documentationを参照してください。たいていの場合、テキストをそのまま記述すれば正確に解釈されるでしょう。倒なのは :helpコマンドのための特別なセクションを書くときだけです。

|<F1>| |:help| |:h| |help|
||:h[elp] {subject}|| +
||<F1>||
____________________________________________________________________________
ヘルプ・ウィンドウを開きます。
{subject}を指定しない場合は、デフォルトのセクションが表示されます。
特定のトピックについてヘルプが必要なときは、コマンド [c]:help overview[c] を
ためしてみてください。
____________________________________________________________________________

上記は下記のように表示されます:

<F1> :help :h help

:h[elp] {subject}

<F1>

ヘルプ・ウィンドウを開きます。{subject}を指定しない場合は、デフォルトのセクションが表示されます。特定のトピックについてヘルプが必要なときは、コマンド :help overview をためしてみてください。

上記のコードについての諸注意。

また、Vimperatorのためのドキュメント用に、asciidocのコマンドを追加しています。

作成したドキュメントをファイルあるいはセクションのどこに置けばいいのか分からないときは、メーリング・リストまたは#vimperator(IRCのチャンネル)にてお問い合わせください。通常、ヘルプ・ドキュメントは、'ウェブ・ページを開く'のように、論理的に結びついたサブジェクトごとにグループ化されます。

opening web pages(ウェブ・ページを開く).