Get the Most out of Oxygen Martin Holmes Author2013 Cameron Butt Author2013 Tye Landels Author2014 Sarah Milligan Copy Editor Cameron Butt Encoder2012 Tye Landels Encoder2013 Data Manager Tye Landels Junior Programmer Joey Takeda Programmer Martin Holmes Associate Project Director Kim McLean-Fiander Project Director Janelle Jenstad The Map of Early Modern Londonhttp://mapoflondon.uvic.ca/includes.xmlVictoria, BC, Canada
Department of English P.O.Box 3070 STNC CSC University of Victoria Victoria, BC Canada V8W 3W1
2016University of Victoria978-1-55058-519-3 Janelle Jenstad london@uvic.ca

Copyright held by The Map of Early Modern London on behalf of the contributors.

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

Further details of licences are available from our Licences page. For more information, contact the project director, Janelle Jenstad, for specific information on the availability and licensing of content found in files on this site.

 Provider: University of Victoria Database: The Map of Early Modern London Content: text/plain; charset="utf-8" TY - ELEC A1 - Holmes, Martin A1 - Butt, Cameron A1 - Landels-Gruenewald, Tye ED - Jenstad, Janelle T1 - Get the Most out of Oxygen T2 - The Map of Early Modern London ET - 7.0 PY - 2022 DA - 2022/05/05 CY - Victoria PB - University of Victoria LA - English UR - https://mapoflondon.uvic.ca/edition/7.0/oxygen.htm UR - https://mapoflondon.uvic.ca/edition/7.0/xml/standalone/oxygen.xml ER - Holmes, Martin D., Cameron Butt, and Tye Landels-Gruenewald. Get the Most out of Oxygen. The Map of Early Modern London, Edition 7.0, edited by Janelle Jenstad, U of Victoria, 05 May 2022, mapoflondon.uvic.ca/edition/7.0/oxygen.htm. Holmes, Martin D., Cameron Butt, and Tye Landels-Gruenewald. Get the Most out of Oxygen. The Map of Early Modern London, Edition 7.0. Ed. Janelle Jenstad. Victoria: University of Victoria. Accessed May 05, 2022. mapoflondon.uvic.ca/edition/7.0/oxygen.htm. Holmes, M. D., Butt, C., & Landels-Gruenewald, T. 2022. Get the Most out of Oxygen. In J. Jenstad (Ed), The Map of Early Modern London (Edition 7.0). Victoria: University of Victoria. Retrieved from https://mapoflondon.uvic.ca/editions/7.0/oxygen.htm. Joey Takeda Joey Takeda JT

Programmer, 2018-present. Junior Programmer, 2015-2017. Research Assistant, 2014-2017. Joey Takeda was a graduate student at the University of British Columbia in the Department of English (Science and Technology research stream). He completed his BA honours in English (with a minor in Women’s Studies) at the University of Victoria in 2016. His primary research interests included diasporic and indigenous Canadian and American literature, critical theory, cultural studies, and the digital humanities.

 Tye Landels-Gruenewald Tye Landels-Gruenewald TLG

Data Manager, 2015-2016. Research Assistant, 2013-2015. Tye completed his undergraduate honours degree in English at the University of Victoria in 2015.

 Cameron Butt Cameron Butt CB

Research Assistant, 2012–2013. Cameron Butt completed his undergraduate honours degree in English at the University of Victoria in 2013. He minored in French and has a keen interest in Shakespeare, film, media studies, popular culture, and the geohumanities.

 Sarah Milligan Sarah Milligan SM

Research Assistant, 2012-2014. MoEML Research Affiliate. Sarah Milligan completed her MA at the University of Victoria in 2012 on the invalid persona in Elizabeth Barrett Browning’s Sonnets from the Portuguese. She has also worked with the <ref target="http://internetshakespeare.uvic.ca/">Internet Shakespeare Editions</ref> and with Dr. Alison Chapman on the Victorian Poetry Network, compiling an index of Victorian periodical poetry.

 Kim McLean-Fiander Kim McLean-Fiander KMF

Director of Pedagogy and Outreach, 2015–2020. Associate Project Director, 2015. Assistant Project Director, 2013-2014. MoEML Research Fellow, 2013. Kim McLean-Fiander comes to The Map of Early Modern London from the Cultures of Knowledge digital humanities project at the University of Oxford, where she was the editor of Early Modern Letters Online, an open-access union catalogue and editorial interface for correspondence from the sixteenth to eighteenth centuries. She is currently Co-Director of a sister project to EMLO called Women’s Early Modern Letters Online (WEMLO). In the past, she held an internship with the curator of manuscripts at the Folger Shakespeare Library, completed a doctorate at Oxford on paratext and early modern women writers, and worked a number of years for the Bodleian Libraries and as a freelance editor. She has a passion for rare books and manuscripts as social and material artifacts, and is interested in the development of digital resources that will improve access to these materials while ensuring their ongoing preservation and conservation. An avid traveler, Kim has always loved both London and maps, and so is particularly delighted to be able to bring her early modern scholarly expertise to bear on the MoEML project.

 Janelle Jenstad Janelle Jenstad JJ

Janelle Jenstad is Associate Professor of English at the University of Victoria, Director of The Map of Early Modern London, and PI of Linked Early Modern Drama Online. She has taught at Queen’s University, the Summer Academy at the Stratford Festival, the University of Windsor, and the University of Victoria. With Jennifer Roberts-Smith and Mark Kaethler, she co-edited Shakespeare’s Language in Digital Media (Routledge). She has prepared a documentary edition of John Stow’s A Survey of London (1598 text) for MoEML and is currently editing The Merchant of Venice (with Stephen Wittek) and Heywood’s 2 If You Know Not Me You Know Nobody for DRE. Her articles have appeared in Digital Humanities Quarterly, Renaissance and Reformation,Journal of Medieval and Early Modern Studies, Early Modern Literary Studies, Elizabethan Theatre, Shakespeare Bulletin: A Journal of Performance Criticism, and The Silver Society Journal. Her book chapters have appeared (or will appear) in Institutional Culture in Early Modern Society (Brill, 2004), Shakespeare, Language and the Stage, The Fifth Wall: Approaches to Shakespeare from Criticism, Performance and Theatre Studies (Arden/Thomson Learning, 2005), Approaches to Teaching Othello (Modern Language Association, 2005), Performing Maternity in Early Modern England (Ashgate, 2007), New Directions in the Geohumanities: Art, Text, and History at the Edge of Place (Routledge, 2011), Early Modern Studies and the Digital Turn (Iter, 2016), Teaching Early Modern English Literature from the Archives (MLA, 2015), Placing Names: Enriching and Integrating Gazetteers (Indiana, 2016), Making Things and Drawing Boundaries (Minnesota, 2017), and Rethinking Shakespeare’s Source Study: Audiences, Authors, and Digital Technologies (Routledge, 2018).

 Martin D. Holmes Martin D. Holmes MDH

Programmer at the University of Victoria Humanities Computing and Media Centre (HCMC). Martin ported the MOL project from its original PHP incarnation to a pure eXist database implementation in the fall of 2011. Since then, he has been lead programmer on the project and has also been responsible for maintaining the project schemas. He was a co-applicant on MoEML’s 2012 SSHRC Insight Grant.

 Born digital.

Our editorial and encoding practices are documented in detail in the Praxis section of our website.

Author A person or organization chiefly responsible for the intellectual or artistic content of a work, usually printed text. This term may also be used when more than one person or body bears such responsibility. MoEML uses the term author to designate a contributor who is wholly or partly responsible for the original content of either a born-digital document, such as an encyclopedia entry, or a primary source document, such as a MoEML Library text. Data manager A person or organization responsible for managing databases or other data sources. MoEML uses the term data manager to designate contributors who maintain and manage our databases. They add and update the data sent to us by external contributors or found by MoEML team members. They also monitor journals and sources regularly to ensure that our databases are current. Markup editor A person or organization performing the coding of SGML, HTML, or XML markup of metadata, text, etc. MoEML uses the code mrk both for the primary encoder(s) and for the person who edits the encoding. MoEML’s normal workflow includes a step whereby encoders check each other’s work. We use the term encoder to designate the principal encoder, and markup editor to designate the person who checks the encoding. Project director A person or organization with primary responsibility for all essential aspects of a project, or that manages a very large project that demands senior level responsibility, or that has overall responsibility for managing projects, or provides overall direction to a project manager. MoEML’s Project Director directs the intellectual and scholarly aspects of the project, consults with the Advisory and Editorial Boards, and ensures the ongoing funding of the project. Programmer A person or organization responsible for the creation and/or maintenance of computer program design documents, source code, and machine-executable digital files and supporting documentation. MoEML uses the term programmer to designate a person or organization responsible for the creation and/or maintenance of computer program design documents, source code, and machine-executable digital files and supporting documentation. Research team head A person who directed or managed a research project. MoEML uses the terms research term head and assistant project manager interchangeably. Copy editor MoEML uses the term copy editor to designate the person who brings the document into conformity with MoEML stylistic and citational practice. Acceptable names for this role are copy editor, principal copy editor, secondary copy editor, or copy editor of a particular section of text. Added table of shortcut keys. Added sourceDesc information for born-digital documents. Standardized respStmts for JENS1, MCFI1, and HOLM3 and added TAKE1 as Junior Programmer. Added XInclude for listPrefixDef in the header. Revised index tags. Added section on wrapping code in Oxygen. Added global publicationStmt through XInclude. Put change elements inside revisionDesc into the correct (latest first) order. Added profileDesc containing document type information expressed in catRef elements. Created file and added content from encoding_practices.xml file. Get the Most Out of Oxygen
Introduction setup your workstation Oxygen basics

This page contains useful information for advanced encoders using Oxygen. These instructions are not comprehensive, but outline a few key features. For an introduction to Oxygen, see this document prepared by MoEML programmer Martin Holmes.

setup your workstation Oxygen MoEML project file Using the MoEML project file

If you check out the MoEML codebase from Subversion as described in Access Files from the Subversion Repository, you will find that there is a file in the root of the checked-out folder (alongside PERS1.xml) called moeml.xpr. This file is an Oxygen project file. Load this file into Oxygen Project / Open Project, and you should see the list of all the files and folders in the project available to you automatically.

Using the moeml.xpr project file brings some other advantages. For instance, you will find that the keystroke shortcut for entering a curly apostrophe described below is automatically configured, and you can also run the diagnostics.xsl file in utilities to perform consistency checks on the entire collection (although this is now done automatically by our Jenkins build server whenever anyone commits to svn).

setup your workstation Oxygen code templates special characters unicode Add Code Templates for Special Characters (Apostrophes, etc.)

Oxygen can remember code templates, or shortcut keys for special characters. This can be useful for typing characters that re-occur frequently but are difficult to type. For example, the website uses curly apostrophes (’), Unicode character U+2019, which must be hard-coded (manually typed in the string of text, rather than rendered dynamically). Documents with straight apostrophes will not validate against our schema. Other useful characters to have in a code template may be the en dash (–) or the em dash (—). Typing such characters is made easier by setting up a code template in Oxygen as follows.

First, find the character in your character map (or in a pre-existing document) and copy it to the clipboard so you can paste it when you need it. The curly apostrophe, en dash, and em dash can be copy-pasted from the text above, for example.

In Oxygen, click on Options/Preferences, then type Code Templates into the filter box at the top. You will see a list of the existing code templates (if any). Click on New, then fill in the following details:

Name: Apostrophe Description: Curly apostrophe (U+2019) Associate with: XML Editor Content: [Paste the apostrophe in here]

Then press OK.

Now, you can insert a curly apostrophe into documents as follows:

Press Control + Shift + Space. You should see the code template selector appear. Use the arrow keys to select the desired code, and press OK to use it.

setup your workstation Oxygen schematron relax ng unicode validation Set Up Schematron Validation

All of our TEI files must of course validate against our TEI schema, which is a RELAX NG schema. This controls the structure and content of our files, by setting out the rules for which elements and attributes can appear in which places, and making sure that (for example) dates are encoded in the proper format. However, the RELAX NG schema has some limitations on the kinds of constraints it can impose. In order to apply some extra, more project-specific rules and strictures to our files, we also use a second schema which is written in a different language called Schematron. So at the top of every XML file, you’ll see two processing instructions pointing at schemas, one pointing at the RELAX NG schema (london_all.rng) and one pointing at the Schematron schema (london_all.sch). The RELAX NG schema is handled automatically by Oxygen, but in order to make the Schematron schema work properly, you will need to make a couple of changes to the Oxygen preferences. If this is not done, validation of XML files will fail.

Click on Options/Preferences. In the filter box at the top left, type XML Parser and press return. XML Parser [P] should be selected. Under Schematron/Schematron XPath Version, select 2.0. Under ISO Schematron, check Allow foreign elements.
setup your workstation Oxygen validation XInclude XML parser Adjust Validation Settings for Files with XInclude

Almost all of our XML files contain XInclude elements. XInclude is used to pull in content from another document; it enables us to keep a single copy of some important pieces of XML in one location and pull it into many other documents automatically. You can see some examples and a brief explanation of XInclude in Website structure: Simple Documents. By default, when Oxygen validates a file containing an XInclude element, it tries to follow the XInclude tag and pull in the extra content before doing the validation. This would be desirable, except that Oxygen is not able to follow some of the XInclude paths we use, because they include XPointers. Therefore we have to turn off this behaviour for the validation to succeed:

Click on Options/Preferences. In the filter box at the top left, type XML Parser and press return. XML Parser [P] should be selected. Under XInclude Options, uncheck Enable XInclude processing.
setup your workstation Oxygen find and replace Find and Replace Encoded Text

Oxygen has a powerful search and replace function, but it should be used with caution to avoid errors.

To search in a certain file, right-click on that file in the project view and select Find/Replace in Files. To search and replace in all files, select the highest file in the tree, london. This action opens a search and replace window. To search for a string of text, simply type that string into the search bar and click Search. Oxygen will open a list of the occurrences it finds at the bottom of the screen. It also lists the number of occurences and the files in which they appear. Double-click on an occurrence to open that file.

setup your workstation Oxygen line wrap preferences in Oxygen Wrap XML Code

Use the Line wrap function in Oxygen to wrap your XML code neatly, so that it does not disappear off the right of your screen with a horizontal scrollbar. To activate the Line wrap function, click on Preferences in the Options toolbar. A new window will open with a table of contents on the left-hand side. Find the Text subsection, nested inside Editor > Edit modes > Text, and check the Line wrap checkbox.

It is absolutely essential that encoders do not use pretty-print, also known as the Format and Indent function in Oxygen. Although this function promises to wrap your TEI code neatly and indent it for you, in practice, it will add extra spaces in the middle of mixed-content elements, resulting in the introduction of spaces where they should not appear. (See related documentation on encoding spaces truthfully.)

Oxygen shortcuts Oxygen code templates special characters keyboard shortcuts copy and paste Keyboard Shortcuts

There are a number of keyboard shortcuts in the MoEML Oxygen project file that quickly perform a number of common encoding tasks.These shortcuts are for a Linux OS; depending on your operating system and keyboard, the commands might be slightly different. For a full list of Oxygen keyboard shortcuts, see Oxygen > Options > Menu Shortcut Keys

Action How to do it Add element around selected text Ctrl+e Save Ctrl+s Validate Ctrl+shift+v Comment/uncomment selected text Ctrl+shift+, Pulls up a menu of special characters and common entity tags that MoEML uses (including curly apostrophe, long s, personography entry, and more) Ctrl+shift+space Undo Ctrl+z Redo Ctrl+shift+z Cut Ctrl+x Copy Ctrl+c Ctrl+v Paste Find/Replace (use with caution!) Ctrl+f Toggle line-wrap Ctrl+shift+y See suggested elements Left bracket (<) and wait for one second See suggested attributes When in the element, press space after typing the element name and wait for one second See suggested attribute values Place cursor between the quotation marks and wait for one second