仕様

XML です

設定は全て XML で記述します。ここでは XML とは『いわゆる "タグ" を独自に定義できて、閉じタグが必ず存在する HTML』と思ってくれれば充分だと思います。設定ファイルは、ファイル名を sites.xml にして generate.php と同じディレクトリに置きます。

もっと詳しい定義や資料が欲しい場合は Extensible Markup Language - Wikipedia あたりからどうぞ。

UTF-8 です

設定ファイルは文字コードが UTF-8 である事を前提にして処理されます。Shift_JIS など、他のエンコーディングで全角文字を書くと、正しく文字を認識できず様々なエラーの原因になります。『文字コードって何？』という人は文字コード - Wikipedia あたりへどうぞ。

また、& / > / < は特殊な意味を持つ文字なので直接は書けません。それぞれ &amp; / &gt; / &lt; と記述するのが良いでしょう。中でも & は URL やサイト名に入っている場合が多いため注意が必要です。

要素一覧

設定ファイルで使用できる全要素です。同じ要素名でも入る内容が異なっていれば別々に表記しています。 それぞれの詳細は別途記述しています。

要素ごとの詳細説明

capture

内包する要素	個数	必要性
width	1	必須
height	1	必須

default, category 直下に指定できる要素です。それぞれに 1 つだけ指定できます。これはスクリーンショットを撮る時の設定で、このサイズの領域で表示した時のものを後で縮小します。width が横幅、height が高さにあたります。

category (要素を内容とする)

内包する要素	個数	必要性
name	1	必須
dir	1	必須
engine	1	任意
capture	1	任意
picture	1	任意
image	1	任意
category	0 以上	任意

ルート直下、或いは category 直下に 0 以上存在する要素です。この category の直下には、これと全く同じ構造を持った category を設定することが出来ます。つまり、category の下に category、その下にまた category、更にその下に……とほぼ無限に階層構造を設定する事ができます。但し、image 内 dir の指定はルート直下のものだけが 有効です。（category 直下の dir と混同しないでください ）

デフォルトカテゴリを定義しない場合、カテゴリ設定は省略する方が好ましいです。通常は、1 つ以上記述します。1 つにつき 1 つのカテゴリを設定します。name がカテゴリ名、dir がディレクトリ名、engine がレンダリングエンジン名、capture が画像撮影設定、picture が画像表示設定です。

上位に設定したカテゴリの image, capture, picture の設定を下位のカテゴリは自動的に引き継ぎます。下位カテゴリにも個別に指定を行うと、これを上書きします。

category (文字列を内容とする)

page か default の直下に存在する要素です。default 直下には 1 つだけ、page 直下には 0 以上指定することが出来ます。カテゴリの名前です。

上記の『要素を内容とする category』で定義した名前 (name) のどれかをここで指定します。但し、階層構造を持った category の name を指定することは出来ません。階層構造のうち、末端にあたる、最も深い（それ以上、下のカテゴリがない）category の name を指定してください。

default 内の指定で、これと一致する名前のカテゴリが複数ある場合、最初に見つけたものがデフォルトとして使用されます。

default

内包する要素	個数	必要性
category	1	任意
engine	1	任意
image	1	任意
capture	1	任意
picture	1	任意

ルート直下に 1 つだけ存在する要素です。これが無い場合は内部デフォルト設定を使って処理しますが、あまりお薦めしません。カテゴリやページで個別に engine, image, picture, capture が指定されなかった場合の設定をここで行います。category がカテゴリ名、engine がレンダリングエンジン名、image が画像設定、capture が画像撮影設定、picture が画像表示設定です。

dir

image 直下に 1 つだけ存在する要素です。全ての画像がここで指定されたディレクトリに置かれます。無くても構いません。デフォルト設定内で指定が無い場合は内部デフォルト設定を使います。カテゴリ内で指定が無い場合はデフォルト設定が使用されます。

また、この要素は category 直下にも存在します。image 直下と違い、こちらは必ず記述します。image の dir で指定された、更にその下にカテゴリ別の画像ディレクトリをこの名前で作成し、使用します。

どちらも英数字のみが使用できます。

engine

default, category, page の直下にそれぞれ 1 つだけ存在する要素です。page 直下での指定が無い場合は category での指定を、それも無い場合は default での指定を使用します。

ext

image 直下に 1 つだけ存在する要素です。画像の拡張子を指定します。gif か jpg か png が指定できます。Webnail 2 で取得する場合は jpg 以外を指定しても意味がありません。Webnail "K" が GIF 形式に対応するのは v0.04 からなので、v0.03 以前を使っているにも関わらず gif を指定するとサムネイルの取得時にうまくいきません。

height

picture と capture の直下にそれぞれ 1 つだけ指定します。必ず記述します。それぞれの画像の高さです。ピクセル値として認識されます。

image

内包する要素	個数	必要性
dir	1	任意
ext	1	任意

default, category の直下にそれぞれ 1 つだけ指定できる要素です。画像の主設定をここで指定します。dir がディレクトリ、ext が拡張子の指定です。

limit

option 直下に 1 つだけ指定する要素です。1 ページで表示する最大サムネイル数です。指定が無い場合は 32 件になります。

link

page 直下に 1 つだけ指定する要素です。必ず記述します。リンク先兼サムネイル取得先の URL を指定します。CGI や PHP など、動的生成のページを指定する場合、& を直接書かないよう注意してください。

name

category 直下に 1 つだけ指定する要素です。必ず記述します。ここにカテゴリの名前を指定します。表示する際、カテゴリリストに使用されます。

option

内包する要素	個数	必要性
limit	1	任意
template	1	任意

ルート直下に 1 つだけ指定する要素です。limit で 1 ページに表示する最大サムネイル数を、template でテンプレートファイル名を指定します。

page

内包する要素	個数	必要性
title	1	必須
link	1	必須
engine	1	任意
category	0 以上	任意

ルート直下に 0 以上指定する要素です。しかし、1 つも指定しない場合このツールを使う意味がありません。1 ページにつき 1 つ指定します。title でページタイトル、link でリンク先兼サムネイル取得先、engine でレンダリングエンジン名、category でカテゴリ名を指定します。

カテゴリ名の指定が複数あった場合、表示する際にどちらのカテゴリでも表示されます。画像の撮影や表示に使用される設定は最初に指定したカテゴリ名のものです。

picture

内包する要素	個数	必要性
width	1	必須
height	1	必須

default, category 直下に指定できる要素です。それぞれに 1 つだけ指定できます。これはサムネイル画像の設定で、このサイズに縮小して画像を表示します。width が横幅、height が高さにあたります。

template

option 直下に 1 つだけ指定する要素です。使用するテンプレートファイル名です。英数字と一部の一般的な記号が使えます。指定が無い場合は template.xhtml になります。

thumblink

内包する要素	個数	必要性
webnail	1	必須
default	1	任意
option	1	任意
category	0 以上	任意
page	0 以上	任意

ルート要素です。主設定が直下に内包されます。webnail でサムネイル取得アプリケーション名、default でデフォルト設定、category でカテゴリ設定、page でページ設定を指定します。

title

page 直下に 1 つだけ指定する要素です。必ず記述します。これは HTML で表示する際、img 要素の alt 属性及び a 要素の title 属性に使用されます。通常、リンク先のタイトルを指定します。

webnail

ルート直下に 1 つだけ存在する要素です。必ず記述します。内包する要素は持ちません。 K (Webnail "K" 用), 2 (Webnail 2 用) のいずれかを記述します。例えば下記のようにします。

<webnail>K</webnail>

width

picture と capture の直下にそれぞれ 1 つだけ指定します。必ず記述します。それぞれの画像の横幅です。ピクセル値として認識されます。

要素の階層構造

階層構造を下記に示します。ここで要素名の直後についている記号はそれぞれ次の意味があります。

!

必須

?

0 か 1 つ。どちらでも良い

*

0 以上

thumblink!
  |
  +- webnail!
  +- option?
  |  |
  |  +- limit?
  |  +- template?
  |
  +- default?
  |  |
  |  +- category?
  |  +- engine?
  |  +- image?
  |  |  |
  |  |  +- dir?
  |  |  +- ext?
  |  |
  |  +- capture?
  |  |  |
  |  |  +- width!
  |  |  +- height!
  |  |
  |  +- picture?
  |     |
  |     +- width!
  |     +- height!
  |
  +- category*
  |  |
  |  +-----←------+
  |  |             |
  |  +- name!      |
  |  +- dir!       |
  |  +- engine?    |
  |  +- image?     |
  |  |  |          |
  |  |  +- dir?    |
  |  |  +- ext?    |
  |  |             |
  |  +- capture?   |
  |  |  |          |
  |  |  +- width!  |
  |  |  +- height! |
  |  |             |
  |  +- picture?   |
  |  |  |          |
  |  |  + width!   |
  |  |  + height!  |
  |  |             |
  |  +- category* -+
  |
  +- page*
     |
     +- category*
     +- engine?
     +- link!
     +- title!