Text Quality Review Tools
 
  Entity Checker Program

Description
For American Memory documents, there is an entity file (.ent) for each SGML-encoded text file (.sgm). The entity file should contain declarations for all the values of the entity attribute found in the SGML file. It also maps these entity values to actual file names and types.

The entity checker is an OmniMark program developed for the American Memory DTD which checks the value of the "entity" attribute against the file that contains entity declarations to ensure that each entity value has a declaration. The parser also checks for this but the entity checker checks for more. It also checks that the file specified in the entity declaration exists. The entity checker reports declarations in the entity file that are not in the .sgm file as well as image files in the directory that are not referenced by entity values in the SGML file.

Marla Banks wrote the OmniMark program which is used for this task.

How to use the entity checker
  1. Install the OmniMark parser.
  2. Copy entychkr.xom into your OmniMark directory. (ftp from rs6/itssgml/pgms) or Download entychkr.xom.
  3. Map a network drive through Windows95 to the aggregate on the server.
  4. Using the MS-DOS prompt, change to the drive letter assigned to the mapped drive.
    Example:
    Type (where E: is the drive letter assigned to the mapped aggregate drive)
    E:
    Then change to the directory that contains the .sgm, .ent and all of the image files. Type
    cd\xxxxx.
    Note : xxxxxx = directory name of item. Example:cd\04681.
  5. Then type:
    omnimark –s entychkr.xom x.sgm –of x.out
    Note: x=filename.
  6. The program creates a report that is found in the x.out file.

NOTE: *You must have write permission for the directories that you wish to check. This program creates a directory list of the image files and uses it for the checking process.

Example report file
Entity checking for lg14.sgm and lg14.ent

List of entity attributes in SGML file: lg140001
lg140002
lg140003
lg140004
lg140005
lg140006
lg140007
lg140008
lg140009
lg140010
lg140010.t01
lg140011
lg140011.t01
 
Entity lg140001 - DECLARED and file lg140001.tif EXISTS
Entity lg140002 - DECLARED and file lg140002.tif EXISTS
Entity lg140003 - DECLARED and file lg140003.tif EXISTS
Entity lg140004 - DECLARED and file lg140004.tif EXISTS
Entity lg140005 - DECLARED and file lg140005.tif EXISTS
Entity lg140006 - DECLARED and file lg140006.tif EXISTS
Entity lg140007 - DECLARED and file lg140007.tif EXISTS
Entity lg140008 - DECLARED and file lg140008.tif EXISTS
Entity lg140009 - DECLARED and file lg140009.tif EXISTS
Entity lg140010 - DECLARED and file lg140010.tif EXISTS
Entity lg140010.t01 - DECLARED but file lg140010.pcx DOES NOT EXIST Entity lg140011 - DECLARED and file lg140011.tif EXISTS
Entity lg140011.t01 - DECLARED but file lg140011.pcx DOES NOT EXIST

List of declared entities in .ent file:
lg140001 lg140001.tif
lg140002 lg140002.tif
lg140003 lg140003.tif
lg140004 lg140004.tif
lg140005 lg140005.tif
lg140006 lg140006.tif
lg140007 lg140007.tif
lg140008 lg140008.tif
lg140009 lg140009.tif
lg140010 lg140010.tif
lg140010.t01 lg140010.pcx
lg140011 lg140011.tif
lg140011.t01 lg140011.pcx

Image files in this directory without a declaration:
File lg140000.tif is not in .ent file
File lg140012.tif is not in .ent file
File lg140013.tif is not in .ent file
File lg140014.tif is not in .ent file
File lg140015.tif is not in .ent file
File lg140016.tif is not in .ent file
File lg140017.tif is not in .ent file
File lg140018.tif is not in .ent file
File lg140019.tif is not in .ent file
File lg140020.tif is not in .ent file

Files named in the .ent file that are not in this directory:
File lg140010.pcx is not in the directory
File lg140011.pcx is not in the directory

13 entity attribute(s) in SGML file
13 entity declaration(s) in .ent file

Of the 13 entity attributes in the SGML file,
and the 13 declarations in the .ent file:
13 entities are declared in the .ent file;
11 file(s) are present in the directory and
2 file(s) ARE NOT PRESENT.

Declared entity counts okay

Finished entity checking.

-- Return to top --
-- Return to Text Quality Review Home --