====== アイコンプラグイン ======

---- plugin ----
description: DokuWiki の中にアイコンを埋め込む
author     : Giuseppe Di Terlizzi
email      : giuseppe.diterlizzi@gmail.com
type       : syntax, action
lastupdate : 2016-04-02
compatible : Weatherwax, Hrun, Detritus
depends    : 
conflicts  : 
similar    : fontawesome
tags       : icons fontawesome glyphicon fugue oxygen silk flag

downloadurl: https://github.com/LotarProject/dokuwiki-plugin-icons/zipball/master
bugtracker : https://github.com/LotarProject/dokuwiki-plugin-icons/issues
sourcerepo : https://github.com/LotarProject/dokuwiki-plugin-icons/
donationurl: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9LJDLVSNGYSA2

screenshot_img : 
----

===== インストール =====

:!: **オプションの外部要件：** このプラグインは、個別にインストールする必要のある次の追加コンポーネントが必要です：
  * [[http://fontawesome.io/|Font Awesome]]
  * [[http://getbootstrap.com|Twitter Bootstrap の Glyphicons]]

[[ja:plugin:plugin|プラグイン管理]]とプラグインの最新バージョンを示す上記のダウンロードURLを使用して、プラグインをインストールします。
手動でプラグインをインストールする方法については[[ja:plugins|プラグイン]]を参照してください。

===== 使用例・使用方法 =====

動作中のプラグインは[[http://lotar.altervista.org/dokuwiki/wiki/plugin/icons|ここ]]を参照して下さい。
使用例ページは、プラグインで使用可能なすべてのスタイルを表示しています。

簡単な使用方法：

  {{icon>house}}

{{ https://img-fotki.yandex.ru/get/66958/85226599.c/0_be81d_80ed63e2_orig.png?60*284|使用例}}

より複雑な使用例：
<code>
{{icon>home?24&circle&padding=10px&background=#DDD&color=#CCC}}
{{fa>home|My Home}}
{{fugue>user?24}}
{{silk>anchor}}
{{flag>en}}
[[:wiki:welcome|{{fa>home?24|Welcome to DokuWiki}}]]
[[https://github.com/LotarProject/dokuwiki-plugin-icons|{{fa>github-square?24|Icons DokuWiki plugin on GitHub}}]]  
</code>

===== 構文 =====

=== 基本構文 ===

<code>{{icon>icon-name&flags|title}}</code>

=== DokuWiki リンク構文 ===

<code>[[:dokuwiki:page|{{icon>icon-name&flags|title}}]]</code>

=== 外部リンク構文 ===

<code>[[protocol://host/path|{{icon>icon-name&flags|title}}]]</code>

=== 利用可能なアイコン集 ===

^  アイコン集  ^^
| ''icon''      | デフォルトアイコン集（''defaultPack'' オプションを参照） |
| ''fa''        | Font Awesome |
| ''glyphicon'' | Glyphicons |
| ''typcn''     | Typicons |
| ''fugue''     | Fugue |
| ''oxygen''    | KDE Oxygen |

===== 設定 =====

管理者メニューにある DokuWiki の[[ja:plugin:config|設定管理]]でプラグインの設定ができます。

^  設定オプション     ^  デフォルト値  ^  説明  ^
^ ''defaultSize''     | ''16''        | サイズが指定されていない場合のデフォルト値 |
^ ''defaultPack''     | ''fa''        | 指定されていない場合のデフォルトアイコン集 |
^ ''loadFontAwesome'' | ''On''        | //Font Awesome//: CSS の読込みの許可・禁止（Bootstrap3 ベースのテンプレートの場合、不可）  |
^ ''fontAwesomeURL''  | (CDN URL)     | //Font Awesome// CDN or local URL |
^ ''loadTypicons''    | ''On''        | //Typicons//: CSS の読込みの許可・禁止 |
^ ''typiconsURL''     | (CDN URL)     | //Typicons// CDN or local URL |
^ ''fugueURL''        | (CDN URL)     | //Fugue// CDN or local URL |
^ ''oxygenURL''       | (CDN URL)     | //KDE Oxygen// CDN or local URL |
^ ''silkURL''         | (CDN URL)     | //Silk// CDN or local URL  |
^ ''flagURL''         | (CDN URL)     | //Flag// CDN or local URL |

**Flag アイコン集のための注意**：デフォルトでは、Dokuwiki 内に存在する [[plugin:translation|Translation plugin]] の flag を利用します。

===== 変数 =====

^  変数          ^  値  ^  説明  ^
| ''size''       | （''defaultSize'' オプションを参照） | アイコンサイズ（ピクセル単位） |
| ''pack''       | （''defaultPack'' オプションを参照） | アイコン集 (fa, glyphicon, fugue, oxygen) |
| ''circle''     | -             | アイコンの周囲に //circle// を作成 |
| ''border''     | -             | アイコンの周囲に//境界線//を追加 |
| ''borderColor''| -             | 境界線の色設定 |
| ''padding''    | -             | アイコンに//余白//を適用（ピクセル単位） |
| ''background'' | -             | アイコンに//背景色//を適用（16進数か色名） |
| ''color''      | -             | アイコンに//色//を適用（16進数か色名） |
| ''class''      | -             | アイコンに CSS クラスを追加（Font Awesome や Glyphicon で便利） |
| ''align''      | ''left|center|right'' | アイコンの配置（//left//・//right//・ //center//） |
| ''left''       | -             | アイコンを//左寄せ// |
| ''right''      | -             | アイコンを//右寄せ// |
| ''center''     | -             | アイコンを//中央揃え// |

==== Font Awesome 変数 ====

^  変数          ^  値  ^  説明  ^
| ''lg''          | - | アイコンサイズを 33% 拡大 |
| ''2x|3x|4x|5x'' | - | アイコンサイズを拡大 |
| ''border''      | - | アイコンに境界線を追加 |
| ''spin''        | - | 回転動作を追加 |
| ''pulse''       | - | 脈動動作を追加 |
| ''rotate''      | ''90|180|270'' | アイコンを回転する |
| ''flip''        | ''horizontal|vertical'' | アイコンを反転する |
| ''pull-left''   | - | 左にアイコンを引き出す |
| ''pull-right''  | - | 右にアイコンを引き出す |

===== デモ =====

デモと使用例は、[[http://www.lotar.altervista.org/dokuwiki/wiki/plugin/icons]] にあります。

===== 開発 =====

[[https://travis-ci.org/LotarProject/dokuwiki-plugin-icons|{{  https://travis-ci.org/LotarProject/dokuwiki-plugin-icons.png?nocache|Build Status}}]]

=== 変更履歴 ===

{{rss>https://github.com/LotarProject/dokuwiki-plugin-icons/commits/master.atom 5 author date 1h }}

=== 既知のバグと問題点 ===

バグ報告と機能要望は[[https://github.com/LotarProject/dokuwiki-plugin-icons/issues|バグ追跡システム]]にお願いします。 

=== ToDo と要望一覧 ===

  * <del>ADD: New configuration option to change the Fugue CDN URL</del>
  * <del>ADD: New configuration option to change the Oxygen CDN URL</del>

===== FAQ =====

=== 携帯用の DokuWiki に Font Awesome や Glyphicon をインストールする方法 ===

最初に Font Awesome パッケージをダウンロードし、DokuWiki 内にインストールディレクトリ（例：''assets/font-awesome''）を作成し、全ファイルを配置します。
次に[[ja:plugin:config|設定管理]]内で ''loadFontAwesome'' を有効にし、''fontAwesomeURL'' に Font Awesome パッケージのローカル URL（例：''/dokuwiki/assets/font-awesome/css/font-awesome.min.css''） を入力します。

代替案は、Font Awesome と Glyphicon を同梱したテンプレート（[[ja:template:bootstrap3|Bootstrap3 テンプレート]]）を使うことです。

===== 議論 =====