Home > Project Documentation > Documentation for Contributors

Creating a New @xml:id

This document is currently in draft. When it has been reviewed and proofed, it will be published on the site.

View the draft document.

Please note that it is not of publishable quality yet.

Creating a New @xml:id

roseList documents mentioning Creating a New xml:id
When creating a new file or entity, encoders need to conform to MoEML’s naming conventions, as described below. Files are either XML documents or binary documents. Files in MoEML need unique IDs that are of the words_with_underscore type (see below for details). Entities are referents to items of various types (location, name, etc.), generated in files including but not limited to: PERS1, ORGS1, GLOSS1, and BIBL1. Entities can also have files of their own, in corresponding project folders, such as The Triumphs of the Golden Fleece (GOLD4) file in the a_lord_mayor folder. These entities require unique IDs that are of the XXXX1type (see below for details). Note that files that refer to entities will have a combination of both ID types: words_with_underscore_XXXX1 (see Stow example below). The project’s schema will prevent you from adding names which do not conform.

Checking and Validating your @xml:id

The first thing you need to do when creating an ID is to check MoEML’s A-Z Index and make sure that you are not duplicating an entity ID. An easy way to do that is to try and find the ID you are about to create: ctrl+F (for Windows) or command+F (for iOS) then type in your new ID. If you cannot find it, then the ID does not already exist and can be added. If it already exists and you are certain of the initials used, then use the next numeral available. For example, if you are about to add TEST1 and you find it in the index, change the ID you are creating to TEST2.

Creating a New Entity ID

An entity can refer to a location, person, work of literature, and others. For example, the historical person George Abbot has an entity ID of ABBO1.
When creating a new entity ID, you must follow MoEML’s entity ID structure, which consists of 3-4 capital letters (preferably 4), followed by the next available integer, i.e. a sequence of one or more digits.

Creating a New File ID

In MoEML, you can either create born digital files (see first item in the list below) or encoded primary sources (second item).
  • When naming files in how-to and info, you must use all lower-case letters, using only underscores to separate between words.
  • Files in Stow must be as follows: stow, followed by an underscore, followed by the year (four digits), followed by an underscore and a word in lower-case letter, unless it is an entity ID then use the ID name (see first item above). For example: stow_1598_bridges and stow_1598_ALDE2.

Creating Binary Documents

Binary documents are non XML files/documents; this includes PDFs, Word documents, images, videos, and others. When naming such documents/files, follow the naming conventions for files in how_to and info: use all lower-case letters, and only underscores to separate between words.
If you are not sure if the file name or entity ID fit MoEML’s naming conventions, or if you have any questions, please consult with the MoEML team.

Cite this page

MLA citation

El Hajj, Tracey. Creating a New @xml:id. The Map of Early Modern London, edited by Janelle Jenstad, U of Victoria, 15 Sep. 2020, mapoflondon.uvic.ca/new_id.htm. Draft.

Chicago citation

El Hajj, Tracey. Creating a New @xml:id. The Map of Early Modern London. Ed. Janelle Jenstad. Victoria: University of Victoria. Accessed September 15, 2020. https://mapoflondon.uvic.ca/new_id.htm. Draft.

APA citation

El Hajj, T. 2020. Creating a New @xml:id. In J. Jenstad (Ed), The Map of Early Modern London. Victoria: University of Victoria. Retrieved from https://mapoflondon.uvic.ca/new_id.htm. Draft.

RIS file (for RefMan, EndNote etc.)

Provider: University of Victoria
Database: The Map of Early Modern London
Content: text/plain; charset="utf-8"

TY  - ELEC
A1  - El Hajj, Tracey
ED  - Jenstad, Janelle
T1  - Creating a New xml:id
T2  - The Map of Early Modern London
PY  - 2020
DA  - 2020/09/15
CY  - Victoria
PB  - University of Victoria
LA  - English
UR  - https://mapoflondon.uvic.ca/new_id.htm
UR  - https://mapoflondon.uvic.ca/xml/standalone/new_id.xml
TY  - UNP
ER  -

RefWorks

RT Unpublished Material
SR Electronic(1)
A1 El Hajj, Tracey
A6 Jenstad, Janelle
T1 Creating a New xml:id
T2 The Map of Early Modern London
WP 2020
FD 2020/09/15
RD 2020/09/15
PP Victoria
PB University of Victoria
LA English
OL English
LK https://mapoflondon.uvic.ca/new_id.htm

TEI citation

<bibl type="mla"><author><name ref="#ELHA1"><surname>El Hajj</surname>, <forename>Tracey</forename></name></author>. <title level="a">Creating a New <att>xml:id</att></title>. <title level="m">The Map of Early Modern London</title>, edited by <editor><name ref="#JENS1"><forename>Janelle</forename> <surname>Jenstad</surname></name></editor>, <publisher>U of Victoria</publisher>, <date when="2020-09-15">15 Sep. 2020</date>, <ref target="https://mapoflondon.uvic.ca/new_id.htm">mapoflondon.uvic.ca/new_id.htm</ref>. Draft.</bibl>

Personography