スクリプトサイドバープラグイン開発の概要

スクリプトサイドバープラグイン開発キット


Lunascape上でここをクリックすると、スクリプトサイドバープラグインを開発するのに必要な、開発キット兼サンプルプラグインが自動的にダウンロードされます。まずこちらをダウンロードしてから、以下のドキュメントをお読みください。

はじめに


このドキュメントは以下の構成で記述しています。

これらを参照して不明な点はスクリプトサイドバープラグインリファレンスまたはプラグイン掲示板をご覧ください。

スクリプトサイドバープラグインフレームワークについて


スクリプトサイドバープラグインフレームワークは、Lunascapeが提供するスクリプトベースのプラグイン(スクリプトサイドバープラグイン)の作成を簡単にするためのフレームワークです。

スクリプトサイドバープラグインフレームワークを利用したスクリプトサイドバープラグインの開発は、最初はステップ形式のチュートリアルを参考にすることで理解を深めることができます。
チュートリアルはベースとなるサンプルプラグインをダウンロードし、解説にしたがってサンプルの変更を加えてプラグインを開発する内容となっています。

フレームワークによる開発の理解が進めば、オリジナルのプラグインを開発し、一般に公開することもできます。

スクリプトプラグインサイドバーフレームワークのしくみ

スクリプトプラグインサイドバーフレームワークは解析スクリプトからサイドバーに表示する内容の素となるデータを取得し、フレームワーク内部でHTMLに変換してサイドバーに表示します。

サイドバーに表示する内容の素となるデータはXMLで記述され、フレームワーク内部でXSLスタイルシートを用いてHTMLに変換されサイドバーに表示されます。

サイドバーに表示する内容の素となるXML
フレームワークに渡すXMLの作成方法には、組み込みのオブジェクト(LunaItemXmlBuilder)を利用して自動的に作成する方法と、独自に作成する方法とがあります。

解析スクリプトからLunaItemXmlBuilderを利用するイメージは以下のようになります。

解析スクリプトがLunaItemXmlBuilderを操作することにより内部データが更新され、ToStringメソッドを呼び出すことで内部データから生成されたXMLを取得することができます。

LunaItemXmlBuilderオブジェクトを利用してXMLを自動的に作成すれば、XMLについて意識せずにプラグインを開発することができます。 LunaItemXmlBuilderオブジェクトが自動的に作成するXMLで目的が達成できない場合でも、独自にXMLを作成すればさまざまなプラグインを開発することができます。

XMLをHTMLに変換するXSLスタイルシート
スクリプトプラグインサイドバーフレームワークは解析スクリプトから受け取ったXMLをサイドバーに表示するHTMLへと変換するために、XSLスタイルシートを利用します。

自動的に作成されるXMLはOPML形式であり、チュートリアル用のサンプルで用いるXSLスタイルシートはOPMLを処理できる形式で記述してあります。独自にXMLを作成する場合の形式は任意であり、XSLスタイルシートも独自の形式を処理できるように記述する必要があります。

OPML形式についての詳細は、

などを参考にしてください。

XSLスタイルシートについての詳細は、

などを参考にしてください。

スクリプトプラグインサイドバーフレームワークを利用したプラグインの開発

スクリプトプラグインサイドバーフレームワークを利用したプラグインの開発は、サイドバーに表示する内容の素となるXMLを作成する作業と、そのXMLをHTMLに変換するためのXSLスタイルシートを作成する作業に分かれます。

XMLを自動的に作成する方法利用したスクリプトサイドバープラグインの開発
XMLを自動的に作成する方法利用したスクリプトサイドバープラグインの開発は下図のようになります。LunaItemXmlBuilderのいくつかのメソッドを利用し、XSLを記述することで、簡単にプラグインの作成ができます。プラグイン開発者が行う作業は図で赤色で示している部分です。

この方法を利用したスクリプトサイドバープラグイン開発は

のチュートリアルで解説します。

XMLを独自に作成する方法を利用したスクリプトサイドバープラグインの開発
LunaItemXmlBuilderが行っているXMLの作成作業を、解析スクリプト自身が行って専用のXSLスタイルシートとの組み合わせで独自のプラグインを作成することもできます。

任意の形式のXMLとXSLスタイルシートの組み合わせを用いることで、Web APIから取得したXMLデータを利用可能にするなど、応用範囲を拡大することができます。

XMLを独自に作成する方法を利用したスクリプトサイドバープラグイン開発は

のチュートリアルで解説します。

利用するスクリプト言語


スクリプトサイドバープラグインでサポートしているスクリプト言語は、VBScriptとJScriptの2つです。それぞれの言語の詳細な説明については以下のサイトを参考にしてください。

なお、プラグイン開発の解説およびサンプルで利用しているスクリプト言語はVBScriptを使用しています。

スクリプトサイドバープラグインフレームワークにおけるGUIDの扱い


オリジナルのスクリプトサイドバープラグインを開発する場合などに、GUIDという用語やGUIDを作成するという作業が登場します。
GUIDとは、しかるべく生成された場合において世界中で唯一であることが保障された128ビットの数値の呼称であり、Lunascapeがプラグインを識別する場合などに利用しています。 オリジナルのプラグインを開発して配布したり、複数のプラグインを開発する場合などにGUIDを作成する必要があります。
GUIDを作成するにはGUID – Generatorをご使用ください。

GUIDの詳細については

などを参考にしてください。

スクリプトプラグインフレームワーク開発チュートリアル


はじめに、ステップ1ステップ2およびステップ3で解説するチュートリアルのベースとなるスクリプトサイドバープラグイン開発キットをダウンロードします。
※すでにインストールしている場合はインストールする必要はありません。

ダウンロードするとサンプルプラグインが自動的にインストールされます。
インストール後に再起動するとLunascapeの[設定]サイドバーの[機能]-[プラグイン]からプラグインを確認できます。

[スクリプトサイドバープラグイン開発用ベース]をクリックすればプラグインを表示できます。

ステップ0

スクリプトサイドバープラグイン開発を開始するには
ダウンロードした開発キットのサンプルに修正や変更を加えてプラグインを開発する方法を解説します。

ステップ1

簡単なスクリプトサイドバープラグインの作成
必要最小限のオブジェクトとメソッドを用いてスクリプトプラグイン開発の基本的な作業を解説します。

高度なスクリプトサイドバープラグインの作成
組み込みのオブジェクトを利用してサイドバーに表示する内容の素となるXMLを作成し、対応するXSLスタイルシートを記述する方法を解説します。

ステップ2

Web APIを利用したスクリプトサイドバープラグインの開発
Web APIを利用してXMLを取得し、対応するXSLスタイルシートを記述する方法を解説します。

ステップ3

スクリプトサイドバープラグインフレームワークを活用した応用例
独自の形式のXMLを作成し、対応するXSLスタイルシートを記述する方法を解説します。

リファレンス


※作成マニュアルで不明な点は、お手数ですが「プラグイン掲示板」へお問い合わせ下さい。

リリースノート