Spelam Rule File Specification

変数名

変数の名前は英字もしくは2バイト文字で始めることとする。

/^[A-Za-z\u0080-\uffff][A-Za-z_0-9\u0080-\uffff]*$/

1.4.1 変数あるいは定数の参照

変数や定数は変数名を2重ブレースで囲むことで参照できる。

 {{name}}

変数の参照は属性値とコンテンツ内の両方で使うことができる。

 <h:a href="{{url}}">{{name}}</h:a>

未定義の変数や定数を参照するとコンパイルエラーが発生する。

 <hoge>abc{{v1}}def<uhyo>ghi</uhyo>jkl</hoge>

 "abc", {{v1}}, "def", <uhyo>ghi</uhyo>, "jkl"

 <hoge parseMode="program">
  <text>abc</text>
  <text>{{v1}}</text>
  <text>def</text>
  <uhyo><text>abc</text></uhyo>
  <text>jkl</text>
 </hoge>

1.4.2 変数の文字列化

変数にはlet文を使うとhtml要素もしまうことができる。 この変数をもし属性文字列中で参照した場合には文字列に変換される。 その処理方法は、 子孫要素に渡ってコンテンツ部分だけを取り出して連結したものとなる。

1
2

 <let name="hoge"><h:span><h:i>hoge</h:i> uhyo</h:span></let>
 <h:span title="{{hoge}}" ></h:span>  <!-- -> 'hoge uhyo' --> 

1.4.3 組み込み変数

{{}}

null 次節を参照。

lb, leftbrace

'{{'

rb, rightbrace

'}}'

empty

空文字列""。属性の場合は""と書ける。

recordNumber

レコード番号。1オリジン。

1.5.1 文字列中のnull

• 文字とnullが連結されるとき、nullは空文字""として扱われる。
• 文字列中にnullしかない場合は、全体がnullになる。
• ただし属性値""は内部的に空の文字列""に変換される。

1.5.2 コンテンツ中のnull

listMode属性によって動作が異なる。

1.5.3 関連項目

listMode属性、 generate属性、 list要素、 array要素、 series要素、 alternate要素。

2.2.1 name

メニューに表示される名前。

任意の文字列。必須。定数。

2.2.2 scale

昆虫の標本ラベルは通常3pt~4pt程度の小さな文字が使用される。 このような小さなサイズはブラウザで制限されていて使えないし、 仮に使えたとしても割付が汚くなる(整数で処理されているもよう)。 そこで、内容を大きく作ってから、 全体を縮小している(cssのtransform機能を使う)。 このときのスケール。

例えばscale="10"とすると、 全体を1/10に縮小するので 内側は10倍の単位30pt〜40ptの大きさで作れる。

あまり大きい値を指定するとブラウザによっては問題を生ずるかもしれない。 10ぐらいが適当?

デフォルトは1。定数。

2.3.1 csvDelimiter

未対応

現在ファイルの先頭から以下の文字を検索し 最初に見つかったものを区切り記号にしている。

"," ";" "|" tab

2.4.1 name

フィールド名を指定する。 ここで指定した名前で参照することができる。

名前規則は変数名と同じ。

必須。定数。

2.4.2 from

フィールド名を変更したい場合に使う。 fromはデータファイルのフィールド名。 nameはルールファイルで使う名前。

1

 <field name="elevation" from="altitude" />

オプション。定数。

2.4.3 default

フィールドが未定義であった場合や空の文字列''であった場合に 標準ではnullが使用される。 これを別の文字列に変換したい場合にdefault属性を使う。

1

 <field name="country" default="Japan" />

オプション。定数。

textboxを使わずに文字を書く場合

ruleの下にhtml要素を置いてその中に文字列を置く場合、 スタイルでwhite-space: normal;を指定する必要がある。

※カードを複数枚横に並べられるようにwhite-space: nowrap;を指定しているが この属性は子要素に引き継がれるため。

textboxの場合はプログラム内で設定している。

html以外

簡単なsvgはOKだった。

※ 未調査

html以外にもブラウザでレンダリング可能な要素なら書けるはずだが

MathMLはなぜかダメだった。htmltextでは大丈夫。

書けない属性

※ 詳しく調べてない。

テンプレートは複製されるためidは書けない。 以下のように別なIDが生成されるようにすれば可能だが、 どういう用途ががあるのかはわからない。

id="hoge-{{recordNumber}}"

spelamの共通属性

名前空間を指定するれば書ける。

1
2
3

 <h:div s:mode="list">
  ...
 </h:div>

変数

Spelamの変数が使える。

1

  <h:a href="{{URL}}">{{title}}</h:a>

2.8.1 scale

ruleで書いたように小さいサイズのフォントを扱うため 内部的に拡大して処理している。 したがってスタイルシートの値もそれに合わせて拡大する必要があるが オプションで変換できるようにした。

下の2つの例は同じスタイルを定義している。

1
2
3
4
5
6

  <style ><![CDATA[
   .card{ width: 220mm; height: 220mm; }
  ]]></style>
  <style scale="10"><![CDATA[
   .card{ width: 22mm; height: 22mm; }
  ]]></style>

オプション。定数。

補足

HTMLの場合、コンテンツ内の文字はデータとして扱われる。 これはparseMode = 'text'に相当する。 インデントを保ちつつ空白を入れないようにしたい場合が時々あり、 その場合は以下のように少し妙な書き方をしないといけない。

1
2
3
4

  <h:div
   ><text>{{country}}</text
   ><text>{{stateProvince}}</text
  ></h:div>

parseMode="porogram"を指定すると空白は無視されるので 以下のようにすっきり書ける。

1
2
3
4

 <h:div s:parseMode="program">
  <text>{{country}}</text>
  <text>{{stateProvince}}</text>
 </h:div>

クラス名の名前の制限

   /^[a-z_\u0080-\uffff][a-z_0-9\-\u0080-\uffff]*
     (\s+[a-z_\u0080-\uffff][a-z_0-9\-\u0080-\uffff]*)*$/i

'slm-'で始まる名前は内部で使用しているので使わないように。

5.2.1 inputFormat 属性

入力書式を"ISO", "DMY", "MDY"のいずれかで指定する。 デフォルトは"DMY"。

5.2.2 format

出力フォーマット。 デフォルトは'd.rm.yyyy'。

  formatValue ::= ((dayFormat sep)? (mothFormat sep)? yearFormat
  dayFormat ::= 'd' | 'dd'
  monthFormat ::= 'rm' | 'RM' | 'Mon' | 'MON' | 'mon' | 'm' | 'mm'
  yearFormat ::= 'yyyy'
  sep ::= [^a-zA-Z0-9]+

  format="d RM yyyy" → 15 III 2018
  format="d.rm.yyyy" → 15.iii.2018
  format="yyyy" → 2018

5.2.3 範囲指定について

入力データの範囲記号は固定で DMY, MDYの場合 ハイフン類('-'|U+2010|U+2011)とする。 ISOの場合は規格どおり'/'とする。

出力フォーマットの範囲記号はU+2010固定としている。

オプション?

入力フィールドが開始日と終了日の２つに分かれている場合、 以下のように'-'(ISOの場合は'/')でつなげていただきたい。

1
2
3
4
5

  <source>
   <field name="dateStart"/>
   <field name="dateEnd"/>
  </source>
  <date>{{dateStart}}-{{dateEnd}}</date>

5.3.1 内容

緯度、経度情報。

入力データは緯度と経度が分離していてもよいしまとまっていてもよい。 まとまっている場合入力フォーマットは自動的に判別されるが、 NSEW記号が含まれない場合は','区切りであることとし、 緯度経度の順であると仮定する。 左側が緯度、右側が経度。 北緯および東経が正の数値で、南緯と西経が負の数値。

  35.795504, 138.389400
  -27.378054, 152.961500

NSEW記号が含まれていればかなり適当に書ける。

  35°47'45.1"N 138°23'21.9"E
  138°23'21.84"E 35°47'43.81"N
  35°47.23'N 138°23.56'E
  N35°47.23' E138°23.56'
  E138°23'21.84" N35°47'43.81"

5.3.2 format属性

出力フォーマット。デフォルトは'DMS'。

値

( 'DMS' | 'DM' | 'D' ) ( '.' decimalPlaces )?
decimalPlaces ::= [0-9]+

'DMS'は度分秒形式、'DM'は度分形式、'D'は度形式。 decimalPlacesは小数点以下桁数。 省略した場合、DMSの場合は0、DMの場合2、Dの場合は4とする。

以下の例では、DMS形式で小数点以下1桁まで表示される。

 format="DMS.1"

5.3.3 symbols属性

度分秒の単位記号として何を使うか。 度の記号はU+00B0(°)固定。

symbols="forComputing"|"forPrinting"

"forComputing"

アポストロフィーU+0027とクォーテーションマーク(U+0022)を使用する。

"forPrinting"

プライムU+2032とダブルプライムU+2033を使用する。

5.4.1 italicIndicators属性

開始記号と終了記号を空白で区切って指定する。 複数文字でもよい。 デフォルトは"/"。

 italicIndicators="{ }"
 italicIndicators="(( ))"

開始と終了が同じ場合は一つで良い。 以下の2つは同じ。

 italicIndicators="/ /"
 italicIndicators="/"

5.4.2 symbols

記号を印刷用のものに変換する。

 symbols="" | "forPrinting"

""

なにもしない。

"forPrinting"

アポストロフィー、一重引用符、乗算記号を変換する。

 't Hart

 \s\'[A-Z]

イタリック化アルゴリズム

栽培種の処理も行っているがここでは割愛する。 (正しいのかどうかもよくわかっていない)

[1] 種小名を探す

以下のパターンであり、

 \s*[a-z][a-z\-\u2010\u2011]*\s

以下のキーワードでないものを種小名とする。

  'subgenus', 'section', 'series',
  'x',
  'ex', 'et', 'in', 'lato', 'nec', 'non', 'sensu', 'strict',

[2] 種小名より左側の文字列に対して

[2.1] 属名

先頭から始まる英大文字で始まる名前を属名としてイタリック化する。

    ^[A-Z][a-z\-\u2010\u2011\.]*\s

'.'は以下のようなのを処理するのに入れてある。

Dianthus caryophyllus × D. plumarius

[2.2] 亜属名

続く()で囲まれた英大文字で始まる名前を亜属名としてイタリック化する。

    \(\s*[A-Z][a-z\-\u2010\u2011]*\s*\)

[2.3] その他

続く以下のキーワードの後ろの大文字で始まる名前をイタリック化する。

 cf. aff. genus gen. subgenus subgen. subg. section sect. series ser.

[3] 種小名をイタリック体で出力

[4] 種小名より後ろの文字列に対して

[4.1] 亜種名

種小名のすぐ後ろに以下のパターンがあった場合、

 \s*[a-z][a-z\-\u2010\u2011]*\s

以下のキーワードはイタリック化しないで出力。

  'subgenus', 'section', 'series',
  'x',
  'ex', 'et', 'in', 'lato', 'nec', 'non', 'sensu', 'strict',

以下のパターンを人名としてイタリック化しないで出力。

  'da', 'de', 'del', 'den', 'di', 'du',
  'la', 'le', 'ten', 'ter', 'van', 'von', 'zur'

それ以外は亜種名としてイタリック化して出力する。

[4.2] 亜種名より後ろは、'f.'などの修飾子の後ろの 小文字で始まる名前をイタリック化する。

 subsp. sub. ssp. var. forma f.

例

joinでデータフィールドが空のときに余計な','を生成したくない場合

1
2
3
4
5
6
7
8
9

 <join>
  <text>, </text>
  <list>
   <text>{{country}}</text>
   <text>{{pref}}</text>
   <text>{{city}}</text>
   <text>{{locality}}</text>
  </list>
 </join>

minWidth, maxWidth, minHeight, maxHeight, minFontSize, maxFontSize

枠の大きさと文字サイズ。 固定の場合は、スタイルで指定してもよい。 指定する場合は、minとmaxは両方を指定し単位は同じであること。 minとmaxは同じ値でもよい。 絶対単位(mm,pt等)の場合、ruleのscale属性が適用される。

構造

2重にdivが作成される。 クラス名を指定した場合は外側のdivに設定される。

 <div class="classname">
  <div>{{contents}}</div>
 </div>

アルゴリズム

文字は大きいほうがよく、枠は小さい方が良いとする。 一次元のパラメタ、評価値(e: 0<=e<=1)をを考え、 以下のような関数でフォントサイズと枠の大きさに対応付ける。 e=1は最も評価が良い状態で e=0は最も評価が悪い。

Fs(e) = maxFontSize*e + minFontSize*(1-e)
Wd(e) = minWidth*e + maxWidth*(1-e)
Ht(e) = minHeight*e + maxHeight*(1-e)

あるeにおけるFs(e)とWd(e)を元に 文字を割り付けた時の高さH(e)とすると、 H(e) <= Ht(e) となる最大のeを求める。

H(e)は必ずしも単調増加ではないが、大域的に単調であるので 2分法を用いて処理している。

e = 0で入らない場合はエラーとする。

7.2.1 rotate

回転する角度を指定する。 単位は"deg"しか対応していない。 正の値で時計回り、負の値を指定すると反時計回りに回転する。

7.2.2 scale, scaleX, scaleY

鏡像のために入れた。

倍率を指定してもよいが、 ruleのscale属性を反映している箇所は 自分で処理する必要がある。

構造

2重にdivが作成される。 クラスを指定した場合はは外側のdivに設定される。

 <div class="classname">
  <div>{{contents}}</div>
 </div>

処理方法

まず内容の大きさを先に求める。 その内容に指定した変形を掛ける。 変形されたものが収まるような最小の枠をその外側に生成する。

制限事項

• textboxの内側には置けない

7.3.1 コンテンツ

コードをしまう。 エンコーディングはUTF-8固定。 スペースもそのまま入るので、無駄なスペースを入れないように注意。

7.3.2 correctLevel 属性

qrcode規格のエラー訂正レベルを指定する。 デフォルトは'Q'。

  'L' | 'M' | 'Q' | 'H'

Hが最も高い。 エラー訂正レベルは高い方が信頼性も高いが、 パターンが複雑になるため小さい面積に印字するのは難しくなる。

スコープ

定数名は一つ上の要素内でのみ有効。

 <textbox>
  <const name="hoge">...</const>
  <!-- このtextbox内でのみ有効 -->
 </textbox>

8.3.1 name

8.3.2 arg

任意の属性を指定できる。