(Microsoft Word - OpenCms\203e\203\223\203v\203\214\201[\203g\212J\224\255\203}\203j\203\205\203A\203\213.doc)

Transcription

1 OpenCms テンプレート 開 発 マニュアル 株 式 会 社 ジークス (2010 年 10 月 25 日 更 新 )

2 目 次 1 OpenCms のページ 生 成 の 仕 組 み ページの 作 成 手 順 データの 入 力 OpenCms のページ 生 成 の 仕 組 み テンプレート(フリーテキストページ 用 )の 作 り 方 テンプレートの 置 き 場 所 モジュールの 作 成 ディレクトリ 構 成 と Online Offline について テンプレートの 作 成 CMS タグライブラリの 基 本 的 な 使 い 方 直 接 編 集 領 域 の 指 定 [cms:include] リンクの 指 定 方 法 (ディレクトリ 階 層 が 合 わない 場 合 ) [cms:link] 表 示 非 表 示 の 制 御 [cms:offline/online/block] プロパティ 値 の 表 示 [cms:property] リンク URL のコントロール [cms:editable] スクリプレットの 記 述 CmsJspActionElement クラスの 利 用 CmsRequestContext クラスの 利 用 CmsObject クラスの 利 用 CmsResourceFilter クラスの 利 用 CmsResource クラスの 利 用 JSTL と 式 言 語 の 利 用 SQL を 実 行 して 結 果 を 表 示 する テンプレート( 構 造 化 コンテンツ 用 )の 作 り 方 構 造 化 コンテンツ(XML Content)とは XSD の 作 成 テンプレート JSP の 作 成 リソースタイプの 追 加 入 力 項 目 を 動 的 に 増 やす 方 法 ウィジェットの 変 更 入 力 項 目 のグループ 化 タブの 設 定 日 本 語 ラベルの 適 用

3 5-10 デフォルト 値 の 設 定 プロパティへのマッピング 入 力 内 容 のチェック(バリデーション)の 設 定 プレビューボタンの 設 置 複 数 の 構 造 化 コンテンツの 一 覧 を 表 示 する その 他 HTML エディタのスタイルシートの 指 定 直 接 編 集 領 域 に 日 本 語 のラベルをつける 文 字 コードの 指 定

4 1 OpenCms のページ 生 成 の 仕 組 み テンプレート 開 発 方 法 の 説 明 に 入 る 前 に OpenCms がどのような 仕 組 みでページを 表 示 しているか を 説 明 します まず ユーザーがページを 作 成 する 時 の 手 順 を 確 認 してみましょう 1-1 ページの 作 成 手 順 1. ページを 作 成 したいディレクトリまで 移 動 します 次 に 新 規 ボタンをクリックします 2. 新 規 ダイアログが 表 示 されるので 新 規 作 成 するリソースタイプを 選 択 します 今 回 は ページを 作 成 するので フリーテキストページ を 選 択 し 次 へ>> ボタンをクリックします 4

5 3. ページの 新 規 作 成 ダイアログが 表 示 されます 名 前 欄 に 作 成 する html の 名 前 を 入 力 します この 名 前 が そのまま URL として 使 用 されます ファイル 名 に 全 角 文 字 や 特 殊 文 字 を 使 用 する 事 は 出 来 ませんので 注 意 してください プルダウンに 現 在 登 録 されているテンプレートが 表 示 されますので 適 用 するテンプレートを 選 択 し 次 へ>> ボタンをクリックします 4. この 後 タイトル 等 を 入 力 すれば 登 録 完 了 となります(タイトルは 全 角 文 字 の 入 力 が 可 能 です) 下 記 のように ファイルが 作 成 されていれば 成 功 です テンプレート 化 しない JavaScript CSS などテキストファイルや 画 像 PDF などのバイナリ ファイルは アップロードボタン 又 は WebDAV 経 由 で 直 接 アップロードして 登 録 します 尚 FireFox 3.6 以 上 であれば HTML5 の 機 能 を 利 用 して ブラウザからファイルを 直 接 ドラ ッグ&ドロップでアップロードできます 他 のブラウザも HTML5 の 対 応 が 進 めば 可 能 になります 5

6 1-2 データの 入 力 ただ この 時 点 では ページは 作 成 されましたが データが 入 力 されていません つまり 本 文 の 無 い 空 白 のページが 作 成 されただけです では 実 際 にデータを 入 力 する 手 順 を 確 認 してみましょう 1. 先 ほどのページをクリックすると そのページのプレビューが 別 ウインドウで 表 示 されます そのプレビューの 中 で 編 集 可 能 な 領 域 には 直 接 編 集 ボタン( )が 表 示 されますので それを クリックしてください 2. HTML エディタが 起 動 し データを 入 力 する 事 が 出 来 るようになります 6

7 3. そこに データを 入 力 したら 左 上 の 保 存 して 閉 じる ボタンをクリックして 下 さい これで データの 入 力 が 完 了 です 7

8 1-3 OpenCms のページ 生 成 の 仕 組 み 次 に テンプレートと 入 力 されたデータを 組 み 合 わせて どのようにページを 生 成 しているか その 仕 組 みを 説 明 します 1. まず 先 ほど 新 規 作 成 した news0309.html には 入 力 されたデータが XML 形 式 で 保 存 されています どのようなデータが 入 っているかは コン テクストメニューから 拡 張 コント ロールコード 編 集 と 選 択 すると 確 認 でき ます 注 意 :データが 壊 れる 可 能 性 がありますので この XML は 編 集 しないで 下 さい 8

9 2. 新 規 作 成 のときに プルダウンからテンプレートを 選 択 しましたが その 時 この news0309.html のプロパティに 選 択 したテンプレートのファイルのパスがセットされます ファイルのプロパティの 確 認 したい 場 合 は コンテクストメニューから プロパティ 拡 張 とクリックします 3. プロパティには そのファイルに 属 する さまざまな 設 定 値 が 保 存 されます テンプレートのファイルのパス 情 報 は template プロパティに 保 存 されます 上 のように template プロパティには JSP ファイルへのパスが 格 納 されています これが このページを 開 いた 時 に 適 用 されるテンプレートとなります テンプレートは 全 て JSP で 作 成 されており JSP として 実 行 されます 9

10 ユーザーが news0309.html のページを 開 くと OpenCms は news0309.html の template プロパ ティを 参 照 し そこに 指 定 されている JSP ファイルを 実 行 します この JSP ファイルの 中 に news0309.html に 保 存 されている 入 力 データ(XML)を 取 り 出 して 表 示 するようなロジックが 書 かれてあれば 入 力 データを 使 って HTML が 生 成 されます 10

11 2 テンプレート(フリーテキストページ 用 )の 作 り 方 では 次 は 実 際 にテンプレートを 作 成 してみましょう 2-1 テンプレートの 置 き 場 所 テンプレートは JSP として 作 成 します 基 本 的 に OpenCms 上 のどのフォルダ 内 に 置 いても 適 用 したい html の template プロパティにパス を 指 定 すれば 動 作 します ただ ページの 新 規 作 成 ダイアログや プロパティ ダイアログで テンプレートプルダウンに 選 択 項 目 として 表 示 させたい 場 合 は テンプレートを 置 く 場 所 は 決 まってきます この 場 合 各 モジュールの templates フォルダ 内 に 置 かなければなりません 2-2 モジュールの 作 成 テンプレートを 作 成 するときは OpenCms のモジュールを 作 成 し その 中 に 置 く 事 が 一 般 的 です そ うしておく 事 で モジュール 単 位 で ZIP ファイルにエクスポートし 別 のマシンの OpenCms にインポ ートするなど 利 便 性 が 向 上 します では モジュールの 作 成 方 法 を 説 明 します 1. 上 段 の 表 示 プルダウンを エクスプローラ から 管 理 メニュー に 変 更 し 管 理 画 面 を 表 示 し ます 次 に モジュールの 管 理 をクリックし 新 しいモジュール をクリックしてください 11

12 2. 作 成 するモジュールの 情 報 を 入 力 する 画 面 が 表 示 されます データを 入 力 し OK ボタンをクリックしてください 12

13 パッケージ 名 モジュールのパッケージ 名 を 記 述 します 全 角 は 使 用 できません これは パッケージを ZIP にエクスポートした 時 のファイル 名 にも 使 用 されます 他 のモジュールと 名 前 がかぶらないようにする 為 ドメインを 逆 にした 名 前 を 使 う 事 が 一 般 的 です モジュール 名 モジュールの 名 前 です 全 角 を 使 用 できます 分 かりやすい 一 行 の 名 前 を 付 けてください モジュールの 説 明 このモジュールの 内 容 を 説 明 するテキストを 入 力 してください モジュールバージョン モジュールのバージョンです 0.1 のままで 問 題 ありません モジュールグループ モジュールのグループを 文 字 列 で 指 定 します 適 当 なものをつけてかまいません 複 数 のモジュールを 作 成 するときに 分 類 しやすくするためのラベルです アクションクラス モジュールのインポート 時 に 実 行 されるクラスを 指 定 します 通 常 は 未 入 力 で 問 題 ありません 著 者 名 このモジュールの 著 作 権 を 持 った 人 物 の 名 前 または 会 社 名 を 入 力 します 著 者 メールアドレス このモジュールの 著 者 への 連 絡 先 メールアドレスを 入 力 します モジュールフォルダー 基 本 的 に 全 てにチェックを 入 れておけば 問 題 ありません チェックを 入 れたフォルダーとその 設 定 が 自 動 的 になされます 後 からフォルダーを 作 成 する 事 は 可 能 です 13

14 3. モジュールが 作 成 できたかどうかを 確 認 します 表 示 プルダウンを エクスプローラ に 戻 して サイトプルダウンを / に 変 更 します モジュールは /system/modules/ 以 下 に 作 成 されますので 先 ほど 作 成 したモジュールのフォルダ が 存 在 するかどうか ディレクトリを 移 動 して 確 認 してください 尚 作 成 したモジュールのフォルダの 直 下 に templates フォルダが 存 在 するかと 思 いますが このフォルダ 内 がテンプレートの 置 き 場 所 となります この 下 に JSP ファイルを 作 成 していきます モジュールの templates フォルダの 中 に 作 成 した JSP ファイルは ページの 新 規 作 成 ダイアログ や プロパティ ダイアログのテンプレートプルダウンに 選 択 項 目 として 自 動 的 に 表 示 されるよ うになります 全 てのユーザーで 表 示 されるようになりますが 逆 に 特 定 のユーザーには 見 せたくないテン プレートの 場 合 は アクセス 権 限 の 設 定 で 表 示 権 限 を OFF にする 必 要 があります また templates の 下 に サイトのフォルダ 名 でサブフォルダを 作 成 すると ユーザーが その サイトを 選 んでいるときのみ 表 示 されます 例 えば./templates/default/の 下 に 置 いた JSP テンプ レートは ユーザーが/sites/default/をサイトに 選 択 している 時 のみ プルダウンに 表 示 されます これは default_bodies 直 下 に 置 くボディー ファイルも 同 様 です 14

15 4. 直 接 発 行 このモジュールを フォルダごと 直 接 発 行 してください パッケージ 名 のフォルダを 右 クリッ クして 直 接 発 行 を 行 えば 完 了 です 暫 く 待 てば 全 ての 青 字 表 示 のリソースは 黒 字 表 示 と なります 管 理 画 面 で 読 み 込 み 中 の 画 面 が 出 てきて そのまま 動 かなくなる 事 がありますが 明 らかに 遅 すぎる 場 合 は 構 わず 右 上 の 再 読 み 込 みボタンをクリックして リロードし てください 15

16 2-3 ディレクトリ 構 成 と Online Offline について ここで OpenCms のディレクトリ 構 成 について 補 足 をします サイトプルダウンを / に 変 更 すると 以 下 のようなディレクトリ 構 成 が 表 示 されます /sites/の 下 にフォルダがありますが これが 各 サイトのサイトルートになります OpenCms は 複 数 のサイトを 管 理 できますが サイトを 追 加 したい 時 は ここにフォルダを 作 成 します ( フォルダ 作 成 後 opencms-system.xml の 設 定 変 更 と Tomcat のリスタートが 必 要 です ) フォルダを 作 成 すると サイトプルダウンに 追 加 され サイトの 切 り 替 えが 出 来 るようになります デフォルトでは "/sites/default/"のみが 作 成 されており プルダウンで"/sites/default/"を 選 択 すると 左 側 のディレクトリツリーが /sites/default/ 以 下 しか 表 示 されないように 制 限 されます サイトプルダウンで"/"を 選 択 すると 左 側 のディレクトリツリーが/system/ 以 下 にもアクセスできるよ うになります ただし "/"は 管 理 者 権 限 を 付 与 されたユーザーしか 選 択 できません /system/ 以 下 は OpenCms のシステムファイルなどが 存 在 し 誤 って 消 すなどすると OpenCms が 動 かなくなってしまうので 扱 いには 注 意 が 必 要 です 16

17 テンプレートの JSP ファイルは /system/modules/*/templates/ 以 下 に 置 く 事 になるので サイトを / に 変 える 必 要 があります しかし ページ 自 体 は 各 サイトに 作 成 するので サイトプルダウン を /sites/default/ にする 必 要 があります テンプレート 開 発 中 に よく 間 違 うのですが JSP を 編 集 し サイトを / にしたままで HTML ページ のプレビューを 表 示 しようとするとエラーになります ページをプレビューするには 面 度 ですが サイトプルダウンを そのサイト("/sites/default/ )に 切 り 替 えてからプレビューする 必 要 があります 画 像 や CSS JavaScript 等 のリソースも 基 本 的 には/sites/ 以 下 のディレクトリにアップロードします 次 に Online と Offline の 関 係 について 説 明 します OpenCms は データを 保 存 する 場 所 として Online と Offline の 二 つの 領 域 が 存 在 します サイトにアクセスしてきた 訪 問 者 が 閲 覧 するページの 情 報 は 全 て Online 領 域 のデータです また OpenCms で 編 集 作 業 を 行 うと それらの 変 更 は 全 て Offline 領 域 に 保 存 されます よって OpenCms 上 でどれだけ 編 集 を 行 っても Online 領 域 つまり 公 開 されているサイトには 全 く 影 響 がありません そして 発 行 という 処 理 を 行 うと Offline 領 域 の 変 更 されたデータが Online 領 域 の 領 域 にコピー されます このとき 初 めて 公 開 サイトのページが 更 新 されます 左 上 のプロジェクト プルダウンで Online か Offline かを 選 択 できます Online に 切 り 替 えると 公 開 されているページの 情 報 のみ 表 示 され 変 更 し まだ 発 行 を 行 っていないデータは 表 示 されない 事 が 確 認 できると 思 います また Online では 一 切 の 編 集 が 出 来 なくなっているはずです 17

18 2-4 テンプレートの 作 成 テンプレートの 作 成 方 法 を 説 明 します 1. モジュールの 下 の templates フォルダ 直 下 で 新 規 ボタンをクリックし JSP ファイルを 選 択 して 下 さい 2. JSP の 新 規 作 成 ダイアログが 表 示 されます テンプレートのファイル 名 を 半 角 で 入 力 してください 拡 張 子 は JSP としてください 18

19 3. 次 にタイトルを 入 力 してください テンプレートを 選 択 するプルダウンに 表 示 されます 4. 作 成 したテンプレートをコンテクストメニューの ソースコードの 編 集 で 開 いてください 19

20 5. 開 いたら ここに HTML を 貼 り 付 けてください JSP なので HTML の 他 にも <% ~ %>で 囲 んで Java のコードを 記 述 する 事 も 可 能 です これ 以 降 は JSTL や OpenCms が 提 供 するタグライブラリを 用 いてテンプレートを 記 述 していき ます ただ その 前 に おまじないとして 以 下 の 2 行 は 追 記 するようにしてください 一 行 目 は CMS のタグライブラリを 利 用 できるようにする 為 の 記 述 で もう 一 行 は 直 接 編 集 ボタン( )を 利 用 可 能 にする 為 の 記 述 です <cms:editable/>タグは <head> ~ </head>の 中 に 記 述 してください <%@ taglib prefix="cms" uri=" %> <html xmlns=" xml:lang="ja" lang="ja"> <head> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <title>zyyx epaper</title> <meta name="keywords" content="" /> <meta name="description" content="" /> <meta http-equiv="content-style-type" content="text/css" /> <meta http-equiv="content-script-type" content="text/javascript" /> <link rel="stylesheet" type="text/css" href="../common/css/screen.css" media="all" /> <cms:editable/> </head> <body> 20

21 3 CMS タグライブラリの 基 本 的 な 使 い 方 CMS が 提 供 しているタグの 基 本 的 な 使 い 方 と テンプレートの 作 成 に 必 要 な 基 本 概 念 を 説 明 します 個 々のタグの 詳 細 な 使 い 方 は OpenCms タグリファレンス を 参 照 してください 3-1 直 接 編 集 領 域 の 指 定 [cms:include] ページ 内 に 編 集 領 域 を 作 成 する 場 合 は その 場 所 に<cms:include/>タグを 記 述 します このタグが 記 述 された 所 に 直 接 編 集 ボタンが 表 示 され HTML エディタで 編 集 できるようになります ソースコード:sample3_1.jsp taglib prefix="cms" uri=" %> <html> <head><cms:editable/></head> <body> <div> 編 集 領 域 1</div> <div><cms:include element="body1" editable="true" /></div> </body> </html> 21

22 実 行 結 果 本 文 を 入 力 していない 場 合 本 文 を 入 力 した 場 合 ( 直 接 編 集 ボタンにマウスを 乗 せると 上 のよう に 編 集 領 域 が 赤 枠 でハイライト 表 示 されます ) まれに ブラウザのキャッシュなどの 関 係 で 直 接 編 集 ボタンが 表 示 されなかったり 表 示 位 置 がずれていたりする 事 がありますが その 場 合 は ブラウザをリロードしてください Shift+スペース 又 は Ctrl+スペースで 直 接 編 集 ボタンの 表 示 非 表 示 を 切 り 替 えられます 22

23 同 一 ページ 内 に 2 つ 以 上 の 編 集 領 域 を 指 定 したい 場 合 は element 属 性 の 名 前 を 違 う 名 前 にします element 属 性 に 指 定 する 名 前 は 自 由 に 決 める 事 が 出 来 ますが 半 角 英 数 で 指 定 してください 同 じ 名 前 を 指 定 した 場 合 その 編 集 領 域 は 共 有 されます 例 えば 下 の 例 では 編 集 領 域 1と 編 集 領 域 2は 同 じ 内 容 が 表 示 され 編 集 領 域 2の 文 字 を 変 更 すると 編 集 領 域 1も 自 動 的 に 変 更 されます また editable 属 性 を false にすると 直 接 編 集 ボタンが 非 表 示 となり そのエリアからは 編 集 画 面 へ 遷 移 できなくなります ソースコード:sample3_2.jsp <%@ taglib prefix="cms" uri=" %> <html> <head><cms:editable/></head> <body> <div> 編 集 領 域 1</div> <div><cms:include element="body1" editable="true" /></div> <div> 編 集 領 域 2</div> <div><cms:include element="body2" editable="true" /></div> <div> 編 集 領 域 3</div> <div><cms:include element="body1" editable="false" /></div> </body> </html> 実 行 結 果 23

24 ヘッダーやフッターなど 複 数 のテンプレートで 共 通 となる 部 分 があるかと 思 います その 場 合 共 通 部 分 のみを 別 のテンプレートにして 共 有 する 事 が 可 能 です ソースコード:header.jsp taglib prefix="cms" uri=" %> <!-- header start --> <div id= header > <p>ここは ヘッダーの 領 域 です </p> </div> <!-- header end --> ソースコード:sample3_3.jsp taglib prefix="cms" uri=" %> <html> <head><cms:editable/></head> <body> <cms:include file="header.jsp" /> <div> 編 集 領 域 1</div> <div><cms:include element="body1" editable="true" /></div> </body> </html> 実 行 結 果 24

25 外 部 ファイル 化 したテンプレートのインクルードの 場 合 は element 属 性 を 指 定 する 必 要 はありません 注 意 点 として 上 記 の 例 では header.jsp も sample3.jsp と 同 じ 階 層 に 作 成 しました つまり モジュールの templates ディレクトリに header.jsp を 置 いた 事 になります この 場 合 ページの 新 規 作 成 ダイアログなどでテンプレートを 選 択 するプルダウンに header.jsp も 選 択 可 能 なテンプレートとして 表 示 されてしまいます HTML の 部 品 として 外 部 化 した JSP は 通 常 テンプレート 選 択 プルダウンに 表 示 させる 必 要 が 無 い ため 別 のディレクトリに 置 くことが 望 ましいです 一 般 的 には モジュールフォルダの 下 に elements フォルダを 作 成 し そこに 外 部 ファイルを 置 きます header.jsp の 移 動 に 合 わせて テンプレートのインクルード 先 のパスも 変 更 します ソースコード:sample3_4.jsp taglib prefix="cms" uri=" %> <html> <head><cms:editable/></head> <body> <cms:include file="../elements/header.jsp" /> <div> 編 集 領 域 1</div> <div><cms:include element="body1" editable="true" /></div> </body> </html> 25

26 次 に テンプレートの 外 部 化 と 似 た 機 能 として 別 のページの 編 集 領 域 で 入 力 されたデータをインクル ードする 事 が 出 来 ます ソースコード:sample3_5.jsp taglib prefix="cms" uri=" %> <html> <head><cms:editable/></head> <body> <div>/news0309.html の 編 集 領 域 body1</div> <cms:include element="body1" file="/news0309.html" editable="true" /> <div> 編 集 領 域 1</div> <div><cms:include element="body1" editable="true" /></div> </body> </html> sample4.jsp を 適 用 して 作 成 された html ページは 全 て news0309.html で 入 力 したデータが 上 部 に 表 示 されるようになります news0309.html を 編 集 すると 全 てのページの 上 部 も 変 更 されます 2 つ 目 の<cms:include/>タグは file 属 性 の 指 定 が 無 いので その html ページそのものの body1 を 表 示 します 先 ほどのテンプレートの 外 部 化 とは 違 い file 属 性 に 指 定 するのは jsp ファイルではなく html です テンプレートが 適 用 され 作 成 されたページのパスを 指 定 します また element 属 性 の 指 定 は 必 須 と なります 26

27 3-2 リンクの 指 定 方 法 (ディレクトリ 階 層 が 合 わない 場 合 ) [cms:link] テンプレート 内 の 画 像 や CSS JavaScript ファイルのパス リンク 先 の URL は 相 対 パスで 記 述 す るようにしてください OpenCms は 実 際 に 公 開 される 時 の URL と プレビューする 時 の URL は 違 います よって 絶 対 パスで 指 定 してしまうと プレビューの 時 は 表 示 されるが 公 開 するとレイアウ トが 崩 れる 又 は その 逆 が 起 こってしまいます しかし さまざまな 階 層 で 使 用 されるテンプレートの 場 合 相 対 パスで 記 述 する 事 が 出 来 ないかと 思 います 例 えば CSS や 画 像 などはどの 階 層 のページからも 共 通 で 使 用 されます また 全 てのページ で 利 用 されるヘッダーを 以 下 のように 相 対 パスにしてしまうと /index.html で 正 常 に 表 示 されたとし ても /news/index.html では 画 像 がリンク 切 れになってしまうと 思 います(/news/images/logo.gif を 参 照 してしまう 為 ) ソースコード:header.jsp <%@ taglib prefix="cms" uri=" %> <!-- header start --> <div id= header > <img src="./images/logo.gif" alt="ヘッダーのロゴ 画 像 "> </div> <!-- header end --> このような 場 合 は 以 下 のように サイトルートからの 絶 対 パスを 指 定 した 上 で <cms:link/>タグ で 囲 みます こうしておけば OpenCms がリンクの 階 層 を 自 動 的 に 判 断 し 変 換 するようになります ソースコード:header.jsp <%@ taglib prefix="cms" uri=" %> <!-- header start --> <div id= header > <img src="<cms:link>/images/logo.gif</cms:link>" alt="ヘッダーのロゴ 画 像 "> </div> <!-- header end --> 尚 この<cms:link/>は 絶 対 パスにしなければいけない 箇 所 のみに 記 述 するようにした 方 が 良 いでし ょう 必 要 の 無 いところまで<cms:link/>タグを 多 用 すると 修 正 箇 所 も 多 くなるのは 勿 論 ページの 表 示 も 遅 くなってしまいます 相 対 パスで 問 題 ない 箇 所 は 相 対 パスのまま 記 述 しておいて 下 さい 27

28 3-3 表 示 非 表 示 の 制 御 [cms:offline/online/block] テンプレートはさまざまなページで 使 用 されますが 特 定 のページにはこの 部 分 を 表 示 したくないと か 逆 に 特 定 のページのみ 表 示 したいものがある 場 合 <cms:block/>タグを 使 用 します 表 示 非 表 示 を 制 御 したい 部 分 をこのタグで 囲 み path 属 性 に 表 示 を 許 可 するパターンを 記 述 します path 属 性 には 正 規 表 現 も 記 述 する 事 が 出 来 ます また カンマ 区 切 りで 複 数 指 定 する 事 も 出 来 ます ソースコード:sample3_6.jsp taglib prefix="cms" uri=" %> <html> <head><cms:editable/></head> <body> <cms:block path="/index.html"> この 部 分 は /index.html の 時 のみ 表 示 されます <br/> </cms:block> <cms:block path="/news/.*.html"> この 部 分 は /news/ 以 下 で 拡 張 子 が html のページの 時 のみ 表 示 されます <br/> </cms:block> <cms:block path="/index.html, /news/.*"> この 部 分 は /index.html の 時 又 は /news/ 以 下 のページの 時 のみ 表 示 されます <br/> </cms:block> </body> </html> 28

29 また プレビューの 時 のみ 表 示 させたい 場 合 は <cms:offline/>タグを 逆 に 公 開 の 時 のみ 表 示 さ せたい 場 合 は <cms:online/>タグを 使 用 します これらのタグも<cms:block/>タグと 同 様 path 属 性 で 条 件 を 記 述 する 事 が 出 来 ます ソースコード:sample3_7.jsp taglib prefix="cms" uri=" %> <html> <head><cms:editable/></head> <body> <cms:offline> この 部 分 は プレビューの 時 のみ 表 示 され 公 開 された 時 には 表 示 されません <br/> </cms:offline> <cms:online> この 部 分 は 公 開 された 時 のみ 表 示 され プレビューの 時 には 表 示 されません <br/> </cms:online> <cms:offline path="/index.html"> この 部 分 は /index.html のページで 且 つ プレビューの 時 のみ 表 示 されます <br/> </cms:offline> </body> </html> 29

30 3-4 プロパティ 値 の 表 示 [cms:property] html ページには さまざまなプロパティをセットできます 代 表 的 なものは Title プロパティや Keywords プロパティ Description プロパティなどです これらは コンテクストメニューの プロパティ で 設 定 できる 値 です ( 管 理 画 面 から 適 当 なプロパティ 名 で 追 加 する 事 も 可 能 です ) ここで 入 力 された 値 を 表 示 する 時 は <cms:property/>タグを 使 用 します name 属 性 に 表 示 させたいプロパティの 名 前 を 指 定 します ソースコード:sample3_8.jsp <%@ taglib prefix="cms" uri=" %> <html xmlns=" xml:lang="ja" lang="ja"> <head> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <title><cms:property name="title"/></title> <meta name="keywords" content="<cms:property name="keywords"/>" /> <meta name="description" content="<cms:property name="description"/>" /> </head> 30

31 file 属 性 にパスを 指 定 すると そのファイルのプロパティ 値 を 表 示 します <!-- 常 に/index.html の Title プロパティを 表 示 します --> <title><cms:property name="title" file="/index.html"/></title> file 属 性 に 以 下 の 値 を 指 定 すると プロパティ 値 の 取 得 方 法 が 変 わります search その HTML ファイルのプロパティに 値 が 無 かった 場 合 親 フォルダのプロパ ティを 再 帰 的 に 検 索 し 表 示 します 親 のフォルダのプロパティ 値 に 値 をセットしておけば それ 以 下 のページ 全 てに 表 示 させる 事 が 出 来 るので 非 常 に 便 利 です element.uri その HTML のプロパティ 値 ではなく 適 用 されているテンプレートのプロパ ティ 値 を 表 示 します テンプレート 単 位 で 共 通 となる 値 であれば こちらを 使 用 しようします 親 フォルダは 検 索 しに 行 きません search.element.uri element.uri の 親 フォルダの 再 帰 検 索 版 です <!-- 該 当 ページの Title プロパティが 未 設 定 の 場 合 は 親 フォルダの Title プロパティ 値 を 表 示 します --> <title><cms:property name="title" file="search"/></title> escapehtml 属 性 に true を 指 定 すると タグをエスケープして 表 示 します <!-- タグが 入 力 されていても 無 効 となります --> <title><cms:property name="title" escapehtml="true"/></title> plaintext 属 性 に true を 指 定 すると タグを 除 去 して 表 示 します <!-- タグが 入 力 されていても 無 効 となり 表 示 もされません --> <title><cms:property name="title" plaintext="true"/></title> default 属 性 に 文 字 列 を 指 定 すると 該 当 のプロパティに 値 が 無 かった 時 代 わりに 表 示 します <! Title プロパティが 未 入 力 の 場 合 は "サンプルページ"と 表 示 されます --> <title><cms:property name="title" default="サンプルページ "/></title> 31

32 3-5 リンク URL のコントロール [cms:editable] <cms:link/>タグで 囲 んだリンクや HTML エディタで 入 力 したリンクに 関 しては <cms:editable/>タグ である 程 度 のコントロールが 可 能 です 例 えば absolutelink 属 性 を true にすると online( 公 開 され た) 側 でのリンクが 相 対 パスではなく サイトルートからの 絶 対 パスで 出 力 されるようになります ソースコード:sample3_9.jsp taglib prefix="cms" uri=" %> <!--../../common/css/screen.css ではなく /common/css/screen.css と HTML 出 力 したい 場 合 --> <html> <head> <cms:editable absolutelink="true"/> <link rel="stylesheet" type="text/css" href="<cms:link>/common/css/screen.css</cms:link>" /> </head> また linkprefix 属 性 に 文 字 列 を 指 定 すると 出 力 されるリンクの 前 にこの 文 字 が 追 加 され 逆 に linkprefixcut 属 性 に 文 字 列 を 指 定 すると その 文 字 から 始 まるリンクであった 場 合 その 文 字 を 削 除 したリンクが 出 力 されます ソースコード:sample3_10.jsp taglib prefix="cms" uri=" %> <!-- /opencms/common/css/screen.css と 出 力 される 場 合 linkprefixcut 属 性 に"/opencms"と 指 定 する と 出 力 される HTML は /common/css/screen.css になる さらに linkprefix 属 性 に"/jp"と 指 定 しているので 最 終 的 に 出 力 される HTML は /jp/common/css/screen.css となる --> <html> <head> <cms:editable absolutelink="true" linkprefixcut="/opencms" linkprefix="/jp" /> <link rel="stylesheet" type="text/css" href="<cms:link>/common/css/screen.css</cms:link>" /> </head> Apache のリライトなどで OpenCms のサイトの 構 成 と 実 際 の URL 構 成 が 違 う 場 合 に これらの 属 性 を 指 定 して 調 整 します 尚 linkprefix 属 性 と linkprefixcut 属 性 は absolutelink 属 性 が true のときのみ 有 効 です これらの 属 性 は online( 公 開 された) 側 でのみ 有 効 ですが offline(opencms 上 でのプレビュー) でも 変 換 されるようにしたい 場 合 は linkoffline 属 性 に true をセットします 32

33 4 スクリプレットの 記 述 OpenCms のテンプレートは JSP なので <% ~ %>の 中 で Java のコードを 記 述 する 事 が 出 来 ます その 場 合 でも CMS のタグライブラリと 同 等 の 機 能 を 利 用 する 事 が 可 能 です 4-1 CmsJspActionElement クラスの 利 用 タグライブラリの 一 部 の 機 能 は CmsJspActionElement クラスが 提 供 します ソースコード:sample4_1.jsp <%@ page import="jp.zyyx.opencms.jsp.cmsjspactionelement, org.opencms.jsp.*" %> <% // インスタンスを 生 成 します CmsJspActionElement jsp = new CmsJspActionElement(pageContext, request, response); // index.html の"body"エレメントの 入 力 値 を 取 得 します String content = jsp.getcontent("/index.html", "body1", java.util.locale.japan); // user タグと 同 じ 機 能 です 引 数 で 指 定 したプロパティ 名 に 対 応 する 値 を 取 得 します // 下 の 例 の 場 合 ログインユーザーの 名 前 を 取 得 しています String username = jsp.user("firstname"); // property タグと 同 じ 機 能 です 引 数 でプロパティ 名 を 指 定 すると 対 応 する 値 がかえってきます // 検 索 方 法 や 読 み 込 み 対 象 のリソースファイルを 直 接 指 定 することも 出 来 ます // プロパティの 値 が 空 だったときに 代 わりに 表 示 するデフォルト 文 字 や // タグをエスケープするかどうかも 指 定 できます String title1 = jsp.property("title"); String title2 = jsp.property("title", "search"); String title3 = jsp.property("title", "search", " 無 題 "); String title4 = jsp.property("title", "search", " 無 題 ", true); // link タグと 同 じ 機 能 です String link = jsp.link("/sites/default/index.html"); // label タグと 同 じ 機 能 です String label = jsp.label("flex.cache.label.title"); 33

34 // <cms:editable />を 記 述 した 事 と 同 じです 直 接 編 集 が 可 能 なテンプレートになります jsp.editable(true); // include タグと 同 じ 機 能 です 指 定 したファイルをインクルードします // また エレメント 名 を 指 定 すると 一 部 分 のみインクルードします // jsp.editable(true) が 指 定 されていれば 第 三 引 数 に true を 入 れると 直 接 編 集 できるようになります jsp.include("header.jsp"); jsp.include("/index.html", "body1"); jsp.include("header.jsp", null, true); // パラメータを 渡 す 場 合 は 以 下 のようにします java.util.hashmap parameters = new java.util.hashmap(); parameters.put(" locale", java.util.locale.japan); parameters.put(" navpart", "toprow"); jsp.include("header.jsp", null, parameters); // template タグと 同 様 の 事 をしたい 場 合 は 以 下 のようにします if (jsp.template("head")) { %> <!-- header start --> <div id= header > <p>ここは ヘッダーの 領 域 です </p> </div> <!-- header end --> <% } // info タグと 同 じ 機 能 です String version = jsp.info(".opencms..version"); %> 34

35 4-2 CmsRequestContext クラスの 利 用 現 在 のリクエストやページの 状 態 を 取 得 するには CmsRequestContext クラスを 使 用 します ソースコード:sample4_2.jsp page import=" jp.zyyx.opencms.jsp.cmsjspactionelement, org.opencms.jsp.*, org.opencms.file.*" %><pre><% // インスタンスを 生 成 します CmsJspActionElement jsp = new CmsJspActionElement(pageContext, request, response); CmsRequestContext ctx = jsp.getrequestcontext(); // 現 在 のページのパス(/news/index.html)を 取 得 します out.println(ctx.geturi()); // 現 在 のページのディレクトリパス(/news/)を 取 得 します out.println(ctx.getfolderuri()); // 現 在 ページにアクセスしているユーザーの 情 報 を 取 得 します out.println(ctx.currentuser().getname()); out.println(ctx.currentuser().getlastname()); out.println(ctx.currentuser().getfirstname()); out.println(ctx.currentuser().get ()); // 現 在 のプロジェクト 名 (Offline/Online)を 取 得 します out.println(ctx.currentproject().getname()); // 現 在 のプレビュー 日 時 を UNIX TIME( 単 位 はミリ 秒 )で 取 得 します out.println(ctx.getrequesttime()); // 現 在 のサイトルートのパス(/sites/default)を 取 得 します out.println(ctx.getsiteroot()); 35

36 // 現 在 ページにアクセスしているユーザーの IP アドレスを 取 得 します out.println(ctx.getremoteaddress()); // 現 在 のページのエンコードを 取 得 します out.println(ctx.getencoding()); // 現 在 のページのロケールを 取 得 します out.println(ctx.getlocale()); %> </pre> 36

37 4-3 CmsObject クラスの 利 用 ファイルの 一 覧 を 取 得 したり 登 録 されているユーザーやグループの 情 報 にアクセスするには CmsObject クラスを 使 用 します ソースコード:sample4_3.jsp page import="jp.zyyx.opencms.jsp.cmsjspactionelement, org.opencms.jsp.*, org.opencms.file.*, java.util.*" %><pre><% // インスタンスを 生 成 します CmsJspActionElement jsp = new CmsJspActionElement(pageContext, request, response); CmsObject cms = jsp.getcmsobject(); CmsResourceFilter filter = CmsResourceFilter.DEFAULT; // ファイルやフォルダが 存 在 するかどうかチェックします out.println(cms.existsresource("/news/index.html")); // 指 定 したファイルやフォルダのオブジェクトを 取 得 します CmsResource res1 = cms.readresource("/index.html"); out.println("res1:" + res1.getrootpath()); // 指 定 したフォルダ 直 下 にあるファイルやフォルダを 取 得 します // 第 三 引 数 を true にすると サブフォルダも 再 帰 的 に 取 得 します(デフォルト) List<CmsResource> list1 = cms.readresources("/news/", filter, false); for(cmsresource res : list1) { out.println("list1:" + res.getrootpath()); } // 指 定 したフォルダの 内 にあるファイルやフォルダを 再 帰 的 に 取 得 します // ただし 第 二 引 数 で 指 定 したプロパティ 値 が 第 三 引 数 の 値 と 一 致 するもののみ 取 得 します // 第 三 引 数 が null の 場 合 第 二 引 数 で 指 定 したプロパティが 未 入 力 でないものを 取 得 します List<CmsResource> list2 = cms.readresourceswithproperty("/news/", "Title", null, filter); for(cmsresource res : list2) { out.println("list2:" + res.getrootpath()); } %></pre> 37

38 4-4 CmsResourceFilter クラスの 利 用 一 覧 を 取 得 する 時 に CmsResourceFilter オブジェクトを 引 数 に 渡 しています このクラスは 検 索 条 件 を 支 持 するためのもので デフォルトでは 以 下 のものが 用 意 されています CmsResourceFilter.ALL 全 てのリソースを 取 得 するフィルターです 削 除 状 態 のリソース( 斜 線 表 示 されているリソース)を 含 みます 公 開 期 間 が 対 象 外 のリソースも 含 みます アクセス 権 限 の 設 定 で 表 示 が 拒 否 になっているリソースも 含 みます CmsResourceFilter.MODIFIED 変 更 されたリソースを 全 て 取 得 するフィルターです 変 更 されたリソースとは ステータスが 新 規 変 更 あり 削 除 の 何 れか つまり エクスプローラビュー 上 で ファイル 名 が 斜 線 表 示 または 黒 字 ではなく 青 字 や 赤 字 で 表 示 されているリソースです 青 字 や 赤 字 のリソースは 発 行 を 行 う 事 で 変 更 なし になります CmsResourceFilter.DEFAULT sourcefilter.default 標 準 的 な 条 件 のフィルターです 削 除 状 態 のリソースは 含 みません 公 開 期 間 が 対 象 外 のリソースは 含 みません アクセス 権 限 の 設 定 で 表 示 が 拒 否 になっているリソースも 含 みます CmsResourceFilter.DEFAULT_FILES CmsResourceFilter.DEFAULT とほぼ 同 様 ですが このフィルターは フォルダは 対 象 外 となり ファ イルのみを 取 得 します CmsResourceFilter.DEFAULT_FOLDERS CmsResourceFilter.DEFAULT とほぼ 同 様 ですが このフィルターは ファイルは 対 象 外 となり フォ ルダのみを 取 得 します CmsResourceFilter.IGNORE_EXPIRATION 公 開 期 間 のチェックを 無 視 するフィルターです 削 除 状 態 のリソースは 含 みません 公 開 期 間 が 対 象 外 のリソースも 含 みます アクセス 権 限 の 設 定 で 表 示 が 拒 否 になっているリソースも 含 みます 38

39 CmsResourceFilter.ONLY_VISIBLE 表 示 可 能 なリソースのみ 取 得 するフィルターです 削 除 状 態 のリソースは 含 みます 公 開 期 間 が 対 象 外 のリソースも 含 みます アクセス 権 限 の 設 定 で 表 示 が 拒 否 になっているリソースも 含 みません CmsResourceFilter.ONLY_VISIBLE_NO_DELETED 表 示 可 能 で 削 除 状 態 でないリソースを 取 得 するフィルターです 削 除 状 態 のリソースは 含 みません 公 開 期 間 が 対 象 外 のリソースも 含 みます アクセス 権 限 の 設 定 で 表 示 が 拒 否 になっているリソースも 含 みません また 上 記 の 用 意 されているフィルター 以 外 にも 自 分 で 条 件 をセットして 使 用 することが 出 来 ます ソースコード:sample4_4.jsp page import=" jp.zyyx.opencms.jsp.cmsjspactionelement, org.opencms.db.cmsresourcestate, org.opencms.file.types.*, org.opencms.jsp.*, org.opencms.file.*, java.util.*" %><pre><% // インスタンスを 生 成 します CmsJspActionElement jsp = new CmsJspActionElement(pageContext, request, response); CmsObject cms = jsp.getcmsobject(); // デフォルトのフィルター CmsResourceFilter filter = CmsResourceFilter.DEFAULT; // デフォルトの 検 索 条 件 にリソースのステータスを 追 加 // 新 規 作 成 されたリソースのみ 取 得 する CmsResourceFilter filter1 = filter.addrequirestate(cmsresourcestate.state_new); // デフォルトの 検 索 条 件 に 公 開 日 が 本 日 以 降 という 条 件 を 追 加 CmsResourceFilter filter2 = filter.addrequirereleaseafter((new Date()).getTime()); 39

40 // デフォルトの 検 索 条 件 から 公 開 期 間 の 制 限 を 除 去 CmsResourceFilter filter3 = filter.addexcludetimerange(); // デフォルトの 検 索 条 件 にリソースタイプを 追 加 画 像 ファイルのみ 取 得 する CmsResourceFilter filter4 = filter.addexcludetype(cmsresourcetypeimage.getstatictypeid()); // デフォルトの 検 索 条 件 にファイルのみ 取 得 する 条 件 を 追 加 CmsResourceFilter filter5 = filter.addrequirefile(); // デフォルトの 検 索 条 件 にフォルダのみ 取 得 する 条 件 を 追 加 CmsResourceFilter filter6 = filter.addrequirefolder(); %></pre> 取 得 したリソースの List 内 をソートする 場 合 は Collection クラスを 使 用 します 40

41 4-5 CmsResource クラスの 利 用 ファイルやフォルダの 情 報 は CmsResource オブジェクトとして 返 されます CmsResource オブジェクトから そのリソースの 情 報 を 取 得 する 事 が 出 来 ます ソースコード:sample4_5.jsp page import="jp.zyyx.opencms.jsp.cmsjspactionelement, org.opencms.file.*" %> <pre><% // インスタンスを 生 成 します CmsJspActionElement jsp = new CmsJspActionElement(pageContext, request, response); CmsRequestContext ctx = jsp.getrequestcontext(); CmsObject cms = jsp.getcmsobject(); CmsResource res = cms.readresource("/index.html"); // リソースの 完 全 なパスを 取 得 します out.println(res.getrootpath()); // リソースのサイトルートからのパスを 取 得 します out.println(ctx.removesiteroot(res.getrootpath())); // リソースのファイル 名 を 取 得 します out.println(res.getname()); out.println(cmsresource.getname(res.getrootpath())); // リソースの 親 フォルダのパスを 取 得 します out.println(cmsresource.getparentfolder(res.getrootpath())); // リソースのディレクトリ 階 層 を 数 値 で 取 得 します out.println(cmsresource.getpathlevel(res.getrootpath())); // リソースがファイルであれば true を 返 します out.println(res.isfile()); // リソースがフォルダであれば true を 返 します out.println(res.isfolder()); 41

42 // リソースの 作 成 日 を UNIX TIME( 単 位 はミリ 秒 )で 取 得 します out.println(res.getdatecreated()); // リソースの 作 成 者 の ID を 取 得 します out.println(res.getusercreated()); // リソースの 最 終 更 新 日 を UNIX TIME( 単 位 はミリ 秒 )で 取 得 します out.println(res.getdatelastmodified()); // リソースの 最 終 更 新 者 の ID を 取 得 します out.println(res.getuserlastmodified()); // リソースの 公 開 日 を UNIX TIME( 単 位 はミリ 秒 )で 取 得 します out.println(res.getdatereleased()); // リソースの 公 開 期 限 を UNIX TIME( 単 位 はミリ 秒 )で 取 得 します out.println(res.getdateexpired()); // リソースの ID を 取 得 します out.println(res.getresourceid()); // リソースタイプの ID を 取 得 します out.println(res.gettypeid()); // リソースのステータスを 取 得 します // 0: 変 更 なし 1: 変 更 あり 2: 新 規 3: 削 除 out.println(res.getstate()); %></pre> 42

43 4-6 JSTL と 式 言 語 の 利 用 OpenCms のテンプレートでは JSTL や 式 言 語 が 使 用 できます スクリプレットの 量 が 減 り HTML の 可 読 性 も 向 上 するので 積 極 的 に 利 用 してください 式 言 語 を 利 用 すると ページ リクエスト セッションのスコープに 変 数 がセットされて 入 れば ${ 変 数 名 }という 形 式 で 表 示 させる 事 が 出 来 ます また セットされている 変 数 が クラスのオブジェクトの 場 合 アクセサメソッドの 利 用 も 出 来 ます JSTL は 標 準 的 なタグライブラリです 使 用 するには taglib の 宣 言 を 行 ってください ソースコード:sample4_6.jsp page import="jp.zyyx.opencms.jsp.cmsjspactionelement,org.opencms.file.*" %> taglib prefix="c" uri=" %> <% CmsJspActionElement jsp = new CmsJspActionElement(pageContext, request, response); CmsObject cms = jsp.getcmsobject(); // オブジェクトを request スコープの 変 数 にセットする request.setattribute("ctx", cms.getrequestcontext()); request.setattribute("list1", cms.readresources("/news/",cmsresourcefilter.default)); %> <p>ページ URL:${ctx.uri}</p> <c:foreach items="${list1}" var="res"> ${res.rootpath}<br> </c:foreach> 43

44 4-7 SQL を 実 行 して 結 果 を 表 示 する DB へ 接 続 し SQL を 実 行 する 場 合 でも JSTL なら 簡 単 に 出 来 ます ソースコード:sample4_7.jsp page import="org.opencms.main.*,java.util.*" %> taglib prefix="c" uri=" %> taglib prefix="sql" uri=" <% // 設 定 ファイル(/WEB-INF/config/opencms.properties)の Map オブジェクトを conf 変 数 にセット request.setattribute("conf", OpenCmsCoreAccess.getConfiguration()); %> <! データソースの 定 義 式 言 語 で 接 続 先 データベースの 情 報 を 取 得 してセットする --> <sql:setdatasource var="db" driver = "${conf['db.pool.default.jdbcdriver']}" url = "${conf['db.pool.default.jdbcurl']}${conf['db.pool.default.jdbcurl.params']}" user = "${conf['db.pool.default.user']}" password = "${conf['db.pool.default.password']}" /> <!-- SQL を 実 行 --> <sql:query var="rs" datasource="${db}" > SELECT * FROM CMS_OFFLINE_PROPERTYDEF </sql:query> <!-- JSTL のタグを 使 用 して DB から 取 得 したデータを 表 示 --> <c:foreach var="rec" items="${rs.rows}" > <c:out value="${rec.propertydef_name}" /> (<c:out value="${rec.propertydef_id}" />)<br/> </c:foreach> 44

45 5 テンプレート( 構 造 化 コンテンツ 用 )の 作 り 方 5-1 構 造 化 コンテンツ(XML Content)とは 先 ほどまでのフリーテキストページは 編 集 領 域 を 指 定 し そこに HTML エディタでデータ 入 力 で きるようにするものでした HTML エディタは フリーフォーマットであり どんなレイアウトも 自 由 に 登 録 できます これに 対 して 構 造 化 コンテンツとは 入 力 フォームを 細 かく 定 義 し 入 力 できるデ ータの 形 式 を 制 限 します 構 造 化 コンテンツの 作 成 は 以 下 の 手 順 で 行 います 1. XSD を 作 成 します( 入 力 フォームは XSD と 呼 ばれる XML ファイルで 定 義 します) 2. それに 対 応 するテンプレートを JSP で 作 成 します 3. XSD と JSP テンプレートのセットを 新 しいリソースタイプとして 登 録 します リソースタイプとは フォルダーやテキストファイル JSP フリーテキストページといったファイ ルやフォルダの 種 類 の 事 で 新 たなリソースタイプとして 登 録 しておくと ページの 新 規 登 録 時 に そ のリソースタイプを 選 択 できるようになります XSD を 作 成 するたびに リソースタイプを 追 加 してい く 必 要 があります 45

46 5-2 XSD の 作 成 最 初 に XSD を 作 成 します XSD はモジュールフォルダの schemas フォルダ 内 に 置 くのが 一 般 的 です まず モジュールフォルダの 直 下 に schemas フォルダを 作 成 してください schemas フォルダ 内 に 移 動 して 新 規 ボタンをクリックしてください 新 規 ダイアログが 表 示 されますので テキストファイル を 選 択 し 次 へ>> をクリックしてくだ さい 46

47 XSD ファイルの 名 前 を 入 力 します ここでは sample.xsd と 入 力 します 作 成 された sample.xsd のコンテクストメニューから ソースコード 編 集 を 選 択 し sample.xsd を 編 集 してください 47

48 sample.xsd を 以 下 のように 記 述 します 黒 字 のところは どのような XSD でも 共 通 です ソースコード:sample.xsd <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:include schemalocation="opencms://opencms-xmlcontent.xsd"/> <xsd:element name="samples" type="opencmssamples"/> <xsd:complextype name="opencmssamples"> <xsd:sequence> <xsd:element name="sample" type="opencmssample" minoccurs="0" maxoccurs="unbounded"/> </xsd:sequence> </xsd:complextype> <xsd:complextype name="opencmssample"> <xsd:sequence> <xsd:element name="date" type="opencmsdatetime" /> <xsd:element name="title" type="opencmsstring" /> <xsd:element name="subtitle" type="opencmsstring" /> <xsd:element name="body" type="opencmshtml" /> <xsd:element name="url" type="opencmsstring" /> </xsd:sequence> <xsd:attribute name="language" type="opencmslocale" use="required"/> </xsd:complextype> </xsd:schema> まず このリソースタイプの 名 前 を 半 角 英 数 で 決 めます この 例 の 場 合 は Sample です 3 行 目 の name 属 性 には リソースタイプの 名 前 の 最 後 に s を 追 加 した 名 前 を 指 定 します そして type 属 性 には name 属 性 の 名 前 の 前 に OpenCms を 付 与 した 名 前 を 指 定 します 5 行 目 の name 属 性 には 3 行 目 の type 属 性 と 同 じ 値 を 指 定 します 7 行 目 の name 属 性 には リソースタイプの 名 前 を type 属 性 には name 属 性 の 名 前 の 前 に OpenCms を 付 与 した 名 前 を 指 定 します 11 行 目 の name 属 性 には 7 行 目 の type 属 性 と 同 じ 値 を 指 定 します <xsd:sequence> ~ </xsd:sequence> の 間 (13 行 目 ~17 行 目 )までが 入 力 フォームの 定 義 です 入 力 フォームは <xsd:element>で 指 定 し name 属 性 に その 項 目 の 名 前 を 半 角 英 数 の 適 当 な 文 字 列 で 指 定 します そして type 属 性 にデータの 種 類 を 指 定 します 48

49 入 力 可 能 なデータの 種 類 には 以 下 のものがあります データタイプ OpenCmsBoolean OpenCmsColor OpenCmsDateTime OpenCmsHtml OpenCmsLocale OpenCmsString OpenCmsVfsFile OpenCmsVfsImage 説 明 真 偽 値 を 表 す"true"または "false"のデータが 入 ります それ 以 外 は 入 りません 未 入 力 の 場 合 は "false"がセットされます "#RRGGBB"といった 色 情 報 を 表 す 形 式 の 文 字 列 のみが 入 ります 日 付 をあらわすデータが 入 ります 登 録 されるデータは UNIX TIME 形 式 (long 値 )のみです 単 位 はミリ 秒 ですので 通 常 の UNIX TIME の 値 が 1000 倍 されたデ ータで 保 持 されます 文 字 列 であれば 何 でも 入 ります "ja" や "en" といったロケールを 示 す 文 字 のみが 入 ります 文 字 列 であれば 何 でも 入 ります リソースのパスを 表 す 文 字 列 のみが 入 ります また OpenCms 上 に 存 在 しないリソースを 指 定 するとエラーとなり 保 存 できません よって 外 部 のファイルを 指 定 し たい 場 合 は OpenCmsString を 使 用 する 必 要 があります ファイルのパスだけではなく リソースの ID まで 保 持 するので 参 照 先 のリソースが 移 動 されたりリネームされたとしても 自 動 的 にパ スが 修 正 され リンク 切 れにはなりません OpenCmsVfsFile とほぼ 同 様 ですが 画 像 をサムネイル 化 した 場 合 は その 縦 横 のサイズ 情 報 や クリッピングした 時 の 座 標 情 報 など も 保 持 します 画 像 の 情 報 を 保 持 するためのデータタイプですが 画 像 以 外 のファイ ルを 指 定 したとしてもエラーとなるわけではありません データタイプを 指 定 すると それに 対 応 した 入 力 フォームが 適 用 されます 例 えば OpenCmsHtml であれば HTML エディタが OpenCmsDateTime であれば テキストフィ ールド + カレンダーが 適 用 されます 49

50 5-3 テンプレート JSP の 作 成 次 は テンプレートを 作 成 します ただ このテンプレートは 構 造 化 コンテンツ 用 であり フリーテ キストページで 使 用 するテンプレートではありません フリーテキストページの 新 規 作 成 画 面 で テン プレートプルダウンの 選 択 項 目 に この JSP が 表 示 されると 紛 らわしくなります よって モジュール フォルダ 直 下 の templates フォルダではなく elements フォルダ 内 に JSP を 作 成 します ソースコード:sample5_1.jsp taglib prefix="cms" uri=" %> <html> <head><cms:editable/></head> <body> <cms:contentload collector="singlefile" param="%(opencms.uri)" editable="true"> <div>date:<cms:contentshow element="date" /></div> <div>title:<cms:contentshow element="title" /></div> <div>subtitle:<cms:contentshow element="subtitle" /></div> <div>body:<cms:contentshow element="body" /></div> <div>url:<cms:contentshow element="url" /></div> </cms:contentload> </body> </html> 構 造 化 コンテンツで 入 力 されたデータは <cms:contentload/>タグで 囲 まれた 領 域 内 でのみ 表 示 が 可 能 になります そして データを 表 示 するには <cms:contentshow/>タグを 使 用 します このタグの element 属 性 に 項 目 名 を 指 定 すると 該 当 する 項 目 の 入 力 データが 表 示 されます 作 成 できたら sample.xsd と sample5_1.jsp を 直 接 発 行 して 下 さい schemas フォルダが まだ 直 接 発 行 されていなければ 直 接 発 行 してください 親 フォルダが 新 規 ( 青 字 )の 状 態 で そのフォルダの 下 のファイルだけ 直 接 発 行 しようとすると エラーとなり 失 敗 します Offline ではプレビューできたのに Online でプレビューするとエラーになる 場 合 は JSP テンプレートを 発 行 したかどうか 確 認 して 下 さい 50

51 5-4 リソースタイプの 追 加 先 ほど 作 成 した XSD と JSP テンプレートのペアを 使 って 新 しいリソースタイプを 追 加 します この 作 業 は ブラウザ 上 では 出 来 ません まず サーバー 上 の 設 定 ファイル./WEB-INF/config/opencms-modules.xml を 開 いてください そして XSD を 配 置 したモジュールを 定 義 している 箇 所 を 探 し 出 してください jp.zyyx.opencms.sample なので <name>jp.zyyx.opencms.sample</name>の 記 述 がある 箇 所 を 検 索 す れば 見 つかります そこに 以 下 の 赤 字 と 緑 字 の 部 分 を 追 記 して 保 存 してください 設 定 ファイル:opencms-modules.xml <module> <name>jp.zyyx.opencms.sample</name> <nicename><![cdata[サンプルモジュール]]></nicename> <group>zyyx</group> <class/> <description><![cdata[サンプルのテンプレートを 含 んだモジュールです ]]></description> <version>0.1</version> <authorname><![cdata[zyyx Inc.]]></authorname> <datecreated/> <userinstalled/> <dateinstalled/> <dependencies/> <exportpoints> <exportpoint uri="/system/modules/jp.zyyx.opencms.sample/lib/" destination="web-inf/lib/"/> <exportpoint uri="/system/modules/jp.zyyx.opencms.sample/classes/" destination="web-inf/classes/"/> </exportpoints> <resources> <resource uri="/system/modules/jp.zyyx.opencms.sample/"/> </resources> <parameters/> <resourcetypes> <type class="org.opencms.file.types.cmsresourcetypexmlcontent" name="sample" id="80"> 51

52 <properties> <property> <name>content-conversion</name> <value type="shared"><![cdata[xhtml]]></value> </property> <property> <name>template-elements</name> <value type="shared"> <![CDATA[/system/modules/jp.zyyx.opencms.sample/elements/sample5_1.jsp]]> </value> </property> </properties> <param name="schema">/system/modules/jp.zyyx.opencms.sample/schemas/sample.xsd</param> </type> </resourcetypes> <explorertypes> <explorertype name="sample" key="fileicon.sample" icon="page.gif" reference="xmlcontent"> <newresource uri="newresource_xmlcontent.jsp?newresourcetype=sample" order="1" autosetnavigation="false" autosettitle="false"/> <accesscontrol> <accessentry principal="group.administrators" permissions="+r+v+w+c"/> <accessentry principal="group.projectmanagers" permissions="+r+v+w+c"/> <accessentry principal="group.users" permissions="+r+v+w+c"/> </accesscontrol> </explorertype> </explorertypes> </module> リソースタイプを 追 加 するたびに 赤 字 の<resourcetype> ~ </resourcetype> と <explorertype> ~ </explorertype> の 範 囲 を 追 記 していきます その 時 赤 字 の 部 分 は 毎 回 同 じ 記 述 で 問 題 ありませんが 緑 色 の 部 分 は リソースタイプごとに 変 更 する 必 要 があります 緑 字 の 部 分 で sample と 記 述 されている 箇 所 は リソースタイプの 名 前 を 小 文 字 で 指 定 している 箇 所 で 別 のリソースタイプを 追 加 する 時 は その 名 前 に 置 き 換 えて 追 記 してください また 同 じリソー スタイプ 名 の 設 定 を 二 重 定 義 してはいけません リソースタイプ 名 が 重 複 していると OpenCms が 正 しく 動 作 しません 52

53 また XSD の 場 所 と JSP テンプレートの 場 所 を 記 述 する 箇 所 も 緑 になっていますが これも リソ ースタイプ 別 に 変 更 してください 最 も 注 意 しないといけない 箇 所 としては id="80" となっている 部 分 です これは 適 当 な 数 字 を 振 れば いいのですが 絶 対 に 他 のリソースタイプの ID と 重 複 してはいけません order="100" となっている 箇 所 があります 新 規 作 成 ダイアログでリソースタイプを 選 択 する 画 面 があります が そのときに 表 示 されるリソースタイプの 並 び 順 をここで 指 定 します 尚 フリーテキストページや JSP フォルダなどの 標 準 のリソースタイプの 設 定 は opencms-modules.xml で はなく opencms-workplace.xml に 記 述 されていますので 参 考 にして 下 さい opencms-modules.xml の 編 集 が 終 わったら Tomcat を 再 起 動 してください opencms-modules.xml の 変 更 後 は 必 ず Tomcat の 再 起 動 が 必 要 になります 再 起 動 が 終 わったら OpenCms へログインし 新 規 ボタンをクリックしてください 追 加 したリソースタイプが 選 択 できるように なっていると 思 います リソースタイプ 名 が??? fileicon.sample??? となっていると 思 いますが これは 日 本 語 の ラベルをまだ 設 定 していないからです 設 定 の 仕 方 は 後 述 しますので 今 は 無 視 してくださ い 53

54 次 にページのファイル 名 を 入 力 し 次 へ>> ボタンをクリックしてください 次 に ページのタイトルを 入 力 し 完 了 ボタンをクリックしてください ここでエラーが 出 る 場 合 は XSD の 記 述 に 誤 りがある 可 能 性 が 高 いようです また opencms-modules.xml で 設 定 した XSD と JSP テンプレートのパスが 正 確 かどうか 確 認 してく ださい 54

55 作 成 された xmlcontent.html をクリックし プレビューを 表 示 してください 下 のように テンプレートが 適 用 されたページが 表 示 されると 思 います 直 接 編 集 ボタンをクリックしてください XSD で 定 義 したとおりの 入 力 項 目 とフォームが 表 示 されます 適 当 な 値 を 入 力 し 左 上 から 二 番 目 の 保 存 して 終 了 ボタンをクリックしてください 55

56 5-5 入 力 項 目 を 動 的 に 増 やす 方 法 項 目 数 が 可 変 となる 入 力 項 目 をセットする 場 合 は XSD を 以 下 のように 修 正 します ソースコード:sample.xsd <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:include schemalocation="opencms://opencms-xmlcontent.xsd"/> <xsd:element name="samples" type="opencmssamples"/> <xsd:complextype name="opencmssamples"> <xsd:sequence> <xsd:element name="sample" type="opencmssample" minoccurs="0" maxoccurs="unbounded"/> </xsd:sequence> </xsd:complextype> <xsd:complextype name="opencmssample"> <xsd:sequence> <xsd:element name="date" type="opencmsdatetime" /> <xsd:element name="title" type="opencmsstring" /> <xsd:element name="subtitle" type="opencmsstring" /> <xsd:element name="body" type="opencmshtml" /> <xsd:element name="url" type="opencmsstring" minoccurs="0" maxoccurs="5" /> </xsd:sequence> <xsd:attribute name="language" type="opencmslocale" use="required"/> </xsd:complextype> </xsd:schema> 上 記 の 例 では URL の 入 力 項 目 を ユーザー 自 身 が 0~3 つまで 増 やせる 事 ができるようにしていま す 可 変 長 の 入 力 項 目 の<xsd:element />の minoccurs 属 性 と maxoccurs 属 性 で 数 を 指 定 します minoccurs 属 性 に 最 小 の 場 合 の 数 字 を 指 定 します 例 えば この 値 が 0 の 時 は 最 初 は URL の 入 力 欄 は 表 示 されていません 2 であれば 最 初 から 2 つの 入 力 欄 が 表 示 されます minoccurs 属 性 を 指 定 しない 場 合 は 1 が 指 定 された 事 になります maxoccurs 属 性 に 最 大 の 場 合 の 数 字 を 指 定 します 例 えば この 値 が 5 の 場 合 は ユーザーは 5 つまで 入 力 欄 を 追 加 する 事 が 出 来 ます unbounded を 指 定 すると 無 制 限 となり ユーザーはいくらでも 入 力 欄 を 増 や 56

57 す 事 が 出 来 るようになります maxoccurs 属 性 を 指 定 しない 場 合 は 1 が 指 定 された 事 になります この XSD での URL 入 力 欄 は 以 下 のようになります URL 入 力 欄 を 4 つまで 増 やした 状 態 です 入 力 欄 の 右 側 には 二 重 丸 のボタン( )があり そのボ タンの 上 にマウスを 乗 せると 4 つのボタンが 表 示 されます は 削 除 ボタンをあらわし クリックすると その 入 力 欄 を データごと 削 除 します は 上 に 移 動 ボタンをあらわし 一 つ 上 の URL 入 力 欄 と 入 力 データを 入 れ 替 えます は 下 に 移 動 ボタンをあらわし 一 つ 下 の URL 入 力 欄 と 入 力 データを 入 れ 替 えます は 新 規 追 加 ボタンをあらわし 新 しく 入 力 欄 を 追 加 します これらのボタンを 利 用 して ユーザーが 項 目 の 数 を 自 由 に 変 更 します XSD の 修 正 のみの 場 合 は Tomcat の 再 起 動 は 必 要 ありません XSD を 修 正 すると 変 更 度 合 いによっては 既 に 入 力 していたデータが 削 除 されるので 注 意 してください HTML エディタを 可 変 にしたいケースがあると 思 いますが 一 画 面 内 に 3 つ 以 内 に 納 まるように 考 慮 してください HTML エディタは 巨 大 な JavaScript の 塊 で たくさん 配 置 すると ブラウザの 動 作 が 非 常 に 重 くなり 最 悪 ブラウザが 強 制 終 了 してしまう 事 があります 57

58 次 に 入 力 項 目 を 可 変 にした 場 合 テンプレート 側 も 可 変 に 対 応 させなければなりません ソースコード:sample5_1.jsp taglib prefix="cms" uri=" %> <html> <head><cms:editable/></head> <body> <cms:contentload collector="singlefile" param="%(opencms.uri)" editable="true"> <div>date:<cms:contentshow element="date" /></div> <div>title:<cms:contentshow element="title" /></div> <div>subtitle:<cms:contentshow element="subtitle" /></div> <div>body:<cms:contentshow element="body" /></div> <cms:contentloop element="url"> <div>url:<cms:contentshow/></div> </cms:contentloop> </cms:contentload> </body> </html> 複 数 項 目 となった 入 力 項 目 に 関 しては ループする 範 囲 を<cms:contentloop> ~ </cms:contentloop> で 囲 みます そして その 中 に<cms:contentshow/>タグを 用 いて 表 示 させます element="url"の 記 述 は <cms:contentloop/>タグで 記 述 しているので <cms:contentshow/>タグに は 必 要 ありません 58

59 5-6 ウィジェットの 変 更 入 力 フォームの 種 類 には テキストフィールドや ラジオボタン チェックボックスなど いくつかの 種 類 がありますが OpenCms では これらの 入 力 インターフェースの 部 品 をウィジェットと 呼 んでい ます OpenCms で 利 用 可 能 なウィジェットには 以 下 のものがあります データタイプ 説 明 BooleanWidget ColorpickerWidget ComboWidget DateTimeWidget DisplayWidget チェックボックスを 表 示 します "#8899FF" 等 の 色 情 報 を 入 力 するインターフェースを 表 示 します カラーテーブルからマウスで 色 を 選 択 できるインターフェースがあり 選 択 した 色 情 報 は テキストフィールドにセットされます コンボボックスを 表 示 します プルダウンリストと 入 力 可 能 なテキスト フィールドが 組 み 合 わさったインターフェースです 日 時 情 報 を 入 力 するインターフェースを 表 示 します カレンダーから 日 時 を 選 択 できるインターフェースがあり 選 択 した 日 付 は テキストフィールドにセットされます テキストの 表 示 のみ 行 います データの 入 力 などは 出 来 ません DownloadGalleryWidget ダウンロードギャラリーを 開 いて ファイルのパスをテキストフィールド にセットするインターフェースを 表 示 します GroupWidget HtmlGalleryWidget HtmlWidget ImageGalleryWidget LinkGalleryWidget MultiSelectWidget SelectorWidget グループを 選 択 するインターフェースを 表 示 します HTML ギャラリーを 開 いて HTML の 部 品 をセットするインターフェー スを 表 示 します 使 用 しているブラウザが 利 用 可 能 な HTML エディタを 表 示 します イメージギャラリーを 開 いて ファイルのパスをテキストフィールドにセ ットするインターフェースを 表 示 します 外 部 リンクギャラリーを 開 いて URL をテキストフィールドにセットす るインターフェースを 表 示 します 複 数 選 択 可 能 なセレクトボックスを 表 示 します セレクトボックスを 表 示 します 59

60 StringWidget TableGalleryWidget TextareaWidget UserWidget VfsFileWidget 一 行 テキストを 入 力 するテキストフィールドを 表 示 します テーブルギャラリーを 開 いて HTML のテーブルをセットするインター フェースを 表 示 します 複 数 行 テキストを 入 力 するテキストエリアを 表 示 します ユーザーを 選 択 するインターフェースを 表 示 します ファイル 選 択 用 のインターフェースを 表 示 します ポップアップにより OpenCms の VFS のファイルツリーを 表 示 し 上 記 は 一 部 の 代 表 的 なものです 詳 しくは OpenCms ウィジェットリファレンス を 参 照 して 下 さい ウィジェットを 指 定 するには XSD で 以 下 のように 指 定 します ソースコード:sample.xsd <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:include schemalocation="opencms://opencms-xmlcontent.xsd"/> <xsd:element name="samples" type="opencmssamples"/> <xsd:complextype name="opencmssamples"> <xsd:sequence> <xsd:element name="sample" type="opencmssample" minoccurs="0" maxoccurs="unbounded"/> </xsd:sequence> </xsd:complextype> <xsd:complextype name="opencmssample"> <xsd:sequence> <xsd:element name="date" type="opencmsdatetime" /> <xsd:element name="title" type="opencmsstring" /> <xsd:element name="subtitle" type="opencmsstring" /> <xsd:element name="body" type="opencmshtml" /> <xsd:element name="url" type="opencmsstring" minoccurs="0" maxoccurs="5" /> </xsd:sequence> <xsd:attribute name="language" type="opencmslocale" use="required"/> </xsd:complextype> 60

61 <xsd:annotation> <xsd:appinfo> <layouts> <layout element="body" widget="textareawidget"/> <layout element="url" widget="vfsfilewidget"/> </layouts> </xsd:appinfo> </xsd:annotation> </xsd:schema> <xsd:annotation> 内 の<xsd:appinfo> 内 の<layouts> ~ </layouts>の 中 に <layout/>タグで 指 定 します element 属 性 に 入 力 項 目 名 を そして widget 属 性 にウィジェット 名 を 指 定 します 上 記 の 例 の 場 合 HTML エディタが 使 われていた Body を シンプルなテキストエリアに 変 更 し URL には ファイル 選 択 ボタンを 表 示 する VfsFileWidget に 変 更 しています VfsFileWidget は 入 力 項 目 の 右 にフォルダのボタンが 表 示 され クリックするとファイルをツリーか ら 選 択 するインターフェースが 別 ウインドウで 起 動 します 61

62 データタイプとウィジェットは 密 接 な 関 係 があり ナンセンスな 組 み 合 わせも 考 えられます 例 えば データタイプが OpenCmsBoolean の 場 合 true か false しか 入 力 できないので HTML エディタのよ うな 高 機 能 なものは 必 要 ありません HtmlWidget を 指 定 するのはナンセンスとなります ウィジェットを 指 定 しない 場 合 は データタイプごとに 決 められたデフォルトのウィジェットが 使 用 されます データタイプとデフォルト ウィジェットの 対 応 表 は 以 下 です データタイプ OpenCmsBoolean OpenCmsColor OpenCmsDateTime OpenCmsHtml OpenCmsLocale OpenCmsString OpenCmsVfsFile デフォルトのウィジェット BooleanWidget ColorpickerWidget DateTimeWidget HtmlWidget StringWidget StringWidget VfsFileWidget セレクトボックスやチェックボックス 等 の 複 数 選 択 項 目 の 場 合 その 選 択 項 目 は configuration 属 性 で 指 定 します 項 目 名 を で 区 切 って 指 定 すると 選 択 項 目 として 表 示 されます ソースコード( 一 部 のみ):sample.xsd <xsd:annotation> <xsd:appinfo> <layouts> <layout element="subtitle" widget="combowidget" configuration="ir 情 報 について 製 品 情 報 について 会 社 情 報 について"/> </layouts> </xsd:appinfo> </xsd:annotation> 62

63 上 記 の 場 合 入 力 されるデータと 選 択 項 目 のラベルが 同 じ 値 になります コンボボックスの 場 合 は 問 題 ありませんが セレクトボックス 等 の 場 合 値 とラベルを 別 にしたい 場 合 がありま す その 場 合 以 下 のような 書 き 方 ができます <layout element="subtitle" widget="selectorwidget" configuration="value='1' option=' 男 ' value='2' option=' 女 ' default='true' value='3' option=' 未 選 択 ' " /> value が 値 で option がラベルです default='true'をセットすると その 項 目 がデフォルト 値 となります でそれらを 区 切 るところは 変 わりありません また option を 設 定 しない 場 合 は value の 値 がラベルに 使 用 されます 以 下 のように help を 指 定 すると 各 選 択 項 目 にポップアップで 説 明 のテキストを 表 示 させる 事 ができます <layout element="subtitle" widget="combowidget" configuration=" value='ir 情 報 ' help='ir に 関 するお 問 い 合 わせはこちら ' value=' 製 品 情 報 ' help=' 製 品 に 関 するお 問 い 合 わせはこちら' value=' 会 社 情 報 ' help=' 会 社 に 関 するお 問 い 合 わせはこちら' value='その 他 ' help='その 他 のお 問 い 合 わせはこちら '" /> 63

64 5-7 入 力 項 目 のグループ 化 以 下 のように 可 変 となった URL 入 力 欄 があります これを 以 下 のように URL 入 力 欄 テキスト 入 力 欄 ターゲット 選 択 欄 の 3 つをグループ 化 した 入 力 フォームに 変 更 してみたいと 思 います ただし このぐらいの 修 正 を XSD に 加 えてしまうと 今 までの XSD で 入 力 したデータの 整 合 性 が 取 れない 為 作 り 直 しになるか 変 換 ルールを XSL で 作 成 し 管 理 画 面 から 変 換 を 行 う 事 になります では まず URL 入 力 欄 テキスト 入 力 欄 ターゲット 選 択 欄 の 3 つの 入 力 フォームを 定 義 した XSD を sample.xsd とは 別 のファイルで 作 成 する 必 要 があります 以 下 の url.xsd を 作 成 し モジュール 直 下 の schemas フォルダ 以 下 に 置 いてください ソースコード:url.xsd <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:include schemalocation="opencms://opencms-xmlcontent.xsd"/> <xsd:element name="urls" type="opencmsurls"/> <xsd:complextype name="opencmsurls"> 64

65 <xsd:sequence> <xsd:element name="url" type="opencmsurl" minoccurs="0" maxoccurs="unbounded"/> </xsd:sequence> </xsd:complextype> <xsd:complextype name="opencmsurl"> <xsd:sequence> <xsd:element name="url" type="opencmsstring" /> <xsd:element name="text" type="opencmsstring" /> <xsd:element name="target" type="opencmsstring" /> </xsd:sequence> <xsd:attribute name="language" type="opencmslocale" use="optional"/> </xsd:complextype> <xsd:annotation> <xsd:appinfo> <layouts> <layout element="target" widget="combowidget" configuration="_blank _self _top"/> </layouts> </xsd:appinfo> </xsd:annotation> </xsd:schema> まず この XSD のデータタイプ 名 を 半 角 英 数 で 決 めます この 例 の 場 合 は Url です 3 行 目 の name 属 性 には データタイプ 名 の 最 後 に s を 追 加 した 名 前 を 指 定 します そして type 属 性 には name 属 性 の 名 前 の 前 に OpenCms を 付 与 した 名 前 を 指 定 します 5 行 目 の name 属 性 には 3 行 目 の type 属 性 と 同 じ 値 を 指 定 します 7 行 目 の name 属 性 には リソースタイプの 名 前 を type 属 性 には name 属 性 の 名 前 の 前 に OpenCms を 付 与 した 名 前 を 指 定 します 11 行 目 の name 属 性 には 7 行 目 の type 属 性 と 同 じ 値 を 指 定 します <xsd:sequence> ~ </xsd:sequence> の 間 (13 行 目 ~15 行 目 )までが 入 力 フォームの 定 義 です URL 入 力 欄 テキスト 入 力 欄 ターゲット 選 択 欄 の 3 つの 入 力 フォームを 定 義 しています ターゲットはウィジェットをコンボボックスにし _blank _self _top を 選 択 できるようにす る 為 23 行 目 の<layout/>で 定 義 しています 65

66 また グループ 化 のための XSD の 場 合 は 17 行 目 の use 属 性 は 必 ず optional と 指 定 してください インクルードされる 側 の XSD の 場 合 は opencms-modules.xml を 修 正 する 手 順 は 必 要 はありません 次 に sample.xsd を 修 正 します ソースコード:sample.xsd <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:include schemalocation="opencms://opencms-xmlcontent.xsd"/> <xsd:include schemalocation="opencms://system/modules/jp.zyyx.opencms.sample/schemas/url.xsd"/> <xsd:element name="samples" type="opencmssamples"/> <xsd:complextype name="opencmssamples"> <xsd:sequence> <xsd:element name="sample" type="opencmssample" minoccurs="0" maxoccurs="unbounded"/> </xsd:sequence> </xsd:complextype> <xsd:complextype name="opencmssample"> <xsd:sequence> <xsd:element name="date" type="opencmsdatetime" /> <xsd:element name="title" type="opencmsstring" /> <xsd:element name="subtitle" type="opencmsstring" /> <xsd:element name="body" type="opencmshtml" /> <xsd:element name="url" type="opencmsurl" minoccurs="0" maxoccurs="5" /> </xsd:sequence> <xsd:attribute name="language" type="opencmslocale" use="required"/> </xsd:complextype> </xsd:schema> まず 先 ほど 作 成 した url.xsd を 読 み 込 めるようにする 為 に 3 行 目 のように 記 述 し url.xsd をイン クルードしてください 後 は URL のデータタイプのところを url.xsd で 定 義 したデータタイプを 指 定 します この 場 合 の データタイプ 名 は OpenCms という 文 字 が 先 頭 に 付 与 された 単 数 形 の 名 前 を 指 定 します 66

67 これで 入 力 フォームがグルーピングされたものに 修 正 されました ただ テンプレートがそのままなので こちらも 今 回 の 変 更 に 合 わせて 修 正 します ソースコード:sample5_1.jsp taglib prefix="cms" uri=" %> <html> <head><cms:editable/></head> <body> <cms:contentload collector="singlefile" param="%(opencms.uri)" editable="true"> <div>date:<cms:contentshow element="date" /></div> <div>title:<cms:contentshow element="title" /></div> <div>subtitle:<cms:contentshow element="subtitle" /></div> <div>body:<cms:contentshow element="body" /></div> <cms:contentloop element="url"> <a href="<cms:contentshow element="url"/>" target="<cms:contentshow element="target"/>"> <cms:contentshow element="text"/> </a><br/> </cms:contentloop> </cms:contentload> </body> </html> <cms:contentloop/>でループさせる 範 囲 を 囲 むところは 通 常 通 りです その 中 で <cms:contentshow/>を 使 って 入 力 されたデータを 表 示 しますが element 属 性 に 入 力 項 目 の 名 前 を 指 定 してください ここで 指 定 するのはインクルードされた 方 つまり url.xsd 側 の 入 力 項 目 名 となります この XSD のインクルードによって XSD ファイル 同 士 で 親 子 関 係 を 持 つ 事 になります これは 親 子 孫 と 何 階 層 でも 持 たせる 事 ができるのですが 注 意 点 として 子 の XSD ファイル 内 で 親 の XSD ファイルのデータタイプを 使 用 したり 自 分 自 身 のデータタイプを 使 用 しないで 下 さい 無 限 ループと なり StackOverflow エラーが 発 生 してしまいます 67

68 5-8 タブの 設 定 入 力 項 目 が 多 いと 画 面 が 縦 に 長 くなりがちです そういう 場 合 は 以 下 のように タブで 入 力 フォームを 切 り 替 えられるようにすると 便 利 です 上 記 の 場 合 TabBasic という 名 前 のタブを 用 意 し その 中 に Date Title SubTitle の 3 つの 入 力 項 目 を 表 示 します そして TabDetail という 名 前 のタブを 用 意 し その 中 に Body URL の 2 つの 入 力 項 目 を 表 示 しています XSD は 以 下 のようになります ソースコード:sample.xsd <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:include schemalocation="opencms://opencms-xmlcontent.xsd"/> <xsd:element name="samples" type="opencmssamples"/> <xsd:complextype name="opencmssamples"> <xsd:sequence> <xsd:element name="sample" type="opencmssample" minoccurs="0" maxoccurs="unbounded"/> </xsd:sequence> 68

69 </xsd:complextype> <xsd:complextype name="opencmssample"> <xsd:sequence> <xsd:element name="date" type="opencmsdatetime" /> <xsd:element name="title" type="opencmsstring" /> <xsd:element name="subtitle" type="opencmsstring" /> <xsd:element name="body" type="opencmshtml" /> <xsd:element name="url" type="opencmsstring" /> </xsd:sequence> <xsd:attribute name="language" type="opencmslocale" use="required"/> </xsd:complextype> <xsd:annotation> <xsd:appinfo> <tabs> <tab element="date" name="tabbasic" collapse="false" /> <tab element="body" name="tabdetail" collapse="false" /> </tabs> </xsd:appinfo> </xsd:annotation> </xsd:schema> <tabs> ~ </tabs> の 中 に 必 要 なタブの 数 だけ <tab/>を 定 義 します <tab/>の element 属 性 には そのタブの 最 初 の 入 力 項 目 名 を 指 定 します 最 初 のタブ(TabBasic)は Date から 始 まるので Date を 指 定 します ( 最 初 のタブは 必 ず 最 初 の 入 力 項 目 名 になるはずです ) 二 つ 目 のタブ(TabDetail)は Body 以 降 の 入 力 項 目 となるので Body を 指 定 します <tab/>の name 属 性 には そのタブの 名 前 を 指 定 します name 属 性 が 未 設 定 の 場 合 は element 属 性 に 指 定 した 値 が 使 用 されます <tab/>の collapse 属 性 は 入 力 画 面 で 入 力 欄 の 左 にあるラベルを 表 示 するかしないかを 指 定 します true にすると 右 の 画 面 のように ラ ベルが 表 示 されなくなります 69

70 5-9 日 本 語 ラベルの 適 用 今 までは ラベルが 全 て 半 角 英 数 表 記 でした これらを 全 角 の 日 本 語 にする 方 法 を 説 明 します まず 日 本 語 ラベルを 定 義 するテキストファイルを 作 成 します モジュールの 直 下 に classes という 名 前 のフォルダがあると 思 いますが その 最 下 層 まで 移 動 して workplace_ja.properties という 名 前 でテキストファイルを 作 成 してください 今 回 の 場 合 は 以 下 のファイルを 作 成 する 事 になります /system/modules/jp.zyyx.opencms.sample/classes/jp/zyyx/opencms/sample/workplace_ja.properties ファイルの 作 成 は そのディレクトリまで 移 動 し 新 規 テキストファイル 次 へ>> (フ ァイル 名 を 入 力 ) 完 了 という 流 れで 行 えます(ファイルの Title は 無 くても 構 いません) workplace_ja.properties というファイル 名 についての 補 足 になりますが OpenCms は 複 数 言 語 に 対 応 していますので 英 語 であれば workplace_en.properties ドイツ 語 であれば workplace_de.properties という 名 前 でファイルを 作 成 しておくことができます ワークプレースの 設 定 で 使 用 言 語 を 切 り 替 え た 時 各 言 語 用 のファイルを 用 意 しておけば 対 応 する 言 語 のラベルを 表 示 させる 事 が 可 能 です 尚 対 応 する 言 語 のファイルが 存 在 しない 場 合 は 最 終 的 に workplace.properties を 読 みにいきます 通 常 workplace.properties には 英 語 のラベルを 定 義 しています では workplace_ja.properties に 以 下 の 内 容 を 入 力 し 保 存 してください 保 存 した 後 は 必 ずこのファイルを 直 接 発 行 して 下 さい この 操 作 は 必 須 です 直 接 発 行 の 際 親 フォルダがまだ 発 行 されていなければ 親 フォルダごと 発 行 してください 親 フォルダを 発 行 しない 状 態 で ファイルのみ 発 行 する 事 はできません 設 定 ファイル:workplace_ja.properties fileicon.sample= 構 造 化 コンテンツのサンプルページ label.sample.date= 公 開 日 label.sample.title=タイトル label.sample.subtitle=サブタイトル label.sample.body= 本 文 label.sample.url=url label.sample.tabbasic= 基 本 情 報 label.sample.tabdetail= 詳 細 情 報 70

71 label.url.url=url label.url.text=リンクテキスト label.url.target=ターゲット 一 行 目 の fileicon.sample は リソースタイプの 日 本 語 ラベルです ページの 新 規 作 成 ダイアログで??? fileicon.sample??? となっていたと 思 いますが ここでラベルを 設 定 する 事 で 日 本 語 の 場 合 のみ この 問 題 が 解 決 します 後 は 構 造 化 コンテンツの 入 力 項 目 の 日 本 語 ラベルの 定 義 ですが 入 力 項 目 名 の 指 定 には 次 のルールがあ ります まず 必 ず "label."で 始 まらなければなりません 次 に XSD で 指 定 したデータタイプ 名 の 単 数 形 の 名 前 を 指 定 します 最 後 に XSD で 指 定 した 入 力 項 目 の 名 前 を 指 定 します 次 に sample.xsd や url.xsd 等 の XSD ファイルを このファイルを 読 み 込 ませるように 修 正 します ソースコード:sample.xsd <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:include schemalocation="opencms://opencms-xmlcontent.xsd"/> <xsd:include schemalocation="opencms://system/modules/jp.zyyx.opencms.sample/schemas/url.xsd"/> <xsd:element name="samples" type="opencmssamples"/> <xsd:complextype name="opencmssamples"> <xsd:sequence> <xsd:element name="sample" type="opencmssample" minoccurs="0" maxoccurs="unbounded"/> </xsd:sequence> </xsd:complextype> <xsd:complextype name="opencmssample"> <xsd:sequence> <xsd:element name="date" type="opencmsdatetime" /> <xsd:element name="title" type="opencmsstring" /> <xsd:element name="subtitle" type="opencmsstring" /> <xsd:element name="body" type="opencmshtml" /> <xsd:element name="url" type="opencmsurl" minoccurs="0" maxoccurs="5" /> </xsd:sequence> 71

72 <xsd:attribute name="language" type="opencmslocale" use="required"/> </xsd:complextype> <xsd:annotation> <xsd:appinfo> <resourcebundle name="jp.zyyx.opencms.sample.workplace"/> <tabs> <tab element="date" name="tabbasic" collapse="false" /> <tab element="body" name="tabdetail" collapse="false" /> </tabs> </xsd:appinfo> </xsd:annotation> </xsd:schema> ソースコード:url.xsd <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:include schemalocation="opencms://opencms-xmlcontent.xsd"/> <xsd:element name="urls" type="opencmsurls"/> <xsd:complextype name="opencmsurls"> <xsd:sequence> <xsd:element name="url" type="opencmsurl" minoccurs="0" maxoccurs="unbounded"/> </xsd:sequence> </xsd:complextype> <xsd:complextype name="opencmsurl"> <xsd:sequence> <xsd:element name="url" type="opencmsstring" /> <xsd:element name="text" type="opencmsstring" /> <xsd:element name="target" type="opencmsstring" /> </xsd:sequence> <xsd:attribute name="language" type="opencmslocale" use="optional"/> </xsd:complextype> <xsd:annotation> 72

73 <xsd:appinfo> <resourcebundle name="jp.zyyx.opencms.sample.workplace"/> <layouts> <layout element="target" widget="combowidget" configuration="_blank _self _top"/> </layouts> </xsd:appinfo> </xsd:annotation> </xsd:schema> 言 語 のラベルを 変 更 した 場 合 は Tomcat の 再 起 動 か ワークプレースの 初 期 化 を 行 う 必 要 があります ワークプレースの 初 期 化 は 以 下 の 手 順 で 行 います 1. ツールバーの 表 示 プルダウンを エクスプローラ から 管 理 ツール に 変 更 2. 管 理 画 面 で ワークプレースツール をクリック 3. ワークプレースの 初 期 化 をクリックし OK ボタンをクリック Tomcat の 再 起 動 または ワークプレースの 初 期 化 が 終 わったら 画 面 を 確 認 してください 73

74 74

75 5-10 デフォルト 値 の 設 定 入 力 項 目 の 初 期 値 を 設 定 するには 以 下 のように XSD に<defaults/>で 定 義 します ソースコード:sample.xsd <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:include schemalocation="opencms://opencms-xmlcontent.xsd"/> <xsd:include schemalocation="opencms://system/modules/jp.zyyx.opencms.sample/schemas/url.xsd"/> <xsd:element name="samples" type="opencmssamples"/> <xsd:complextype name="opencmssamples"> <xsd:sequence> <xsd:element name="sample" type="opencmssample" minoccurs="0" maxoccurs="unbounded"/> </xsd:sequence> </xsd:complextype> <xsd:complextype name="opencmssample"> <xsd:sequence> <xsd:element name="date" type="opencmsdatetime" /> <xsd:element name="title" type="opencmsstring" /> <xsd:element name="subtitle" type="opencmsstring" /> <xsd:element name="body" type="opencmshtml" /> <xsd:element name="url" type="opencmsurl" minoccurs="0" maxoccurs="5" /> </xsd:sequence> <xsd:attribute name="language" type="opencmslocale" use="required"/> </xsd:complextype> <xsd:annotation> <xsd:appinfo> <resourcebundle name="jp.zyyx.opencms.sample.workplace"/> <tabs> <tab element="date" name="tabbasic" collapse="false" /> <tab element="body" name="tabdetail" collapse="false" /> </tabs> 75

76 <defaults> <default element="date" value="${currenttime}"/> <default element="title" value="( 無 題 )"/> <default element="subtitle" value="${key.subtitle.default.value}"/> </defaults> </xsd:appinfo> </xsd:annotation> </xsd:schema> <defaults> ~ </defaults> の 中 に <default/>で 初 期 値 を 定 義 します element 属 性 に 入 力 項 目 名 を value 属 性 にその 初 期 値 をセットします ${currenttime}のようなマクロを 指 定 することも 可 能 です このマクロは 現 在 時 刻 を 表 しています マクロを 指 定 するときは 全 て ${(マクロ 名 )}という 表 記 で 記 述 します Title の 初 期 値 のように 直 接 文 字 列 を 入 力 する 事 も 出 来 ますが これだと ワークプレースの 言 語 設 定 をドイツ 語 に 変 えても 日 本 語 の 初 期 値 が 表 示 されてしまいます このような 場 合 マクロを 使 用 して 各 言 語 用 のプロパティファイルを 参 照 するように 指 定 できます プロパティファイルを 参 照 する 場 合 は ${key.(キー 名 )} という 表 記 で 記 述 します 日 本 語 ラベルのプロパティファイル(workplace_ja.properties)に 以 下 の 行 を 追 加 し 直 接 発 行 ワークプレースの 初 期 化 or Tomcat 再 起 動 を 行 ってください 設 定 ファイル( 追 加 分 のみ):workplace_ja.properties subtitle.default.value=サブタイトルの 初 期 値 です では この 構 造 化 コンテンツのページを 新 規 作 成 し 編 集 画 面 を 確 認 してください ( 既 に 作 成 されているページを 開 いても 意 味 がありません ) 76

77 また 外 部 の XSD をインクルードしている 場 合 初 期 値 をセットするのは 親 の XSD の 方 になるので 注 意 してください 子 の XSD に 初 期 値 の 定 義 を 記 述 しても 無 効 です また 子 の XSD の 初 期 値 をセットする 場 合 は / 区 切 りでその 階 層 も 指 定 する 必 要 があります 例 えば url.xsd の Text の 初 期 値 をセットする 場 合 は sample.xsd で 以 下 のように 定 義 します ソースコード( 一 部 のみ):sample.xsd <defaults> <default element="date" value="${currenttime}"/> <default element="title" value="( 無 題 )"/> <default element="subtitle" value="${key.subtitle.default.value}"/> <default element="url/text" value="( 無 題 )"/> </defaults> 77

78 初 期 値 に 独 自 のクラス クラスを 指 定 する 方 法 動 的 な 初 期 値 を 指 定 したい 場 合 マクロだけでは 不 十 分 な 事 があります そのような 場 合 は 自 前 で 作 成 したクラスを 指 定 すれば 解 決 します 初 期 値 にクラスを 指 定 する 場 合 <default>の value に "class:(クラス 名 )"の 形 式 で 指 定 します ここに 指 定 するクラスは jp.zyyx.opencms.xml.content.defaults.i_cmsxmlcontentdefault インター フェースをインプリメントしたクラスでなければなりません 以 下 のクラスは 翌 日 の 17 時 の 時 間 を UNIX TIME( 単 位 はミリ 秒 ) 形 式 で 返 すサンプルです ソースコード:Tomorrow17h.java package jp.zyyx.opencms.xml.content.defaults; import java.util.calendar; import java.util.locale; import org.opencms.file.cmsobject; import org.opencms.xml.types.i_cmsxmlcontentvalue; public class Tomorrow17h implements I_CmsXmlContentDefault { public String getdefault(cmsobject cms, I_CmsXmlContentValue value, Locale locale) { Calendar cal = Calendar.getInstance(); cal.add(calendar.date, 1); cal.set(calendar.hour_of_day, 17); cal.set(calendar.minute, 0); cal.set(calendar.second, 0); cal.set(calendar.millisecond, 0); } return String.valueOf(cal.getTimeInMillis()); public String getdescription() { } return " 翌 日 の 17 時 の 時 刻 を UNIX TIME( 単 位 はミリ 秒 )で 返 す "; 78

79 } public String getlabel() { } return " 翌 日 17 時 "; getdefault()メソッドが 返 す 値 が 初 期 値 として 使 われます これを 日 付 を 入 力 するウィジェットで 使 用 すると ペ ージを 作 成 した 時 点 の 翌 日 の 17 時 が 初 期 値 にセットされるようになります XSD で Tomorrow17h クラスを 指 定 する 場 合 は 以 下 のようになります ソースコード( 一 部 のみ):sample.xsd <defaults> <default element="date" value="class:tomorrow17h"/> <default element="title" value="( 無 題 )"/> <default element="subtitle" value="${key.subtitle.default.value}"/> </defaults> パッケージ 名 を 省 略 すると jp.zyyx.opencms.xml.content.defaults パッケージのクラスとみな されます 79

80 クラスにパラメータ パラメータを 渡 す 場 合 Tomorrow17h クラスに XSD からパラメータを 渡 したい 場 合 は クラス 名 の 後 にカンマを 入 れて 文 字 列 を 指 定 します ソースコード( 一 部 のみ):sample.xsd <defaults> <default element="date" value="class:tomorrow17h, debug=true"/> <default element="title" value="( 無 題 )"/> <default element="subtitle" value="${key.subtitle.default.value}"/> </defaults> 指 定 したパラメータは getdefault()メソッド 内 で "CMS_DEFAULT_ARGS" をキーに cms オブジェクトか ら 取 得 できます ソースコード( 一 部 のみ):Tomorrow17h.java public String getdefault(cmsobject cms, I_CmsXmlContentValue value, Locale locale) { String args = (String) cms.getrequestcontext().getattribute("cms_default_args"); } ( 省 略 ) 80

81 5-11 プロパティへのマッピング 各 ページには さまざまなプロパティを 設 定 する 事 ができます プロパティは コンテクストメニューから プロパティ を 選 択 すると 設 定 画 面 が 開 きます また コンテクストメニューから 拡 張 公 開 期 間 の 設 定 と 選 択 すると ページの 公 開 日 と 公 開 期 限 を 設 定 できます 81

82 Title プロパティは エクスプローラビューのファイル 名 の 横 に 表 示 されます content-encoding プロパティは ページの 文 字 コードに 影 響 します 公 開 期 間 は そのページの 表 示 期 間 をあらわします このように それぞれ 重 要 な 意 味 を 持 っているものがありますが いちいち 別 の 画 面 で 設 定 するのが 面 倒 で 構 造 化 コンテンツの 編 集 画 面 で 入 力 した 内 容 を 自 動 的 に それぞれのプロパティにもセットさ れるように 関 連 付 けを 行 う 事 ができます 関 連 付 けを 行 う 場 合 は XSD を 以 下 のように 修 正 します ソースコード:sample.xsd <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:include schemalocation="opencms://opencms-xmlcontent.xsd"/> <xsd:element name="samples" type="opencmssamples"/> <xsd:complextype name="opencmssamples"> <xsd:sequence> <xsd:element name="sample" type="opencmssample" minoccurs="0" maxoccurs="unbounded"/> </xsd:sequence> </xsd:complextype> <xsd:complextype name="opencmssample"> <xsd:sequence> <xsd:element name="date" type="opencmsdatetime" /> <xsd:element name="title" type="opencmsstring" /> <xsd:element name="subtitle" type="opencmsstring" /> <xsd:element name="body" type="opencmshtml" /> <xsd:element name="url" type="opencmsstring" /> </xsd:sequence> <xsd:attribute name="language" type="opencmslocale" use="required"/> </xsd:complextype> <xsd:annotation> <xsd:appinfo> 82

83 <mappings> <mapping element="date" mapto="attribute:datereleased" /> <mapping element="title" mapto="property:title" /> <mapping element="title" mapto="property:description" /> </mappings> </xsd:appinfo> </xsd:annotation> </xsd:schema> <mappings> ~ </mappings> の 中 に <mapping/>で 定 義 を 記 述 します <mapping/>の element 属 性 に 入 力 項 目 の 名 前 を 指 定 し mapto 属 性 にマッピング 先 を 指 定 します マッピング 先 に 公 開 日 をセットする 場 合 は attribute:datereleased と 記 述 します 上 記 の 例 だと Date に 入 力 された 日 付 が 保 存 時 に そのリソースの 公 開 日 にセットされます 公 開 期 限 の 場 合 は attribute:dateexpired と 記 述 します マッピング 先 にプロパティをセットする 場 合 は property:(プロパティ 名 ) で 記 述 します 上 記 の 例 だと Title に 入 力 された 文 字 を Title プロパティと Description にマッピングします 尚 この 機 能 は 構 造 化 コンテンツ プロパティ or 公 開 期 間 への 一 方 通 行 です つまり 構 造 化 コンテンツの 編 集 画 面 から 入 力 すると 各 プロパティや 公 開 期 間 にセットされますが プロパティ 編 集 画 面 でプロパティ 値 を 変 更 したり 公 開 期 間 を 変 更 しても 構 造 化 コンテンツの 入 力 値 は 変 更 されませんので 注 意 してください 83

84 5-12 入 力 内 容 のチェック(バリデーション)の 設 定 XSD に 正 規 表 現 によるバリデーションを 定 義 する 事 ができます ソースコード:sample.xsd <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:include schemalocation="opencms://opencms-xmlcontent.xsd"/> <xsd:element name="samples" type="opencmssamples"/> <xsd:complextype name="opencmssamples"> <xsd:sequence> <xsd:element name="sample" type="opencmssample" minoccurs="0" maxoccurs="unbounded"/> </xsd:sequence> </xsd:complextype> <xsd:complextype name="opencmssample"> <xsd:sequence> <xsd:element name="date" type="opencmsdatetime" /> <xsd:element name="title" type="opencmsstring" /> <xsd:element name="subtitle" type="opencmsstring" /> <xsd:element name="body" type="opencmshtml" /> <xsd:element name="url" type="opencmsstring" /> </xsd:sequence> <xsd:attribute name="language" type="opencmslocale" use="required"/> </xsd:complextype> <xsd:annotation> <xsd:appinfo> <resourcebundle name="jp.zyyx.opencms.sample.workplace"/> <validationrules> <rule element="title" regex=".+" message="タイトルが 入 力 されていません " /> <rule element="subtitle" regex=".+" type="warning" message="サブタイトルが 入 力 されていません " /> <rule element="date" regex=".+" type="error" 84

85 </validationrules> </xsd:appinfo> </xsd:annotation> </xsd:schema> message="${key.validate.date.blank}" /> <validationrules> ~ </validationrules> の 間 に <rule/> で 定 義 していきます <rule/>の element に 入 力 チェックを 行 う 項 目 の 名 前 を 指 定 します regex に 正 規 表 現 を 記 述 します 記 述 した 正 規 表 現 に 該 当 しない 場 合 エラーまたは 警 告 となります type には error または warning を 指 定 します warning を 指 定 した 場 合 は 警 告 す る だ け で 保 存 は で き ま す が error を 指 定 した 場 合 は 入 力 内 容 を 修 正 しないと 保 存 できません message には エラー または 警 告 時 の メッセージを 入 力 します 直 接 文 字 列 を 入 力 する 事 も 出 来 ますが それだと ワー クプレースの 言 語 設 定 をドイツ 語 に 変 えて も 日 本 語 のメッセージが 表 示 されてしま います このような 場 合 マクロを 使 用 して 各 言 語 用 のプロパティファイルを 参 照 するように 指 定 できます プ ロパティファイルを 参 照 する 場 合 は ${key.(キー 名 )} という 表 記 で 記 述 します 日 本 語 ラベルのプロパティファイル(workplace_ja.properties)に 以 下 の 行 を 追 加 し 直 接 発 行 ワークプレースの 初 期 化 or Tomcat 再 起 動 を 行 ってください 尚 一 つのエレメント エレメント( 入 力 項 目 )に 定 義 できる<rule/>は 一 つだけ だけです です 設 定 ファイル( 追 加 分 のみ):workplace_ja.properties validate.date.blank= 公 開 日 が 入 力 されていません 85

86 先 ほどの 正 規 表 現 を 利 用 したバリデーションでは データベースにアクセスしたり 複 数 の 入 力 項 目 間 で 関 連 するチェックが 出 来 ないなど 色 々と 制 限 があります そういったバリデーションを 行 いたい 場 合 は バリデーション 用 のクラスを 作 成 し 保 存 の 前 に それを 読 み 込 ませるようにします バリデーション 用 のクラスファイルのパッケージ 名 は 決 まっており クラス 名 は XSD のデータタイ プ 名 と 同 じにします パッケージ 名 は jp.zyyx.opencms.xml.validator で 今 回 の 場 合 クラス 名 は OpenCmsSample となります このクラスファイルを 作 成 し サーバー 上 の WEB-INF/classes/ 以 下 にアップすれば 完 了 で XSD の 修 正 は 不 要 です (class ファイルをアップした 後 は Tomcat の 再 起 動 が 必 要 です ) では ソースファイルを 見 てみましょう どのようなリソースタイプのバリデーションを 実 装 する 場 合 でも 以 下 のソースの 赤 字 以 外 の 部 分 は 変 更 の 必 要 は 無 いので このまま 流 用 しても 問 題 ありません ソースコード:OpenCmsSample.java package jp.zyyx.opencms.xml.validator; import java.util.list; import java.util.resourcebundle; import org.opencms.file.cmsfile; import org.opencms.file.cmsobject; import org.opencms.xml.cmsxmlcontentdefinition; import org.opencms.xml.content.cmsxmlcontenterrorhandler; import org.opencms.xml.types.i_cmsxmlcontentvalue; public class OpenCmsSample { /** * バリデーション. cms CmsObject definition XSD 情 報 file 処 理 対 象 リソース errors エラーハンドラ contentvalues widget 情 報 */ public static void validate( 86

87 CmsObject cms, CmsXmlContentDefinition definition, CmsFile file, CmsXmlContentErrorHandler errors, List<I_CmsXmlContentValue> contentvalues) { ResourceBundle messages = definition.getcontenthandler().getmessages( cms.getrequestcontext().getlocale()).getresourcebundle(); for (I_CmsXmlContentValue value : contentvalues) { if (!value.issimpletype()) { continue; } } } } if(value.getpath().equals("title[1]")) { String title = value.getstringvalue(cms); if(title == null title.trim().length() == 0) { errors.adderror(value, "タイトルが 入 力 されていません "); } } else if(value.getpath().equals("subtitle[1]")) { String subtitle = value.getstringvalue(cms); if(subtitle == null subtitle.trim().length() == 0) { errors.addwarning(value,"サブタイトルが 入 力 されていません "); } } else if(value.getpath().equals("date[1]")) { String date = value.getstringvalue(cms); if(date == null date.trim().length() == 0 date.equals("0")){ errors.adderror(value, messages.getstring("validate.date.blank")); } } 87

88 contentvalues は I_CmsXmlContentValue オブジェクトのList になっています I_CmsXmlContentValue オブジェクトが 各 入 力 項 目 の 情 報 です ソースでは I_CmsXmlContentValue オブジェクトをvalue という 変 数 に 格 納 していますが value.getpath()で 各 入 力 項 目 名 をフルパスで 取 得 できます 可 変 長 の 入 力 項 目 を 意 識 して 全 て 配 列 の 形 式 の 名 前 (xxx[1])が 返 ってきます value.getname()であれば パスの 情 報 を 含 まず 名 前 だけが 返 ってきます シンプルな 構 造 の 入 力 項 目 であればvalue.getName()で 十 分 です value.getstringvalue(cms)で その 入 力 項 目 の 入 力 データを 取 り 出 すことができます エラーがあった 場 合 errors.adderror()メソッド または errors.addwarning()メソッドで エラーメッセージをセットしていきます エラーの 場 合 は errors.adderror() 警 告 の 場 合 は errors.addwarning() を 使 用 し ま す 各 言 語 用 の プ ロ パ テ ィ フ ァ イ ル を 参 照 す る 場 合 は messages.getstring("validate.date.blank")でメッセージを 取 得 できます 以 下 は I_CmsXmlContentValue クラスの 代 表 的 なメソッドです メソッド 名 説 明 例 getname() エレメント 名 を 取 得 します タイトル 本 文 URL getpath() パスを 取 得 します タイトル[1] 本 文 [1] URL[2] getplaintext(cms) タグなどの 装 飾 情 報 を 除 いた 入 力 値 を 取 得 します タイトルです これはサンプルデータです getstringvalue(cms) 入 力 されている 値 をそのまま 取 得 します タイトルです これは<b>サンプル</b> データです <br/> gettypename() データタイプを 取 得 します OpenCmsString OpenCmsHtml OpenCmsString getcontentdefinition().getinnername() コンテンツの 定 義 名 ( 単 数 形 )を 取 得 します Sample Sample Sample getcontentdefinition().getoutername() コンテンツの 定 義 名 ( 複 数 形 )を 取 得 します Samples Samples Samples 88

89 getminoccurs() XSD で 定 義 された minoccurs の 値 です getmaxoccurs() XSD で 定 義 された maxoccurs の 値 です getindex() このエレメントの 番 号 です 0 か ら 始 まります getmaxindex() このエレメントに 入 力 された 個 数 です (value.getmaxindex() <= maxoccurs)

90 5-13 プレビューボタンの 設 置 入 力 画 面 にプレビューボタンを 設 置 する 事 ができます これにより 保 存 する 前 に プレビューで 確 認 する 事 ができるようになります プレビューボタンを 表 示 するには XSD を 以 下 のように 修 正 します ソースコード:sample.xsd <xsd:schema xmlns:xsd=" elementformdefault="qualified"> <xsd:include schemalocation="opencms://opencms-xmlcontent.xsd"/> <xsd:element name="samples" type="opencmssamples"/> <xsd:complextype name="opencmssamples"> <xsd:sequence> <xsd:element name="sample" type="opencmssample" minoccurs="0" maxoccurs="unbounded"/> </xsd:sequence> </xsd:complextype> <xsd:complextype name="opencmssample"> <xsd:sequence> <xsd:element name="date" type="opencmsdatetime" /> <xsd:element name="title" type="opencmsstring" /> <xsd:element name="subtitle" type="opencmsstring" /> <xsd:element name="body" type="opencmshtml" /> <xsd:element name="url" type="opencmsstring" /> </xsd:sequence> <xsd:attribute name="language" type="opencmslocale" use="required"/> </xsd:complextype> <xsd:annotation> <xsd:appinfo> <preview uri="${previewtempfile}" /> </xsd:appinfo> </xsd:annotation> </xsd:schema> 90

91 以 下 のように 右 上 に 虫 眼 鏡 のアイコンが 表 示 され クリックすると 別 ウインドウでプレビューが 表 示 されます また 以 下 のようにすれば プレビュー 時 の URL を 操 作 し 独 自 にカスタマイズした JSP で 表 示 させ る 事 もできます ソースコード( 一 部 のみ):sample.xsd <xsd:annotation> <xsd:appinfo> <preview uri="/system/modules/.../prev.jsp?resource=${previewtempfile}" /> </xsd:appinfo> </xsd:annotation> 91

92 5-14 複 数 の 構 造 化 コンテンツの 一 覧 を 表 示 する 特 定 のフォルダの 下 にある 構 造 化 コンテンツの 一 覧 を 取 得 して 表 示 する 場 合 は <cms:contentload/>の collector の 指 定 を singlefile から zx.allinfolder に 変 更 します そして param にパスと 最 大 表 示 件 数 を 指 定 します ソースコード:sample5_1.jsp taglib prefix="cms" uri=" %> <html> <head><cms:editable/></head> <body> <cms:contentload collector="zx.allinfolder" param="/news/ sample 10" editable="false"> <div>date:<cms:contentshow element="date" /></div> <div>title:<cms:contentshow element="title" /></div> <div>subtitle:<cms:contentshow element="subtitle" /></div> <div>body:<cms:contentshow element="body" /></div> <cms:contentloop element="url"> <a href="<cms:contentshow element="url"/>" target="<cms:contentshow element="target"/>"> <cms:contentshow element="text"/> </a><br/> </cms:contentloop> <hr/> </cms:contentload> </body> </html> collector に zx.allinfolder を 指 定 すると 特 定 のフォルダの 直 下 のファイルをパスの 昇 順 で 取 得 します collector に 指 定 する 値 次 第 で 取 得 されるリソースと ソート 順 が 決 まります そして 最 大 表 示 件 数 などの 詳 細 なパラメータを param で 指 定 します 92

93 collector に 指 定 できる 値 は 以 下 のものがあります 詳 しくは OpenCms タグリファレンス を 参 照 して 下 さい zx.singlefile 単 一 のファイルの 情 報 を 取 得 します zx.allinfolder 特 定 のフォルダの 直 下 のファイルをパスの 昇 順 で 取 得 します zx.allinfolderdesc 特 定 のフォルダの 直 下 のファイルをパスの 降 順 で 取 得 します zx.allinfolderdatereleased 特 定 のフォルダの 直 下 のファイルを 公 開 日 の 昇 順 で 取 得 します 公 開 日 が 未 設 定 のファイルは 最 終 更 新 日 でソートされます zx.allinfolderdatereleaseddesc 特 定 のフォルダの 直 下 のファイルを 公 開 日 の 降 順 で 取 得 します 公 開 日 が 未 設 定 のファイルは 最 終 更 新 日 でソートされます zx.allinfoldernavpos 特 定 のフォルダの 直 下 のファイルを NavPos プロパティ 値 の 昇 順 で 取 得 します 但 し NavPos が 未 設 定 のファイルが 一 つでもあると zx.allinfolderdatereleased と 同 様 の 動 作 になります zx.allinfoldernavposdesc 特 定 のフォルダの 直 下 のファイルを NavPos プロパティ 値 の 降 順 で 取 得 します 但 し NavPos が 未 設 定 のファイルが 一 つでもあると zx.allinfolderdatereleaseddesc と 同 様 の 動 作 になります zx.allinfolderdatelastmodified 特 定 のフォルダの 直 下 のファイルを 最 終 更 新 日 の 昇 順 で 取 得 します zx.allinfolderdatelastmodifieddesc 特 定 のフォルダの 直 下 のファイルを 最 終 更 新 日 の 降 順 で 取 得 します zx.allinsubtree 特 定 のフォルダ 内 のファイルをパスの 昇 順 で 取 得 します サブフォルダも 再 帰 的 に 検 索 します zx.allinsubtreedesc 特 定 のフォルダ 内 のファイルをパスの 降 順 で 取 得 します サブフォルダも 再 帰 的 に 検 索 します zx.allinsubtreedatereleased 特 定 のフォルダ 内 のファイルを 公 開 日 の 昇 順 で 取 得 します 公 開 日 が 未 設 定 のファイルは 最 終 更 新 日 でソートされます サブフォルダも 再 帰 的 に 検 索 します zx.allinsubtreedatereleaseddesc 特 定 のフォルダ 内 のファイルを 公 開 日 の 降 順 で 取 得 します 公 開 日 が 未 設 定 のファイルは 最 終 更 新 日 でソートされます サブフォルダも 再 帰 的 に 検 索 します zx.allinsubtreenavpos 特 定 のフォルダ 内 のファイルを NavPos プロパティ 値 の 昇 順 で 取 得 し ま す 但 し NavPos が 未 設 定 のファイルが 一 つ で も あると zx.allinsubtreedatereleased と 同 様 の 動 作 になります サブフォルダも 再 帰 的 に 検 索 します zx.allinsubtreenavposdesc 特 定 のフォルダ 内 のファイルを NavPos プロパティ 値 の 降 順 で 取 得 し ま す 但 し NavPos が 未 設 定 のファイルが 一 つ で も あると zx.allinsubtreedatereleaseddesc と 同 様 の 動 作 になります サブフォルダも 再 帰 的 に 検 索 します 93

94 zx.allinsubtreedatelastmodified zx.allinsubtreedatelastmodifieddesc zx.allinfolderprioritydateasc zx.allinfolderprioritydatedesc zx.allinsubtreeprioritydatedesc zx.allinfolderprioritytitledesc zx.allinsubtreeprioritytitledesc 特 定 のフォルダの 直 下 のファイルを 最 終 更 新 日 の 昇 順 で 取 得 しま す サブフォルダも 再 帰 的 に 検 索 します 特 定 のフォルダの 直 下 のファイルを 最 終 更 新 日 の 降 順 で 取 得 しま す サブフォルダも 再 帰 的 に 検 索 します 特 定 のフォルダの 直 下 のファイルを collector.priority プロパティ 値 の 昇 順 で 取 得 します collector.priority プロパティ 値 が 同 じであれ ば collector.date プロパティ 値 を 第 2 ソートキーとして 使 用 します 特 定 のフォルダの 直 下 のファイルを collector.priority プロパティ 値 の 降 順 で 取 得 します collector.priority プロパティ 値 が 同 じであれ ば collector.date プロパティ 値 を 第 2 ソートキーとして 使 用 します 特 定 のフォルダ 内 のファイルを collector.priority プロパティ 値 の 降 順 で 取 得 します collector.priority プロパティ 値 が 同 じであれば collector.date プロパティ 値 を 第 2 ソートキーとして 使 用 します サブフォルダも 再 帰 的 に 検 索 します 特 定 のフォルダの 直 下 のファイルを collector.priority プロパティ 値 の 降 順 で 取 得 します collector.priority プロパティ 値 が 同 じであれ ば Title プロパティ 値 を 第 2 ソートキーとして 使 用 します 特 定 のフォルダ 内 のファイルを collector.priority プロパティ 値 の 降 順 で 取 得 します collector.priority プロパティ 値 が 同 じであれば Title プロパティ 値 を 第 2 ソートキーとして 使 用 します サブフォルダも 再 帰 的 に 検 索 します collector が 未 設 定 の 場 合 zx.allinfolderdatereleased が 指 定 されたものとみなします 94

95 次 に param には 読 み 込 むフォルダのパスと リソースタイプと 最 大 表 示 件 数 を 指 定 します param では パラメータが 複 数 の 場 合 で 区 切 る 事 になっていますので 以 下 のようにします 使 用 例 <!-- /news/ 以 下 で 尚 且 つリソースタイプが sample のリソースを 上 位 10 件 まで 取 得 します --> <cms:contentload collector="zx.allinfolderdatereleaseddesc" param="/news/ sample 10" > ( 省 略 ) </cms:contentload> 表 示 件 数 に 0 を 指 定 すると 無 制 限 になります リソースタイプには 構 造 化 コンテンツのリソースタイプしか 指 定 できません また editable を true にした 場 合 直 接 編 集 ボタン 削 除 ボタン 新 規 ボタンが 表 示 されるようにな ります その 時 プレビューから 新 規 ボタンをクリックして 自 動 的 に 新 しいページを 生 成 できるように なるのですが ファイル 名 に 連 番 用 マクロの%(number)を 指 定 していれば 自 動 的 にファイル 名 が 決 定 され ページが 生 成 されます 使 用 例 <cms:contentload collector="zx.allinfolderdatereleaseddesc" editable="true" param="/news/news%(number).html sample 10" > ( 省 略 ) </cms:contentload> この 場 合 新 規 作 成 するたびに /news の 直 下 に news0000.html news0001.html news0002.html と 自 動 的 にファイル 名 が 割 り 振 られます パスやリソースタイプは カンマ 区 切 りで 複 数 指 定 する 事 が 可 能 です また 最 大 表 示 件 数 の 次 に で 区 切 って さまざまな 関 数 を 指 定 できます 詳 しくは OpenCms タグリファレンス を 参 照 して 下 さい 95

96 6 その 他 6-1 HTML エディタのスタイルシートの 指 定 フリーテキストページで 使 用 される HTML エディタは そのままではスタイルシートが 適 用 されま せん その 為 ページのプレビューを 見 るまでは レイアウトが 崩 れたままであったり 表 示 色 が 違 っ てしまう 為 編 集 作 業 に 支 障 をきたす 場 合 があります HTML エディタにスタイルシートを 適 用 する 場 合 は テンプレートの template プロパティにスタイ ルシートのパスを 指 定 します サイトのスタイルシートを 指 定 しても 余 計 な CSS 定 義 が 含 まれているため 上 手 くいかないケー スが 多 いと 思 います 大 抵 は HTML エディタ 専 用 に 別 途 スタイルシートを 用 意 する 事 になります 96

97 6-2 直 接 編 集 領 域 に 日 本 語 のラベルをつける 直 接 編 集 領 域 を 作 成 すると element で 指 定 した 文 字 が HTML エディタのエレメントプルダウンに 表 示 され HTML エディタ 上 で 編 集 領 域 を 切 り 替 える 事 が 出 来 ます ソースコード:sample6_1.jsp taglib prefix="cms" uri=" %> <html> <head><cms:editable/></head> <body> <div> 編 集 領 域 1</div> <div><cms:include element="body1" editable="true" /></div> <div> 編 集 領 域 2</div> <div><cms:include element="body2" editable="true" /></div> </body> </html> element 属 性 に は 半 角 英 数 し か 使 用 で き ま せんが 日 本 語 の ラ ベ ルを 適 用 し た い 場 合 は template-elements 属 性 にラベルを 指 定 します 指 定 する 時 のフォーマットは 以 下 の 通 りです (element 名 ) ( 日 本 語 ラベル), (element 名 ) ( 日 本 語 ラベル), element 名 とラベルを でつなぎ カンマ 区 切 りで 列 挙 していきます 97

98 6-3 文 字 コードの 指 定 表 示 される HTML の 文 字 コードは デフォルトで UTF-8 です これを 別 の 文 字 コードにしたい 場 合 は そのページの content-encoding プロパティに 文 字 コードを 指 定 します プロパティにセットするのは テンプレートの JSP ファイルではなく html ファイルのプロパティ なので 注 意 してください また html ページの content-encoding プロパティにセットすると そのページの 文 字 コードのみが 変 更 されますが フォルダの content-encoding プロパティにセットすると そのフォルダの 中 のページ 全 てに 対 して 適 用 されます html ページだけでなく CSS や JavaScript txt xml といった テキストデータであれば 同 様 の 方 法 で 文 字 コードを 指 定 できます 注 意 点 として テキストファイルを OpenCms へアップロードする 場 合 ですが 新 規 のときは UTF-8 ととして 解 釈 されます アップロードで 新 規 作 成 されるとき content-encoding プロパティには 何 もセ ットされませんので デフォルトの UTF-8 が 適 用 され 文 字 化 けとなります この 場 合 は アップロード 後 手 動 で content-encoding プロパティに 文 字 コードをセットするか あ らかじめ そのフォルダの content-encoding プロパティに 文 字 コードをセットしておく 必 要 があります 運 用 上 の 混 乱 を 避 ける 為 にも サイト 単 位 で 文 字 コードは 統 一 しておく 事 をお 勧 めします 98