時点の ToraToraWikiManual/ja/Wiki/Function/alias
概要
&alias(エイリアス名){エイリアスの定義}
よく使用するWiki記法に名前をつけておき,後で簡単に使用できるように準備します. これをエイリアスを定義しているといいます. 定義を行うのみでこの記法自体は何の表示も行いません.
定義されたエイリアスは
&エイリアス名
という形でファンクションと同じように使用できます. パラメータや対象もファンクションと同様に使用できます.
エイリアスは定義された位置より後ろでのみ使用できます. 定義された位置より後ろであれば &include で挿入されたページ内でも使用できます. 全ページ共通で有効なエイリアスは管理者のみ設定できます.
パラメータ
- エイリアス名
- 定義したいエイリアスの名前を指定します.&記号は不要です.
対象
エイリアスの定義をWiki記法で書きます.
エイリアスの定義内で
<PARAMS> と記述すると,エイリアスが使用された際のパラメータに置き換わります.
<パラメータ名> と記述すると,エイリアスが使用された際のパラメータのうちパラメータ名=値形式のものの値に置き換わります.
<TARGET> と記述すると,エイリアスが使用された際の対象に置き換わります.
<PARAMS=初期値> や <TARGET=初期値> のように記述するとパラメータや対象が省略された場合の初期値を設定できます.
定義の先頭を半角スペースにすると行頭記法の整形済みテキストとして解釈されるので注意して下さい.
例
とを同時に使うことが頻繁にある場合, &aliasを使用すると簡素に記述することができます. ここではこの二つの組み合わせをlargecolorというエイリアス名で定義して使用しています.
- ソース
&alias(largecolor){&size(200%){&color(<PARAMS>){<TARGET>}}} &largecolor(red){大きいし,色もつけたい.けど長い記述はめんどう.} &largecolor(green){何度も似た記述をする場合はエイリアスは有用.}
- 表示
大きいし,色もつけたい.けど長い記述はめんどう. 何度も似た記述をする場合はエイリアスは有用.