読者です 読者をやめる 読者になる 読者になる

kengo700のナレッジベース

誰かの役に立つと思う情報を発信するブログ

RedmineのWikiで用語集

この記事では、私たちの研究室のRedmine内に作成した用語集のページを紹介します。新しく研究室に来た人のために、研究に関する専門用語をまとめています。RedmineのWiki機能を利用して作成しました。

はじめに

研究室に配属された後、進捗報告会で先生と先輩の議論を聞いていると、知らない単語がバンバン出てきます。

「やばい、ついていけない!」と内心焦りつつ単語をメモして、後で調べてみるのですが、専門的すぎてググっても見つからないものも多いです。そもそもその研究室固有の呼び名(例えば製作したロボットの名前や、サーバーのホスト名など)だとググっても出てくるわけがありません。

という体験を昔したので、研究室のRedmine(プロジェクト管理システム)内に用語集のページを作りました。私たちの研究室固有の単語や、研究関連の単語など、とにかく研究室配属前の私が知らなかった単語の「簡単な説明」と「詳しい情報へのリンク」を詰め込んでいます。

私にはRedmineのプラグインを弄るスキルがまだないので、標準機能であるWikiを使って用語集ページを作っています。

Wikiによる用語集の概要

f:id:kengo700:20160112212336j:plain

この用語集ページでは、Wikiの表組とページ内リンクを利用して目次を作っています。 上図の「テンプレート」にあるように、各用語をh3.見出しで記載しています。

目次の文字をクリックしたり、ブラウザの検索機能(「Ctrl」+「f」キー)により、目的の用語の場所まで移動することができます。

f:id:kengo700:20160116122454j:plain:w500

ページが長くなるため、このブログと同様に、右下に「ページトップへ戻る」ボタンを表示するようにしています。これは「Redmine view customize」プラグインと、下記ページのソースを利用して実現しています。

この「ページトップへ戻る」ボタンの追加方法については、下記記事を参照ください。

kengo700.hatenablog.com

用語集の目次部分のソース

用語集の目次部分のソースは下記のようになっています。

---

|<a href="#あ"></a>|<a href="#い"></a>|<a href="#う"></a>|<a href="#え"></a>|<a href="#お"></a>||<a href="#か"></a>|<a href="#き"></a>|<a href="#く"></a>|<a href="#け"></a>|<a href="#こ"></a>||<a href="#さ"></a>|<a href="#し"></a>|<a href="#す"></a>|<a href="#せ"></a>|<a href="#そ"></a>||<a href="#た"></a>|<a href="#ち"></a>|<a href="#つ"></a>|<a href="#て"></a>|<a href="#と"></a>||<a href="#な"></a>|<a href="#に"></a>|<a href="#ぬ"></a>|<a href="#ね"></a>|<a href="#の"></a>|
|<a href="#は"></a>|<a href="#ひ"></a>|<a href="#ふ"></a>|<a href="#へ"></a>|<a href="#ほ"></a>||<a href="#ま"></a>|<a href="#み"></a>|<a href="#む"></a>|<a href="#め"></a>|<a href="#も"></a>||<a href="#や"></a>||<a href="#ゆ"></a>||<a href="#よ"></a>||<a href="#ら"></a>|<a href="#り"></a>|<a href="#る"></a>|<a href="#れ"></a>|<a href="#ろ"></a>||<a href="#わ"></a>||<a href="#を"></a>||<a href="#ん"></a>|


|<a href="#A">A</a>|<a href="#B">B</a>|<a href="#C">C</a>|<a href="#D">D</a>|<a href="#E">E</a>|<a href="#F">F</a>|<a href="#G">G</a>|<a href="#H">H</a>|<a href="#I">I</a>|<a href="#J">J</a>|<a href="#K">K</a>|<a href="#L">L</a>|<a href="#M">M</a>|<a href="#N">N</a>|<a href="#O">O</a>|<a href="#P">P</a>|<a href="#Q">Q</a>|<a href="#R">R</a>|<a href="#S">S</a>|<a href="#T">T</a>|<a href="#U">U</a>|<a href="#V">V</a>|<a href="#W">W</a>|<a href="#X">X</a>|<a href="#Y">Y</a>|<a href="#Z">Z</a>|

|<a href="#0">0</a>|<a href="#1">1</a>|<a href="#2">2</a>|<a href="#3">3</a>|<a href="#4">4</a>|<a href="#5">5</a>|<a href="#6">6</a>|<a href="#7">7</a>|<a href="#8">8</a>|<a href="#9">9</a>|

{{collapse(目次 / Table of Contents)

{{toc}}

}}

---

ページ内リンクを使うために、下記ページの方法でaタグを有効にしておく必要があります。

上記ソース内の{{toc}}は見出しを表示するWikiマクロです。 書き込んだ用語の数だけ見出しが長くなるので、{{collapse}}マクロにより折り畳んでいます。

用語集のプラグインの紹介

Redmineには、用語集のプラグインが公開されています。

このプラグインの用語集は、フィルター、ソート、インデックス表示などの便利な機能を備えているそうです。

しかし、このプラグインは私たちの研究室のRedmineでは正常に動作しませんでした。プログラムの修正に挑戦したのですがうまくいかず、またWikiで実用的な用語集が実現できたので、修正はあきらめました。Ruby on Railsに詳しい人は、下記ページの方のように、このプラグインを修正して使ったほうが便利だと思います。

リンク

関連記事

kengo700.hatenablog.com

終わりに

用語集の用語はだいたい私が書き込みました。(´・ω・`)

300近く。(´・ω・`)