PukiWiki/1.4/マニュアル/プラグイン/c


calendar、calendar_edit、calendar_read

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式

#calendar(
[{[ページ名],
[年月]}]
)

#calendar_edit(
[{[ページ名],
[年月]}]
)

#calendar_read(
[{[ページ名],
[年月]}]
)

概要

指定した位置にカレンダーを設置します。カレンダー上でyyyy/mm/ddという日付を選択すると、ページ名/yyyymmddというページを編集/表示できます。

カレンダーの日付を選択した場合に該当するページを編集状態、表示状態のどちらで開くかが3つのプラグインの違いです。calendar_editとは編集状態で、calendar, calendar_readは表示状態で開きます。

引数

ページ名はWikiNameまたはBracketNameで指定します。
ページ名を省略すると設置したページのページ名になります。

年月は表示するカレンダーの西暦と月をyyyymmの形式で指定します。省略した場合は現在の年月になります。

備考

より高機能なcalendar2プラグインがあるため、あえてcalendarプラグインを使う必要性はほとんどなくなりました。

calendar_editプラグイン及びcalendar_readプラグインの中からcalendarプラグインを呼び出しているため、calendarプラグインがないと機能しません。

calendar_viewer

種別

(コマンド)

ブロック型プラグイン

重要度

★★★☆☆

書式
#calendar_viewer(
ページ名,
yyyy-mm|
n|
x*y|
this
[,[past|future|view]
[,年月日表示の区切り文字]]
)
概要

calendarプラグインまたはcalendar2プラグインで作成されたページを指定した位置に表示します。

引数

ページ名はcalendarプラグインまたはcalendar2プラグインを設置しているページの名前を指定します。ページ名はWikiNameまたはBracketNameで指定します。

yyyy-mmを指定時、指定した年月のページを表示します。

数字を指定時、指定した件数分のページを表示します。

x*yを指定時、先頭より数えて x ページ目(先頭は0)から、y件づつ一覧表示します。x と yはいずれも数値です。

thisを指定時、今月のページを一覧表示します。

past、future、viewで表示するページの条件を指定します。省略/無指定時はpastとなります。

  • past - 今日以前のページを表示します。
  • future - 今日以降のページを表示します。
  • view - 過去から未来へ一覧表示します。

年月日の区切り文字は-や/などを指定します。省略した場合は-になります。

備考

calendar2プラグインでは今日の日付の記事がない場合、記事を表示しないため、午前0時になったとたんに記事が表示されなくなるという弱点がありました。calendar_viewerはその弱点を補うために開発されたプラグインです。calendar_viewは、日付が変わっても最新の記事を表示することができます。カレンダーそのものの表示はcalendar2(off)で行ないます。

calendar2

種別

(コマンド)

ブロック型プラグイン

重要度

★★★☆☆

書式
#calendar2(
[{[ページ名|*],
[yyyymm],
[off]}]
)
概要

指定した位置にカレンダーを設置します。表示月のとなりに表示されたリンク(<< および >>)を選択することで先月/次月分のカレンダーを表示できます。カレンダー上でyyyy/mm/ddという日付を選択すると、ページ名/yyyy-mm-ddというページを表示できます。当日分のページが作成されていた場合、カレンダーの右隣に当日分のページ内容を表示します。

引数

ページ名で表示するページの上位階層のページを指定できます。ページ名を省略すると設置したページのページとなります。ページ名に*を指定すると上位階層のページはなし(表示するページ名がyyyy-mm-dd)となります。

yyyymmで表示するカレンダーの西暦と月を指定できます。省略時は当日の年月となります。

offを指定時、当日分ページを表示する機能は抑制されます。省略時は当日分のページを表示します。

備考

calender_editで作成したページはページ名/yyyymmddとなり、calender2で作成したページはページ名/yyyy-mm-ddとなるため、注意が必要です。

clear

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#clear
概要

refプラグインのaroundオプションで有効となったテキスト回り込み指定を解除します。

備考

imgプラグインのclearオプション指定時と処理内容は同等です。

color

種別

インライン型プラグイン

重要度

★★★★☆

書式
&color(
文字色
[,背景色]
){
文章
};
概要

引数で指定したインライン要素(主に文章)の、文字色・背景色を指定します。

引数

文字色には文章の文字色を6桁の16進数値(rrggbb)か、色名で指定します。

背景色には文章の背景色を6桁の16進数値(rrggbb)か、色名で指定します。

備考

以下、W3C勧告書より抜粋した色名。
Aqua = "#00FFFF",
Black = "#000000",
Blue = "#0000FF",
Fuchsia = "#FF00FF",
Gray = "#808080",
Green = "#008000",
Lime = "#00FF00",
Maroon = "#800000",
Navy = "#000080",
Olive = "#808000",
Purple = "#800080",
Red = "#FF0000",
Silver = "#C0C0C0",
Teal = "#008080",
White = "#FFFFFF",
Yellow = "#FFFF00"

comment

種別

(コマンド)

ブロック型プラグイン

重要度

★★★★★

書式
#comment(
{[above],
[below],
[nodate],
[noname]}
)
概要

コメントの入力用の入力欄を表示します。

引数

コメントの挿入方法を引数で指定します。

  • above - 入力したコメントがコメント入力欄の上に追加します
  • below - 入力したコメントがコメント入力欄の下に追加します(省略時はaboveが指定されたとみなします)
  • nodate - コメント記入者名の入力欄を非表示とします(省略時は表示します)
  • noname - 挿入するコメントに、挿入時刻を付加しない(省略時は付加します)
プラグイン内設定

  • COMMENT_NAME_COLS コメントの名前テキストエリアの表示幅
  • COMMENT_COLS コメントのテキストエリアの表示幅
  • COMMENT_NAME_FORMAT 名前欄の挿入フォーマット
  • COMMENT_MSG_FORMAT コメント欄の挿入フォーマット
  • COMMENT_NOW_FORMAT 時刻欄の挿入フォーマット
  • COMMENT_FORMAT コメント内容全体の挿入フォーマット
  • COMMENT_INS コメントを入力欄の前後どちらに挿入するか
  • COMMENT_MAIL コメントが投稿された場合、内容を送るメールアドレス

contents

種別

擬似ブロック型プラグイン

重要度

★★★☆☆

書式

#contents

概要

設置したページ中の見出しの一覧を表示します。

counter

種別

ブロック型プラグイン

インライン型プラグイン

重要度

★★★☆☆

書式

#counter

&counter(
[total|
yesterday|
total]
);

概要

設置したページの参照回数を表示します。

引数

カウンタ表示方法として today,yesterday,total いずれかを指定します。省略時やその他の文字列を指定した場合はtotalが指定されたとみなします。ブロック型プラグインでは常にtotalが指定されたとみなします。

  • total - そのページが参照された回数の総計を表示します。
  • today - そのページが参照された回数(当日分)を表示します。
  • yesterday - そのページが参照された回数(昨日分)を表示します。
プラグイン内設定

  • COUNTER_EXT ページ参照回数を保持するデータファイルの拡張子
備考

すべてのページで参照回数を表示したい場合は、MenuBarやスキンからcounterプラグインを呼び出してください。