EAD Report Card Desktop Version—Readme

This version of the RLG EAD Report Card is meant to run on the Windows desktop; there is also a version you can run on a web server. You can adapt either version of the EAD Report Card to comply with your own best practices for EAD.

System requirements

  • Windows OS: XP, Windows 2000, Windows NT
  • Browser: Internet Explorer 5.0 (or more recent), recent versions of Mozilla Firefox.
  • Java: you must have the Java Virtual Machine (included with the Java Development Kit)installed on your machine. In addition to having Java installed on your computer, your browser must be enabled to run Javascript. You can download the Java Virtual Machine (and the Java Development Kit) at http://java.sun.com.

How can I tell what my system is running? This page ( http://www.java.com/en/download/help/testvm.xml) will tell you:

  • where your Java came from (Sun, Microsoft, Apple, etc.).
  • what version of Java you have installed.
  • your operating system.
  • what version of your operating system you are running.

Although this page will tell you if you have Java enabled, it will not tell you if Javascript has been enabled in your browser, so please also check your browser settings.

Desktop application

In the directory "local", there are two desktop implementations: dynamic and static.

Dynamic

This version generates a report on the fly. It does not save as a file.

  • Point your browser to local/index.html.
  • Follow the directions that appear in the middle window.
  • Important! You must place all documents that you wish to check in the subfolder called "documents". Javascript has security features that prevent the browser from looking anywhere but the current folder and its subfolders for files.

Static

This version produces a report that is automatically saved in a subfolder of the folder where the chosen EAD document resides.

If you wish to use the static version of the EAD Report Card, be sure to install the program so that the path name contains no spaces (in other words, not in a directory structure that looks like "C:/Documents and Settings/My Documents/EAD report card/", but one that looks like "C:/programs/eadreportcard/".)

Read the README.html in the "local/desktop" folder to get started.

  1. Create a desktop shortcut for "createreport.bat".
  2. If you'd like the batch file to be run minimized or invisibly, right-click on the "createreport.bat" shortcut and select Properties. Now change the Run properties to Minimized.
  3. Make sure that the DOCTYPE in your EAD file points to the DTD on your local system; if not, comment out the DOCTYPE.
  4. Use the Windows Explorer to find your EAD document. Drag it to the desktop icon. A subfolder will be created in the folder where your document is. It will correspond to the name of the document. Inside that folder, open "index.html" with your browser. The report will be displayed in the top window.

Updating and adapting the guidelines and stylesheets

Note: this process must be run on a Windows machine.

  1. Go to "sources" directory.
  2. Modify "bpgrules.xml" with changes to the best practice guidelines. To understand how to encode the rules, point your browser to "sources/rulesdefinition.xml". (Use IE or a browser that can transform documents with XSL stylesheets.)

    If you have problems reading xml files such as "sources/rulesdefinition.xml" with your browser, try this:
  3. Once you have made changes to "bpgrules.xml", click on "generatestyles.bat". It will automatically rerun the generator and place the new stylesheets in the stylesheets directory.
  4. Move the stylesheet "desktopbpg.xsl" to local/desktop.
  5. Move the stylesheet "bpg.xsl" to local/. You can now check finding aids against the new guidelines.

We are a worldwide library cooperative, owned, governed and sustained by members since 1967. Our public purpose is a statement of commitment to each other—that we will work together to improve access to the information held in libraries around the globe, and find ways to reduce costs for libraries through collaboration.