MorphAdorner: Comparing Adorned Files

Comparing Adorned Files

CompareAdornedFiles compares two adorned files and writes a change log indicating the differences between the two.

Usage:

compareadornedfiles oldadorned.xml newadorned.xml diffs.xml

where

oldadorned.xml is the "old" adorned TEI XML file.
newadorned.xml is the "new" (modified) version of the adorned file.
diffs.xml is the file name to receive the change log of the token-based differences from the old to the new adorned file.

Change log file format

CompareAdornedFiles uses a simple XML format to contain a list of token-based changes. The format of this file is as follows.

<ChangeLog>
  <changeTime>The time the change file was created.</changeTime>
  <changeDescription>A description of the changes.</changeDescription>
  <changes>
   <change>
     <id>xml:id of token to be changed.</id>
     <changeType>addition, modification, or deletion.</changeType>
     <fieldType>Type of field to change: text or attribute.</fieldType>
     <oldValue>Old field value.</oldValue>
     <newValue>New field value.</newValue>
     <siblingID>xml:id of sibling word for a word being added.</siblingID>
     <blankPrecedes>true if blank precedes the token, else false.</blankPrecedes>
   </change>
            ...
(more <change> entries)
            ...
  </changes>
</ChangeLog>

This simple XML formatted change file allows a file to be transformed to a corrected file using a utility in the MorphAdorner suite. A file can be "untransformed" from the corrected version to the uncorrected version using the same change file. A likely use case for the change log is an edition that wants to use long 's' and other original spellings.

Here is an example of a change log entry which records the replacement of a long "s" with a plain "s".

<ChangeLog>
  <changeTime>2013-07-09 13:04:17.149 CDT</changeTime>
  <changeDescription>Changes from \tokenized\K000379.000.xml to \tokenized-no-word-breaks\K000379.000.xml as determined by CompareAdornedFiles.</changeDescription>
  <changes>
    <change>
      <id>K000379_000-00080</id>
      <changeType>modification</changeType>
      <fieldType>text</fieldType>
      <oldValue>Addreſs'd</oldValue>
      <newValue>Address'd</newValue>
      <blankPrecedes>true</blankPrecedes>
    </change>
        ...
  </changes>
</ChangeLog>

A change log may be used to transform one version of an adorned file into another using the UpdateAdornedFile utility.

	Home
	Welcome
	Announcements and News
	Announcements and news about changes to MorphAdorner
	Documentation
	Documentation for using MorphAdorner
	Download MorphAdorner
	Downloading and installing the MorphAdorner client and server software
	Glossary
	Glossary of MorphAdorner terms
	Helpful References
	Natural language processing references
	Licenses
	Licenses for MorphAdorner and Associated Software
	Server
	Online examples of MorphAdorner Server facilities.
	Talks
	Slides from talks about MorphAdorner.
	Tech Talk
	Technical information for programmers using MorphAdorner