skins:vars

Nucleus変数

Nucleusでは、特定の機能を呼び出す際に、意味を持った特殊な文字列を使用します。 ページを表示する際に、Nucleusがその文字列を読みとって適切な値に交換します。

スキンやテンプレート、アイテムの本文中などで使用します。

Nucleus変数は、

<%変数名(引数1,引数2...)%>

という形で書きます。

  • 引数は「パラメータ」と呼ばれることもあります。
  • 引数が不要の変数もあります。
  • プラグイン機能を実行させる時、この記述方法を使う場合もあります。
    • プラグインを呼び出す場合は、変数名はプラグイン名の先頭「NP_」に続く名前と同じです。
    • 大文字/小文字も判別しますので一致していない場合は正しく呼び出すことができませんので注意してください。
    • プラグイン呼び出しの場合の引数は、プラグインによって異なります。各プラグインの説明を参照してください。
  • Nucleusのバージョンによりサポートされている変数/引数が異なります。引数が追加される場合もあります。

変数のリスト

各変数の機能や引数の種類などの詳細は、変数名をクリックして個別ページを参照してください。

また、付属の /nucleus/documentation/help.html ( http://japan.nucleuscms.org/documentation/help.html ) にも解説があります。

アイテムの本文(続き)でのみ使える変数

アイテムの本文(続き)で使う場合のみ、引数の区切りは「,」(カンマ)ではなく「|」になります。

変数名 概略
<%image%> アイテムの本文中に画像を埋め込む
<%popup%> アイテムの本文中に画像へのリンクを埋め込む
<%media%> アイテムの本文中にファイルへのリンクを埋め込む

スキン/テンプレートの両方で使える変数

変数名 概略
<%include%> 指定されたファイルをそのまま読み込んで展開する
<%parsedinclude%> 指定されたファイルを読み込み、Nucleus変数をパースして展開する
<%phpinclude%> 指定されたファイルを読みみ、PHPファイルとして実行して展開する
<%plugin%> プラグインを呼び出す

スキンでのみ使える変数

変数名 概略
<%additemform%> 選択されているblog(通常はデフォルトのもの)へアイテムを追加するフォームを表示する
<%adminurl%> 管理領域への完全なURLを挿入する
<%archive%> 選択されている月と選択されているblog(通常はデフォルトのもの)のアーカイブを、指定されたテンプレートを用いて表示する
<%archivedate%> 表示しているアーカイブの日付をフォーマットして挿入する
<%archiveyearlist%> スキン変数<%archivelist%>と同様だが、月ごとの代わりに年ごとのエントリーを表示する
<%archivedaylist%> スキン変数<%archivelist%>と同様だが、月ごとの代わりに日ごとのエントリーを表示する
<%archivelink%> 選択されているblog(通常はデフォルトのもの)とカテゴリーのアーカイブリストへのリンクを挿入する
<%archivelist%> 選択されているblog(通常はデフォルトのもの)の存在するアーカイブのリストを、指定されたテンプレートを用いて表示する
<%archivetype%> 日単位か月単位か、どちらのアーカイブタイプが現在表示されているのか示す
<%blog%> 選択されているblog(通常はデフォルトのもの)の一番新しいアイテム群を、指定されたテンプレートを用いて表示する
<%blogsetting%> 選択しているblog(通常はデフォルトのもの)に関する情報を挿入する
<%category%> 選択されているカテゴリーに関する情報を挿入する
<%categorylist%> 指定したblog(通常は選択されているblog)のカテゴリーリストを、指定されたテンプレートを用いて表示する
<%charset%> ページの文字コードを挿入する (3.22より)
<%commentform%> コメント投稿フォームを表示する
<%comments%> 選択されているアイテムにつけられたコメント群を、指定されたテンプレートを用いて表示する
<%else%> 直前の<%if%>で定義された条件を満たしていない場合に、この変数に続く記述を実行する (<%if%><%endif%>とセットで使用)
<%endif%> 直前の<%if%><%else%>との条件分岐を終了する (<%if%><%else%>とセットで使用)
<%errormessage%> エラーが発生したときに、それに相当するメッセージを挿入する
<%if%> 引数の条件を満たしている場合のみこの変数に続く記述を実行する (<%else%><%endif%>とセットで使用)
<%ifcat%> (<%if(category)%>と同義)
<%image%> 画像のポップアップページにて、選択された画像を表示する
<%imagetext%> 画像のポップアップページにて、選択された画像の見出しを表示する (<%image(caption)%><%image(text)%>と同義 <%image%>参照)
<%item%> 選択されているアイテムを、指定されたテンプレートを用いて表示する(コメントは除く)
<%itemid%> 選択されているアイテムのIDを挿入する
<%itemlink%> 選択されているアイテムへの永続リンクを挿入する
<%itemtitle%> 選択されているアイテムのタイトルを挿入する
<%loginform%> ログインフォームを加えるか、"ログイン中"というメッセージを表示する
<%member%> 現在ログインしているメンバーに関する情報を挿入する
<%membermailform%> メンバーの詳細ページで選択されているメンバーに対して、他のログインしているメンバーがメッセージを送ることのできるフォームを表示する
<%nextarchive%> 1つ次のアーカイブを示す文字列を挿入する (アーカイブページへのURL内で使用できる)
<%nextitem%> 同一blogにおいて1つ後にあたるアイテムのIDを挿入する
<%nextitemtitle%> 同一blogにおいて1つ後にあたるアイテムのタイトルを挿入する
<%nextlink%> アイテムページにおいては1つ先のアイテムへの、アーカイブページにおいては1つ先のアーカイブへのリンクを挿入する
<%nucleusbutton%> Nucleuのウェブサイトへのリンクが付いた、ボタン(あるいはバナー)を挿入する
<%otherarchive%> 選択されている月のアーカイブを、指定されたblogとテンプレートを用いて表示
<%otherarchivedaylist%> スキン変数<%archivedaylist%>と同様だが、月ごとの代わりに日ごとのエントリーを表示
<%otherarchivelist%> 選択された月のアーカイブを、指定されたblogとテンプレートを用いて表示する
<%otherblog%> 指定されたblogの一番新しいアイテム群を、指定されたテンプレートを用いて表示する
<%othersearchresults%> 指定されたblogの現在のクエリに対する検索結果を、指定されたテンプレートを用いて表示する
<%prevarchive%> 1つ前のアーカイブを示す文字列を挿入する (アーカイブページへのURL内で使用できる)
<%preview%> 指定されたテンプレートを用いて、ページ内にアイテムのプレビューを挿入する
<%previtem%> 同一blogにおいて1つ前にあたるアイテムのIDを挿入する
<%previtemtitle%> 同一blogにおいて1つ後にあたるアイテムのタイトルを挿入する
<%prevlink%> アイテムページにおいては1つ前のアイテムへの、アーカイブページにおいては1つ前のアーカイブへのリンクを挿入する
<%query%> 現在の検索クエリを挿入する
<%referer%> 参照元のURLを挿入する
<%searchform%> 現在のblogに対する検索フォームを表示する
<%searchresults%> 検索結果を表示する
<%self%> 現在表示しているページのファイル名を挿入する
<%set%> パーサーのプロパティを設定する
<%sitevar%> サイトに関する情報を表示する
<%skinfile%> インポートされたスキン内のファイルへの相対リンクを挿入する
<%skinname%> 現在使用しているスキンの名前を挿入する
<%todaylink%> 選択されているblog(通常はデフォルトのもの)とカテゴリーのメインページへのリンクを挿入する
<%version%> 現在使用しているNucleusのバージョンを挿入する

テンプレートでのみ使える変数

変数名 概略
<%title%> アイテムのタイトル
<%body%> 本文のテキスト
<%more%> 続きのテキスト
<%category%> カテゴリーの名前
<%categorylink%> カテゴリーへの未加工のリンク
<%karma%> カルマ投票の得点
<%authorlink%> 作者への未加工のリンク
<%itemlink%> アイテムへの未加工のリンク(permanent)
<%author%> 作者の名前
<%smartbody%> 本文か続きのどちらか
<%morelink%> 続きを読む為のリンク
<%date%> フォーマット済みの日付
<%time%> フォーマット済みの時刻
<%daylink%> その日のアーカイブへの未加工のリンク
<%comments%> コメント・ブロックかコメント数
<%itemid%> アイテムのID
<%blogurl%> blogのURL
<%authorid%> 現在のアイテムの作者ID
<%blogid%> blogのID
<%catid%> 現在のアイテムが属するカテゴリーのID
<%query%> 検索のクエリ(もし存在するなら)
<%syndicate_title%> 配信用のタイトル
<%syndicate_description%> 配信用の本文テキスト
<%karmaposlink%> 投票用の未加工リンク
<%karmaneglink%> 投票用の未加工リンク
<%new%> 新しいアイテムを示すテキスト
<%edit%> アイテム編集のリンクを挿入
<%editlink%> アイテム編集の未加工リンク(bookmarkletへのリンク)
<%editpopupcode%> editlink用のウィンドウをポップアップするjavascriptコード
<%skinfile%> インポートされたスキンに属しているファイル用の正確なURLの取り込み
<%set%> パーサーのプロパティを設定
<%image%> メディア書庫へのインライン画像
<%popup%> メディア・ディレクトリの画像をポップアップ
<%media%> メディア・ディレクトリからの他のメディア・オブジェクト
<%relevance%> 検索結果を表示するテンプレートに'search,hit,relevance'をインクルードする(2.5 より)

スキンのタイプ別使用可能一覧

変数名 archive archivelist error popup index item member search
<%additemform%> × × × × × × ×
<%adminurl%>
<%archive%> × × × × × × ×
<%archivedate%> × × × × × × ×
<%archivedaylist%> × × ×
<%archivelink%>
<%archivelist%> × × ×
<%archivetype%> × × × × × × ×
<%blog%> × × ×
<%blogsetting%> × ×
<%category%>
<%categorylist%> × × ×
<%commentform%> × × × × × × ×
<%comments%> × × × × × × ×
<%else%>
<%endif%>
<%errormessage%> × × × × × × ×
<%if%>
<%image%> × × × × × × ×
<%include%>
変数名 archive archivelist error popup index item member search
<%item%> × × × × × × ×
<%itemid%> × × × × × × ×
<%itemlink%> × × × × × × ×
<%itemtitle%> × × × × × × ×
<%loginform%>
<%member%>
<%membermailform%> × × × × × × ×
<%nextarchive%> × × × × × × ×
<%nextitem%> × × × × × × ×
<%nextitemtitle%> × × × × × × ×
<%nextlink%> × × × ×
<%nucleusbutton%> 2
<%otherarchive%> × × × × × × ×
<%otherarchivedaylist%>
<%otherarchivelist%>
<%otherblog%>
<%othersearchresults%> × × × × × × ×
<%parsedinclude%>
<%phpinclude%>
<%plugin%>
変数名 archive archivelist error popup index item member search
<%prevarchive%> × × × × × × ×
<%preview%> × × × × × × ×
<%previtem%> × × × × × × ×
<%previtemtitle%> × × × × × × ×
<%prevlink%> × × × ×
<%query%> × × × × × × ×
<%referer%>
<%searchform%>
<%searchresults%> × × × × × × ×
<%self%>
<%set%>
<%sitevar%>
<%skinfile%>
<%skinname%>
<%todaylink%>
<%version%>
 
skins/vars.txt · 最終更新: 2011/03/23 21:28 (外部編集)