--> Finding aids -->Preparing Finding Aids for EAD --> 
Correcting XML and HTML files

- Notes
- Correcting XML Files
      - Minor Corrections
      - Major Corrections
- Correcting HTML-only Files
(updated 5/21/98) 

NOTES:

FOR ALL FILE CORRECTIONS - CHECK THE "XMLLOAD" DIRECTORY AS WELL AS THE "URXML" DIRECTORY FOR FILES. THERE MAY BE A MORE RECENTLY UPDATED FILE IN THE "XMLLOAD" DIRECTORY 

Correcting XML files

Because the coding of these files takes a significant numbers of steps, corrections should be handled in two ways:

Minor corrections (typos, addition of a few folders, minor reorganization)

After the ur-files are corrected, it is best to make a printout of the changed pages, or at least note the exact wording of the changes. Because the coding and proofing of XML files can be quite complicated, such minor changes and additions are best done manually within the ur-XML file along the following guidelines:

    Simple data corrections can be made directly in the XML ur-file, which will then be taken through the requisite steps to validate and reload the file, as detailed in Preparing XML files for WebText, starting with Step 6.
    Additions

    If a folder is being added, locate a similar folder in the existing XML file and duplicate the coding (by copying-and-pasting), then replace the existing data with the new folder information.
    (e.g. given the following entry, the coding in pink has been copied and the data in green has been replaced:)

    <c02><did><container label="box"/>
    <container id="f1807">1807</container>
    <unittitle> Comments on text about African and slave musicians, typescript carbon </unittitle><unitdate>n.d.</unitdate></did></c02>

    <c02><did><container label="box"/>
    <container id="f1807a">1807a</container>
    <unittitle> "Committee Report to the Tenants League of 89-105 Lefferts Place"
    </unittitle><unitdate>n.d.</unitdate></did></c02> 

    This method works whereever there are additions that fit in neatly with existing lists of like items. Keep in mind the need to make sure that the complete coding is copied - the exclusion of a single tag can cause an error.

    (e.g. given the following entry, the coding in pink has been copied and the data in green has been replaced, but the coding and data in purple has been copied and replaced from a similar "see" reference elsewhere in the file:)
     

    <c05><did><container label="box"/>
    <container id="f268">268</container> 
    <unittitle> Announcements for book signing party </unittitle>
    <unitdate>1948 Jan 24</unitdate></did></c05>

    <c05><did><container label="box"/> 
    <container id="f268a">268a</container> 
    <unittitle> Announcements and reviews - clippings </unittitle> 
    <unitdate>1947-65</unitdate></did> 

    <c06><did><container/><container/> 
    <note><p><ref target="f1927"> See also: Oversize, Box 119, folder 1927 <ref></p></note></did> </c06>
    </c05>

    For more complicated changes, which may necessitate the addition of a new heading, you will have to copy and paste at least a couple of different sequences of coding.
    (e.g. given the following entry, the coding in pink has been copied and the data in green has been replaced:)

    <c03><did><unittitle>McCallum, C. E.</unittitle> </did>

    <c04><did><container label="box"></container> 
    <container id="f1720">1720</container>
    <unittitle> To Claude M. McCallum </unittitle> 
    <unitdate>1943 Jul 3</unitdate></did></c04> 

    <c04><did><container/><container/>
    <unittitle> To Coke Stevenson </unittitle>
    <unitdate>1944 Mar 27</unitdate></did></c04> 
    </c03>

    <c03><did><unittitle>Maniquet, L. de</unittitle></did> 

    <c04><did><container label="box"></container>
    <container id="f1720a">1720a</container> 
    <unittitle>[Note found in Richard Wright's copy of <title>Black Boy</title>] to Ellen Wright </unittitle>
    <unitdate>1970[?] Jun 5</unitdate></did></c04>
    </c03> 

    For the addition of an entire series, or a very long list of new folders, there is an alternate strategy that can be used to generate coding. Create a new, temporary box file containing ONLY the new data from your corrected ur-file - making sure that this new list is complete (with proper Series and headers - just like a regular file) - then process it through the standard box coding procedure

      (i.e.:

      edixit [name].box
      alt-v rip [enter]

      After file is"ripped", from DOS command line, type either:

        xmlit [name]
      if the finding aid is a standard box-and-folder listing, or:
        xmlit [name] rec
      if the finding aid is a miscellany or a similar type that lists cataloging details as notes under folder titles.

      The completed file will be named [name].xml)

    Then cut-and-paste the newly coded data from your new temporary XML file into your ur-XML file.

    After any type of additions, take the file through the requisite steps to finish, validate and reload the file, as detailed in Preparing XML files for WebText, starting with Step 3.b.

    Deletions

    Deletions of data should be very simple - just take care to not remove any tags that are required because of other coding. After deletions are made, take the file through the requisite steps to validate and reload the file, as detailed in Preparing XML files for WebText, starting with Step 5.

    Reorganization of data

    Like deletions, reoganizing data should be pretty straightforward, keeping in mind that you should be careful to not move tags that don't effect the newly posiitoned data and that there may be some extra editing mecessary if the reoganization effects the hierarchy of an archive, and thus the coding levels needed in XML. After any reorganizations is made, take the file through the requisite steps to validate and reload the file, as detailed in Preparing XML files for WebText, starting with Step 5.

Major changes (the addition of a large number of items; the reorganization of an entire series)


Correcting HTML-only files:

Minor corrections and additions can be made directly in the ur-HTML file (which is then proofed and moved to the loading directory, as detailed in Preparing HTML-only files for Webext).
Major changes may require a regeneration of the file following the steps in Preparing HTML-only files for OpenText.

Comments: Nicole Bouché,
Copyright 1997. Beinecke Rare Book and Manuscript Library
All rights reserved.