Program xcitata version 0.1.3

Initial revision 2003-04-05; Last revision 2004-05-31

1  Download

Win9x-EXE (minGW cross-compiled): mingw/xcitata.zip [37 Kb ]

2  File readme

xcitata --- index of cross-citations for two texts


SUPPORTED ENVIRONMENTS

http://www.gnu.org    GNU/Linux 
http://www.mingw.org  MinGW --- Minimalist GNU For Windows


COMPILATION

Enter make (or gmake) in the directory where sources reside


BRIEF INSTRUCTION

This program is helpful for construction of the index of
cross-citations for two files you wish to compare, which is easy to
navigate using web-browser. 

Command

  xcitata file1.txt file2.txt

produces files file1.txt.html and file2.txt.html, containing markup of
cross-citations and also it produces index.html file, containing the
index to these citations. Using your favourite browser you can now
navigate through cross-citations.

This program uses algorithm, which is very different from Unix "diff"
command algorithms and xcitata is intended more for literature
research than for comparision of program texts. 

The most striking feature of xcitata is that it can be used in
conjunction with program named "trised" (see D. Khmelev, Text Analysis
and Conversion Utilities at
http://www.math.toronto.edu/dkhmelev/PROGS/tacu/) in order to compare
texts "modulo" some filter, e.g., it can ignore case and do much more
interesting things, using capabilities of trised. For example, suppose
you use the following script

filter.sh:
trised --tr="\L\l/ //ac" --sq=" " --tr="\L/\l//a" -b $1.undo $1 $1.txt

to filter your files FILE1, FILE2 without extension:
$ filter.sh FILE1
$ filter.sh FILE2

(for explanation of the trised command line see trised manual).

Now you can apply xcitata with -t option to produce special trised
output:

$ xcitata -t FILE1.txt FILE2.txt

To do backup you use the following script:

undo.sh:
trised -u -b $1.undo $1.txt.html $1.txt.html
trised -u -b $1.txt.trised $1.txt.html $1.txt.html

$ undo.sh FILE1
$ undo.sh FILE2

The miracle! You have now markup of cross-citations, which takes into
consideration only source words!

License conditions are described in file LICENSE.txt

3  Usage and options summary

user@computer$ ./xcitata -e --help
Usage: xcitata [-m <num>] [-t] [LONGOPTIONS] FILE1 FILE2 FILE3
-e -h in English (don't forget to add -h or -H switch!)
-v print version information
-q --quiet       no diagnostics displayed
--program-output-encoding=a Output messages encoding --- a(cp866) can be wkim
--verbose=N      Diagnostics level 1(basic)..5(all)

4  Project revision history

2003-04-05

2003-04-06

2003-04-08

2003-04-09

2003-05-18

2003-06-04

2003-08-14

2003-08-23

2004-05-31

5  License

Available at http://www.math.toronto.edu/dkhmelev/PROGS/tacu/

Author:

Dmitry V. Khmelev dkhmelev((at))math.toronto.edu [change ((at)) to @ in order to get proper address - antispam]

University of Toronto, Department of Mathematics, 100 St George Street, M5S 3G3 ON, Canada

LICENSING TERMS

This program is granted free of charge for research and education purposes. However you must obtain a license from the author to use it for commercial purposes.

Scientific results produced using the software provided shall acknowledge the use of xcitata. The proper reference is:

D. Khmelev, Text Analysis and Conversion Utilities http://www.math.toronto.edu/dkhmelev/PROGS/tacu/

Moreover shall the author of xcitata be informed about the publication.

The software must not be modified and distributed without prior permission of the author.

By using xcitata you agree to the licensing terms.

NO WARRANTY

BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM ÄS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.