PluginUsage - Redmine Glossary Plugin Wiki - Redmine Glossary Plugin

FrontPage

移動しました。 : http://www.r-labs.org/projects/rp-glossary/wiki/Usage

使用法

Outline

1. 使用法
   1. 用語の追加
   2. 用語の各項目の説明
      1. 用語
      2. 英語名
      3. ふりがな
      4. 略語の展開名称
      5. データ型
      6. コーディング用名称例
      7. カテゴリ
      8. 説明
   3. 用語へのリンク

プロジェクトメニューの 用語集 を選択すると 登録した用語の一覧が表示されます。

用語の追加

用語の追加 のリンクを選択すると追加ページになります。

用語の各項目の説明

用語

用語の名前です。

英語名

用語の英語表記名です。 対訳表などとして利用する場合やラベル名を統一するために入力します。

ふりがな

用語が漢字の場合などでその読み方を入力します。 リンク表示した場合の振り仮名(ルビ)や索引機能、用語名でのソートなど で利用されます。

略語の展開名称

用語が HTTP などの略語の場合、その省略しない全体の名称です。 例えば HTTP の場合には Hyper Text Transfer Protocol と入力します。

リンク表示した場合の abbr タグ(一般的なブラウザではツールチップ) として表示されます。

データ型

コーディング時にその用語をどのようなデータ型(クラス)で実装するかの名前です。 用語集を型変換テーブルとして利用する場合に指定します。

コーディング用名称例

会社やプロジェクトなどでコードを読みやすくするために コーディングルールを決めることはよくあると思います。

同じようにコーディング時に用語の省略名を個人ごとにバラバラの 名前を使っているとわかりづらくなります。 それらの用語を統一するための項目です。

カテゴリ

用語を分類するための項目です。 階層的に記述したい場合は / スラッシュを利用してください。

カテゴリによる検索時、親のカテゴリを指定すると子のカテゴリも表示されます。

説明

用語の詳細な解説を記述します。 wiki 記法が使えます。

用語へのリンク

wiki マクロを使って用語へのリンクを張ることが出来ます。 このマクロは用語集内である必要はなく、 wiki が使えるところでは どこでも使用できます。

リンク先の用語の指定には、番号、用語名の 2 通りの方法があります。

    {{termno(用語番号)}}
    {{term(用語)}}
    {{term(用語、プロジェクト識別名)}}

例

    {{termno(1)}}
    {{term(foo)}}
    {{term(foo, barproj)}}

term マクロでプロジェクトを指定した場合はそのプロジェクト内の用語にリンクを張ります。 プロジェクトを省略した場合は、現在プロジェクト内で用語を探し、 見つからなければ他のプロジェクトの用語集も探してリンクを張ります。

term マクロは wiki 用のテキストボックス上部の ボタンを押して、 挿入することも出来ます。