オンライン数表示プラグイン
互換性のある DokuWiki バージョン
- 2024-02-06 "Kaos" 不明
- 2023-04-04 "Jack Jackrum" 不明
- 2022-07-31 "Igor" 不明
- 2020-07-29 "Hogfather" 確認済
This extension is not in the 'plugin' or 'template' namespace and is therefore ignored.
類似 whoisonline
概要
このプラグインは、自分のWikiを閲覧している現在の人数を表示します。
whoisonlineプラグインが既にある事は存じ上げていますが、それよりもシンプルなヤツが欲しかったので、PukiWikiのOnlineプラグインから移植しました1)(PukiWikiから他の幾つかのプラグインも移植予定なので、その練習をしたかったってのもある)。
オンラインの判断基準
プラグインが呼び出されたときに、閲覧者のIPアドレス(表示されません)と時刻を内部的に記録します。
また、そうして記録されたデータの呼び出しも行い、直近10分以内(時間は変更可)にアクセスがあった場合に、その人はオンラインだと判断されます。
導入
プラグインマネージャーと上記URLを利用すると、プラグインの最新版をインストール出来ます。プラグインを手動でインストールする場合はこちらをご覧下さい。
例 / 使い方
括弧内の要素を仕切る文字を「:」から「|」に変更しました(「:」より、あまり馴染みのない文字「|」にした方がいいのかなって思った)。
プラグインを使うページには、~~NOCACHE~~
マクロを記述して下さい(データがリアルタイムに変動するので、ページがキャッシュされると困る)。
このプラグインが呼び出された時にのみ、ユーザーがオンラインだと認識されます(例えば、このプラグインをトップページにのみ設置した場合、トップページ以外へのアクセスはオンラインだと認識されません)。恐らく、サイドバーかテンプレートにこのプラグインを設置するのが一番いい方法かと思います。
一番シンプルなのは、次のような使い方です。
直近10分以内に、{{onlinenumber}}人がこのサイトの閲覧を開始しました。
この時、直近10分以内に、3人がこのサイトの閲覧を開始しました。
のように表示されます(もしオンライン人数が3人だった場合)。
また、オンライン数が1人だった場合と、2人以上だった場合とで、その後に表示するテキストを変更出来ます。
元々は、英語環境で使用する際に、こんな感じで書いてもらう機能です。
{{onlinenumber| visitor is online.| visitors are online.}}
すると、1 visitor is online.
(1人の場合)や4 visitors are online.
(4人の場合)のように表示されます。
一応、こんな感じで日本語環境下でも機能を利用出来ます。
いまは{{onlinenumber|にんのフレンズがここにきてくれてるみたいだね! あなたがそのひとり? おともだちになろうよ!|にんのフレンズたちがここにきてくれてるみたいだね! すっごーい!}}
この時の出力例です。
いまは1にんのフレンズがここにきてくれてるみたいだね! あなたがそのひとり? おともだちになろうよ!
(1人の場合)
いまは9にんのフレンズたちがここにきてくれてるみたいだね! すっごーい!
(9人の場合)
プラグインが動作している様子はこちらからご確認頂けます(日本語ですよ)。
エラー
プラグインが、データファイルを書き込めなかった場合、次のエラーが掃き出されます。
Onlinenumberプラグインでエラーが生じました: "(ファイルの位置)"に書き込めません。
このエラーメッセージはローカライズ(翻訳)出来ます(現時点では英語と日本語が使用可能です)。
構文
{{onlinenumber|メッセージA|メッセージB}}
- メッセージA:オンライン数に続く表示(オンラインが1人の場合)
- メッセージB:オンライン数に続く表示(オンラインが2人以上の場合)
設定系統
設定管理プラグインから、以下の設定を変更出来ます。
オプション | 説明 | 値のタイプ | 規定値 |
---|---|---|---|
onlineseconds | オンラインであると判断する秒数(ここで設定した秒数以内にアクセスがあった場合に、オンラインだと判断します) | numeric | 60 * 10 2) |
設定管理で表示される説明は、次の言語で見られます。
- 英語
- 日本語
開発
変更履歴
- 2018-05-15
- 最初のリリース
- 2018-05-22
- 小変更のアップデート
- 2018-06-18
- 幾らか改善を施したアップデート。エラーメッセージのローカライズ化に対応しました。
- 2018-08-29
- htaccessファイルの追加。
既知のバグや問題点
現在はありません
連絡先
プラグインに問題が見付かりましたら、GitHubのページにトピックを作成出来ます(日本語OKです)。他の事で何かありましたら、以下の連絡先をご利用下さい。