SIRIUSの関数一覧と使い方
SIRIUS関数一覧
SIRIUSで使える関数のリストと説明です。関数を使えばSIRIUS独自タグを変化させることがきます。バージョン1.5以降も対応済み。
スタイルシートの独自タグでは関数は使えないので注意しましょう。
関数の使い方
独自タグの後に「|」 を付け、その後に特定の関数を指定することで、独自タグの内容を変更させることができます。
<% 独自タグ | 関数 %>
関数は複数同時に指定することができます。複数の関数が指定されている場合、左側に指定されている関数から適用されます。
<% 独自タグ | 関数１ | 関数2 | 関数3 %>
例えば<% pageTopic %>は以下のように「ページ設定」で入力したH1テキストを見出し（H1）として出力する独自タグです。
<h1>H1テキスト</h1>
以下ではこの独自タグを例として大まかな関数の使い方を説明します。
tag_replaceを使用する場合
tag_replaceは指定したタグを置き換える関数です。tag_replaceの関数を使ってH1をH2に置き換えてみます。
<% pageTopic | tag_replace(h1,h2) %>
<h2>H1テキスト</h2>
出力されるタグがH2に置き換わりました。クラスを設定する場合は以下になります。titleクラスに置き換えた場合です。
<% pageTopic | tag_replace(h1,div class="title") %>
<div class="title">H1テキスト</div>
tag_insertを使用する場合
tag_insertは独自タグで出力されるコードを囲むように親要素にタグが追加されます。
<% pageTopic | tag_insert(div class="title") %>
<div class="title"><h1>H1テキスト</h1></div>
複数のtag_insertの関数を使用した場合、最後に記述したタグが親要素になります。
<% pageTopic | tag_insert(div class="title") | tag_insert(div class="title2") %>
<div class="title2">
<div class="title"><h1>H1テキスト</h1></div>
</div>
tag_insert_innerを使用する場合
tag_insert_innerを使えば指定したタグの子要素にタグを追加することができます。
<% pageTopic | tag_insert_inner(h1,span class="title") %>
<h1><span class="title">H1テキスト</span></h1>
tag_putとtag_pushを使用する場合
tag_putは独自タグの前、tag_pushは後ろに文字列を追加します。文字列なのでタグを追加したい場合は山括弧「<>」で囲む必要がります。
tag_putとtag_pushを使用して記事タイトルと記事本文の前後に<section>タグを挿入すれば、それぞれが記入された場合に<section>タグで囲むようにすることが可能です。
<% textTitle1 | tag_put(<section>) %><% textBody1 | tag_push(</section>) %>
<section>
<h2>記事タイトル1</h2>
<div id="text2">記事本文1</div>
</section>
addAtributeを使用する場合
addAtributeを使用すれば独自タグにstyleなどの属性を追加できます。
<% pageTopic | addAtribute(style="color: red;") %>
<h1 style="color: red;">H1テキスト</h1>
2つの属性を追加したり、クラス属性を追加してスタイルを適用することもできます。
<% pageTopic | addAtribute(style="color: red;") | addAtribute(class="title") %>
<h1 style="color: red;" class="title">H1テキスト</h1>
関数一覧
| 関数 | 関数の説明 | 使用例 |
|---|---|---|
| html | HTMLエスケープを行なう
(タグを文字列のまま表示する) |
ああああ |
| nl2br | 改行コードを<br>タグに変換する |
ああああ |
| ns2sp | 改行コードをスペース文字に変換する |
ああああ |
| oneline | 改行コードを抜いて一行にする |
ああああ |
| shorten(文字数,true) | 削除指定文字数以降を表示しない(画像やタグは削除される)
trueをfalseにすると三点リーダを削除 |
例)shorten(4,true)
ああ<br>ああああああ |
| shorten2(文字数,true) | shortenとは違いHTMLタグを削除しない
<% pageBody | shorten2(300,True) %>のように使うと画像もタグも出力できる |
例)shorten2(3,false)
ああ<br>ああああああ |
| tag_strip | HTMLタグを全て取り除く |
<strong>ああああ</strong> |
| tag_strip(取り除くタグ) | 指定されたタグを全て取り除く |
例)tag_strip(p) |
| tag_insert(追加するタグ) | 指定されたタグを親要素として追加する |
例)tag_insert(p) |
| ag_insert_inner(指定タグ、追加するタグ) | 指定されたタグの子要素としてタグを追加する |
例)tag_insert_inner(strong,p) |
| tag_replace(置換したいタグ,置換後のタグ) | 指定されたタグを置換する |
例)tag_replace(p,h3) |
| tag_put(文字列) | 指定された文字列を前に追加する
タグを使うには(<p>)のように記述 |
例)tag_put(いいいい) |
| tag_push(文字列) | 指定された文字列を後に追加する
タグを使うには(<p>)のように記述 |
例)tag_push(いいいい) |
| str_replace(置換したい文字列,置換後の文字列) | 指定された文字列を置換する |
例)str_replace(ああああ,いいいい) |
| addAtribute(属性) | 指定された属性を追加する |
例)addAtribute(style="color: red;") |
| addRound | 旧角丸テンプレート用のタグを挿入する |