colorscheme.inc.php †
名称 | ダークモード対応プラグイン |
---|---|
ファイル | colorscheme.inc.php |
バージョン | 1.00 |
対象サーバー | PukiWiki 1.5.3 / PHP 7.4 / UTF-8 |
対象ブラウザー | Firefox, Chrome, Safari, Edge 各最新版 |
ライセンス | GPLv3 |
ウィキをOSのカラースキーム(カラーテーマ)に対応させ、ダークモード表示を簡易的に実現するPukiWiki用プラグイン。
インストール †
colorscheme.inc.phpをPukiWikiのpluginディレクトリに配置してください。
使い方 †
&colorscheme();
選択ボックスが表示され、自動切替モード(OSのカラースキームに応じて自動的に変化する)・ライトモード・ダークモードを選ぶことができる。選んだモードはブラウザーに記憶される。
#colorscheme()
ユーザーインターフェイスなし、自動切替モード固定。
全画面に適用できないと通常意味がないため、本プラグインはMenuBarなど全画面共通で表示されるページに挿入してください。もしくは、次のコードをスキンファイルHTML内の適当な場所に挿入してください。
<?php if (exist_plugin_convert('colorscheme')) echo do_plugin_convert('colorscheme', 1); ?>
ご注意 †
- 本プラグインを挿入できるのは1ページにつき1箇所のみです。
- 逆効果になるため、もともと暗い色調のスキンや、カラースキームに対応済みのスキンとは併用しないでください*1。
- JavaScriptが有効でないと動作しません。
- 古いブラウザーでは動作しない場合があります。
設定 †
コード内の下記の定数で動作を制御することができます。
定数名 | 値 | 既定値 | 意味 |
---|---|---|---|
PLUGIN_COLORSCHEME_EXCLUSION | 文字列 | #contents img, #contents video, object, embed, iframe | 明暗反転処理を除外する要素のセレクター(ヘッダ画像も除外するなら「#contents 」を省く) |
PLUGIN_COLORSCHEME_BRIGHTNESS | 数値 | 85 | ダークモード時の画面輝度(0~100) |
default.ini.phpへの設定 †
本プラグインの定数設定(ファイル内の下記のような行)は、PukiWikiルートディレクトリにある標準設定ファイルdefault.ini.phpにも記述することができます。本プラグインの定数設定行をdefault.ini.phpの末尾にそのままコピーしてください。default.ini.php側の設定値が優先されます。
///////////////////////////////////////////////// // ○○プラグイン設定(○○.inc.php) if (!defined('PLUGIN_○○_×××)) define('PLUGIN_○○_×××', △);
設定をdefault.ini.phpに記述することで、プラグインをアップデート(ファイル上書き)するたびに値を書き直す必要がなくなります。また、設定がdefault.ini.phpに集中することで、運用中の設定管理も楽になります。
凡例 †
プラグインの引数は下記の書式で表現しています。
- [] … 省略でき必要に応じて記述します
- | … |で区切られた項目のうち1つを記述します
- {} … 中カッコ内の引数は任意の順序で記述できます