Random Banner

v1.1 の文法

定義される関数

className は読み込み時のパラメーターで、デフォルト値は RBanner です。

関数名	説明	引数	戻り値
className	className.rb_easy と同等	className.rb_easy と同等	className.rb_easy と同等
className.rb_easy	メインとなる関数。ランダムバナーを定義し、表示する。	別記	なし
className.rb_easy	className.rb_easy の画面へ出力しないバージョン。	className.rb_easy と同等	生成した HTML の文字列
className.rb_html	v1.0 互換。HTML を生成し、表示する。通常は利用しない。	フォーマット文字を含むHTML, 可変引数...	なし
className.rbs_html	最終的に呼ばれる関数。className.rb_html の画面へ出力しないバージョン。	className.rb_html と同等	生成した HTML の文字列

className.rb_easy の引数

引数には次のような値をがあります。

仮称	値	デフォルト
img_url	画像の URL。フォーマット文字を含む。	なし
alt	画像の代替文字	空文字
url	リンク先の URL	なし
width	画像の幅	自動
height	画像の高さ	自動
target	リンク先のターゲット	読み込み時パラメーターの target

引数の順番は次のうちのどれかでなければいけません。

• img_url
  
• img_url, alt
  
• img_url, alt, url
  
• img_url, alt, url, target
  
• img_url, width, height
  
• img_url, width, height, url
  
• img_url, width, height, url, target
  
• img_url, alt, width, height
  
• img_url, alt, width, height, url
  
• img_url, alt, width, height, url, target

また、最後にフォーマットに応じた可変引数が付きます。
詳細はサンプルをご覧ください。

サンプル

利用できるフォーマット文字は、利用する sprintf のライブラリに依存します。
ただし、基本となるのは、C言語の printf のフォーマット文字です。

数値で指定する場合

RBanner("image%d.jpg", "test", "http://example.com", [1, 10]);

この場合、ランダムで次の画像が表示されます。
image1.jpg, image2.jpg, ... , image10.jpg
代替文字は test、リンク先は !http://example.com となhttp://example.com
また、次のように複数箇所にフォーマット文字を指定することも出来ます。

RBanner("image%d-%d.jpg", [1, 10], [1, 5]);

この場合、ランダムで次の画像が表示されます。
image1-1.jpg, image1-2.jpg, ... , image10-5.jpg
リンク先を指定していないため、リンクは生成されません。
範囲を複数指定することもできます。

RBanner("image%d.jpg", [1, 5, 10, 15]);

この場合、ランダムで次の画像が表示されます。
image1.jpg, image2.jpg, ... , image5.jpg もしくは image10.jpg, image11.jpg, ... , image15.jpg

文字列で指定する場合

RBanner("image-%s.jpg", ["foo", "bar", "baz"]);

この場合、次の画像がランダムで表示されます。
image-foo.jpg, image-bar.jpg, image-baz.jpg
両方を組み合わせて利用することも、もちろん可能です。