目次

DokuWikiのテンプレートとプラグイン

テンプレートの変更

DokuWiki公式・テンプレートからDokuWikiで使用可能なテンプレート一覧が確認可能。

デフォルトのテンプレートをそのまま使うか、変更する場合はBootstrap3 Template がおすすめ。

人気のパラメーターを見るとBootstrap3が圧倒的に人気が高い。
2位と10倍以上の差をつけている。

テンプレートをインストール

管理 > 拡張機能管理 > 検索とインストール


Bootstrap3を検索。

Bootstrap3 Template(作者: Giuseppe Di Terlizzi)のインストールをクリック。

インストールしただけでは適用されない。
別途、管理画面から設定が必要。

テンプレートを変更

管理 > サイト設定

基本
template
テンプレート(Wikiのデザイン)
bootstrap3

保存をクリック。

テーブルのスタイルを設定

管理 > サイト設定

テンプレート
Bootstrap3
レイアウト
tpl»bootstrap3»tableFullWidth
100% のテーブル幅を有効にする(Bootstrap のデフォルト)
チェックしない
tpl»bootstrap3»tableStyle
Table 形式
striped チェックする
bordered チェックする
hover チェックしない
condensed チェックする
responsive チェックする

保存をクリック。

ページIDを非表示にする

デフォルトでは、画面の上部に[[start]]のようなテキストが表示される。
これを非表示にする。

管理 > サイト設定

テンプレート
Bootstrap3
レイアウト
tpl»bootstrap3»showPageId
DokuWiki ページ名(ページ ID)を上部に表示する
チェックしない

不要なプラグインを削除する

プラグインを削除する方法

管理 > 拡張機能管理


インストール済みプラグインタブで、プラグインの横のアンインストールをクリック。

不要なプラグインの候補

Active Directory Auth Plugin

DokuWiki公式・Active Directory 認証プラグイン

Acrive Directoryを使用していない場合、このプラグインは不要。


LDAP Auth Plugin

DokuWiki公式・LDAP Auth plugin: Active Directory

Active Directoryなどのディレクトリーサービスを使用していなければ不要。


authpdo plugin

DokuWiki公式・authPDO Plugin

PDO(PHP Data Object)を使用していなければ不要。
PDOはMySQLなどの認証で使うもの。


Popularity Feedback Plugin

DokuWiki公式・Popularity Feedback プラグイン

DokuWikiの開発元に統計データを送信するためのプラグイン。
調査に協力したければこのプラグインを利用してもいいが、アンインストールしても問題はない。

プラグインの導入

管理 >  拡張機能管理 > 検索とインストール

メジャーなDokuWiki Plugin

プラグイン 開発者 説明
smtp plugin Andreas Gohr SMTPを使えるようにする
アカウント作成・パスワードリセットなどのシステムメール送信に必要
EditTable plugin Andreas Gohr Excelライクにtableを編集できる
socialcards plugin Mark C. Prins Twitter:cardなどのOGPを追加する
Socialite plugin Fernando Ribeiro TwitterやFacebookなどのシェアボタンを一括管理する
Footer plugin Juergen aus Zuendorf 全ページのコンテンツエリア下端にアイテムを挿入する
Socialite pluginのSNSボタンを全ページ一括で設定するのに使う
xbr Plugin Christopher Smith \\なしで改行が反映されるようになる
caption Plugin Till Biskup 画像の下にキャプションを表示できるようになる
color Plugin
(color syntax plugin)
Harald Hanche-Olsen テキスト、テキストの背景に色を付けられる
cleanup Plugin Andreas Gohr 古い編集履歴を削除する

DokuWiki公式・smtp plugin

DokuWiki公式・EditTable plugin

DokuWiki公式・socialcards plugin

DokuWiki公式・Socialite plugin

DokuWiki公式・Footer plugin

DokuWiki公式・xbr Plugin

DokuWiki公式・caption Plugin

DokuWiki公式・color Plugin

DokuWiki公式・cleanup Plugin

DokuWikiにOGPを設定する方法

socialcards pluginをインストール

管理 > 拡張機能管理 > 検索とインストール

socialcards pluginをインストールする。

サイト設定

管理 > サイト設定

Socialcards
plugin»socialcards»twitterName
Twitter account name for this site
@xxx
plugin»socialcards»twitterUserName
Twitter account name of the author
@xxx
plugin»socialcards»fallbackImage
Default (fallback) image for OpenGraph and Twitter cards. (a fully qualified url or a media id)
wiki:ogImage.jpg
plugin»socialcards»languageTerritory
Locale (Language and territory).
ja_JP

保存をクリック。

twitterNameはOGPのtwitter:siteに対応。
twitterUserNameはOGPのtwitter:creatorに対応。
一般的にどちらも同じ値を設定する。

fallbackImageはOGPのtwitter:imageに対応。

languageTerritoryはOGPのog:localeに対応。

OGP用画像をアップロード

メディアマネージャーを開く。

名前空間を選択wikiを選択。

アップロードタブから、ogImage.jpgという名前のファイルをアップロード。

ogImage.jpg504×264サイズの画像にする。
(縦横比1.91:1、Twitterでシェアしたときに綺麗に見えるサイズ)

twitter:cardをsummaryからsummary_large_imageに変更

デフォルトの設定では、twitter:cardの値はsummaryとなっている。
action.phpというファイルを編集することで、twitter:cardの値をsummary_large_imageに変更する。

Twitterでページがシェアされたときに、
summaryは正方形の小さな画像が、
summary_large_imageは長方形の大きな画像が表示される。


cd /home/user1/Dokuwiki/xxx
vi lib/plugins/socialcards/action.php

action.phpを開く。

action.php
        $event->data['meta'][] = array(
            'name'    => 'twitter:card',
            'content' => "summary",
        );

上記のsummaryの部分をsummary_large_imageに書き換え。

action.phpへの編集は、socailcards pluginをアップデートした際にリセットされる可能性がある。

DokuWikiにSNSシェアボタンを設置する方法

Bootstrap3のSNSシェアリンク

画面右上にある

のようなアイコンをクリックすると、SNSシェアができるようになっている。


SNSシェアリンクの設定

管理 > サイト設定

テンプレート
Bootstrap3
ページ
tpl»bootstrap3»showPageIcons
ページ上に便利なアイコン (印刷・シェアリンク・メール送信等) を表示する
チェックする
tpl»bootstrap3»pageIcons
表示するアイコンを選択する
social-share チェックする
feed チェックする
send-mail チェックする
permalink チェックする
print チェックする
help チェックする
tpl»bootstrap3»socialShareProviders
表示する SNS シェアリンクを選択する
facebook チェックする
linkedin チェックする
microsoft-teams チェックする
pinterest チェックする
whatsapp チェックする
reddit チェックする
twitter チェックする
telegram チェックする
yammer チェックしない

保存ボタンをクリック。

DokuWikiの管理画面から、

を設定できる。

Socialite Pluginをインストール

管理 > 拡張機能管理 > 検索とインストール

Socialite Pluginを検索、インストールをクリック。


Socialite Pluginの最終更新日

Socialite Pluginは、
最終更新日2019-01-01となっている。
DokuWiki 2020-07-29 “Hogfather”のリリース日よりも古い)

しかし、Compatible with DokuWikiは、
2020-07-29 “Hogfather” となっている。

DokuWiki (Hogfather)のリリースによるプラグインの更新はないが、動作確認は行っているようなので使用しても問題はない。

Socialite Pluginを設定

管理 > サイト設定

Socialite
plugin»socialite»networks
表示するボタンを半角スペースで区切り順番に指定します。 指定可能なボタン名は
twitter facebook googleplus linkedin pinterest tumblr reddit taringa stumbleupon telegram hackernews xing vk email
twitter facebook googleplus linkedin pinterest tumblr reddit email

(デフォルトから以下のものを削除
taringa stumbleupon telegram hackernews xing vk)
plugin»socialite»display
表示プション: アイコンと名前の両方、アイコンのみ、背景色の上に名前のみから選択
color
plugin»socialite»target
Link target: specifies where to open the social network page.
_blank
plugin»socialite»twitter_user
Twitterユーザー名(“@“は含めない)
xxxxx

保存ボタンをクリック。

networksは各自の好みで設定する。
taringastumbleuponなど、知名度が低いものは削除。

displaycolorがおすすめ。
iconに比べてアイコン画像の読み込みが発生しないため表示が速くなる。

SNSシェアボタンを設置

wikiの編集画面で、
~~socialite~~と書くと、その位置に


のようにSNSシェアボタンが表示される。

全ページに一括でSNSシェアボタンを設置する場合は、別途プラグインなどが必要。
(Footer pluginがおすすめ)

Footer pluginを導入すると、全ページまたはカテゴリー単位に一括でフッターを設置できる。


管理 > 拡張機能管理 > 検索とインストール

Footer pluginを検索してインストール

全ページにフッターを設定

cd /home/user1/Dokuwiki/xxx
vi data/pages/__footer.txt

data/pagesディレクトリに、__footer.txtというファイルを新規作成。

__footer.txt
~~socialite~~

__footer.txtに書いた内容がすべてのページに表示される。

__footer.txtの中ではDokuWikiの記法が使える。

特定のページを除外

たとえば、サイドバーにはフッターを追加したくないという場合は、
sidebarのページ編集画面に



というテキストを追加すれば、そのページには
__footer.txt
に設定した内容が表示されなくなる。

_footer.txtと__footer.txtの違い

_footer.txt(アンダースコア1つ)だと、_footer.txtを設置した階層にだけフッターが追加される。
__footer.txt(アンダースコア2つ)だと、__footer.txtを設置した階層およびサブディレクトリーすべてにフッターが追加される。


data/pages/_footer.txt(アンダースコア1つ)を作成すると、

には、フッターが表示されるが、

には、フッターが表示されない。


data/pages/__footer.txt(アンダースコア2つ)を作成すると、

など、すべての階層にフッターが表示される。


特定の名前空間にだけフッターを設定

data/pagesディレクトリは、名前空間のルート。
URLはhttp://example.com

data/pages/aaaディレクトリは、名前空間aaa
URLはhttp://example.com/aaa

data/pages/aaa/bbbディレクトリは、名前空間aaa:bbb
URLはhttp://example.com/aaa/bbb

上記のような対応関係になっている。


cd /home/user1/Dokuwiki/xxx
vi data/pages/aaa/_footer.txt

data/pages/aaa/_footer.txt(アンダースコア1つ)を作成すると、

には、フッターが表示されるが、

には、フッターが表示されない。


data/pages/aaa/__footer.txt(アンダースコア2つ)を作成すると、

には、フッターが表示されず、

には、フッターが表示される。
aaa以下のすべての階層にフッターが表示される)

xbr Pluginをインストールする方法

DokuWiki記法では、改行に\\記号を使う。

xbr Pluginを使うと、編集画面での改行が、表示画面でもそのまま改行になる。
\\の入力をしなくてすむ)

xbr Pluginは長期間メンテナンスがされておらず、
Last updated on(最終更新日)は2012-06-30となっている。

しかし、Compatible with DokuWiki2020-07-29 “Hogfather”となっているので、DokuWii 2020-07-29 Hogfatherでも動く。

xbr Pluginをインストールする

管理 > 拡張機能管理 > 検索とインストール

xbrで検索、xbr Pluginインストール

xbr Pluginを設定

管理 > サイト設定

高度な設定
renderer_xhtml
Wikiの出力(xhtml)に使用するレンダラー
XBR Plugin(プラグイン)

レンダラーをxhtml(Dokuwikiコア)からXBR Plugin(プラグイン)に変更する。

保存をクリック。

DokuWiki公式・設定項目: renderer_xhtml

画像にキャプションをつける

caption Pluginをインストール

管理 > 拡張機能管理

caption Pluginをインストール。

caption Pluginを設定

管理 > サイト設定

Caption
plugin»caption»abbrev
Use abbreviations (Fig., Tab.) in caption instead of full names (Figure, Table)?
チェックを入れる
(デフォルトは、チェックなし)

デフォルトでは、画像の下に
Figure 1: キャプション
のような表示になるのが
Fig. 1: キャプション
のような表示に変わる。

キャプションの設定方法

<figure>
{{http://example.com/xxx.jpg|あああ}}
<caption>いいい</caption>
</figure>

ページ編集画面で上記のような書き方をすると
imgタグのalt属性にあああというテキストが設定され、
画像の下には、Fig. 1: いいいのようなキャプションが表示さ
れる。

テキストに色を付ける

管理 > 拡張機能管理

color Pluginをインストール。

<color red>aaa</color>

上記のような書き方をすると、aaaという文字が赤くなる。

DokuWiki公式・color Plugin

編集履歴を削除する

cleanup Pluginをインストール

管理 > 拡張機能管理

cleanup Pluginをインストール。

cleanup Pluginを設定

管理 > サイト設定

Cleanup
plugin»cleanup»runautomatically
ファイルの整理処理を自動的に実行する?
チェックする

以前のリビジョンは

の2つからなる。

「過去の文書ファイル」は、過去の各編集時点でのページの文書ファイル。
「変更履歴ファイル」は、編集日時や編集ページ下部の「編集の概要」に入力した情報が保存されているファイル。

2か月以上経過したページの「過去の文書ファイル」が自動的に削除される。
(./data/attic/xxx.txt.gzのようなファイルが削除される)

2か月以上経過した現存しないページの「変更履歴ファイル」が自動的に削除される。
(./data/meta/xxx.changesのようなファイルが削除される)

DokuWiki公式・cleanup Plugin