LEMDO: Make Links to and from Documentation

Make Links to and from Documentation

LEMDO prefers a series of densely interlinked files and sections over a single linear XML file (See Documentation Style Guidelines). This section explains the best practices for linking to sections within an XML file from other parts of the same file or from other XML files, for linking to XML files from other XML files, and for linking from our XML files to external sources.

¶ Link to Specific Sections in Files Within LEMDO’s Repository

To link to a specific section in a file in LEMDO’s repository, you must:

Insert a


                                             <ptr>

element where you would like the link to be.

Give the


                                             <ptr>

element a


                                          @target

attribute.

Begin the value with the doc: prefix, followed by the name of the file you want to link to (excluding the file extension).

Add a hash character (#) after the file name in the value, followed by the xml:id of the


                                             <div>

element you want to link to.

Sample encoding of a link from another file to a specific


                                          <div>

element in learn_encodeForeignLanguages.xml:

For more information, see <ptr target="doc:learn_encodeForeignLanguages#learn_encodeForeignLanguages_quotations"/>.

Sample rendering of the example: For more information, see Foreign Words in Quotations.

Note that the process is the same for linking from one section to another section within the same file. Add the name of the file you are working on after the doc: prefix and add the xml:id of the section you want to link to after the hash character.

¶ Link to Another File In LEMDO’s Repository

To link to another XML file in LEMDO’s repository, you must:

Insert a


                                             <ptr>

element where you would like the link to be.

Give the


                                             <ptr>

element a


                                          @target

attribute.

Begin the value with the doc: prefix, followed by the name of the file you want to link to (excluding the file extension).

Sample encoding of a link from one file to learn_encodeQuotations.xml:

For more information, see <ptr target="doc:learn_encodeQuotations"/>.

Sample rendering of the example: For more information, see Introduction to Quotations, Terms, Expressions, Glosses, Emphasis, and Foreign Languages.

¶ Link to Sources Outside of LEMDO

To link to an external web page (such as the TEI Guidelines), you must:

Choose the word or phrase to bear the link

Wrap that word or phrase in a


                                             <ref>

element

Add a


                                          @target

attribute to the


                                             <ref>

element

Paste the full URL of the web page into the value (including the http:// or https://).

Sample encoding of a link from a LEMDO file to an element spec in the TEI Guidelines:

See the <ref target="https://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-stage.html">element specification for the <gi>stage</gi> element in the <title level="m">TEI Guidelines</title>
</ref>.

Sample rendering of the example: See the element specification for the


                                          <stage>

element in the TEI Guidelines.

For well designed web pages, such as the TEI Guidelines, it is often possible to link to specific sections of the page. If you can click on a pilcrow symbol or an anchor, check the URL to see if it changes from the page URL to something more specific. If yes, you can use this URL to link directly to the section in question.

See <ref target="https://www.tei-c.org/release/doc/tei-p5-doc/en/html/DR.html#DRSTA">
<title level="a">7.2.4 Stage Directions</title>
</ref> in the <title level="m">TEI Guidelines</title>.

Sample rendering of the example: See 7.2.4 Stage Directions in the TEI Guidelines.

¶ Link to Sources Outside of LEMDO that Have Pre-Defined LEMDO Pointers

A few websites to which we often link have been given prefixes in the LEMDO system (e.g., MoEML, STC, EEBO, WSB, DEEP). These prefixes are all defined in TAXO1.xml. Look for the


                                          <listPrefixDef>

element in TAXO1.xml, where the complete list is give along with the URLs to which the prefixes will point.

In documentation, we often point to the MoEML Praxis pages. Because we have a prefix for MoEML (mol:), typing mol:praxis is a shorthand way of indicating https://mapoflondon.uvic.ca/praxis.htm.

Youʼll find <ref target="mol:subversion">full SVN instructions on the MoEML site</ref>.

That bit of encoding will be resolved and rendered as a link to https://mapoflondon.uvic.ca/subversion.htm.

Prosopography

Isabella Seales

Isabella Seales is a fourth year undergraduate completing her Bachelor of Arts in English at the University of Victoria. She has a special interest in Renaissance and Metaphysical Literature. She is assisting Dr. Jenstad with the MoEML Mayoral Shows anthology as part of the Undergraduate Student Research Award program.

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 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.

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

Project manager 2022–present. Textual remediator 2021–present. Navarra Houldin (they/them) completed their BA in History and Spanish at the University of Victoria in 2022. During their degree, they worked as a teaching assistant with the University of Victoriaʼs Department of Hispanic and Italian Studies. Their primary research was on gender and sexuality in early modern Europe and Latin America.

Nicole Vatcher

Technical Documentation Writer, 2020–2022. Nicole Vatcher completed her BA (Hons.) in English at the University of Victoria in 2021. Her primary research focus was womenʼs writing in the modernist period.

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	Make Links to and from Documentation
Type of text	Documentation
Short title
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.