Introduction to Documentation Guidelines

The documentation in this chapter is for LEMDO team members who write and encode technical documentation. It will guide you through the process of creating and encoding documentation for the LEMDO project.

Rationale

LEMDO’s technical documentation contains all of the information that our editors and encoders need to encode a LEMDO edition. It also contains information directed towards developers and remediators. It is important that our documentation meets the needs of each audience by being clear, consistent, and correct. The documentation in this chapter will support you to write and encode documentation that aligns with our overall style and provide accurate instructions for correctly-encoded editions.

Learning Outcomes

This chapter gives you all the information you need to encode technical documentation for the LEMDO project. By the time you have worked through every section of this chapter, you will:
Understand the principles underlying how we write documentation.
Be familiar with the relationship between our documentation pages and the ODD file.
Be familiar with the structure of our documentation and the rationale behind it and know how to make changes to our documentation structure from the ODD file.
Know about our specific structure for chapter introduction pages.
Be able to follow our style guidelines for documentation.
Know how to encode documentation files, including how to give credit to the people who work on them and how to add sample code.

Contents

Section Description
Documentation Principles Learn about the base principles that govern how we write documentation
The Relationship between Documentation and the ODD File Learn about how the ODD file interacts with our documentation
General Documentation Structure Learn about the overall structure of the documentation index
Documentation Chapter Introductions Learn how to write and structure a chapter introduction page
Documentation Style Guidelines Read the style guidelines that we follow when writing documentation
Create and Name Documentation Files Learn how to make a new documentation page
Give Credit for Documentation Files Learn how to give credit to documentation authors and proofreaders
Structure of a Single Documentation File Learn how to structure the documentation that you write
Encode Intended Audience for Documentation Learn how to tag documentation pages as being intended for specific audience groups
Encode Sample XML Learn how to determine which tags to use when encoding sample XML and other code
Encode egXMLs Learn how to encode examples of TEI
Encode Element Names Learn how to tag element names in running prose
Encode Attribute Names Learn how to tag attribute names in running prose
Encode Value Names Learn how to tag attribute values in running prose
Encode Non-XML Markup Learn how to tag IML and other non-XML elements
Encode Command Line Instructions Learn how to tag command-line instructions and SVN commands
Encode Closing Tags and Opening Tags with Attributes and Values Learn how to tag closing tags in running prose
Format Sample Encoding Learn how to format examples so that they are most helpful to your audience
Make Links to and from Documentation Learn how to link to documentation pages
Link Technical Terms to Glossary Learn how to link to our shared glossary of technical terms
Include Automatically-Generated Content in Documentation Learn how to use inline processing instructions to generate content in documentation
Create Templates for Editors Learn how to create templates for editors and encoders in Oxygen

Prosopography

Illya

Illya has a BA in English and Sociocultural Anthropology and an MA in English. Prior to joining the HCMC, he was a PhD candidate in English and Book History at the University of Toronto and worked on Records of Early English Drama and on the Modernist Archives Publishing Project. His work at the HCMC focuses on creating web-based applications for research projects led by members of the faculty of Humanities at the University of Victoria. This involves creating schemas for new and existing datasets, writing XSLT and build files to transform datasets into structured TEI and HTML formats, implementing staticSearch, and ensuring that new projects are Endings Principles compliant.

Janelle Jenstad

Janelle Jenstad is a Professor of English at the University of Victoria, Director of The Map of Early Modern London, and Director of Linked Early Modern Drama Online. With Jennifer Roberts-Smith and Mark Beatrice Kaethler, she co-edited Shakespeare’s Language in Digital Media: Old Words, New Tools (Routledge). She has edited 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, Elizabethan Theatre, Early Modern Literary Studies, Shakespeare Bulletin, Renaissance and Reformation, and The Journal of Medieval and Early Modern Studies. She contributed chapters to Approaches to Teaching Othello (MLA); Teaching Early Modern Literature from the Archives (MLA); Institutional Culture in Early Modern England (Brill); Shakespeare, Language, and the Stage (Arden); Performing Maternity in Early Modern England (Ashgate); New Directions in the Geohumanities (Routledge); Early Modern Studies and the Digital Turn (Iter); Placing Names: Enriching and Integrating Gazetteers (Indiana); Making Things and Drawing Boundaries (Minnesota); Rethinking Shakespeare Source Study: Audiences, Authors, and Digital Technologies (Routledge); and Civic Performance: Pageantry and Entertainments in Early Modern London (Routledge). For more details, see janellejenstad.com.

Joey Takeda

Joey Takeda is LEMDO’s Consulting Programmer and Designer, a role he assumed in 2020 after three years as the Lead Developer on LEMDO.

Mahayla Galliford

Project Manager, 2025-present; Assistant Project Manager, 2024-2025; Research Assistant, 2021-present. Mahayla Galliford (she/her) graduated from the University of Victoria with a BA (honours with distinction) in 2024, and an MA English in 2026. Mahayla’s undergraduate research explored early modern stage directions and civic water pageantry. Her SSHRC-funded MA thesis project focuses on transcribing, editing, and encoding early modern girls’ manuscripts, specifically Lady Rachel Fane’s May Masque in collaboration with LEMDO.

Martin Holmes

Martin Holmes has worked as a developer in the UVic’s Humanities Computing and Media Centre for over two decades, and has been involved with dozens of Digital Humanities projects. He has served on the TEI Technical Council and as Managing Editor of the Journal of the TEI. He took over from Joey Takeda as lead developer on LEMDO in 2020. He is a collaborator on the SSHRC Partnership Grant led by Janelle Jenstad.

Navarra Houldin

Training and Documentation Lead 2025–present. LEMDO project manager 2022–2025. Textual remediator 2021–present. Navarra Houldin (they/them) completed their BA with a major in history and minor in Spanish at the University of Victoria in 2022. Their primary research was on gender and sexuality in early modern Europe and Latin America. They are continuing their education through an MA program in Gender and Social Justice Studies at the University of Alberta where they will specialize in Digital Humanities.

Samuel Seaberg

Samuel Seaberg, a University of Victoria English undergrad, enjoys riding his bike. During the summer of 2025, he began working with LEMDO as a recipient of the Valerie Kuehne Undergraduate Research Award (VKURA). Unfortunately, due to his summer being spent primarily in working to establish an edition of Thomas Heywood’s If You Know Not Me, You Know Nobody, Part 2 and consequently working out how to represent multi-text works in a digital space, his bike has suffered severely of sheltered seclusion from the sun. Note: Samuel now works for LEMDO as the Assistant Project Manager, much to his bike’s chagrin.

Tracey El Hajj

Junior Programmer 2019–2020. Research Associate 2020–2021. Tracey received her PhD from the Department of English at the University of Victoria in the field of Science and Technology Studies. Her research focuses on the algorhythmics of networked communications. She was a 2019–2020 President’s Fellow in Research-Enriched Teaching at UVic, where she taught an advanced course on Artificial Intelligence and Everyday Life. Tracey was also a member of the Map of Early Modern London team, between 2018 and 2021. Between 2020 and 2021, she was a fellow in residence at the Praxis Studio for Comparative Media Studies, where she investigated the relationships between artificial intelligence, creativity, health, and justice. As of July 2021, Tracey has moved into the alt-ac world for a term position, while also teaching in the English Department at the University of Victoria.

Orgography

LEMDO Team (LEMD1)

The LEMDO Team is based at the University of Victoria and normally comprises the project director, the lead developer, project manager, junior developers(s), remediators, encoders, and remediating editors.

Metadata

Authority title Introduction to Documentation Guidelines
Type of text Documentation
Publisher University of Victoria on the Linked Early Modern Drama Online Platform
Series Linked Early Modern Drama Online
Source
TEI Customization created by Martin Holmes, Joey Takeda, and Janelle Jenstad; documentation written by members of the LEMDO Team
Editorial declaration n/a
Edition Released with Linked Early Modern Drama Online 1.0
Encoding description Encoded in TEI P5 according to the LEMDO Customization and Encoding Guidelines
Document status prgGenerated
Funder(s) Social Sciences and Humanities Research Council of Canada
License/availability
This file is licensed under a CC BY-NC_ND 4.0 license, which means that it is freely downloadable without permission under the following conditions: (1) credit must be given to the author and LEMDO in any subsequent use of the files and/or data; (2) the content cannot be adapted or repurposed (except in quotations for the purposes of academic review and citation); and (3) commercial uses are not permitted without the knowledge and consent of the editor and LEMDO. This license allows for pedagogical use of the documentation in the classroom.