Skip to content

Translation of Tag Libriaries

Karin Bredenberg edited this page Nov 2, 2021 · 2 revisions

Guidelines for the Translation of Tag Libraries

In GitHub in the repository for Tag Libraries (TL) you have all the Tag Libraries.

A guide to GitHub: Ruth Tillman's guide to GitHub

Rules and policies for revising tag libraries:

Tag Library contributor roles

Role of TS-EAS Documentation Team

  • Provide a link from the EAD and/or EAC-CPF sites to your translated document
  • If you utilize our preferred approach to maintaining the source files in GitHub, we can assist in generating PDF and other outputs. We can provide instructions/guidance
  • If we receive any reports suggesting additions or corrections, we'll route them to you

Role of contributor (of translated document)

  • Provide Documentation Team with a key editorial contact (or contacts), including name, affiliation, e-mail, and phone number. This information will be posted with the link to translation
  • We ask that you utilize our preferred method to maintaining the source files in GitHub, but not absolutely required
  • Follow the EAD and/or EAC-CPF main GitHub repo, so you are aware of version changes and updates to the English versions of the Tag Library
  • Use the TEI lite schema developed for the Tag Libraries TL-teiliteSchema.rng.
  • Maintain a stable link to the translated document
  • Let the Documentation Team know if you are no longer able to actively maintain the documentation

Basic instructions

You will need to create one XML file with the following naming convention: the name of the standard, a dash “-”, and the 3-digit code of the language of the translation, such as EAC-CPF-TL-eng.xml. You must update the Headingtranslation.xml file, with the translation of all the headings that are used in the Tag Library in the language of the translation. For example, the tag name for "description" is translated as follows:

<term name="description">

<translation lang="en">Description</translation>

<translation lang="fr">Description</translation>

<translation lang="gr">Περιγραφ&#942;</translation>

<translation lang="de">Beschreibung</translation>

<translation lang="it">Descrizione</translation>


Translate all words in the Headingtranslation.xml document.

You should keep in mind the following:

  • English version is the master version.
  • The ISBN is for the English version--we will aid you in the work of getting a ISBN for the translation.
  • You do the translation in your Tag Library clone and then submit it to the TS-EAS which can add the translation after validation and acceptance of the translation.
  • TS-EAS will create PDF and HTML version of the submitted project and submit them for publication at the standards’ sites.

Detailed guidelines

What needs to be translated for each element:

For <div type="fullName"> you need to translate the text in <p>

For example: <div type="fullName"> <p xml:lang="eng">Mandate</p></div>

For <div type="summary"> you need to translate the text in <p>

For example: <div type="summary"><p xml:lang="eng">The source of authority or mandate for the corporate body...</p></div>

For <div type="description"> you need to translate the text in <p>

For example: <div type="description" xml:lang="eng"><p>A <gi>mandate</gi> element …</p></div>

For <div type="occurrence"> used in EAC-CPF you need to translate the text in the different <p> elements

For example: <div type="occurrence"><div type="mandatory"><p>Optional</p></div>, and <div type="repeatable"><p>Repeatable</p></div>

For <div type="availability"> used in EAD you need to translate the text in <p>

For example: <div type="availability"><p>Required, not repeatable</p></div>

It is important to note that you must not translate the content of the <gi> elements wherever you find them. These refer to other XML nodes that must not be translated.

Do not translate the following elements:


<div type="mayContain">

<div type="mayOccurWithin">

<div type="attributes">: In this case you must translate only the parts that are related to the occurrence of an attribute, such as <item>Optional</item>

<div type="reference">

<div type="examples">: In this <div> section you can provide your own examples or use the existing ones without translating them. Each example must be in an <egXML xmlns="">...</egXML> element, following the correct syntax of the standard on which the example is based, such as EAC-CPF. You also need to use a namespace prefix like in the indicative example “eac-cpf”. An indicative example is the following:

<div type="examples">

<egXML xmlns="">

<eac-cpf:mandate xmlns:eac-cpf="urn:isbn:1-931666-33-4">


<eac-cpf:fromDate standardDate="1919">1919</eac-cpf:fromDate>

<eac-cpf:toDate standardDate="1925">1925</eac-cpf:toDate>


<eac-cpf:citation>Minnesota. Executive Session Laws 1919 c49</eac-cpf:citation>


<eac-cpf:p>Board created in 1919 to receive and examine applications for bonuses from Minnesota soldiers.</eac-cpf:p>





As far as the prefixes are concerned:

All examples needs to use a namespace prefix.

The defined namespace prefixes are the following:

When other prefixes are used the new namespace prefix and its domain needs to be submitted together with the Tag Library to TS-EAS.

What needs to be translated for each attribute:

<div type="fullName">

<div type="summary">

<div type="description">

It is important to note that a <gi></gi> pair of tags in the text of an element, you must not translate this, but leave it as it is. This refers to other XML nodes.

Do not translate the following:

<div type="attributeDocumentation" xml:id="xxx">


<div type="datatype">

<div type="values">

You need to add information on the title page regarding who has made the translation Add an element <docAuthor> after the present elements of <docAuthor> stating who is responsible for the translation.