Top > Extensions > mwxhp

* mwxhp [#l45a31ca]

- 配布元: [[OOobbs3/15]]

拡張機能のヘルプファイルを MediaWiki マークアップで記述したファイルから xhp ファイルに変換して作成するツール。変換には Python mwxhp ライブラリを利用します。

このツールを利用する前に次のことについてよく知っておく必要があります。
- 拡張機能 OXT ファイル内での拡張ヘルプの配置
- 拡張ヘルプの多言語化
- 
- 利用できる書式

[[Extensions/Help]] などを参照してください。

#contents

** インストール [#t0eee425]
Python mwxhp ライブラリをインストールしておきます。

*** Linux 環境 [#d815ef8f]

- wxPython

mwxhpconv.py ファイルをダブルクリックして起動します。

*** Windows 環境 [#o6f32e44]
不明。

** マークアップ [#l5c4aa8d]
xhp ファイルで有効な書式 (タグ) はかなり限定的です。

*** 有効なマークアップ [#e343076b]

 '''bold'''  太字
 == Heading ==  見出し
 * (リスト)  
 # (番号付きリスト)
   (フォーマット済みテキスト)  インデントは保持されません
 <br />  改行
 [[Link]] [[Link|text]] [[Link#Anchor]]  リンク
 [[Link]] [[Link|text]] [[Link#Anchor]] [[#Anchor|text]] リンク
 [[Image:Image.png]]  画像
 {| table |}  表

- 見出しレベル 1 はページの一番上にあるタイトルで利用されます。ページ中の見出しはレベル 2 以降を利用してください。
- 見出しはセクションを生成します。リンクのアンカーとして指定できます。
- フォーマット済みテキストはインデントが削除されてしまいます。コードを記述するためには向きません。また、改行も表示されないため各行に <br /> が必要です。
*** 無効なマークアップ [#p37def2e]
以下は代表的な利用できないマークアップです。

 <tt>  テレタイプ
 ''italic''  斜体
 ----  水平線
 {{Template}}  テンプレート

- 斜体は無効。
** テンプレート [#t649d152]
特殊な要素を生成するためにテンプレートを利用します。

|テンプレート|説明|h
|{{OOo}}&br;{{PRODUCTNAME}}|%PRODUCTNAME に置換され、ヘルプファイル表示前に OpenOffice.org などの名称に置換されます|
|{{Tip&#x7c;CONTENT}}&br;{{Note&#x7c;CONTENT}}&br;{{Caution&#x7c;CONTENT}}&br;{{Warning&#x7c;CONTENT}}|左側に画像のついた段落を生成します。Caution は Warning に置換されます。|
|{{aHelp&#x7c;HID&#x7c;VISIBILITY&#x7c;CONTENT}}|ツールチップなどを生成する ahelp タグを作成します。ツールチップを正しく表示させるには同じページにブックマークが必要です。&br;{{Bookmark&#x7c;hid/.uno:BasicIDEAppear&#x7c;This is an entry.}}&br;{{aHelp&#x7c;.uno:BasicIDEAppear&#x7c;Basic IDE}}|
|{{Bookmark&#x7c;BRANCH&#x7c;COMPONENTS&#x7c;VALUES}}|ブックマークを作成します。ブックマークは段落の子要素になれないので、独立した段落に記述してください。複数のブックマークを一度に定義するには VALUES を &#x7c;&#x7c; で区切ります。BRANCH は index または hid/ の形式になります。COMPONENTS は sbasic, scalc, schart, sdatabase, sdraw, simpress, smath, swriter のどれかおよびコンマで区切って複数を指定できます。BRANCH が index のときにサブエントリーを作成するには / で区切ります。main/Extension とすると main の下に Extension サブエントリを作成します。|
|{{HowToGet&#x7c;CONTENT}}|機能へアクセスする方法を表示する段落を作成します。|
|{{RelatedTopics&#x7c;CONTENT}}|関連するページセクションを作成します。ページ最下部に配置してページへのリンクを表示するのが普通です。|
|{{Variable&#x7c;ID&#x7c;VISIBILITY&#x7c;CONTENT}}|Embedvar で埋め込める変数 ID を定義します。VISIBILITY は動作しません。|
|{{Embedvar&#x7c;HREF}}|Variable テンプレートで定義した値を埋め込みます。HREF は ページ名#ID の形式で指定します。|

- VISIBILITY には要素の表示/非表示を visible または hidden で指定します。
** 例 [#r9d96ab5]

*** 他ページへのリンク [#b650a02e]
 [[page1|リンクテキスト]]
page1 へリンクします。表示テキストは「リンクテキスト」になります。

*** 画像の埋め込み [#i04efbfd]
 [[Image:icon.png]]
icon.png ファイルを表示します。

*** この機能へのアクセス方法 [#i130ed60]
 {{HowToGet|ツール - アドオン - 生成...}}
機能をメニューなどから利用する順序を示す段落を表示します。

*** マーク付き段落 [#f724bfbc]
 {{Warning|次のようなエラーが表示されたときには、OpenOffice.org を再起動してください。}}
左側に画像のついた段落を作成します。

*** 拡張ツールチップ [#ra97b255]
Shift + F1 キーを押して表示される拡張ツールチップを作成します。

aHelp で作成した項目に加えて、同 ID を持つ Bookmark を同じページに作成しておく必要があります。
 {{aHelp|mytools.hoge:Create|hidden|Creates something}}
 
 {{Bookmark|hid/mytools.hoge:Create|Put the bookmark in the other paragraph.}}

*** インデックスに項目を追加 [#vcfbf0e2]
 {{Bookmark|index|scalc|Watching Window}}
Calc のインデックスに Watching Window の項目を追加します。

 {{Bookmark|index|main/Sub}}
main の下に Sub 項目を追加します。

*** 関連するページ [#tffdc359]
 {{RelatedTopics|[[page2|Page 2]]<br />[[index]]}}

** 操作方法 [#gaf6a80f]

[[操作方法>./operation]]
** チュートリアル [#b58a3a95]
[[チュートリアル>./tutorial]]

** ディレクトリ構成 [#v3d80226]
データなどのファイル配置。拡張機能パッケージ中での xhp ファイルの配置とほぼ同じディレクトリ構成になっています。

- データファイル
 ./data/ (デフォルトでのディレクトリ名)
   - (lang)/
     - (extension id)/
       - files
   - images/ (画像共有時)
     - image files

画像をすべての言語で共有しないときには (lang)/ 内の images/ ディレクトリ以下に画像が配置されます。

- アウトプットファイル
 ./help
   - (lang)/
     - (extension id)/
       - files
   - images/
     - image files
画像ファイルについてはデータファイルと同じ配置になります。

** プロジェクトファイルフォーマット [#f4466b5c]
プロジェクトの設定などは XML ファイルに保存されます。DTD はありません。

 <?xml version="1.0" encoding="UTF-8"?>
 <wiki2xhp version="2">
	<meta>
		<identifier>mytools.calc.WatchWindow</identifier>
		<share_images>True</share_images>
		<mode>raw</mode>
		<file_extension>.txt</file_extension>
		<wiki/>
		<out>./help</out>
		<data>./data</data>
		<html>./html</html>
	</meta>
	<pages>
		<node application="watchingwindow">
			<item lang="en" title="Watching Window"/>
			<item lang="ja" title="ウォッチングウィンドウ"/>
			<item lang="ru" title="Окно наблюдения"/>
			<page file_name="index">
				<item lang="en" name="index" page_title="" 
                             title="Watching Window"/>
				<item lang="ja" name="index" page_title="" 
                             title="ウォッチングウィンドウ"/>
				<item lang="ru" name="index" page_title="" 
                             title="Окно наблюдения"/>
			</page>
		</node>
	</pages>
 </wiki2xhp>

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