Wex：編集履歴情報の抽出プログラム
説明書
1.1.0

2019/10/1

RIKEN AIP 自然言語理解チーム

1目次
1.

2.

はじめに ................................................................................................................... 3
1.1.

動作環境 ............................................................................................................ 3

1.2.

導入 .................................................................................................................. 3

プログラム引数 .......................................................................................................... 4
2.1.

3.

実行 .................................................................................................................. 4

2.1.1.

引数 ........................................................................................................... 4

2.1.2.

オプション ................................................................................................... 42.2.

出力ファイル ...................................................................................................... 52.3.

使用例 ............................................................................................................... 5

出力 ......................................................................................................................... 73.1.

標準出力 ............................................................................................................ 73.2.

標準エラー出力.................................................................................................... 72

1. はじめに
本書は、編集履歴情報の抽出プログラムの操作手順を説明するものです。

1.1.

動作環境

本プログラムの動作には Windows および Microsoft Word が必要になります。動作保証環境を下表に示します。
No.
1.

OS
Windows 10 64 bit
表 1 動作保証環境一覧

1.2.

導入

本プログラムはインストーラによってインストールおよびアンインストールが行われます。インストールが正常に成功した後、Windows の再起動をすることによってプログラムが有効になります。

3

2. プログラム引数
2.1.

実行

編集履歴情報の抽出プログラムを実行するには、コマンドプロンプトを起動して以下のコマンドを実行します。
$ wex [options] source
引数およびオプションについては次項以降で説明します。

2.1.1. 引数
編集履歴情報の抽出プログラムに指定する引数を下表に示します。
No.
1.

引数

必須

source...

説明
抽出対象の word ファイルへのパスまたはフォルダへのパスを指定します。複数指定が可能です。
フォルダへのパスを指定した場合、サブフォルダを含むそのフォルダ内〇の全ての word ファイル（拡張子が doc、docx、docm のいずれかのファイル）が抽出対象となります。
尚、フォルダを指定時に、各ファイルの処理において何らかのエラーが発生した場合、そのファイルの処理はスキップし、次のファイルの処理へと移行します。
（アプリケーションは終了せず、処理は継続します。
）
表 2 引数一覧

2.1.2. オプション
編集履歴情報の抽出プログラムのオプションを下表に示します。これらのオプションは全て任意です。
No.

オプション

説明

2.

-a

コメント XML ファイル出力時に author 属性を省略します。

3.

-c

変更履歴 XML ファイルのみ生成します。

4.

-f

変更履歴 XML ファイル、コメント XML ファイルまたはコメント CSV ファイルの出力先に同名のファイルが既に存在した場合に警告なく上書きをします。このオプションが指定されていない場合、上書きは行われません。

5.

-m

コメント CSV ファイルのみ生成します。

6.

-r

コメント XML ファイルのみ生成します。

7.

-s

全ての CSV ファイルを生成します。バージョン 1.1.0 の時点ではコメント CSVファイルのみ生成されます。

8.

-x

変更履歴とコメントの全ての XML ファイルを生成します。-c, -m, -r, -s, -x の4いずれも指定されていない場合、このオプションが有効となります。
9.

-v, --version

以下を標準出力に出力してプログラムを終了します。
wex version {バージョン}

10.

-h, --help

ヘルプを標準出力に出力してプログラムを終了します。
表 3 オプション一覧

2.2.

出力ファイルプログラムを実行した際、下表のような形式でファイルが出力されます。
No.

種別

ファイル名

1.

変更履歴 XML ファイル

{Word ファイル名}-revision.xml

2.

コメント XML ファイル

{Word ファイル名}-comment.xml

3.

コメント CSV ファイル

{Word ファイル名}-comment.csv
表 4 出力ファイル名一覧

2.3.

使用例

編集履歴情報の抽出プログラムの使用例を下表に示します。
No.
1.

使用例
wex sample.docx

説明
カレントフォルダの sample.docx から変更履歴とコメントを抽出し、同じフォルダに変更履歴 XML ファ
イルとコメント XML ファイルを生成する場合の例です。

2.

wex .\sample.docx同上です。

3.

wex C:\sample.doc

同様です。ただし、source に絶対パスを指定した場合の例です。

4.

wex “sample with space.docx”

同様です。ただし、source にスペースを含む名前のファイルを指定した場合の例です。

5.

wex samples

同様です。ただし、source にフォルダへのパスを指定した場合の例。

6.

wex -a sample.docx

コメント XML ファイル中の author 属性を省略する場合の例です。

7.

wex -c sample.docx

変更履歴 XML ファイルのみを生成する場合の例です。

8.

wex -f sample.docx

sample.docx-comment.xml

やsample.docx-revision.xml が既に存在したときに強制的に上書きする場合の例です。

59.

wex -r sample.docx

コメント XML のみを生成する場合の例です。

10.

wex –m sample.docx

コメント CSV ファイルのみを生成する場合の例です。

11.

wex –s sample.docx

全ての CSV ファイルを生成する場合の例です。バージョン 1.1.0 時点ではコメント CSV ファイルのみ生成されます。

12.

wex –x sample.docx

全ての XML ファイルを生成する場合の例です。

13.

wex -a -r -f sample.docx samples

1、5、6、8、9 を同時に指定する場合の例です。

14.

wex -arf sample.docx samples同上です。
表 5 使用例一覧

6

3. 出力本章では、編集履歴情報の抽出プログラム実行中に表示されるメッセージについて説明します。

3.1.

標準出力

プログラムが正常に動作している場合、下表のメッセージが標準出力に表示されます。
No.

メッセージ

詳細

1.

アプリケーションの初期化処理を開始します。

プログラム実行直後に表示されます。

2.

アプリケーション初期化処理が完了しました。

プログラムの実行準備が終わった段階で表示されます。

3.

4.

5.

6.

変更履歴 XML ファイルの出力に成功しました。

{パス}の変更履歴 XML ファイルが正常に出:力された場合に表示されます。

{パス}

コメント XML ファイルの出力に成功しました。

{パス}のコメント XML ファイルが正常に出:力された場合に表示されます。

{パス}

コメント CSV ファイルの出力に成功しました。

{パス}のコメント CSV ファイルが正常に出:力された場合に表示されます。

{パス}終了しました。

プログラムが終了した場合に表示されます。
表 6 標準出力のメッセージ一覧

3.2.

標準エラー出力プログラム実行中に何らかの問題が発生した場合、下表のメッセージが標準エラー出力に出力されます。
No.
1.

メッセージ

詳細想定外のエラーが発生しました。

想定外のエラーが発生した場合に表示されます。

2.

使い方が不正です。 wex -h で使い方を確認し構文エラーがある場合に表示されます。てください。
3.

アプリケーションの初期化に失敗しました。

Microsoft Word がインストールされていな

Microsoft Word がインストールされているかい場合に表示されます。

どうか確認してください。
4.

指定されたファイルまたはフォルダが開けませ{パス}が存在しないか、アクセス権限が無いん。などの理由で開くことが出来ない場合に表示

:
5.

されます。

指 定 さ れ た フ ァ イ ル が 不 正 で す 。 Microsoft{パス}が Microsoft word ファイルとしてword ファイルを指定してください。

認識できない場合に表示されます。

:
6.

{パス}

{パス}

ファイルの書き込みに失敗しました。同名のファ
7{パス}が既に存在し、ファイルの書き込みにイルが既に存在します。-f オプションの利用を失敗した場合に表示されます。

検討してください。
:
7.

{パス}

ファイルの書き込みに失敗しました。

{パス}へのアクセス権限が無いなどの理由:で書き込むことが出来ない場合に表示されま{パス}す。
8.

コメントファイルの出力に失敗しました。非サポ{パス}に非サポートの形式のコメント、（特ートのコメントが含まれています。コメントの交に、コメントの交差）が含まれていた場合に差を解消してください。

表示されます。

:{パス}:{行番号}
表 7 標準エラー出力のメッセージ一覧

8