MediaWiki:Widgetsについて

提供: omotenashi-mind
移動先: 案内検索

Widgetsとは、MediaWiki上に直接HTMLコンテントを埋め込むことができるプラグインです。使い方は簡単で、Widgets導入済みのMediaWikiであれば、Widgets用のページを作成して{{#widget}}タグを埋め込むだけで、Widgets用ページを別ページに読み込むことができるようになります。

ここでは、そのWidgetsの導入手順から、実際のWidgetsの利用方法を簡単にまとめます。

はじめに

Widgetsプラグインを導入するために、"git"コマンドを利用します。gitコマンドが未導入であればはじめに導入を行なってください。
以下にUbuntuでの導入例を示します。

sudo apt-get install git


インストール手順

Git経由でのモジュールダウンロード

Git経由でWidgetsモジュールのダウンロードを行なうためには、MediaWiki設置フォルダ配下にあるextensionsフォルダにて次のようにコマンドを実行します。

sudo git clone https://git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/Widgets.git
cd Widgets
git submodule init
git submodule update


設定

モジュールのダウンロードが完了したら、次はMediaWikiがモジュールを読み込めるように設定を行ないます。MediaWiki設置フォルダ配下にあるLocalSettings.phpを編集モードで開いてください。
(MediaWiki設置フォルダ配下で次のコマンドを実行)

sudo vi ./LocalSettings.php


LocalSettings.phpを編集モードで開いたら、ファイルの最下部に次の内容を追記して、Widgetsモジュールを読み込むように設定を行なってください。

require_once("$IP/extensions/Widgets/Widgets.php");

以上で設定が完了です。

ワークフォルダ権限設定

最後にWidgetsを実行するために利用する作業用フォルダに書き込み権限を設定する作業を行ないます。これを行なわないと、Widgetsが動作しないのでご注意ください。作業用フォルダは最初の手順でダウンロードしてきたWidgetsモジュールフォルダの配下にある「compiled_templates」となります。まずは、Widgetsモジュールフォルダに移動して、次のようにコマンドを実行しましょう。

sudo chmod a+rw ./compiled_templates

これで導入作業は全て完了です。お疲れさまでした。

利用方法

WidgetsはHTMLコンテントをMediaWiki内に読み込むための拡張機能のため、Widgetsだけ導入しても何も起きません。実際のWidgets対応プラグインを導入して、その効果を確認していきましょう。ここでは、題材としてTwitterのフォローリンクを表示できる「Twitter Flollow Widgets」をベースに利用手順をご説明致します。

Twitter Follow Widgetsタグの設置

Twitter Followリンクを設置したいページに次の内容を埋め込んでください。

{{#widget:Twitter Follow
 |twitter=xxx
 |what=me
 }}

※ "xxx"の箇所はご自身のTwitterアカウントIDを設定するようにしてください。(アットマーク@は不要です)

すると、ページリンクが表示されますので、そのリンクをクリックすると「Twitter Follow」ページの作成画面に遷移します。あとはページ内容に次の内容を記載して、保存してください。

<noinclude>__NOTOC__
 This widget allows you to display '''[http://twitter.com/goodies/buttons Twitter
  follow us/me widget]''' on your wiki page.
 
 Created by [http://www.mediawikiwidgets.org/User:Jeroen_De_Dauw Jeroen De Dauw].
 
 == Using this widget ==
 For information on how to use this widget, see [http://www.mediawikiwidgets.org/Twitter_Follow 
 widget description page on MediaWikiWidgets.org].
 
 == Copy to your site ==
 To use this widget on your site, 
 just install [http://www.mediawiki.org/wiki/Extension:Widgets MediaWiki Widgets extension] and 
 copy [{{fullurl:{{FULLPAGENAME}}|action=edit}} full source code] of this page to your wiki as
  '''{{FULLPAGENAME}}''' article.
 </noinclude>
 <includeonly><a href="http://www.twitter.com/<!--{$twitter|escape:'urlpathinfo'}-->">
 <img src="http://twitter-badges.s3.amazonaws.com/follow_<!--{$what|escape:'urlpathinfo'}-->-a.png"
 alt="Follow <!--{$twitter|escape:'quotes'}--> on Twitter"/></a></includeonly>

Twitter Followボタン用HTMLタグが収められたページを作成後に、さきほどwidgetタグを埋め込んだページに戻ると、Twitterのフォローボタンが表示されるようになります。

(Twitter Followボタン表示例)
Follow kutsuna_ma on Twitter

まとめ

いかがだったでしょうか。MediaWiki用に提供されるWidgetsには、他にも便利なものが数多く提供されています。英語サイトですが、Widgets Catalogには有益なWidgetsが数多くまとめられていますので参考にしてみてはいかがでしょうか。

使用上の注意

Widgetの内容を修正した場合、対象Widgetを読み込んでいるページに反映されない場合があります。
その場合はWidget利用対象ページを一度、編集・保存して強制的に反映する必要があります。


参考サイト

http://www.mediawiki.org/wiki/Extension:Widget