Top > Extensions > mwxhp > tutorial

mwxhp チュートリアル Edit

mwxhp を利用してヘルプファイルを作成する手順です。

ヘルプファイルを作成するターゲットの拡張機能を用意しておいてください。その拡張機能には拡張機能 ID が必要です、事前に定義しておいてください。

起動 Edit

mwxhpconv.py ファイルをダブルクリックしてください。種々のライブラリが正しくインストールできていれば wxPython で作成されたウィンドウが表示されます。

オプション設定 Edit

利用するエディタ、ウェブブラウザなどの環境を設定します。

  1. Tools - Options を選択。ダイアログが表示されます。
  2. エディタのパス、ウェブブラウザのパスを設定します。
  3. プレビューを利用するのであれば、saxon9.jar のパスおよび misc ファイル類を配置したディレクトリを指定します。
  4. OK をクリックします。

これらの設定は ~/.mxhp ファイルに保存され、起動時に読み込まれます。

プロジェクト設定 Edit

拡張機能 ID などのヘルプファイル生成に必要な情報を設定します。

  1. Tools - Settings... を選択します。ダイアログが表示されます。
  2. 拡張機能 ID、その他の設定を行います。
  3. OK ボタンをクリックします。

必須なものは拡張機能 ID です。他の値はデフォルト値でかまいません。

最初の言語追加 Edit

一群のヘルプファイルは各言語ごとに分けられた状態で拡張機能パッケージ内に配置されます。ここで一つ目の言語を追加します。

  1. Edit - Add Language.. を選択します。ダイアログが表示されます。
  2. Language Code に追加したい言語を ISO コードで指定してください。英語であれば en、日本語であれば ja になります。
  3. OK をクリックします。
  4. ツールバーにあるリストボックスに先ほど入力した言語コードが表示されます。複数の言語がある場合には、このリストボックスで表示する言語を変更できます。

二つ目以降の言語を追加する場合にも同様の操作で行います。

トップエントリの追加 Edit

最初の言語を追加した状態ではウィンドウの中央のツリーリストには何も表示されていません。ヘルプビューアの左側に表示されているコンテンツツリーで表示される様子と同様にツリーに項目を追加していきます。

  1. Edit - Create Top Entry を選択します。ダイアログが表示されます。
  2. ツリーの一番上に表示されるノードのタイトルを指定します。
  3. Application には拡張機能に独自な、簡単な名前を指定します。
  4. OK をクリックします。
  5. ウィンドウに項目が追加されます。

項目を選択した状態で Edit - Edit Item を選択すると表示されるダイアログで項目を編集できます。項目をマウスで二度クリックしてその場で編集できます。

Application は表示されませんが、必須です。

新規ページの追加 Edit

トップノードの下にページを追加します。

  1. ウィンドウのツリーリストでトップノードを選択します。
  2. Edit - Add Page を選択します。ダイアログが表示されます。
  3. ツリーでのタイトル、ファイル名、ページ名、タイトルを指定します。
  4. OK をクリックします。

新しい項目が表示されます。

  • ツリーでのタイトルは、タイトルが指定されていなければ、ページでのタイトルにも利用されます。
  • ファイル名はページの内容、変換後のファイル名です。既存のファイルなど名なども可です。
  • ページ名は、ページのリンクなどでのページ指定に利用します。
  • タイトルは、ページの一番上に表示されます。

ページの編集 Edit

追加したページ項目の内容を編集します。

  1. 編集するページの項目を選択します。
  2. View - Edit を選択します。プロジェクトが保存されていなければ、ここで保存を促すメッセージが表示されます。
  3. エディタが開きます。

Tools - Options で指定したエディタでページ用のファイルが開きます。事前に設定しておいてください。

MediaWiki のマークアップに従ってファイルを記述してください。

XHP ファイルへの変換 Edit

各ページを XHP ファイルに変換、さらにツリーを作成します。

  1. Tools - Convert を選択します。
  2. XHP ファイルが生成されます。

Tools - Settings... の Output directory で指定したディレクトリに xhp ファイルが出力されます。

拡張機能ファイルへの追加 Edit

xhp ファイルを拡張機能のパッケージに追加します。

  1. Tools - Settings で指定した Output directory 以下にあるファイルを拡張機能パッケージ内にコピーします。
  2. META-INF/manifest.xml で指定します。
  3. 拡張機能のファイルをパッケージングします。

拡張ヘルプのファイル群は META-INF/manifest.xml ファイル中で配置場所を指定できますが、慣例的に help/ に入れ、次のように指定します。

<manifest:file-entry manifest:full-path="help" 
 manifest:media-type="application/vnd.sun.star.help"/>

Tools - Settings のデフォルトの設定では、プロジェクトのファイルを保存したディレクトリの help ディレクトリにファイルが生成されます。このディレクトリごと拡張機能パッケージにコピーすると配置がそのまま利用できます。


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