Captions – IBM DOORS Next モジュールの図と表のキャプションを章ごとに番号付け

概要と開発の背景

Word や PDF にエクスポートする仕様書には、章ごとに番号が付いた図と表が必要です（Fig. 2.1、Fig. 2.2、Table 2.1）。DOORS Next では、キャプションは説明対象の画像や表の下に置かれる独立した成果物で、その番号は単なるテキストです。画像を追加したり、セクションを移動したり、章を追加したりするたびに番号がずれ、手作業で直すにはキャプションを 1 つずつ開くしかありません。

Captions は、モジュール内のすべてのキャプションに 1 回の実行で番号を付けます。モジュールの章を読み取り、図と表の各キャプションの番号を算出し、まず一覧で表示してから書き込みます。置き換えるのは、各キャプションの先頭にある古い番号だけです。

解決する課題

セクションの追加、移動、削除の後、図番号や表番号が章と合わなくなる。
同じ番号の図が 2 つある、または番号が飛んでいることに、エクスポートした文書で初めて気付く。
レビューやリリースの前に、キャプションを 1 つずつ開いて番号を手入力するのに何時間もかかる。
1 つの文書の中で、キャプションの番号の書き方がばらばら（「Figure 3:」、「Fig. 1.2」、番号なし）。

メリット

章ごとの番号付け： Fig. 2.1、Fig. 2.2、Table 2.1 のように、図と表は別々にカウントされ、章ごとに 1 から始まります。
まず確認： 何かを変更する前に、各キャプションの現在の番号と新しい番号がプレビューに一覧表示されます。
キャプションのテキストはそのまま： 置き換えるのは古い番号だけで、文言や太字・斜体は元のままです。
何度でも安心して実行： 既に正しい番号のキャプションには書き込まず、Excel の変更レポートに各テキストの変更前と変更後を記録します。

使い方

あなた1モジュールを開く
ウィジェット2すべての番号をプレビュー
あなた3Number captions を確定
DOORS Next4章ごとにキャプションを番号付け
結果5Excel の変更レポート

必須： Captions は、プロジェクトに Caption という名前の成果物タイプがある場合にのみ動作します。キャプションはそのタイプの成果物で、それぞれの画像や表の下に置かれます。Caption Type 属性（Figure または Table）は任意です。
モジュールを開きます。Settings で Change をクリックし、New number at headings up to でどの見出しレベルから新しい番号を始めるかを選び（レベル 1：1.1、1.2 … その次は 2.1）、Caption text after the number で Keep the text、Only the number (remove the text)、または図や表の属性（Name など）を選びます。Done をクリックします。
Module で Preview をクリックすると、Captions に各キャプションの現在の番号、新しい番号、新しいテキストが表示されます。行を開いて Show in module をクリックすると、そのキャプションがモジュール内に表示されます。
Number をクリックし、確認の内容を読んで Number captions をクリックします。結果ブロックに番号を付けた件数、追加した件数、既に正しかった件数、失敗した件数が表示され、Log で変更レポートをダウンロードできます。

スクリーンショット

1プレビュー：各キャプションの現在の番号と新しい番号、および図や表の名前から取ったテキスト（名前が空の場合は "text removed"）
2確認には、モジュール全体に書き込まれる内容が表示されます。番号の後に図や表の名前が入ることも含まれます
311 件に番号を付け、2 件を追加。8 件は名前のテキスト、5 件はテキストを削除

知っておきたいこと

Captions は変更セットの中で実行してください。結果が意図どおりでなければ、変更セットを破棄できます。
最初の章より前にあるキャプションには章 0 が使われます（Fig. 0.1）。Caption Type のないキャプションは、語を付けずに独自のカウントで番号付けされます。
Caption Type 属性は省略できます。属性がない場合、Captions は古い番号の語（Fig.、Table）か、キャプションの隣の図や表から、図か表かを判断します。キャプションのない図や表には、そのすぐ下に新しいキャプションが追加されます（Settings でオフにできます）。
既定では、元の Captions ウィジェットと同じく、キャプションは中央揃えになり、成果物の名前は空になります。どちらも Settings でオフにできます。
キャプションのタイプ、その属性、番号の前に付ける語（Fig.、Table）はウィジェットの設定で変更できます。たとえば別の言語のキャプションに使えます。
Captions はキャプションのテキストも自動で書けます。Settings で図や表の属性（たとえば Name）を選ぶと、その値が古いテキストの代わりに番号の後に書かれます（例: Fig. 1.2 Battery pack layout）。値が空なら番号だけが残ります。すべてのキャプションからテキストを消すには Only the number を、番号だけを変えるには Keep the text を選びます。