【SmartDoc】『新旧対照表』作成機能について

kikuchi

現在、弊社が開発したConfluenceプラグインであるSmartDocを、無償で公開しております。

SmartDocとは

SmartDocとは、マニュアル制作システム「WikiWorks」で提供されている協力な編集機能を持ったConfluenceプラグインです。
SmartDocは、以下の機能を持っています。

  • 『新旧対照表』作成機能
  • 改訂履歴作成機能
  • コメント一覧機能
  • 検索/置換機能
  • ラベル管理機能
  • 画像(添付ファイル)一覧機能
  • ページ一覧機能

今回は、SmartDocで提供している機能の中から、「『新旧対照表』作成機能」についてご紹介します。

Confluenceには標準でページの比較機能がありますが、機能として物足りなさがあります。
SmartDocの「『新旧対照表』作成機能」との違いを示すために、まずはConfluence標準の比較機能の使用方法と、比較結果の画面を紹介します。

Confluence標準のページ履歴比較機能

Confluence標準のページ比較機能の使い方は、下記の通りです。

1.

比較をするページを開き、右上にある[ツール]ボタンをクリックします。
表示されるドロップダウンリストから、[ページ履歴]を選択します。
blog_5

2.

比較するバージョンを2つ選択し、[選択したバージョンを比較]ボタンをクリックします。
blog_6
チェックした2つのバージョンの比較結果が表示されます。
blog_7

Confluence標準の比較機能の弱点

簡単な比較であればConfluence標準の比較機能で十分ですが、下記のような場合には適していません。

  • 比較結果が見づらい
    上記のとおり、比較結果が色分けで表示されるものの、2つのページの比較をページ1つぶんのテキストにまとめてしまっているため、見づらさを感じます。
    変更箇所がたくさんある場合は特に、結果が煩雑になり、把握するのが困難です。
  • 比較結果を保存できない
    Confluence標準の比較機能は、結果を保存することができません。
    比較結果を基に資料を作成する、などの作業が難しいです。
  • 異なるページを比較できない
    Confluence標準の比較機能は、基本的に同一ページの履歴同士を比較するものです。
    異なるページを比較することはできません。

SmartDocの『新旧対照表』作成機能

SmartDocの「『新旧対照表』作成機能」は、同一ページの履歴の比較はもちろん、異なるページ同士の比較も可能です。
また、比較結果がページに保存され、対照表が作成されます。
この比較結果に対してWikiWorksのWord出力機能を使用することで、提出用文書として活用できます。

新旧対照表の作成方法

新旧対照表の作成方法は、下記の通りです。

1.

新旧対象表を保存するページを作成します。

2.

編集画面で、ページに"Sddiff"タグを記述します。
blog_8

3.

ページを保存すると、比較するページの情報を選択できるようになります。
blog_9
【同一ページで比較をする場合】

  1. [スペース名]をドロップダウンリストから選択します。
  2. [ページ名]をドロップダウンリストから選択します。
  3. [バージョン(新ページ)]と[バージョン(旧ページ)]をそれぞれドロップダウンリストから選択します。

【異なるページで比較をする場合】

  1. 【新ページ】と[旧ページ]の[スペース名]をそれぞれドロップダウンリストから選択します。
  2. 【新ページ】と[旧ページ]の[ページ名]をそれぞれドロップダウンリストから選択します。
  3. 【新ページ】と[旧ページ]の[バージョン]をそれぞれドロップダウンリストから選択します。

4.

[『新旧対照表』を作成]ボタンをクリックします。
処理が行われ、新旧対照表が作成されます。
blog_10

新旧対照表の詳細

新旧対照表は、Confluenceのテーブルを用いて、作成したページに上書きする形で保存されます。
よって、作成した新旧対照表について追加で編集することが可能です。

新旧対照表は3つの列からなり、左から「新ページの内容」、「旧ページの内容」、「差分」となります。

「新ページの内容」と「旧ページの内容」は、下記のように色分けされます。

追加された文字列(「新ページの内容」にあり、「旧ページの内容」にない文字列)
削除された文字列(「旧ページの内容」にあり、「新ページの内容」にない文字列)
変更された文字列(「新ページの内容」と「旧ページの内容」で記述が異なる文字)

「差分」は、下記のような段落の情報が表示されます。

[変更] 新ページと旧ページで、段落の内容が一部異なる段落。
[追加] 新ページにあり、旧ページにはない段落。
[削除] 旧ページにあり、新ページにはない段落。
[移動] 新ページと旧ページで、位置が異なる段落。

最後に

今回ご紹介した「『新旧対照表』作成機能」は、現在無償で公開しております「SmartDoc」の機能の1つとして提供しております。
興味のある方は、ぜひお試しください。

SmartDocの無償ダウンロードはこちらから
他の記事へはこちらから

お問合せ・資料請求はこちら

TEL03-6893-2237
受付時間 10:00~18:00(土・日・祝日を除く)

Webからのお問合わせ・資料ダウンロード