XiuMai::Module

モジュールマニュアル

概要

モジュールは、XiuMai形式テキストの書式では指定できない細かい指定や、複雑な機能を実行します。

モジュールには以下の2つの形式があります。

ブロックモジュール

行単位に記述します。

#モジュール名(パラメータ)<<EOD
内容...
内容...
EOD

内容にはモジュールを含む任意のXiuMai形式テキストを記述できます。 EODには任意の文字が使用できますので、目印となる名前をつけるとよいでしょう。

インラインモジュール

1行の中に記述します。

&モジュール名(パラメータ){内容};

複数行にまたがっての記述はできません。 内容にはインラインモジュールも記述できます。


title - HTMLのタイトルを指定する

#title(タイトル)

文書のタイトルの代わりに、指定したタイトルをHTMLのタイトルとして使用します。 タイトル中に $$ を記述すると、その位置に文書のタイトルを挿入します。

contents - 目次を作成する

#contents

指定された位置に目次を作成します。

include - 別のファイルを読み込む

#include(URL)

指定された位置にURLで指定されたファイルの内容を展開します。 同一XiuMaiサーバ内のXiuMai形式テキストのみがインクルード可能です。

img - 画像を埋め込む

#img(URL, 代替文字列, オプション...)
&img(URL, 代替文字列, オプション...);

URLで指定された画像を埋め込みます。 代替文字列はHTMLのalt属性になります。

オプションには以下が指定できます。 複数のオプションを指定する場合は、カンマで区切ってください。

color - 文字の色を変える

&color(文字色[, 背景色]){文字列};

文字列の文字色と背景色を指定します。 背景色は省略できます。

文字色, 背景色には以下の形式が使えます。

size - 文字の大きさを変える

&size(サイズ){文字列};

文字列のフォントサイズを指定します。 サイズには以下の形式が使えます。

br - 改行する

&br;

指定された位置で改行します。

footnote - 脚注を表示する

#footnote

指定された位置に脚注を表示します。

clear - 文字の回り込みを解除する

#clear(オプション)
#clear
&clear(オプション);
&clear;

imgモジュールなどで指定された文字の回り込みを解除します。

オプションにはleftもしくはrightが指定できます(CSSのclearプロパティの値)。 オプションを省略した場合は、左右両方の回り込みを解除します(CSSのboth)。

class - スタイルシート用のクラスを定義する

#class(クラス名)<<EOD
&class(クラス名){文字列};

ブロックモジュールの形式の場合、以下のHTMLに変換されます。

<div class="クラス名"> ... </div>

インラインモジュールの形式の場合は、以下のHTMLです。

<span class="クラス名">文字列</span>

style - スタイルシートを指定する

#style(URL[, media])
#style<<EOD

URLが指定された場合、そのURLを外部スタイルシートのURLとします。 外部スタイルシートは複数指定できます。 mediaにスタイルシートの“media”を指定することもできます。

URLが指定されていない場合は、 EODにはさまれた文字列をHTML内部にスタイルシートとして展開します。

icon - アイコンを指定する

#icon(URL)

URLで指定された画像をアイコン(favicon)として使用します。

lang - コンテンツの言語を指定する

#lang(言語)
#lang(言語)<<EOD
&lang(言語){内容};

言語をコンテンツの言語とします。 言語には、ja, en-US といった言語タグを指定してください。 内容を指定した場合は、内容の部分のコンテンツの言語を指定します。

redirect - 指定したURLにリダイレクトする

#redirect(URL[, 秒数])

URLで指定したURLに秒数後にリダイレクトします。 秒数を省略した場合は、即座にリダイレクトします。

tag - HTMLタグを使う

#tag(タグ名 属性)<<EOD
#tag(タグ名 属性)
&tag(タグ名 属性){内容};
&tag(タグ名 属性);

自由にHTMLのタグを埋め込むことができます。

内容が指定された場合は以下に変換します。

<タグ名 属性> ... </タグ名>

内容が指定されていない場合は以下に変換します。

<タグ名 属性 />

属性は、属性名="属性値" の形式で、複数指定できます。