Redmine の Wiki ページに「ページトップへ戻る」ボタンを追加する方法を紹介します。
このブログの右下にも表示されているように、クリックするとページの上部までスクロールしてくれるボタンです。Wiki ページが長くなっているときに便利です。
はじめに
以前紹介した Redmine の Wiki による用語集のページでは用語の数だけページが長くなるので、用語を調べた後に戻るのが大変でした。
そこで、このブログの右下に表示されているような「ページトップへ戻る」ボタンを追加しました。
※ 私は HTML などに詳しくないので、ほとんど見よう見まねで設定しています。もっと簡単な方法があるかもしれません。
事前準備
必要なプラグイン
事前に下記プラグインをインストールする必要があります。それぞれ非常に便利なプラグインなので、ほとんどの Redmine にインストールされているのではないかと思いますが、まだの場合はリンク先のインストール方法を参考にしてインストールしてください。
一つ目の「Redmine view customize plugin」は、Redmine の画面をカスタマイズできるプラグインです。JavaScript と CSS に詳しければ、かなり自由に画面をカスタマイズすることができます（私は詳しくないので、ほとんどコピペですが）。
二つ目の「Redmine Wiki Extensions Plugin」は、Redmine の Wiki に様々な機能を追加するプラグインです。今回は Wiki の全ページにボタンを追加するために、このプラグインの「Footer」機能を使っています。
タグの設定
下記ページを参考に、aタグとpタグを有効にする必要があります。
Wikiの記述にHTMLタグを使用したい — Redmine.JP
「ページトップへ戻る」ボタンの追加方法
CSS の設定
「Redmine view customize plugin」がインストールされていれば、Redmine の左上メニューの「管理」のページに「View customize」という項目があるはずなので、これをクリックします。
「New view customize」をクリックし、下記のとおり設定して「作成」をクリックします。
「Code」の部分は、下記ページの「css」の部分そのままです。これを修正するとボタンの見た目が変わります。
JavaScript の設定
同様に「New view customize」から、下記のとおり設定して「作成」します。
「Code」の部分は、下記ページの「javascript」の部分そのままです。これを修正するとボタンの挙動が変わります。
Wiki の設定
「Redmine Wiki Extensions Plugin」をインストールした状態で、Wiki に「Footer」という名前のページを新しく作成します。このページの内容は、すべての Wiki の下部に表示されます。
この「Footer」に、下記コードを書き込んで保存します。
このコードは、下記ページの「html」の部分そのままです。
以上の設定により、Wiki ページ右下に「PAGE TOP」というボタンが表示されるはずです。
関連記事
おわりに
下記記事で紹介したように、このボタン追加作業も Redmine チケットに記録してあったので、この記事を簡単に書けました。やはり行った作業を記録しておくことは大切ですね。
