DocDiff Readme

2000-12-09..2011-02-23 Hisashi MORITA

目次

ニュース

See the ChangeLog for detail.

予定

簡単な説明

2つのテキストファイルを単語ごと、文字ごと、あるいは行ごとに比較する

概要

DocDiffは2つのテキストファイルを比較してその違いを表示します。単語ごと、文字ごと、そして行ごとにファイルを比較できます。結果を出力する形式は、HTML, tty（文字端末向けのエスケープシーケンス）, Manued（真鵺道という校正用のマークアップ形式）などが用意されており、ユーザ定義のタグを使うこともできます。

次のエンコーディング（文字コード）と行末コード（改行文字）をサポートしています: ASCII（およびISO-8859-*などのシングルバイトエンコーディング）, UTF-8, EUC-JP, Shift_JIS、そしてCR, LF, CRLF.

必要なもの

インストール方法

注意: 正しくインストールするためには適切なファイルアクセス権限が必要です（管理者権限が必要な場合があります）。

  1. docdiff/ディレクトリとその内容をrubyのライブラリを格納するディレクトリに配置して、Rubyインタプリタがdocdiffライブラリをロードできるようにする。
    (e.g.

    # cp -r docdiff /usr/lib/ruby/1.9.1

    )
  2. docdiff.rbをコマンドを格納するディレクトリに配置する。
    (e.g.

    # cp docdiff.rb /usr/bin/

    )
    ここで必要に応じてファイル名をdocdiffのように変更してもよい。
    (e.g.

    # mv /usr/bin/docdiff.rb /usr/bin/docdiff

    )
  3. 適切なパーミッションを設定する。
    (e.g.

    # chmod +x /usr/bin/docdiff.rb

    )
  4. (オプション) もしサイトの全ユーザに適用される設定ファイルが必要なら、docdiff.conf.exampleを/etc/docdiff/docdiff.confとして配置し、編集する。
    (e.g.

    # cp docdiff.conf.example /etc/docdiff.conf
    # $EDITOR /etc/docdiff.conf

    )
  5. (オプション) もしユーザごとの設定ファイルが必要なら、docdiff.conf.exampleを~/etc/docdiff/docdiff.confとして配置し、編集する。
    (e.g.

    % cp docdiff.conf.example ~/etc/docdiff.conf
    % $EDITOR ~/etc/docdiff.conf

    )

使い方

概要

docdiff [options] oldfile newfile
e.g. % docdiff old.txt new.txt > diff.html

詳しくはヘルプメッセージを参照してください（docdiff --help）。

例

% cat sample/01.ja.eucjp.lf
こんにちは、私の名前はわたなべです。
私はJust Another Ruby Porterです。
% cat sample/02.ja.eucjp.lf
こんばんは、私の名前はまつもとです。
Rubyを作ったのは私です。私はRuby Hackerです。
% docdiff sample/01.ja.eucjp.lf sample/02.ja.eucjp.lf
こんにちはこんばんは、私の名前はわたなべです名前はまつもとです。
 Rubyを作ったのは私です。私はJust Another Ruby PorterHackerです。
 %

設定

設定ファイルは次の場所に配置すると有効になります:

設定ファイルの記法は次のとおりです（docdiff.conf.exampleファイルも参照してください。配布アーカイブに含まれているはずです）:

# comment
key1 = value
key2 = value
...

値（value）は、数字として解釈できるもの以外は、すべて文字列として扱われます。数字は数値（たいていは整数）として扱われます。

問題解決とヒント

wrong argument type nil (expected Module) (TypeError)

DocDiffがたまにエンコーディングや行末文字の自動判定に失敗して、次のようなエラーを出力することがあります。

charstring.rb:47:in `extend': wrong argument type nil (expected Module) (TypeError)

このような場合は、エンコーディングや行末文字を明示的に指定してみてください（e.g. docdiff --utf8 --crlf）。

不適切な挿入と削除

スペースで区切られたテキスト（英文やプログラムのソースコードなど）を比較しているときに、行末にある単語が、特に必要もないのにいったん削除されてからまた挿入されることがあります。これはDocDiffの単語分割機能に制限があるせいで起きます。テキストは次のように単語に分割されます。

text 1:

foo bar
("foo bar" => ["foo ", "bar"])

text 2:

foo
bar
("foo\nbar" => ["foo", "\n", "bar"])

comparison result:

foo foo
bar
("<del>foo </del><ins>foo</ins><ins>\n</ins>bar")

Fooは（必要もないのに）削除されると同時に挿入されています。

作者はこの問題をいつか解決したいと思っていますが、簡単ではなさそうです。もし空白を1つの要素として分割したなら（i.e. ["foo", " ", "bar"]）、比較した結果出力される単語の並びが今よりも不自然になってしまいます。良い案があったら教えてください。

DocDiffをバージョン管理システムと組み合わせて使う

DocDiffをVCSの外部diffプログラムとして使いたければ、次のようにするとよいでしょう。

Subversion

% svn diff --diff-cmd=docdiff --extensions "--ascii --lf --tty --digest"

Git

% GIT_EXTERNAL_DIFF=~/bin/gitdocdiff.sh git diff

~/bin/gitdocdiff.sh: 

#!/bin/sh
docdiff --ascii --lf --tty --digest $2 $5

zshを使えば、いろいろな場所にある文書をDocDiffや他のユーティリティで自由に比較できます。次の例ではリポジトリ内の特定のリビジョンのfoo.htmlとウェブサイト上のfoo.htmlとを比較しています。

CVS:
% docdiff =(cvs -Q update -p -r 1.3 foo.html) =(curl --silent http://www.example.org/foo.html)

Subversion:
% docdiff =(svn cat -r3 http://svn.example.org/repos/foo.html) =(curl --silent http://www.example.org/foo.html)

HTMLやWord文書などのプレーンテキストではないファイルを比較する

適切な変換ツールを使えば、HTMLやMicrosoft Word文書など、プレーンテキスト以外のファイルも比較できます。

HTML文書の内容（タグを除く）を比較:
% docdiff =(w3m -dump -cols 10000 foo.html) =(w3m -dump -cols 10000 http://www.example.org/foo.html)

Microsoft Word文書の内容を比較:
% docdiff =(wvWare foo.doc | w3m -T text/html -dump -cols 10000) =(wvWare bar.doc | w3m -T text/html -dump -cols 10000)

Latin-* (ISO-8859-*) のための回避策: ASCIIを指定する

文字コードがLatin-* (ISO-8859-*) のテキストを扱うときは、文字コードにASCIIを指定してみてください。ASCIIが指定されると、DocDiffは対象をシングルバイト文字のテキストとして扱います。

Comparing Latin-1 texts:
% docdiff --encoding=ASCII latin-1-old.txt latin-1-new.txt

ライセンス

このソフトウェアはいわゆる修正BSDスタイルライセンス（http://www.opensource.org/licenses/bsd-license.php（広告条項なし））のもとで配布されています。このソフトウェアに貢献すると、あなたは貢献したものが同ライセンスのもとに取り込まれることに同意したとみなされます。

ソースコードの主となる部分の著作権と使用条件は次のとおりです: 

Copyright (C) Hisashi MORITA.  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
3. Neither the name of the University nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

diffライブラリ（docdiff/diff.rbおよびdocdiff/diff/*）は、もともと田中哲さんによるRuby/CVSの一部分でした。Ruby/CVSは修正BSDスタイルライセンスのもとで配布されています。詳細は次を参照してください。

クレジット

謝辞

情報源

フォーマット

同様の目的を持ったソフトウェア

テキストを単語単位や文字単位で比較することができるソフトウェアは、ほかにもあります。