オプションは、特に「省略不可です」と書かれているもの以外は全て省略可能です。
オプションでディレクトリやファイル名の指定を行う場合、rnote.php からの相対URLで記述するものと、entries が基点になるものの２種類ありますので注意が必要です。基本的に、カテゴリや記事の場合はentriesが基点になり、スキンファイル等の指定は rnote.php の存在する場所が基点になります。
- <%=$include%>
-
別のテキストファイルを指定位置に挿入します。
複数の html_body.skin が複数のディレクトリに存在する場合、もし、各 html_body.skin に共通部分が多いならば、その共通部分を別ファイル化し、各 html_body.skin から include するようにすると、更新の際はその共通部分のファイルのみを変更すれば良く、管理が楽になります。オプション名 説明 url 挿入するテキストファイルを指定します。rnote.php の存在する場所からの相対URLで記述します。
このオプションは省略不可です。この命令を使って、別のCGIで生成したテキストファイルを指定位置に挿入するというテクニックも使用できます。但し、挿入された状態でキャッシュが生成されるので、毎回内容を変化させたいような場合にはこのテクニックは使用出来ません。
そのような事をしたい場合は、evalを有効にして <?php print(file_get_contents('うんちゃら.txt'));?> とするか、又は（xhtml的には問題がありますが）インラインフレームで表示するという方法もあります。 - <%=$plugin%>
-
プラグインを呼びます。
オプション名 説明 name プラグイン名です。省略不可。 func 関数名です。プラグインによっては省略できます。 opt プラグインに渡すオプションを記述します。プラグインによっては省略できます。 cache offにするとプラグインの出力がキャッシュされず、毎回プラグインが呼ばれます。 詳しくは各プラグインの説明に従ってください。
- <%=$site_items%>
-
ITEM用スキンを挿入します。要するに、この置換命令の場所に記事が表示されます。
オプション名 説明 url カテゴリの指定です。このオプションが省略された場合は、ユーザーのアクセスしたカテゴリが表示されます。
例えば、サイドバーに最新記事のタイトルを表示したいという場合は url="/" と書いておいて下さい。これを書き忘れますと、日記コーナーに入った時は日記の最新記事タイトルが、画廊に入ったら画廊の最新記事タイトルが表示されてしまいます。date 日付の指定です。
2004年の記事を表示したい場合は date="2004"、2004年1月の記事を表示したい場合は date="2004-01" と書きます。num １ページに表示する記事の最大数です。省略時は初期設定で設定された数になります。 start
end例えば「２つめから４つめ迄の記事を表示」というような事が出来ます。
このオプションが指定されている場合は num オプションは無視されます。
マクロ処理の結果、表示すべきものが何も無かった場合、その記事はカウントの対象になりません。sort ソート方法を指定します。 - sort="df" タイムスタンプの古い順
- sort="dr" 新着順（省略時ディフォルト）
- sort="ff" ファイル名順
- sort="fr" ファイル名逆順
- sort="cf" コメント込みのタイムスタンプ正順
- sort="cr" コメント込みのタイムスタンプ逆順
skin このオプションが指定されている場合は、ディレクトリ依存の標準ITEM用スキンではなく、ここで指定されたITEM用スキンが使用されるようになります。
rnote.php の存在する場所からの相対URLで記述します。 - <%=$navi_forthback%>
-
前後移動などのサイトナビゲーションを作成します。
オプションの記述が無い場合は、下記のような標準のナビゲーション表示を行います。Category:Home (Total 59 items) « 7-9 | 4-6 | 1-3 »
<%=$site_items%> 置換命令がページ中に存在し、かつ url と date オプションが共に指定されていない場合にのみ、<%=$navi_forthback%> 命令はサイトナビゲーションを作成します。
オプション名 説明 mode="link" HTMLの<head>タグ内の<link rel="prev" や rel="next" タグを生成します。 mode="category" (0.9.6以降) 現在の階層（Home/Diary 等）を表示します。 id="..."
class="..."mode="prev" 及び "next" において生成されるボタンの <a> タグ内に、指定された id 及び class 属性を記述します。 mode="compact" 表示がコンパクトになります。主に携帯表示用。 prev_str="..."
next_str="..."単一ファイル表示時、前後移動が記事名ではなく、指定の文字列になります。 mode="prev"
mode="next"前後移動のボタンのみを生成します。 str="..." mode="prev" 及び "next" において生成されるボタンに表示する文字列を指定します。
strオプションが無い場合は、単独ファイル表示時は前後のエントリのタイトル、複数ファイル表示時は 4-6 等の表示になります。prev_str, next_str の使用例：
<%=$navi_forthback prev_str="←前の記事" next_str="次の記事→" %>
prev ＆ next ボタン生成の記述例：
<%=$navi_forthback mode="prev" class="btn_prev" str="前へ戻る" %> <%=$navi_forthback mode="next" class="btn_next" str="次へ進む" %>
- <%=$last_modified%>
-
最終更新日時を表示します。
ちなみにこれは、再構築した日時ではなく、一番新しい記事（但しHomeで表示されないものは除外）のタイムスタンプです。オプション名 説明 fmt 日付のフォーマット文字列を指定します。
fmt="%Y-%m-%d" のように記述します。
詳細は PHPの strftime(); 命令の説明をお読みください。locale 日付のロケールを指定します。曜日を「日曜日」と表示したい場合は「ja_JP」又は「ja_JP.UTF8」、「Sunday」と表示したい場合は「en_US」等にします。
省略時は初期設定で指定されたロケールが使用されます。 - <%=$site_link%>
-
サイト内リンクを生成します。
詳細は「サーバーの設定」の項で説明しますが、> http://your.site.com/rnote.php?u=diary/d20040101.htm
というアドレスは、mod_rewrite を使用し rnote.php を隠蔽した場合、
> http://your.site.com/diary/d20040101.htm
でアクセス出来るようになり、mod_rewrite を使用するかしないかで、サイト内のURLが変化してしまいます。
<%=$site_link%> 置換命令を使用してサイト内リンクを生成すれば、mod_rewrite 使用・不使用に関わらず、書き換えを行う必要が無くなります。オプション名 説明 url アクセスしたいカテゴリ、又は記事を指定します。
カテゴリを指定する場合は、最後が / で終わっていなければなりません。date アクセスしたい日付を指定します。 skin このオプションが指定された場合は、ディレクトリ依存のBODY用スキンではなく、ここで指定されたBODY用スキンが使用されます。
rnote.php の存在する場所からの相対URLで記述します。
なお、拡張子 .skin は記述する必要はありません。type "html" 又は "xml" のいずれかを指定出来ます。"html"がディフォルトです。"xml" が指定された場合は、Content-Type: text/xml;（初期設定で変更可能）として送信されます。 mode 任意のモード名を設定出来ます。同じ URl でも、モードによって表示内容を変更する事が可能です。条件判断は <if mode="..."> で行います。 - <%=$site_base%>
-
rnote.php が置かれているurlです。
- <%=$site_url%>
-
サイトのurlです。初期設定の SITE_URL の内容が表示されます。
<%=$site_base%> と似ていますが、rNote をサイトの一部だけで使用してる場合、両者は異なった url になります。 - <%=$site_title%>
-
サイト名です。初期設定の SITE_TITLE の内容が表示されます。
- <%=$site_entrytitle%>
-
HTMLの<head>の<title>タグ用です。現在のカテゴリ名又は記事タイトルが表示されます。
- <%=$site_charset%>
-
文字コードです。ディフォルトは UTF-8 です。初期設定の SITE_CHARSET の内容が使用されます。
- <%=$site_lang%>
-
言語です。日本は ja です。初期設定の SITE_LANG の内容が使用されます。
- <%=$site_author%>
-
管理者名です。初期設定の SITE_AUTHOR の内容が使用されます。
- <%=$rss_url%>
-
RSSファイルのURLです。
- <%=$rnote_version%>
-
rNoteのバージョンが表示されます。
- <%=$rnote_url%>
-
rNoteサポートページへのリンクが生成されます。
- <%=$bbs_posturl%> （0.9.4以降）
-
BBSのPOST先です。BBSのフォームを生成するのに使用します。
- <%=$cookie_name%> （0.9.4以降）
- <%=$cookie_url%> （0.9.4以降）
- <%=$cookie_pass%> （0.9.4以降）
-
クッキーに記録された投稿者の名前、URL、パスワードです。BBS及びツッコミのフォームを生成するのに使用します。
- <%=$navi_category%> （0.9.3以前）
- <%=$navi_archive%> （0.9.3以前）
- <%=$navi_calendar%> （0.9.3以前）
-
これらの命令は将来廃止予定です。カテゴリ表示、日付アクセス、カレンダーはプラグイン化され、本体から分離しました。