リファレンスの読み方

XVCDファイルには、例１のようなXMLデータ構造（変換元XML文書）を例２のような結果のデータ構造（変換後のXML文書）に変換する規則を記述します。XVCDファイルに記述されたコードは、変換のひな形となる規則（テンプレートルール）の集合と言えます。

［例１］XMLデータ構造（変換元XML文書）

<?xml version="1.0"?>
<hw:document xmlns:hw="http://xmlns.xfytec.com/samples/helloworld">
   <hw:message>
      Hello World!
   </hw:message> 
</hw:document>

［例２］結果のデータ構造（変換後のXML文書）

<?xml version="1.0"?>
<xhtml:html
   xmlns:xhtml="http://www.w3.org/1999/xhtml"
   xmlns:hw="http://xmlns.xfytec.com/samples/helloworld"
   >
   <xhtml:body>
      <xhtml:p>
         Hello World!
      </xhtml:p>
   </xhtml:body>
</xhtml:html>

XVCDによるボキャブラリコンポーネント開発では、テンプレートルールを２つの手順で作成します。

1. テンプレートルールを適用する対象を記述する
   何に対してテンプレートルールを適用するかを記述します。
2. テンプレートルールによる変換結果を記述する
   テンプレートルールを適用する対象が持つどのデータをどのように出力するかを、テンプレートルールに記述します。

XMLボキャブラリに対応する編集機能は、XVCDの編集に関係する要素や関数をテンプレートルールに記述すると実現できます。

XVCDでテンプレートルールを記述することで、単にXML文書を表示するだけではなく、次のような表現を利用できます。

• 表形式でXML文書を表示する
• ウィンドウをいくつかに区切り、それぞれに別の内容を表示する
• タブシートを使ってXML文書やユーザーインターフェイスを切り替える

XMLドキュメントの表示と編集に関係するリファレンスは、以下のとおりです。

• VC中核
  XVCDにとって基本要素である頂点要素やテンプレート要素など、テンプレートルールを解説します。またXML文書の編集に関係するXVCD要素や関数を説明します。
• 表記述
  XVCDで生成する変換後のXML文書に表記述を使用すると、XML文書を表形式で表示できます。表記述では、表形式でXML文書を表示する方法を解説します。
• フレーム記述
  XVCDで生成する変換後のXML文書にフレーム記述を使用すると、ウインドウをいくつかに区切ってXML文書を表示できます。フレーム記述では、ウインドウをフレームに分割する方法と各フレーム内にXML文書を表示するための方法を解説します。
• タブシート記述
  XVCDで生成する変換後のXML文書にタブシート記述を使用すると、タブシートを使ってXML文書やユーザーインターフェイスを切り替えられます。タブシート記述では、タブシートの作成方法とXML文書をタブシートの中に表示する方法を説明します。
• XHTMLサポート状況
  XVCDで生成する変換後のXML文書にXHTMLを使用すると、XML文書をXHTMLの表現力を使って表示できます。このリファレンスでは、xfy technologyユーザーエージェントのXHTMLのサポート状況を解説します。
• CSSサポート状況
  xfy technologyユーザーエージェントでは、CSSを使って変換後のXML文書をレイアウトできます。このリファレンスでは、xfy technologyユーザーエージェントによるCSSのサポート状況を解説します。

キーやマウス、メニューバーなどを操作して、ユーザーはXML文書を編集します。XML文書の編集操作によっては、変換元のXML文書への新しい要素の追加や、要素の削除など、XMLデータ構造を操作する必要が生じます。

キーやマウスのユーザー操作はイベントとして表現されます。xfy technologyでは、あらかじめ基本的なユーザー操作に対応するイベントを提供しています。

メニューバーやツールバーには、ボキャブラリコンポーネントで作成したメニュー項目を追加してユーザーインターフェイスをカスタマイズできます。

キーやマウス、メニューバーなどを操作すると、コマンドが実行されます。ユーザーの操作に対応してXMLデータ構造を操作するときは、コマンドで行います。コマンドには、xfy technologyで提供される組み込みコマンドとボキャブラリコンポーネントで作成するコマンドの２種類があります。

組み込みコマンドを利用するときは、提供されているコマンドをイベントやユーザーインターフェイスに割り付けます。

ボキャブラリコンポーネントでコマンドを作成するには、コマンド要素（ xvcd:command要素）内にコマンドの処理（コマンドインストラクション）や制御文（条件分岐など）を記述します。作成したコマンドはイベントやユーザーインターフェイスに割り付けます。

イベントにコマンドを割り付けるには、アクション要素（ xvcd:action要素）を使用します。ユーザーインターフェイスにコマンドを割り付けるには、ユーザーインターフェイス記述を使用します。コマンドをイベントやユーザーインターフェイスに割り付けると、ユーザーがそのコマンドを実行できるようになります。

XMLデータ構造の操作に関係するリファレンスは、以下のとおりです。

• VC中核
  コマンド要素（ xvcd:command要素）とアクション要素（ xvcd:action要素）、XML文書編集用のコマンドインストラクションや関数を解説します。
• プラットフォームコマンド
  xfy technologyで提供される組み込みコマンドを解説します。XVCDで使用できる組み込みコマンドは、次のグループに分類できます。
  • ファイル操作
  • 表示
  • 編集
  • ブックマーク操作
  • ツール
  • その他
• プラットフォームコマンドインストラクション
  コマンドの処理を記述するためのコマンドインストラクションを解説します。また制御文を実現するためのXVCD要素も説明します。
• プラットフォームイベント
  xfy technologyが提供するイベントを解説します。
• ユーザーインターフェイス記述
  メニューバーやツールバーなどのユーザーインターフェイスのカスタマイズ方法と、ユーザインターフェイスへのコマンドの割り付け方法を解説します。

ボキャブラリコンポーネントが扱うXMLボキャブラリによっては、次に挙げるような高度な表示・編集機能を必要とする場合があります。

• 日付を自動的に更新する
• 平方根や三角関数を使用した計算をする

xfy technologyが提供する補助機能を使用すると、容易に高度な表示・編集機能に対応できます。xfy technologyには、補助機能として計算スクリプトとデータ変換、プラットフォーム拡張関数が用意されています。

ボキャブラリコンポーネントの補助機能に関係するリファレンスは、以下のとおりです。

• 計算スクリプト
  XML文書内で計算をするためのスクリプトの概要と要素を解説します。
• データ変換
  ドラッグ＆ドロップやコピー＆ペーストのときに行われるデータ変換で使用される要素と使用条件、およびデータ変換時に行われる補完方法を解説します。
• プラットフォーム拡張関数
  xfy technology独自のXPath関数を解説します。プラットフォーム拡張関数は、次のグループに分類できます。
  • 入出力系関数
  • 数値関数
  • 統計関数
  • 日付関数
  • 文字列操作関数
  • 論理関数
  • ツール関数

保存するXML文書の書式を整えるために、XVCDでは書式整形規則を記述できます。この書式整形規則をXFR（XML Formatting Rule）と呼びます。XFRではXML文書で使用されている要素ごとに書式の整形方法を指定して、XML文書をソース表示したときの体裁を整えることができます。指定できる書式の整形方法には、次のようなものがあります。

• 要素の配置方法
• 要素内の空白の扱い
• インデント位置

xfy technologyユーザーエージェントで新規XML文書を作成するときは、文書テンプレートを使用できます。文書テンプレートを作成するには、ドキュメントテンプレート要素（ xvcd:document-template要素）を使用します。ドキュメントテンプレート要素内に記述されたテンプレートルールに現在処理中のXVCDが適用されて、文書テンプレートが作成されます。

既存のXMLファイルをそのまま新規XML文書として利用することもできます。新規XML文書の作成については、新規XML文書作成スキームのリファレンスを参照してください。

XML文書の保存と新規作成に関するリファレンスは以下のとおりです。

• XFR（XML Formatting Rule）
  XFRの概要や使用方法、要素・属性を解説します。
• VC中核
  現在処理中のXVCDを適用した文書テンプレートの作成を解説します。ドキュメントテンプレート要素（ xvcd:document-template要素）を参照してください。
• 新規XML文書作成スキーム
  既存のXMLファイルをそのまま新規XML文書として利用する方法や、XVCDファイルのドキュメントテンプレート要素（xvcd:document-template要素）から新規XML文書を作成する方法を解説します。

XVCDでボキャブラリコンポーネントを作成するときに、効率的に開発を進めるため、そのコンポーネントの情報や共通で使用する文字列などを別のファイルに記述して、XVCDファイルから参照できます。このような目的のためにリソースファイルが用意されています。

マニフェストファイルには、ボキャブラリコンポーネントの登録やアップデートに必要な、次のような情報を記述します。

• ベンダー名
• ボキャブラリコンポーネントのバージョン

マニフェストファイルを作成することで、ボキャブラリコンポーネントの管理が容易になります。

xvcd:import要素を使用すると、複雑なXVCDの一部分を別ファイルに記述することができます。XVCDの一部分を別ファイルにして共用すると、同じ処理を記述する手間が省け、またコードを読みやすくすることができます。

たとえば、表やリスト、文章をそれぞれ表示させるXVCDファイルを作成したり、部署ごとや章ごとにXVCDファイルを作成したりして、必要に応じて結合して利用するような用途が考えられます。

ボキャブラリコンポーネントの作成支援に関係するリファレンスは以下のとおりです。

• リソースファイル
  リソースファイル作成に必要な要素を解説します。
• マニフェストファイル
  マニフェストファイル作成に必要な情報を解説します。
• VC中核
  別ファイルに記述されたXVCDを取り込む方法を解説します。 xvcd:import要素を参照してください。

説明中で使用する名前空間プレフィックスは、各リファレンスの冒頭で明記します。

説明で使用するデータ型の表記は、特に明記しない限り、次のデータ型表記に準拠します。

• 要素内に記述する値・属性に設定する値
  XSLTのW3C勧告、または、XML SchemaのW3C勧告で使用されているデータ型
• 関数の引数・返値
  XPathのW3C勧告で使用されているデータ型