template-project.xml コンフィグレーションファイル

templateProject.xml ファイルは、プロジェクトを JSP テンプレートプロジェクトとしてコンフィグレーションします。JSP テンプレートプロジェクトは、デフォルト JSP テンプレートオプションのリスト ([ウィンドウ｜設定｜ファイルテンプレート｜デフォルトの JSP テンプレート] で使用できる) に追加される一連の JSP テンプレートを定義します。

テンプレートプロジェクトには、少なくとも 1 つのテンプレート定義、テンプレート処理で使用される少なくとも 1 つのソースファイル定義、およびテンプレートと関連付けられた任意の数のリソース定義 (GIF、JPG など) が含まれます。

一般構造

<template-project>
    <template>
        <description>
        <source-ref>
        <resource-ref>
    <source>
    <resource>

<description>

<description> 要素は、<template> 要素の子要素です。テンプレート作成者は、ここでテンプレートのプロパティについて説明する必要があります。

<template-project>
<template>
<description>

構文

<description>
   string_value
</desciption>

属性

なし

出現

最小出現数 : 0

最大出現数 : 1

階層構造

親 : <template>

子 : なし

<resource>

テンプレートが処理される (新しい JSP ページが作成される) ときにコピーされるテンプレートファイルについて記述します。このファイルがコピーされるときにこのファイルで文字列の置換が実行されます。

<template-project>
<resource>

構文

<resource id="id_value" path="string_value" />

属性

属性	説明
id	必須の文字列。このテンプレートプロジェクト内の他のリソース要素に対してユニークな ID。
path	必須の文字列。projectTemplate.xml ファイルを基準とした、ディスク上のリソース要素の相対パス。

出現

最小出現数 : 0

最大出現数 : 制限なし

階層構造

親 : <template-project>

子 : なし

<resource-ref>

テンプレートが処理されるときに文字列の置換なしでコピーされるリソースについて記述します。

<template-project>
<template>
<resource-ref>

構文

<resource-ref resource="resource_id" outputpath="path_string"/>

属性

属性	説明
resource	必須の文字列。このテンプレートプロジェクト内のリソース要素の ID。
outputpath	必須の文字列。

出現

最小出現数 : 0

最大出現数 : 制限なし

階層構造

親 : <template>

子 : なし

<source>

標準の Velocity テンプレート構文でファイルについて記述します。詳細については、(http://jakarta.apache.org/velocity/index.html) を参照してください。

<template-project>
<source>

構文

<source id="id_value" type="type_string" />

属性

説明

必須の文字列。このテンプレートプロジェクト内の他のソース要素に対してユニークな ID。

type

必須の文字列。テンプレートを処理するときに出力パスに拡張子が指定されていない場合、このファイルの出力時に使用される拡張子。たとえば、このテンプレートが JSP ファイルを表す場合、type 属性を jsp に設定する。この場合、出力パス MyProject/MyFolder/MyFile でテンプレートが処理されると、MyProject/MyFolder/MyFile.jsp が作成される。

出現

最小出現数 : 制限なし

最大出現数 : 1

階層構造

親 : <template-project>

子 : なし

<source-ref>

テンプレート内で文字列変数の置換用に処理されるファイルについて記述します。

<template-project>
<template>
<source-ref>

構文

<source-ref source="id_value" context="context_string" contextAdapter="contextAdapter_string" />

属性

属性	説明
source	必須の文字列。このテンプレートプロジェクト内のソース要素の ID。
context	必須の文字列。テンプレートが処理されるときに、コンテキストには文字列置換に使用される変数とその値が含まれる。たとえば、JSP テンプレートを処理するときには、JSPBaseBean というコンテキストがテンプレートに渡されて処理される。context 属性に JSPBaseBean を指定すると、JSPBaseBean のプロパティがテンプレート内の文字列を置換するために使用される。
contextAdapter	省略可能な文字列。コンテキストアダプタは、処理前にテンプレートに与えられるコンテキスト変数を追加および変更できる。これは、テンプレートに同じコンテキストを使用する 2 つの source-ref 要素があり、それらの出力ファイル名が異なる場合に便利である。

出現

最小出現数 : 1

最大出現数 : 制限なし

階層構造

親 : なし

子 : <template>、 <source>

<template>

テンプレートは、処理用に選択されるときに作成される論理的なファイルセットです。つまり、テンプレートは処理されるときに出力されるファイルを定義します。

<template-project>
    <template>
        <description>
        <source-ref>
        <resource-ref>

構文

<template id="" typeClass="" name="" icon=""> templateString </template>

属性

属性	説明
id	必須の文字列。このテンプレートプロジェクト内でユニークな文字列 ID 値。
typeClass	必須の文字列。テンプレートのクラスと文字列置換コンテキストタイプの識別子。たとえば、JSPBean を指定する typeClass 値は、このテンプレートが JSP ファイルの作成時にだけ適用可能で、内部の文字列置換変数が JSPBean 定義内のこれらのプロパティに制限されることを示す。
name	必須の文字列。テンプレート選択が可能な場合に表示されるテンプレートのユーザ定義の名前。
icon	省略可能な文字列。いくつかのテンプレートは Workshop UI で選択できる。icon は、これを実装する XML ファイルを基準とするイメージファイルの相対パス。

出現

最小出現数 : 1

最大出現数 : 制限なし

階層構造

親 : <template-project>

子 : <description>、<source-ref>、 <resource-ref>