Tweeki

提供:きまぐれ手記 Kimagurenote
移動先: 案内検索
当サイトではアフィリエイト広告を掲載しています
この記事は、最終更新日よりおよそ 10 ヶ月経過しています。 公式サイトなどで最新情報を確認してください。(最終更新:2023年9月)
Tweeki 使用例

Tweeki という MediaWikiSkin(外装)を導入したので、設定の備忘録。

詳しくは公式の解説を参照。

経緯

以前使っていたカスタムSkin(公開されている外装を大幅改造したもの)が、MediaWiki 1.28 への更新に伴い使えなくなってしまったので、他のSkinを探していて見つけた。

Tweeki では Twitter Bootstrap を採用し、responsive design になっており、端末を選ばず見やすくなっている。

見た目にも、他の MediaWiki Skin にありがちな、過剰なナビメニューなどが大胆に省略されている。 一方、既定ではカテゴリなどの一般的に使われている要素や、移動や削除などの管理用メニューも表示されないなど、少々癖もある。Wikipediaでお馴染みの左上に大きく表示されるロゴも、Tweekiでは標準で非表示になっている(設定すれば表示できる)。

Wikipediaのような多数の一般編集者がいるサイトには向かないだろうが、個人や団体のサイトなど、編集者が特定少数で、多数の一般閲覧者には編集させないサイトで使うには良い選択肢になりそう。

導入

1.公式ホームページのインストール手順(英語)を参照

2.GitHub からダウンロードし、MediaWiki の skins ディレクトリ下に展開する。WebサーバにSSHログインできれば git clone(下記)が手軽。GitHub からリリース版 (zip, tar.gz) をダウンロードもできる。

% cd /path/to/mediawiki/skins
% git clone https://github.com/thaider/Tweeki

3.LocalSettings.php に、下記を追加。

LocalSettings.php 
wfLoadSkin( 'Tweeki' );
$wgDefaultSkin = "Tweeki";

設定

LocalSettings.php

設定例。→公式の解説(英語)

LocalSettings.php 
# Tweeki settings
$wgTweekiSkinHideable = [ 'navbar', 'sidebar-right' ];
	# 本文中に {{#tweekihide}} の記述があるページでのみ非表示にすることができる要素を指定
$wgTweekiSkinHideAnon = [ 'EDIT', 'EDIT-EXT', 'TOOLBOX', 'TOOLBOX-EXT', 'PERSONAL' ];
	# ログインしていない人に見せない要素を指定
	# (編集メニュー、ツールボックス、マイページへのリンクボタンを指定)
$wgTweekiSkinFooterIcons = true;
	# フッタのアイコン (CreativeCommons, MediaWiki) を表示する
$wgTweekiSkinHideAll['footer-info'] = false;
	# フッタの更新日等を表示する

Navigation Sections

Navigational Sectionsの図にあるように、上下左右の計5面に、表示したい要素を割り当ててゆく。

Footer の設定例はこちら

内部リンクを設定する場合は、[[ ]] で括らず、ページ名|表示名 と記述する。 項目を階層化する場合は、先頭に見出しの文字列を記述し、続いて各子項目の先頭に * を付ける。 例:

このサイトについて,*About|会社概要,*News|ニュースリリース,*Privacy|プライバシーポリシー

編集関連メニューの割り振り

'EDIT' や 'TOOLBOX' が表示されないと編集者には不便なので、適宜使いやすい場所に割り当てておく必要がある。管理用には 'VIEWS' や 'ACTIONS'(履歴表示や移動、削除など)も必要になるだろう。

多数の編集者がいるサイトでTweekiを使う場合は、'PERSONAL' や 'TALK' も必要になるかもしれない。

各項目の詳細は 公式の解説(英語)を参照。

限られた編集者以外は閲覧専用のサイトや、匿名利用者の編集を認めないサイトであれば、ログインしていない場合は編集等のメニューを非表示にできる。 例:

LocalSettings.php 
$wgTweekiSkinHideAnon = [
	'EDIT' => true,
	'TALK' => true,
	'PERSONAL' => true,
	'TOOLBOX' => true,
	'ACTIONS' => true ,
	'VIEWS' => true
];

または、Tweekiの編集関連メニューは非表示にして、特定の編集者のみ他のSkinを使う方法もある。

HTMLタグの埋め込み

外部リンクは Navigation Sections に直接指定できるようになったが、HTMLの埋め込みは直接指定できず、HTMLets のような拡張機能も使えない(本文に埋め込みたい場合はもちろん使える)。

Navigation Sections にHTMLタグを埋め込みたい場合は、LocalSettings.php 内で関数による定義が必要。このように生成した独自のタグ(下記例では 'MYTAG')を Navigation Sections 内に割り当てることで、HTMLを埋め込むことができる。[1] 例:

LocalSettings.php 
$wgTweekiSkinSpecialElements['MYTAG'] = 'tweekiMyTag';
	# MYTAG タグが指定されたときに tweekiMyTag 関数を呼び出す

# 呼び出される関数
function tweekiMyTag( $skin, $context ) {
	echo '<埋め込むHTMLタグ>';
}

スクリプトの埋め込み

上記から察しの通り、(本文以外の場所に)HTMLタグを埋め込むにはいちいち関数を追加する必要があって面倒だが、見方を変えれば任意のスクリプトを動かすことができる。

PHPを書ける人ならば、セキュリティホールを作らない程度に遊んでみるのも良さそう。

#スクリプトを埋め込む(上級者向け)を参照

Font Awesome

Tweeki には Font Awesomeが組み込まれており、LocalSettings.php に下記の設定をすると使える。

LocalSettings.php 
$wgTweekiSkinUseAwesome = true;

使い方は、本文中の Font Awesome のアイコンを挿入したい箇所に‎<i>...‎</i>タグを入れる。 例えば、こんな感じ。

.fas = Solid Font Awesome 5 Free

<i class="fas fa-wrench" title="Maintainance"></i>
<i class="fas fa-user" title="User"></i>
<i class="fas fa-walking" title="Walking"></i>
<i class="fas fa-biking" title="Bicycle"></i>
<i class="fas fa-bus" title="Bus"></i>
<i class="fas fa-train" title="Train"></i>
<i class="fas fa-tram" title="Tram?"></i>
<i class="fas fa-smile" title="smile"></i>

.fab = Brand Font Awesome 5 Brands

<i class="fab fa-creative-commons" title="Creative Commons"></i>
<i class="fab fa-usb" title="USB"></i>
<i class="fab fa-bluetooth" title="Bluetooth"></i>
<i class="fab fa-wikipedia" title="Wikipedia"></i>
<i class="fab fa-firefox" title="Firefox"></i>
<i class="fab fa-chrome" title="Chrome"></i>
<i class="fab fa-safari" title="Safari"></i>
<i class="fab fa-edge" title="Edge"></i>
<i class="fab fa-internet-explorer" title="Internet Explorer"></i>
<i class="fab fa-freebsd" title="FreeBSD"></i>
<i class="fab fa-linux" title="Linux"></i>
<i class="fab fa-ubuntu" title="Ubuntu"></i>
<i class="fab fa-android" title="Android"></i>
<i class="fab fa-microsoft" title="Microsoft"></i>
<i class="fab fa-windows" title="Windows"></i>
<i class="fab fa-apple" title="Apple"></i>
<i class="fab fa-app-store-ios" title="App Store (iOS)"></i>
<i class="fab fa-itunes" title="iTunes"></i>
<i class="fab fa-google" title="Google"></i>
<i class="fab fa-google-play" title="Google Play"></i>
<i class="fab fa-github" title="Github"></i>
<i class="fab fa-instagram" title="Instagram"></i>
<i class="fab fa-line" title="LINE"></i>
<i class="fab fa-twitter" title="Twitter"></i>
<i class="fab fa-youtube" title="YouTube"></i>
<i class="fab fa-steam" title="Steam"></i>

けっこうあるねー でもFedExDHLUPSがあるのに黒猫飛脚がいないのはお察しください(;_;)

郵便Unicodeに入っているので、やっぱりお察しください(^^;

&#x3012;
&#x3020;

〒 〠

使えたり使えなかったりするので試行錯誤するしかないが、Tweeki 1.2.6 から Font Awesome to 5.15.4 が入っているようだ。最新のバージョンはソースコードを見れば判る。

Tweekiを使っていない場合は、Extension:FontAwesome を入れれば Font Awesome Free (version 6.2.1) を使えるようになる(MediaWiki 1.35以降)。

.far は使えないっぽい?

Font Awesome の手前に余計な空白が入る

日本語の字下げなどで CSS の text-indent を使っている場合に、Font Awesome のアイコンの先頭に1字分の空白が入ってしまうことがある。

該当する場合は、MediaWiki:Common.css に下記のように設定しておくと、余計な空白を防ぐことができる。

MediaWiki:Common.css 
/* Font Awesome への干渉を防ぐ */
I.fa, I.fab, I.fad, I.fal, I.far, I.fas {
	text-indent: 0;
}

Common.cssを弄れない等の事由により個別に対処したい場合は、Font Awesome の ‎<i> タグに style="display: inline;" 指定を追加する。

<i class="far fa-user" style="display: inline;"></i>

How-to

表や画像のレスポンシブ化

表や画像のclassに .img-responsive ないし .img-fluid を追加すると、サイズの自動追従に対応する。[2]

画像の場合は下記のようにする。 (Bootstrap 3 の場合)

[[File:Screenshot tweeki.png|class=img-responsive]]

(Bootstrap 4 の場合)

[[File:Screenshot tweeki.png|class=img-fluid]]

段組み

Bootstrapを使わない段組み方法(例)。

<div style="clear: both; columns: 16em; column-rule: 1px solid #ddd; column-gap: 2em;">
本文
 ︙
本文
</div>

Bootstrapを使っての段組み方法。

<div class="container text-left">
	<div class="row">
		<div class="col">
本文1
		</div>
		<div class="col">
本文2
		</div>
	</div>
	<div class="row">
		<div class="col">
本文3
		</div>
		<div class="col">
本文4
		</div>
	</div>
</div>

Grid system (グリッドシステム)

表の並べ替え

jQueryのtablesorterを使った表‎<table>の並べ替えを利用できる。使い方は簡単で、表に class="wikitable sortable" を指定すれば良い。Wikitableの機能なので、Tweekiでなくても使える。

{|class="wikitable sortable"
|-
!class="unsortable"|ソート外
!data-sort-type="number"|数値
!data-sort-type="text"|文字列
!data-sort-type="isoDate"|日付
!data-sort-type="url"|URL
|-
!#1
|1,234
|1,234
|2023-09-30
|http://example.com/
|-
!#2
|321
|321
|2023-01-01
|https://secure.example.com/
|-
!#3
|123,456,789
|123,456,789
|2023-03-03
|https://kimagurenote.net/
|}
ソート外 数値 文字列 日付 URL
#1 1,234 1,234 2023-09-30 http://example.com/
#2 321 321 2023-01-01 https://secure.example.com/
#3 123,456,789 123,456,789 2023-03-03 https://kimagurenote.net/

注意点としては、規定では文字コードによる並べ替えなので、カンマ区切り数値が入ると期待した動作にならない。この場合は見出し行の該当列に data-sort-type="number" を指定する。

number 以外にも、currency, url, IPAddress, isoDate などがある。

w:en:Help:Sortable tables#Configuring the sorting

並べ替えの対象にしたくない列は、見出し行の該当列に class="unsortable" を付ける。

セルに data-sort-value="…" を付けることで、別個のソートキーを指定できる。例えば日数が並んでいる列に「24時間」という値が混じっている場合は、data-sort-value="1" と指定しておけば期待した動作になる。

povo 2.0#データトッピング

目次の一覧表示

目次 (TOC, Table of contents) は規定で sidebar-right に表示される。

規定ではレベル2 ‎<H2> のみが一覧表示されて、クリック/タップされるとレベル3 ‎<H3> 以降が表示される。

見た目にはすっきりするが、一覧性が低く、どこに何が書いてあるか一見して判りづらい難がある。

MediaWiki:Common.css に下記の設定を追加すると、最初から全件が一覧表示されるようになる。

MediaWiki:Common.css 
#tweekiTOC #toc ul > li > ul { display: block; }

一方、細かい見出しが出すぎると見づらくなる。細かい見出しを目次に表示したくない場合は、MediaWiki の機能を使い、LocalSettings.php に $wgMaxTocLevel を指定する。 例えば、レベル3 ‎<H3> までを目次に表示したいときは、こうする。

LocalSettings.php 
$wgMaxTocLevel = 3;

見出しレベルとは

  • ==レベル2== → ‎<H2>
  • ===レベル3=== → ‎<H3>
  • ====レベル4==== → ‎<H4>
  • =====レベル5===== → ‎<H5>
  • ======レベル6====== → ‎<H6>

見出しレベル1 ‎<H1> は記事のタイトルなので、目次には表示されない。

sidebar-right をスクロールできるようにする

規定では sidebar-right にはスクロールバーが出ないが、ここに目次が表示されるので、全件表示にすると下の方が見切れてしまうことがある。

そこで、MediaWiki:Common.css に下記の設定を追加して、sidebar-right のスクロールを有効にしてやる。

MediaWiki:Common.css 
#sidebar-right {
	overflow: scroll;
}

本文中に目次を表示したいときは

Tweekiでは、規定では sidebar-right に目次が表示される。#Navigation Sections内のどこにでも移動できるが、TOCを複数表示することはできない

Tweekiスタイルではなく、MediaWikiで一般的な目次(本文中に表示される)を表示したい場合は、Mediawiki:Tweeki-sidebar-right を含む全て#Navigation Sections から「TOC」を削除するとともに、MediaWiki:Tweeki.css(または MediaWiki:Common.css)に下記を追加する。

MediaWiki:Common.css 
#toc { display:block; }

こうすると、MediaWikiの流儀に従い、本文中に目次が表示される。この場合は __TOC__ などのマジックワードも使える。

カテゴリを表示する

既定ではカテゴリが非表示になっている。表示する場合は MediaWiki:Tweeki.cssに下記の設定を追加。[3]

MediaWiki:Tweeki.css 
#catlinks { display: block; }
MediaWiki:Common.css を書き換えると他のSkinにも有効になる。Tweekiだけで有効にしたい(他のSkinでは異なる設定をしたい)場合は、MediaWiki:Tweeki.css に追加する。

カテゴリの表示位置を上方に移動

Tweeki.skin.php を直接書き換え。これを実施する場合、Tweekiをアップデートする度に書き換えが必要。 書き換え例:

Tweeki.skin.patch (1KB) 
--- Tweeki.skin.php.orig	2017-04-13 04:30:51.000000000 +0900
+++ Tweeki.skin.php	2017-06-12 06:56:54.000000000 +0900
@@ -268,6 +268,11 @@
 			<?php if( !$skin->checkEmptiness( 'subnav' ) ) { $skin->renderSubnav( $mainclass ); } ?>
 
 			<div class="row">
+
+				<?php if ( $this->data['catlinks'] ) { ?>
+				<?php $this->html( 'catlinks' ); ?>
+				<?php } ?>
+
 				<div class="<?php echo $mainclass ?>" role="main">
 					<?php $skin->renderContent(); ?>
 				</div>
@@ -834,9 +839,6 @@
 				<?php $this->html( 'printfooter' ); ?>
 				</div>
 				<?php } ?>
-				<?php if ( $this->data['catlinks'] ) { ?>
-				<?php $this->html( 'catlinks' ); ?>
-				<?php } ?>
 				<?php if ( $this->data['dataAfterContent'] ) { ?>
 				<?php $this->html( 'dataAfterContent' ); ?>
 				<?php } ?>

特定のページでのみナビゲーション要素を隠したい

公式の解説→Hiding Page Elements, Parser Functions

例えば、特定のページでは navbar と編集リンクとロゴを隠せるようにしたい、といった場合の設定例。

LocalSettings.php に下記設定を追加

LocalSettings.php 
# Tweeki settings
$wgTweekiSkinHideable = [ 'navbar', 'EDIT', 'LOGO' ];

指定した要素を隠したいページの記事本文中に、下記記述を追加

{{#tweekihide:navbar|EDIT|LOGO}}
Navigational SectionsNavigational Elements の両方を指定可。

ただし、他のSkinを使うと {{#tweekihide:}} が認識されず、見えてしまうことがあるので、要注意。後々面倒なことにならないよう、トップページや管理用の記事で使う程度に留め、一般の記事では使わない方が良いかも。

Sitenotice・Anonnoticeを左揃えにしたい

サイト全体に告知(障害告知等)を表示したいときに便利な anonnotice / sitenotice だが、Tweekiでは‎<H1>と同じく中央揃えで表示される。

MediaWiki:Tweeki.css にて変更できる。

MediaWiki:Tweeki.css 
DIV#siteNotice {
	text-align: left;
}

フッタに任意の Powered by アイコンを追加する

LocalSettings.php に下記の設定をする

  • Tweekiのフッタでアイコン表示を有効にする
LocalSettings.php 
$wgTweekiSkinFooterIcons = true;
LocalSettings.php 
$wgFooterIcons['poweredby']['freebsd'] = array(
	"src" => "/path/to/bannerimage.gif",
	"url" => "http://www.freebsd.org/ja/",
	"alt" => "Powered by FreeBSD",
	"width" => "171", 
	"height" => "64"
);

How-to Bootstrap 4

Bootstrapのバージョン

Tweekiのバージョンにより、Bootstrap のバージョンが異なる。

  • Tweeki 1.1.x - MediaWiki 1.31~1.35 - Bootstrap 3
  • Tweeki 1.2.x - MediaWiki 1.31~1.35 - Bootstrap 3 / 4 切り替え可
  • Tweeki 2.0.x - MediaWiki 1.35~1.39 - Bootstrap 4 ←2023年6月現在の最新安定版
  • Tweeki 3.0.x - MediaWiki 1.39~ - Bootstrap 5 ←2023年6月現在、未提供

Installation

MediaWiki 1.35.x (LTS) までは Bootstrap 3 が動作するが、MediaWiki 1.36 以降は Tweeki 2.0.x に更新する必要があるので、Bootstrap 4 に変更になる。

Bootstrap 3 と 4 でいろいろと変わったため、バージョンアップすると表示が乱れることがある。バージョンアップは簡単だが、その後に細かな表示調整が必要になると思うので、バージョンアップは時間のある時に実施しよう。

MediaWiki 1.35.x (LTS) は2023年9月でサポート終了になり、次のLTS版は 1.39.x(2025年11月までサポートされる)。よって、遅くとも2023年9月までには Bootstrap 4 に移行しておく必要がある

さらに MediaWiki 1.402023年 7月 1日(日本時間)公開)以降は Tweeki 3.0.x(2023年 7月 1日時点では未提供)に更新する必要があるので、Bootstrap 5 が規定になる。

Bootstrap 4 に切り替える

Tweeki 1.2.x では Bootstrap 3 が規定だが、Bootstrap 4 も動作するようになった。

LocalSettings.php に下記を追加することで、Bootstrap 4 が有効になる[4]。 (Tweeki 2.0.x 以降では無効

LocalSettings.php 
$wgTweekiSkinUseBootstrap4 = true;

Bootstrap 3→4 の変更で大きなもの:

Tweekiの挙動の変更:

  • 従来は縦長画面で表示すると sidebar-right が下に回るが、Bootstrap 4 にすると下に回らなくなる(ので本文が狭くなる)。
  • 縦方向にスクロールすると navbar が見えなくなる(上方に固定ではなくなる)。
  • footerが3分割される

Bootstrap 3→4 に変更する際は、全体に見直しが必要になるかもしれないので、時間がある時にじっくり作業するのが良いと思う。

標準のフォントサイズを変える

Bootstrap 3 では標準のフォントサイズが 14px だったが、Bootstrap 4 以降では 16px になった。

以前の文字サイズに戻したい場合は、MediaWiki:Tweeki.css(または MediaWiki:Common.css)に下記を追加する。

MediaWiki:Tweeki.css 
html {
	font-size: 14px;
}

表(table)の見出し(caption)の位置

‎<table>の見出し ‎<caption>表示位置が、上から下に移動した。

従来通り上に表示したい場合は、MediaWiki:Common.css に下記を追加する。

MediaWiki:Common.css 
caption {
	caption-side: top;
}

目次の「to top」を変更する

MediaWiki:Tweeki-toc-top を書き換えることで、目次の「to top」を変更できるようになった。 [5]

sidebarの幅を調整する

Bootstrap 3 では縦長画面では sidebar-right が下に回り込んでいたが、Bootstrap 4 以降では回り込まなくなったので、縦長画面でコンテンツ表示部が狭くなってしまった。 sidebar の幅は規定で3ブロックだが、sidebar の幅を狭くすることで本文の幅を広げたいときは LocalSettings.php に下記の設定を追加する。

LocalSettings.php 
$wgTweekiSkinGridRight = [
	'mainoffset' => 0,
	'mainwidth' => 10,
	'rightoffset' => 0,
	'rightwidth' => 2
];

Bootstrapでは横幅を12個に区切って管理するので、12ブロック中の何ブロックを割り当てるかを指定する。 ⇒Grid system (グリッドシステム)

もちろん、逆にsidebarを拡げることもできる。

Carousel カルーセル

複数の画像を横方向に「回転する」ように表示させる機能が使える。

<div id="carouselExample" class="carousel slide" data-ride="carousel">
  <div class="carousel-inner">
    <div class="carousel-item active" data-bs-interval="2000">
[[Image:19q4155_1920x1200.jpg|640px|class="d-block w-100"|link=https://www.flickr.com/photos/kimagurenote/47772598382/in/album-72157664374313917/]]
    </div>
    <div class="carousel-item">
[[Image:18t4851_1920x1200.jpg|640px|class="d-block w-100"|link=https://www.flickr.com/photos/kimagurenote/43740441662/in/album-72157692097071760/]]
    </div>
    <div class="carousel-item">
[[Image:18za0560_1920x1200.jpg|640px|class="d-block w-100"|link=https://www.flickr.com/photos/kimagurenote/32328297178/in/album-72157688317227282/]]
    </div>
    <div class="carousel-item">
[[Image:18m4362_1920x1200.jpg|640px|class="d-block w-100"|link=https://www.flickr.com/photos/kimagurenote/26817918388/in/album-72157690487946621/]]
    </div>
  </div>
</div>
注意: 最初のdivタグ中の data-ride="carousel" (Bootstrap 4 の場合)で、カルーセルを起動している。Bootstrap 5 では data-bs-ride="carousel" とする。

広告を入れる

Google Adsense

MediaWiki#広告を入れるを参照

Yahoo!ショッピング

注意: Yahooの商品検索APIが変更されたため、現在このままでは動作しない。爆速JSONPオープンソース化されているので、自己責任で改修して使うことはできる。

電子機器類のページでは、ショッピングサイトへのリンクがあると良さそう。Amazonや楽天が定番だが、簡単で自由度が高いYahoo!ショッピング商品検索APIを使ってみることにした。

例えば楽天の規約には、「楽天アフィリエイト」以外は使うな、楽天以外へのリンクを載せるな、作ったプログラムは楽天に無償で使わせろといった規定がある。

TweekiのSkin領域内に埋め込んでみたが、驚くほど簡単。具体的には下記の準備が必要。

  1. バリューコマースに会員登録し、Yahoo!ショッピングと提携する
  2. Yahoo! JAPAN ID が無ければ取得し(無料会員でOK)、アプリケーションIDを発行する
  3. アプリケーションID発行完了画面に、同社の爆速JSONPフレームワークを使ったサンプルが表示されるので、そのHTMLコード(中身は JavaScript)をコピペすればそのまま使える
  4. ちょっと手を加えてやって、Tweekiに埋め込んで使う

ちょっと手を加えてTweekiに埋め込んだ即席スクリプトの例:

LocalSettings.php 
$wgTweekiSkinSpecialElements['YAHOOSHOPPING'] = 'tweekiTagYahooshopping';

function tweekiTagYahooshopping( $skin, $context ) {
	$title = urlencode($skin->getSkin()->getTitle()->getBaseText());
	$appid = '※';
	$vcid = '※';

	/* appid 無指定では動作しない */
	if( empty($appid) ) {
		return;
	}

	$ret = <<<'START_END_MARKER'
<div class="yahooshoppingitemsearch">
<script src="/file/bakusoku-jsonp-v1-min.js"
  data-url="//shopping.yahooapis.jp/ShoppingWebService/V1/json/itemSearch"
  data-p-appid=
START_END_MARKER;
	$ret .= "\"$appid\"";
	if( !empty($vcid) ) {
		$ret .= <<<'START_END_MARKER'
  data-p-affiliate_type="vc"
  data-p-affiliate_id=
START_END_MARKER;
		$ret .= '"' . $vcid . '"';
	}
	$ret .= <<<'START_END_MARKER'
  data-p-sort="-score"
  data-p-query=
START_END_MARKER;
	$ret .= "\"$title\"";
	$ret .= <<<'START_END_MARKER'
>
{{#ResultSet.0.Result}}
 {{#0}}
 <a href="{{Url}}" target="_blank" rel="nofollow"><img src="{{Image.Medium}}" title="{{Name}}" /></a>
 {{/0}}
 {{#1}}
 <a href="{{Url}}" target="_blank" rel="nofollow"><img src="{{Image.Medium}}" title="{{Name}}"></a>
 {{/1}}
 {{#2}}
 <a href="{{Url}}" target="_blank" rel="nofollow"><img src="{{Image.Medium}}" title="{{Name}}"></a>
 {{/2}}
{{/ResultSet.0.Result}}
</script>
</div>
START_END_MARKER;
	echo $ret;
}
関連Extension
Extension:YJShopping

楽天トラベル

鉄道路線ページに商品リンクがあってもあまり意味がなく、沿線の宿が表示されると良いと思ったので、それなりの量の宿情報を提供している楽天トラベルのキーワード検索APIを使ってみた。

これは良いサンプルが無かったので自作した。即席で書いた汚いコードだけれど、WebAPI的な物に触ったことがある人ならば見ればすぐに分かると思う。

LocalSettings.php 
$wgTweekiSkinSpecialElements['RAKUTEN-TRAVEL'] = 'tweekiTagRakutenTravel';

function tweekiTagRakutenTravel( $skin, $context ) {
	$title = urlencode($skin->getSkin()->getTitle()->getBaseText());
	$appid = '◆ your app id set here ◆';
	$affiliateid = '◆ your affiliate id set here ◆';
	$count = 3;
	$imgclass = 'tweeki-rakuten-travel-hotel img-responsive';

	/* appid 無指定では動作しない */
	if( empty($appid) ) {
		return;
	}
	/* 呼び出すURLを生成 */
	$apiurl = "https://app.rakuten.co.jp/services/api/Travel/KeywordHotelSearch/20170426?applicationId=$appid";
	if( !empty($affiliateid) ) {
		$apiurl .= "&affiliateId=$affiliateid";
	}
	$apiurl .= "&format=json&formatVersion=2&responseType=small&keyword=$title";
	/* API 呼び出し */
	$retapi = file_get_contents($apiurl);
	if( !$retapi ) {
		return;
	}
	/* JSON分解 */
	$result = json_decode( mb_convert_encoding( $retapi, 'UTF8', 'ASCII,JIS,UTF-8,EUC-JP,SJIS-WIN'), true );
	/* 読み出したデータが異常(失敗を含む)ならば何もせずに返す */
	if( is_null($result) ) {
		return;
	}
	/* 先頭から $count 数だけ表示 */
	for( $i=0; $count > 0; $i++) {
		if( empty($r = $result['hotels'][$i][0]['hotelBasicInfo'])
		 || $i >= $result['pagingInfo']['recordCount'] ) {
			break;
		}
		if( empty($r['hotelImageUrl']) ) {
			continue;
		}
		echo '<a href="' . $r['hotelInformationUrl'] . '" target="_blank" rel="nofollow"><img src="' . $r['hotelImageUrl'] . '" title="' . htmlspecialchars($r['hotelName']);
		if( !empty($imgclass) ) {
			echo '" class="' . $imgclass;
		}
		echo '" /></a>';
		$count--;
	}
}
楽天トラベルキーワード検索APIの出力をFirefoxで表示した例

楽天トラベルキーワード検索APIのように戻り値の階層が深い場合など、仕様書を眺めていてもピンとこなければ、まずは簡単なリクエストURLを作ってFirefoxなどで開いて見ると良い。

右図は「只見線」で検索した例。この場合は期待通りの結果が得られて満足。

ところが、例えば「会津鉄道会津線」などで検索しても、うまく出てこないのが課題。まあ普通は「会津鉄道」だけで通るからねぇ。 ソフトウェアで処理することも考えたけれども、「内陸線」だけで通っている所もあったりするし、「」のような表記ふれもあったりするので、悩ましい。

関連Extension
Extension:Yado

スクリプトを埋め込む(上級者向け)

閲覧者のIPv4/v6を表示

接続先(閲覧者)のIPアドレスバージョン(IPv4またはIPv6)を表示する。

LocalSettings.php 
$wgTweekiSkinSpecialElements['IPV6READY'] = 'tweekiTagIpv6ready';

# [Skin:Tweeki] 接続先(閲覧者)のIPアドレスバージョンを表示する
function tweekiTagIpv6ready( $skin, $context ) {
	$myipaddr = getenv('REMOTE_ADDR');
	if(preg_match('/^\d+\.\d+\.\d+\.\d+$/', $myipaddr)) {
		$myiptype = '4';
	} elseif(preg_match('/^\[?[\dabcdef]*\:[\:\dabcdef]+\]?$/i', $myipaddr)) {
		$myiptype = '6';
	} else {
		return;
	}
	echo "<div id='ipv6ready'><span id='ready'>IPv6 Ready</span> You connected via <span id='ip'>IPv$myiptype</span></div>";
}

※実際に使う場合は、別途スタイルシートで加工してあげましょう。例→MediaWiki:Common.css

ページの端にQRコードを表示する

URLのQRコードをページ端に表示することで、モバイル端末などで開きやすくする。

PHP QR Codeを使っているので、予めダウンロードしてMediaWiki配下に置いておく必要がある(ここの例では lib というディレクトリを作ってその中に展開している)。

LocalSettings.php 
require_once "lib/phpqrcode/qrlib.php";

$wgTweekiSkinSpecialElements['URLQR'] = 'tweekiPageUrlQR';

function tweekiPageUrlQR( $skin, $context ) {
	global $wgSitename;

	if( $skin->getSkin()->getTitle()->getNamespace() != NS_MAIN ) {
		/* NS_MAIN 以外では処理しない */
		return;
	}
	$title = $skin->getSkin()->getTitle()->getBaseText();
	if( !empty( $wgSitename ) ) {
		$title .= " - " . $wgSitename;
	}
	$url = $skin->getSkin()->getTitle()->getFullUrl();
	$tmpfile = tempnam( sys_get_temp_dir(), __FUNCTION__ );
	if( empty( $url ) or empty( $tmpfile ) ) {
		return;
	}
	QRcode::png( $url, $tmpfile );
	$png = file_get_contents( 'php://filter/read=convert.base64-encode/resource=' . $tmpfile );
	if( !empty( $png ) ) {
		echo Html::element( 'img', [
			'class' => "pageurlqr",
			'border' => "0",
			'style' => "margin: 0 auto;",
			'width' => "100",
			'height' => "100",
			'title' => $title,
			'src' => "data:image/png;base64," . $png
		] );
	}
	unlink( $tmpfile );
}

PHP QR Code は内部でGDを使っているが、ファイルに出力するかstdoutに出力するしかないので、一旦仮ファイルに出力してその内容を取得している

この後、MediaWiki:Tweeki-sidebar-right(または他の表示したい場所)に「URLQR」を指定すると、URLのQRコードを自動生成して表示するようになる。

無事QRコードが表示されたら、MediaWiki:Tweeki.css にて位置調整(任意)。 例:

MediaWiki:Tweeki.css 
#sidebar-right {
	padding-top: 0;
}
.sidebar-sticky {
	top: 0;
}
使用例 ちなみに Extension:QRLite との共存もできた
ファイルハンドル (resource) を渡すこともできるが、この関数が値を戻した時点で自動的に閉じてしまうので、仮ファイル名を付けて保存しておかないと、どうしようもない。
perlのGDだと簡単にできることをいちいち遠回しにしているが、phpではこれが限界。phpでstdoutの内容を取り込むにはob_start()を使う方法もあるが、PHP QR Code は内部でheader()を呼んでしまっているせいか、うまくいかない。

Bugs

.plainlinks が使えない

Tweekiではなぜか「.plainlinks」が使えない(指定しても効かない=外部リンクアイコンが表示されてしまう)。

MediaWiki:Tweeki.css に下記の指定をすることで「.plainlinks」クラス指定が効くようになる。

MediaWiki:Tweeki.css 
#content .plainlinks a.external::after, .link-http::after, .link-https::after {
	content: none !important;
}

Safariブラウザで「応答を解析できません」

Safariブラウザで開くと「応答を解析できません」エラー発生

2021年5月頃、最新のiOS・iPadOSに更新したiPhone・iPadのSafariブラウザで開くと「応答を解析できません」というエラーになる不具合が起きていた。

筆者が普段使っているFirefoxやChromeではこの不具合が起きなかったので気づくのが遅れたが、このときは Tweeki をアップデートすることで解消した。

MediaWikiバージョンアップ等の際にはiPadでも表示確認しているので、以前は問題が無かったのだが、その後、Safari側の変更でこの不具合が発生するようになったと思われる。

時々他のブラウザでも開いてみるとともに、Tweekiは頻繁に更新されているので、時々更新すると良さそうだ。

SSH等でサーバにログインできれば、更新は簡単にできる。

% cd /path/to/mediawiki/skins
% mv Tweeki Tweeki.old
% git clone https://github.com/thaider/Tweeki
% rm -r Tweeki.old

SSH等を使えないWebサーバを借りている場合は、リポジトリよりZipでダウンロードし、展開してからWebサーバにアップロードする。

Navigationに外部リンクを設定できない

Navigation に外部リンクを設定すると、なぜか INVALID-TITLE:[…] への余計なAタグが生成されてしまう。(下記例) → 修正されたっぽい

<a href="INVALID-TITLE:[http://mobile.twitter.com/kimagurenote/media twitter]"
id="n-.5Bhttp:.2F.2Fmobile.twitter.com.2Fkimagurenote.2Fmedia-twitter.5D" class="btn btn-primary btn-block">
<a rel="nofollow" class="external text" href="http://mobile.twitter.com/kimagurenote/media">twitter</a>
</a>

規定ではページの移動、削除といった管理メニューが表示されないので、Tweekiのみで運用する場合は、設定変更が必要(設定例を参照)。 または、編集担当者(ログインユーザ)は個人設定で他のSkinを選択しておくなど、他のSkinとの併用する方法もある。

参考リンク

関連記事