Top > Extensions > description

description.xml Edit

拡張機能パッケージ自体のデータを記述するファイル。このファイルのファイル名は変更してはいけません。

また、ファイルは拡張機能ファイルの一番上のディレクトリに配置することになっています。配置が違う場合には単純に無視されます。

パッケージ内に入れるだけでなくオンラインアップデートのときのパッケージの情報の記述にも利用します。

ヘッダとフッタ Edit

<?xml version="1.0" encoding="UTF-8"?>
<description xmlns="http://openoffice.org/extensions/description/2006"
	xmlns:xlink="http://www.w3.org/1999/xlink"
	xmlns:d="http://openoffice.org/extensions/description/2006">

</description>

要素 Edit

記述可能な要素には以下のものがあります。

識別子 Edit

拡張機能パッケージの固有 ID。アップデート、ヘルプ、パッケージ関連 API で利用されます。2.0.4

<identifier value="mytools.mri" />

さまざまな場面で利用されるためぜひ設定しましょう。

バージョン Edit

パッケージのバージョン。アップデート時のバージョン比較に利用されます。2.0.4

<version value="0.4.0" />

形式は「メジャーアップデート.マイナーアップデート.バグフィックス」の形式が推奨されています。

ライセンス表示 Edit

インストール時に表示されるライセンス表示設定。2.0.4

<registration>
  <simple-license accept-by="user" default-license-id="this" suppress-on-update="true" suppress-if-required="false">
    <license-text xlink:href="notices/notice.txt" lang="en" license-id="this" />
  </simple-license>
</registration>

accept-by は user または admin を指定します。admin を指定すると管理者がインストールするときにライセンスを受諾しておけば誰でも利用できるようになります。一方で user を指定するとユーザーが一人ずつインストールしなければいけなくなります。

suppress-on-update を true にするとオンラインアップデート時にライセンス表示が出ません。ライセンスは言語ごとに指定できます。

3.2.1 からは suppress-if-required を true にすると unopkg を利用したコマンドラインでのインストールの際に --suppress-license オプションを指定してライセンスを非表示にすることを許可します。

依存性 Edit

バージョン依存性設定。拡張機能が動作する最低限必要なバージョンを設定する。2.0.4

<dependencies>
  <d:OpenOffice.org-minimal-version value="2.2" d:name="OpenOffice.org 2.2" />
</dependencies>

また、バージョンの上限も設定できます。3.1

<dependencies>
  <d:OpenOffice.org-maximal-version value="3.2" d:name="OpenOffice.org 3.2" />
</dependencies>

同時に利用できます。

LibreOffice 3.5 以降では、LibreOffice のみのバージョン依存性が指定できます。しかし、これを利用したパッケージは Apache OpenOffice でインストールしようとするとエラーになります。

<description xmlns="http://openoffice.org/extensions/description/2006"
 xmlns:xlink="http://www.w3.org/1999/xlink"
 xmlns:d="http://openoffice.org/extensions/description/2006" 
 xmlns:l="http://libreoffice.org/extensions/description/2011">
 
<dependencies>
  <l:LibreOffice-minimal-version value="4.0" d:name="LibreOffice 4.0" />
</dependencies>

拡張機能パッケージの表示名 Edit

拡張機能マネージャでファイル名の替わりに表示する名称。言語ごとの設定が可能。2.4

<display-name>
  <name lang="en">display name</name>
</display-name>

パブリッシャー表示 Edit

更新時に表示されるパブリッシャーへのリンク。description.xml もしくは update-information 先の update.xml に記載する。2.4

<publisher>
  <name xlink:href="http://.html" lang="en">Publisher</name>
</publisher>

3.x から拡張機能マネージャのインストールされているパッケージ一覧に表示される可能性があります。

リリースノートリンク表示 Edit

オンライン更新時に表示されるリリースノートへのリンク。update-information 先の update.xml に記載する。2.4

<release-notes>
  <src xlink:href="http://.html" lang="en" />
</release-notes>

アップデート Edit

アップデート情報を記載したファイルへのリンクを指定。2.2

<update-information>
  <src xlink:href="http://./MRI.update.xml"/>
</update-information>

識別子およびバージョンをパッケージに指定しておく必要があります。

指定先のファイルにはアップデート情報を記載。

<?xml version="1.0" encoding="UTF-8"?>
<description xmlns="http://openoffice.org/extensions/update/2006" 
 xmlns:xlink="http://www.w3.org/1999/xlink">
<version value="3.0.0" />
<identifier value="hoge.example" />
 <update-download>
   <src xlink:href="http://localhost/extension3.oxt"/>
 </update-download>
</description>

拡張機能の識別子、新しいパッケージのバージョン、パッケージダウンロード先の URL を指定します。

ブラウザでのアップデート Edit

update-information 先の update.xml に update-download の替わりに update-website を記述する。2.4

<update-website>
  <src xlink:href="http://.html" lang="en" />
</update-website>

ターゲットプラットホーム Edit

拡張機能をプラットホームごとにインストールの許可を与えることができます。OOo 3.0 以降。

<platform value="all"/>

複数の時にはコンマ "," で区切ります。

プラットホーム指定は Platform 参照。

ターゲットプラットホームが別々の拡張機能の ID はそれぞれ違ったものにする必要があります。

アイコン Edit

新しい拡張機能マネージャで表示されるアイコンを指定できます。OOo 3.1 くらい以降。

<icon>
  <default xlink:href="icon.png"/>
  <high-contrast xlink:href="icon_hc.png"/>
</icon>

画像は 32 x 32 pixel。42 x 42 pixel に変更になりました。

パッケージの説明 Edit

3.1 から manifest.xml 中で指定していた application/vnd.sun.star.package-bundle-description が廃止になりこっちで指定する様に変更になりました。

<extension-description>
    <src lang="en" xlink:href="descriptions/descripton_en.txt"/>
    <src lang="ja" xlink:href="descriptions/descripton_ja.txt"/>
</extension-description>

表示場所などは同じです。書き換えるだけで以前のものを利用できます。

インストール/アンインストール時のフック Edit

com.sun.star.deployment.XDeploymentHooks インターフェースをサポートしたサービスがインストールおよびアンインストール時に呼ばれる。未実装。

<deploymentHooks service="service_name"/>

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