MarineProjects/MarineToolbar/Developer/エクステンション

エクステンション bookmark

ご注意 bookmark


	エクステンションによる拡張機能は、Marineツールバーの1.13 β2以上で提供される機能です。それ以前のバージョンでは利用することができません。

エクステンションは、XMLとスクリプトを利用てMarineツールバーのボタンを作成する拡張機能です。

作成されたボタンは、プラグインとして認識され、COMを利用して作成されたプラグインと同じようにMarineツールバーに登録して利用することができます。

C(C++)言語+COMを利用して作成されるプラグインほど自由な機能を実装できませんが、XMLが理解できる程度の知識でボタンを作成できます。

エクステンションで実装可能な機能は以下通りです。単純なボタンから、下記機能を組み合わせたボタンを作成することができます。

リンク
- 任意のURLをボタンやメニューに登録することができます。
検索
- 任意の検索エンジンをボタンやメニューに登録することができます。
RSSフィード
- 任意のRSSフィードをメニューに登録することができます。
スクリプト
- 任意のスクリプトをボタンやメニューに登録することができます。
  スクリプトは、XMLファイルとは別のファイルで作成したものを利用します。利用できるスクリプト言語は、スクリプトプラグインサポートしているJScriptとVBScriptで作成します。

エクステンションの導入 bookmark

エクステンションは、Marineツールバーをインストールしたフォルダ配下のExtensionフォルダに格納します。
エクステンションには、固有の識別子が割り当てられます。識別子はGUIDとも呼ばれており、GUID作成ツールを利用して生成することができます。

個々のエクステンションは、Extensionフォルダの下にGUIDのサブフォルダを作成して、その中にXMLなどのファイルを格納します。

エクステンションの構成 bookmark

エクステンションを作成するには、XMLファイルやボタン画像、スクリプトファイルが必要になりますが、必須のファイルは２つだけです。

GUIDの作成 bookmark

GUIDの作成は、VC++やPlatform SDKに含まれているguidgen.exeというツールを利用して生成します。

guidgen.exeを起動して、4のRegistry Formatが選択されているのを確認して、[Copy]ボタンをクリックすると、作成されたGUIDがクリップボードにコピーされます。
別のGUIDを作成する場合は、[New GUID]ボタンをクリックしてください。

必須ファイル bookmark

extension.xml
- エクステンションについて定義したXMLファイル
extension.bmp
- ボタンの画像として表示されるBMPファイル(16×16)

その他のファイル bookmark

.ico
- メニューに表示するアイコンファイル(16×16)
.js、.vbs
- スクリプトを記述したファイル。


	スクリプトファイルやアイコンファイルは、extension.xmlと同じフォルダに格納する必要があります。

標準的なボタン　 bookmark

サンプル bookmark

任意のサイトに移動するだけの標準的なボタンを記述したextension.xmlです。
この例では、ボタンをクリックすると「Yahoo! JAPAN」に移動するボタンについて、定義しています。

ボタンに表示される画像はextension.bmpです。

このボタンのGUIDは、{0A4CFB59-41E9-477e-BC9F-5055626E4E07}ですので、Extension\{0A4CFB59-41E9-477e-BC9F-5055626E4E07}にextension.xmlとextension.bmpを格納すればMarineツールバーで利用することができます。

プラグインの追加と削除ダイアログ

Marineツールバーでの表示

このようにエクステンションを利用すると簡単にボタンを作成して、Marineツールバーで利用できるようになります。

説明 bookmark

先ほどのextension.xmlを例にXMLの記述方法について説明します。

1行目の<?xml version="1.0" encoding="utf-8"?>はお約束なのでそのまま記述してください。
エクステンションのルート要素は<buttons>で、その中にエクステンションについて記述します。<buttons>の属性として、GUIDを記述します。

buttons要素
GUIDを属性として記述します。
- title要素
  エクステンションのタイトルを記述します。ここに記述されたタイトルは、「プラグインの追加と削除」ダイアログで、プラグイン名として表示されます。
- description要素
  エクステンションの説明を記述します。ここに記述されたタイトルは、「プラグインの追加と削除」ダイアログで、説明として表示されます。
- author要素
  エクステンションの作者名を記述します。ここに記述された作者名は、「プラグインの追加と削除」ダイアログで、作者名として表示されます。
- version要素
  エクステンションのバージョンを記述します。ここに記述された作者名は、「プラグインの追加と削除」ダイアログで、バージョンとして表示されます。(4桁の文字列を.で区切って表記します)
- button要素
  Marineツールバー上に表示されるボタンについて記述します。
  属性のtypeは、ボタンの形状を指定します。標準のボタンはnormal、ドロップダウンのみはwholedropdown、ボタン＋ドロップダウンの場合はdropdownを指定します。
  - title要素
    ボタンに表示するタイトルを記述します。ボタン名を表示しない場合は省略できます。
  - tooltip要素
    ボタンがマウスオーバー時に表示されるツールチップの文字列を記述します。
    ツールチップが不要な場合は省略できます。
  - action要素
    ボタンがクリックされた時の動作について記述します。この例では、「Yahoo! JAPAN」のサイトに移動することを記述しています。
    属性のtypeにその他の動作をしてすることで検索実行やスクリプト実行を行うことができます。

複数の機能を持つボタン bookmark

先ほど紹介した標準的なボタンをベースに、エクステンションでサポートする機能を追加したサンプルを紹介します。
このサンプルは、ボタン＋ドロップダウン形式でメニュー機能を実装します。

サンプル bookmark

メニューでは、以下の機能を定義しています。

検索機能
- Yahoo!検索
- Yahoo!オークション検索
リンク
- Yahoo!ウィジェットへ移動
スクリプト機能
- Yahoo!メールへのログイン
- Yahoo!オークションへのログイン
RSSフィード
- Yahoo!新着情報 - 話題先読み情報の表示
- Yahoo!新着情報 - 新着オススメサイト集の表示

XMLの記述は以下の通りです。

<?xml version="1.0" encoding="utf-8"?>
<buttons guid="{B9206388-6FDF-4702-BBF2-F0262B81D674}">
  <title>Yahoo! JAPAN</title>
  <description>Yahoo! JAPANのサービスを利用するボタンです</description>
  <author>Darksky</author>
  <version>1.0.0.1</version>
  <button type="dropdown">
    <title></title>
    <tooltip>Yahoo! JAPAN</tooltip>
    <action type="link">
      <url>http://www.yahoo.co.jp</url>
    </action>
  </button>
  <menus>
    <menu type="item">
      <title>Yahoo!検索</title>
      <description>Yahoo! JAPANで検索します</description>
      <icon>yahoo.ico</icon>
      <action type="search">
        <method>get</method>
        <url><![CDATA[http://search.yahoo.co.jp/search?p=<1>]]></url>
        <param />
        <charset>euc-jp</charset>
        <referer />
      </action>
    </menu>

<menu type="item">
      <title>Yahoo!オークション検索</title>
      <description>Yahoo!オークションで検索します</description>
      <icon>yahoo.ico</icon>
      <action type="search">
        <method>get</method>
        <url><![CDATA[http://search.auctions.yahoo.co.jp/jp/search/auc?p=<1>]]></url>
        <param />
        <charset>euc-jp</charset>
        <referer />
      </action>
    </menu>

<menu type="item">
      <title>Yahoo!ウィジェット</title>
      <description>Yahoo!ウィジェットに移動します</description>
      <icon>yahoo.ico</icon>
      <action type="link">
        <url>http://widget.yahoo.co.jp/</url>
      </action>
    </menu>

<menu type="folder">
      <title>スクリプト</title>
      <icon>folder.ico</icon>

<menu type="item">
        <title>Yahoo!メールにログイン</title>
        <description>Yahoo!メールにログインします</description>
        <icon>yahoo.ico</icon>
        <action type="script">
          <file>自動ログイン：Yahoo!メール.js</file>
        </action>
      </menu>

<menu type="item">
        <title>Yahoo!オークションにログイン</title>
        <description>Yahoo!オークションにログインします</description>
        <icon>yahoo.ico</icon>
        <action type="script">
          <file>自動ログイン：Yahoo!オークション.js</file>
        </action>
      </menu>
    </menu>

<menu type="folder">
      <title>RSSフィード</title>
      <icon>folder.ico</icon>

<menu type="item">
        <title>Yahoo!新着情報 - 話題先読み情報</title>
        <description>Yahoo!新着情報 話題先読み情報</description>
        <icon>feed.ico</icon>
        <action type="feed">
          <url>http://picks.dir.yahoo.co.jp/topics/rss/</url>
        </action>
      </menu>

<menu type="item">
        <title>Yahoo!新着情報 - 新着オススメサイト集</title>
        <description>Yahoo!新着情報 - 新着オススメサイト集</description>
        <icon>feed.ico</icon>
        <action type="feed">
          <url>http://picks.dir.yahoo.co.jp/dailypicks/rss/</url>
        </action>
      </menu>
    </menu>

</menus>
</buttons>

説明 bookmark

先ほどのサンプルと大きく違うところは、buttonのtypeにdropdownをしていることと、メニューとして表示される情報となるmenus要素が定義されていることです。

リファレンス bookmark

buttons要素 bookmark

要素・属性	説明	備考
guid	guidを属性として記述します。	必須
title	エクステンションのタイトルを記述します。	必須
description	エクステンションの説明を記述します。	必須
author	エクステンションのタイトルを作者名します。	必須
version	エクステンションのタイトルをバージョンします。	必須
button	ボタンについて定義します。詳細はbutton要素の属性と要素で記述します。	必須
menus	ボタンのタイプをドロップダウン形式に指定した場合に表示されるメニューについて定義します。詳細はmenu要素の属性と要素で記述します。	任意

button要素 bookmark

要素・属性	説明		備考
type	ボタンの形式をtypeで属性として記述します。		必須
	normal	標準ボタン
	wholedoropdown	ドロップダウン
	dropdown	ボタン＋ドロップダウン
title	ボタンに表示されるタイトルを記述します。ボタン名を表示しない場合は省略できます。		任意
tooltip	ボタンがマウスオーバー時に表示されるツールチップの文字列を記述します。ツールチップが不要な場合は省略できます。		任意
action	ボタンがクリックされた時の動作について記述します。		必須

button要素中のaction要素 bookmark

要素・属性	説明		備考
type	動作をtypeで属性として記述します。		必須
	link	リンク
	search	検索
	script	スクリプト
url	typeにlink、searchを指定した場合に使用されます。		任意
charset	検索パラメータのエンコーディングを指定します。省略した場合はutf-8で送信されます。		任意
	shift-jis	シフトJIS
	utf-8	UTF-8
	euc-jp	EUC-JP
	iso-2022-jp	JIS
method	検索のメソッドをgetまたはpostで指定します。typeにsearchを指定した場合に使用されます。		任意
param	検索のpostパラメータに使用するパラメータを記述します。methodにpostを指定した場合に使用されます。		任意
referer	検索実行時に使用するrefererを記述します。typeにsearchを指定した場合に使用されます。		任意
file	typeにscriptを指定した場合に使用されます。スクリプトプラグインによって実行されるスクリプトが記述されたファイル名を記述します。		任意

menus要素 bookmark

要素・属性	説明		備考
menu	メニューについての定義を記述します。menu要素の詳細についてはmenu要素表をご参照ください。		必須

menu要素 bookmark

要素・属性	説明		備考
type	メニューの形式をtypeで属性として記述します。		必須
	folder	サブメニュー
	item	メニューアイテム
title	メニューのタイトルを記述します。		必須
description	メニューのツールチップを指定します。typeにfolderを指定し場合は使用されません。		任意
icon	メニューに表示するアイコンのファイル名を指定します。		任意
action	メニューがクリックされた時の動作について記述します。typeにfolderを指定し場合は使用されません。		任意

menu要素中のaction要素 bookmark

要素・属性	説明		備考
type	動作をtypeで属性として記述します。		必須
	link	リンク
	search	検索
	script	スクリプト
	feed	RSSフィード
url	typeにlink、search、feedを指定した場合に使用されます。		任意
charset	検索パラメータのエンコーディングを指定します。省略した場合はutf-8で送信されます。		任意
	shift-jis	シフトJIS
	utf-8	UTF-8
	euc-jp	EUC-JP
	iso-2022-jp	JIS
method	検索のメソッドをgetまたはpostで指定します。typeにsearchを指定した場合に使用されます。		任意
param	検索のpostパラメータに使用するパラメータを記述します。methodにpostを指定した場合に使用されます。		任意
referer	検索実行時に使用するrefererを記述します。typeにsearchを指定した場合に使用されます。		任意
file	typeにscriptを指定した場合に使用されます。スクリプトプラグインによって実行されるスクリプトが記述されたファイル名を記述します。		任意

その他 bookmark

検索機能について
- 検索機能を利用する場合のクエリー文字列やpostパラメータの指定は、Marineツールバーの検索エンジンを追加する方法と同じです。詳しくは、検索エンジンのヘルプをご参照ください。

ご注意 bookmark


	エクステンションによる拡張機能は、Marineツールバーの1.13 β2で提供される予定です。それ以前のバージョンでは利用することができません。

MarineProjects/MarineToolbar/Developer/エクステンション

エクステンション bookmark

ご注意 bookmark

エクステンションの導入 bookmark

エクステンションの構成 bookmark

GUIDの作成 bookmark

必須ファイル bookmark

その他のファイル bookmark

標準的なボタン bookmark

サンプル bookmark

説明 bookmark

複数の機能を持つボタン bookmark

サンプル bookmark

説明 bookmark

リファレンス bookmark

buttons要素 bookmark

button要素 bookmark

button要素中のaction要素 bookmark

menus要素 bookmark

menu要素 bookmark

menu要素中のaction要素 bookmark

その他 bookmark

ご注意 bookmark

標準的なボタン　 bookmark