XVCDによるボキャブラリコンポーネントの開発手順

XVCDによるボキャブラリコンポーネントの作成を支援するために、xfy Developer's Toolkitが提供されています。あらかじめ xfy Developer's Toolkit を手順に従って導入しておくことで、XVCDを使用したボキャブラリコンポーネントが効率よく作成できます。

xfy Developer's Toolkit によるボキャブラリコンポーネント作成支援については、［xfy Developer's Toolkit によるボキャブラリコンポーネント作成支援］を参照してください。

はじめに、作成するボキャブラリコンポーネントが表示・編集対象とするXMLボキャブラリを使用した、動作確認用のXML文書ファイルを用意します。

対象のXMLボキャブラリを使用したXML文書ファイルがない場合は、作成するXVCDのひととおりの動作が確認できる内容のXML文書ファイルを作成します。動作確認に使用するだけなので、XMLボキャブラリに対する要求をすべて実現していなくてもかまいません。また、すでに対象のXMLボキャブラリを使用したXML文書ファイルがある場合は、作成するXVCDのひととおりの動作を確認するのに適したXML文書ファイルを選びます。

動作確認用のXML文書ファイルには、XVCDファイルを関連付けてボキャブラリコンポーネントを登録するための処理命令を記述しておきます。

対象のXML文書を表示・編集するためのボキャブラリコンポーネントをXVCDで記述します。

1. XVCDファイルを作成する
   xvcd:xvcd要素を頂点要素とし、 xvcd:vocabulary要素や xvcd:template要素などから構成されるXVCDファイルを作成します。xvcd:vocabulary要素のmatch属性に指定されているパターンにXML文書の頂点要素が適合すると、XVCDはそのXML文書に適用できます。xvcd:vocabulary要素のmatch属性に*またはnode()が指定されている場合は、すべてのXML文書に適用できます。
2. 表示・編集などの機能を作成する
   ui:ui要素や、 xvcd:command要素、xvcd:template要素などを記述して、表示や編集などの機能を作成します。単純な表示など、基本的な機能からはじめることをおすすめします。
3. XVCDの動作を確認する
   処理命令が記述された動作確認用のXML文書をxfy technologyユーザーエージェントで開いて、XVCDで予定した機能が実現できているか、確かめます。
4. XVCDファイルに機能を追加する
   作成した機能が問題なく動作したら、コマンド、ユーザーインターフェイス、新規作成文書のテンプレートと、順次、機能を拡張します。
   機能を拡張するごとに、拡張した機能の動作を確かめることをおすすめします。

XVCDファイルを作成するときは、XVCDのサンプルを参考にしてください。また、要素や属性の仕様を知りたいときは、それぞれのリファレンスをご覧ください。

XVCDによるボキャブラリコンポーネントの作成が完了した後は、xfy technologyユーザーエージェントの実行環境へインストールします。

XVCDファイルを作成している間は、XML文書に処理命令を記述することでボキャブラリコンポーネントを使用することができました。しかし、この方法は、xfy Developer's Toolkitをインストールしないと使用できません。また、XVCDで作成したボキャブラリコンポーネントで処理したいすべてのXML文書に、処理命令を記述しなければなりません。そのため、処理命令が記述されていないXML文書を直接扱うことができないという問題があります。これらの問題を回避するには、ボキャブラリコンポーネントを作成してインストールする必要があります。

ボキャブラリコンポーネントをインストールすると、xfy Developer's Toolkitがインストールされていない環境や、XVCDファイルを関連付ける処理命令が記述されていないXML文書でも、インストールしたボキャブラリコンポーネントを使ってXML文書を処理できるようになります。

基本的に、ボキャブラリコンポーネントをはじめとする各種xfyコンポーネントをxfy technologyユーザーエージェントで使用するには、JARファイルを作成します。作成したxfyコンポーネントは、xfy technologyユーザーエージェントの実行環境へインストールします。

XVCDによるボキャブラリコンポーネントの場合は、簡易的な方法として、scriptsフォルダ以下にXVCDファイルを配置する方法も用意されています。