fa.inc.php

名称アイコン表示プラグイン
ファイルfa.inc.php
バージョン1.00
対象サーバーPukiWiki 1.5.3 / PHP 7.4 / UTF-8
対象ブラウザーFirefox, Chrome, Safari, Edge 各最新版
ライセンスGPLv3

Font Awesomeによるアイコンを表示するPukiWiki用プラグイン。

Font Awesome公式サイトにユーザー登録してKit Codeを取得するか、ファイル一式をダウンロードしてあらかじめスキンに組み込んでおく必要があります。FontAwesome Version 5向けに実装しているため、互換性にご注意ください。

インストール

fa.inc.php
3.0KB | 2020-05-28

fa.inc.phpPukiWikipluginディレクトリに配置してください。

使い方

&fa(code[,[color][,scale]]){[code2[,color2]]};
  • code … アイコンコード。Font Awesomeサイト発行の各アイコンHTML「<i class="faX fa-XXXX XXX"></i>」の「faX fa-XXXX XXX」部分
  • color … 表示色。形式は #RRGGBB, rgba(R,G,B,A), 色名, CSSカスタムプロパティ等(CSSで使える形式)。省略すると文字と同じ色
  • scale … 表示倍率。単位は px, %, em, CSSカスタムプロパティ等(CSSで使える単位)。省略時の既定値は 100%
  • code2,color2 … アイコンを2つ重ねる場合に使用。両code内に fa-stack-?x 指定が必須。下記の最後の使用例を参照

使用例

&fa(far fa-smile);

&fa(fas fa-save fa-2x);

&fa(fa fa-cog fa-fw,#009999);

&fa(fas fa-camera fa-stack-1x){fas fa-ban fa-stack-2x,Tomato};

設定

コード内の下記の定数で動作を制御することができます。

定数名既定値意味
PLUGIN_FA_KITCODE文字列1Font AwesomeをロードするためのKit Code(例:'<script src="https://kit.fontawesome.com/xxxxxxxxxx.js" crossorigin="anonymous"></script>')
PLUGIN_FA_STYLE文字列アイコンに共通して適用するスタイル(例:'.fa,.fab,.fad,.fal,.far,.fas { vertical-align: middle; }')

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つを記述します
  • {} … 中カッコ内の引数は任意の順序で記述できます