Skip to content

Configuring Oxygen to Preview msdesc TEI as HTML

Andrew Morrison edited this page Jun 22, 2020 · 2 revisions

The following instructions allow a cataloguer to preview how a TEI document they are working on, which has been written to validate to the schema in this repository, would appear on a web site like www.fihrist.org.uk or medieval.bodleian.ox.ac.uk. It will lack customisations added for each catalogue and CSS styling like fonts and indenting. It may be very different from how it will appear on another web site, if your project is using the schema, but not the Blacklight-based front end developed by BDLSS.

  1. Run Oxygen XML editor (the full version). These instructions should work with version 19 or higher, possibly some earlier versions.
  2. If you haven't already, go to Project > New Project and create a project. The transformation scenario created in the next steps will be associated with that project.
  3. Open a TEI document you wish to work on and/or preview.
  4. Go to Document > Transformation > Configure Transformation Scenario(s).
  5. Click New and select XML transformation with XSLT.
  6. Give it a Name of your choosing (e.g. "Preview msdesc TEI as HTML").
  7. The XML URL should already be set to ${currentFileURL}
  8. Enter the following in the XSL URL field: https://raw.githubusercontent.com/msDesc/consolidated-tei-schema/master/preview.xsl (unless working on a local copy of an Oxford-maintained catalogue, in which case click the folder icon to the right and find previewManuscript.xsl in the processing subfolder instead.)
  9. Select Saxon-PE 9.x.x.x in the Transformer drop-down.
  10. Go to the Output tab.
  11. In the Output file section, select Save as and click the folder icon to the right.
  12. Find somewhere on your local machine to save a temporary HTML file (e.g. the Desktop), enter a File Name (e.g. tei_preview.html), and click Save.
  13. Select Open in Browser/System Application then Saved file.
  14. Unselect all options in the Show in results view as section.
  15. Click OK then Save and close.

You will now be able preview the TEI document you have open by selecting Document > Transformation > Apply Transformation Scenario(s), or pressing Ctrl+Shift+T, or clicking a red play icon in a white circle in one of the toolbars. It will open in your default web browser.

For each different TEI file you open, you will have to select which transformation to apply when previewing (it will be one of the options presented in a list, named whatever name you chose in step 6). Tick the box next to it and click the Apply associated button. Then each subsequent preview of the same file will simply open it in your web browser.

Clone this wiki locally