Top > Extensions > HelpMaking > MakeXHP

PukiWiki -> XHP 変換 Edit

PukiWiki で拡張機能の使用説明を書いたり、HTML に変換してヘルプファイルを作成していたものを利用できるように、 PukiWiki から XHP ファイルを作成するための一連の PukiWiki プラグイン。

PukiWiki plus i18n 用。(ヘルプが他言語対応のため)

ファイル群 Edit

filemakexhp_2.1.zip

PEAR の File_Archive を利用するように変更。ディレクトリを作成せずに zip アーカイブとしてダウンロードさせるようにしたのでここでも動くようになりました。

2 -> 2.1: 表が変換されていなかったのを修正

ファイル構成 Edit

  • makexhp.inc.php xhp に変換
    • convert_xhp.php include される
  • xhplanglist.inc.php 言語リスト
  • xhpidentifier.inc.php 拡張機能 identifier を指定
  • xhppara.inc.php paragraph を生成
  • xhpsection.inc.php section を生成
  • xhpbk.inc.php bookmark タグを生成
  • xhpa.inc.php ahelp タグを生成
  • xhpid.inc.php 段落に id を特に設定
  • xhptitle.inc.php ページのタイトルを指定
  • xhp.inc.php xhp ファイル作成時の編集時切り替え

サポートされていないため動作しないもの。

  • xhpvar.inc.php variable を生成
  • xhpemb.inc.php embed する

準備 Edit

※ PEAR の File_Archive が必要です。

PukiWiki plus i18n を用意。

  • ./extend/plugin ディレクトリに上記のファイルを入れます。

次のように記述して適当なページに makexhp プラグインを表示させます。

#makexhp

拡張機能ヘルプを作成するときの親ページを作成します。

たとえば、MRI のドキュメントでは次のようにしてみます。

親ページに拡張機能の id を次のようにして xhpidentifier プラグインを使って指定します。下記の拡張機能 ID は mytools.mri です。表示は OOo/Ext/MRI/Documentation 参照。

#xhpidentifier(mytools.mri)

さらに、作成する言語を xhplanglist プラグインで指定します。「言語接頭辞」:「ロケール」の様に入力、セットごとはコンマで区切ります。

#xhplanglist(en:en-US,ja:ja)

xhp ファイルに変換するとき、ページ名が「親ページ名」/「言語接頭辞」/ 以下のファイルをその言語のものとしてみなします。また、「親ページ名」/「言語接頭辞」のページにはヘルプビューアに表示するツリーの情報を入力します。

変換 Edit

makexhp プラグインを設置したページに表示されるエディットに親ページ名を入力、MakeXHP ボタンを押します。

変換後、zip アーカイブをダウンロードさせます。

各プラグイン Edit

makexhp Edit

変換用フォームを表示する。エディットには親ページ名を入力する。

#makexhp

xhplanglist Edit

言語リストを与える。言語:ロケールの順に指定。言語は言語に対応したページ作成時の接頭辞に使用。

#xhplanglist(en:en-US)
#xhplanglist(en:en-US,ja:ja,fr:fr)

など。

このプラグインは親ページでのみ使用します。

xhpidentifier Edit

拡張機能 ID を指定する。

#xhpidentifier(mytools.mri)

xhppara Edit

特殊な段落を生成するときに使用する。警告 warning、注釈 note、ヒント tip。role でタイプを指定する。id は省略可能。

#xhppara(role[,id]){{
paragraph content
}}

role: note, tip, warning

xhpsection Edit

セクションを生成するときに使用。この機能の見つけ方 howtoget、関連テーマ relatedtopics。id でタイプを指定する。

#xhpsection(id){{
entries
}}

id: howtoget, relatedtopics

例: 次のようにすると、この機能の見つけ方の枠と内容が表示されます。

#xhpsection(howtoget){{
ツール - アドオン - ほにゃらら
}}

また、次のようにすると関連するページが表示されます。

#xhpsection(relatedtopics){{
[[MkXHP>Extensions/HelpMaking/MakeXHP]]
}}

xhpbk Edit

ブックマークを生成するときに使用。

索引へのエントリーを作成するときには次のようにする。

#xhpbk(index,id){{
bookmark_value1
bookmark_value2 ...
}}

例:

#xhpbk(index,i100023){{
entries (lv1);page1(lv2)
}}

hid によるページへのアンカーの埋め込みに利用する。ヘルプボタンなどでの表示に利用する。hid に ahelp タグの hid を指定する。id は省略可能。

#xhpbk(hid[,id])

hid は hid/ を省いて入力する。

#xhpbk(mytools.Test:Button1,ialise1)

xhpa Edit

ahelp タグでの拡張ヘルプ用。hid の指定は上記 xhpbk と同様。

インラインの時には次のように指定する。

&xhpa(hid,visibility=1,data);

visibility=1 の時には表示。それ以外の時には非表示。非表示は xhp ファイル上には表示されないが、拡張ヘルプのツールチップの内容のみの指定に利用できる。

&xhpa(mytools.mri.edit,1,This edit shows ...);

xhpid Edit

makexhp は段落に id を自動で振るが、特に id を指定したいときに利用する。現在のスタイルシートでは段落 id は変換されず、 html 上に反映されないため不要 (?)。

&xhpid(id);

xhptitle Edit

makexhp はページの最初の Lv1 の見出しをタイトルに使用するが、特に別指定したいときに利用する。

#xhptitle(title[,visibility=false])

といってもタイトルがヘルプファイル上に現れることはないので不要。

xhp Edit

xhp ファイル変換用に編集するとき、xhpa プラグインなどによる表示のオン/オフ切り替え。ページの先頭付近に記述する。

表示

#xhp(1)

非表示

#xhp(0)

Edit

複雑なので例。 MRI


Attach file: filemakexhp_2.1.zip 120 download [Information]

Reload   New Lower page making Edit Freeze Diff Upload Copy Rename   Front page List of pages Search Recent changes Backup   Help   RSS of recent changes