The EAD Editor comes with a built-in menu to help you add mark-up to your descriptions. This menu can be accessed by right-clicking in one of the free-text boxes (these contain <p></p> tags) - or, if you're using a Mac, cmd+click in the box.
This menu means that it's not possible to use the right-click menu in your browser to select, copy and paste while in the EAD Editor. You'll need to use the keyboard shortcuts:
Copy crtl+c (Windows) cmd+c (Mac)
Paste ctrl+v (Windows) cmd+v (Mac)
Select all ctrl+a (Windows) cmd+a (Mac)
The right-click menu allows you to insert XML tags into your description, to correctly mark-up:
- Titles and fonts
XML tags will be inserted into your post in pairs, like this:
These are the tags for marking up a paragraph, and each free-text box starts with a pair of paragraph tags. Enter your text between the opening and closing tags, like this:
<p> Dorothy Hill (1909-1999), otherwise known as Chili Bouchier, actress... </p>
The right-click menu also allows you to add special characters.
We recommend adding in paragraphs to break up long blocks of text, and make them easier to read on-screen. To add a new paragraph tag, place your cursor in the desired loaction, right-click, and select 'paragraph' from the menu. This will place a pair of paragraph tags <p></p> in your field.
If you're using Chrome or Firefox, you can select text to place in a paragraph, by highlighting it with your mouse, and then right-clicking and choosing 'paragraph'. This will place an opening <p> tag at the start of your selected text, and a closing </p> tag at the end of the selected text.
You can also mark up paragraphs manually, by typing in your <p></p> tags. Make sure that you remember to give each opening <p> tag a matching closing </p> tag. If the Editor detects that your mark-up is incorrect, the field background will turn pink, until the mark-up is corrected.
You may be used to seeing hyperlinks marked up in html, like this: <a href="">. This syntax won't work in the EAD Editor: you need to use the correct EAD <extref href=" "></extref> syntax. This can be added using the right-click menu.
You can add references to other archival descriptions by using the 'archival ->' options on the right-click menu. See our linking page for more information about these relationships.
You may use the <extref> syntax to make links to webpages, and other internet resources that might be of interest. Choosing 'links -> www' will add this syntax:
You need to enter 2 pieces of information. The text between the "" is for the full web address of the link, including the http://, eg
The text between the angle brackets is what the user will see displayed. eg
<extref href="http://archiveshub.ac.uk">Archives Hub</extref>
<extref href="http://www.jisc.ac.uk/">Jisc website, www.jisc.ac.uk</extref>
You may enter whatever text you like for this human-readable text, but many usability sources recommend displaying the web address, so that if someone is using assistive software, or prints the page, they know what the link should be.
In Chrome and Firefox you can highlight your link text before choosing 'links -> www' to have the <extref> tags correctly placed around your display text. You'll still need to add the link address between the "".
If you're entering an email address to allow user to contact you, you can mark it up so that they can click on it to send you an email.
Choosing 'links -> email' will give you this syntax:
<extref href="mailto: "></extref>
Again, you need to enter 2 pieces of information. The email address goes between the "", eg
While the text the user sees goes between the angle brackets, eg:
<extref href="mailto:firstname.lastname@example.org">Contact the Archives Hub</extref>
It's recommended that you repeat the email address as the link text:
Contact us: <extref href="mailto:email@example.com">firstname.lastname@example.org</extref>
The right-click menu allows you to mark-up lists of items, to display as bulleted lists.
There are two tags associated with lists, <list> and <item>. When you choose 'lists -> list' from the right-click menu, you'll get the following syntax:
The first tag tells the browser to start a list. The second tells it to start an item within that list, and the third to finish that item. The fourth tag tells it to finish the list. List tags must be opened an closed in the correct order - don't try to close an </item> after you've closed the </list>.
Place the text of your first item between the <item></item> tags, like this:
<list><item>The first thing</item></list>
To add more items to your list, place your cursor after the closing </item> tage, but before the closing </list> tag, and chose 'list -> item' from the right-click menu. This will give you:
<list><item>The first thing</item><item></item></list>
Enter your text between this new set of item tags:
<list><item>The first thing</item><item>The second thing</item></list>
This will display on the Hub as:
- The first thing
- The second thing
You can add as many items as you need. You might find it easier to spread your tags out, like this:
<item>The first thing</item>
<item>The second thing</item>
This won't affect the final display.
If you're using Chrome or Firefox, you can highlight each item text in turn, to have the item tags correctly placed around it.
Title and fonts
You can mark up titles and sections of text with various font options: bold, italic, quoted, or underline. There's also an option to mark up titles as titles without adding any special display instructions - to do this, choose 'title -> plain'.
<title>Gone with the Wind</title> displays as Gone with the Wind
<title render="italic">Bleak House</title> displays as Bleak House
Special characters, including all accented characters, need to be encoded correctly to display without error on the Archives Hub. Copying and pasting these characters from a word processing program or browser will often not work, and result your characters being displayed incorrectly.,
- The keyboard can be accessed by clicking on the 'Character Keyboard' link on the navigation bar (clicking a second time will remove it) or the 'keyboard on/off' option on the right click menu in the form fields.
- Once the keyboard is visible on the screen it can be minimised, maximised and closed using the icons in the top right corner.
- The 'Caps Lock' button switches the characters between lower-case and upper-case.
- To enter a character into the form simply click on the field you wish to enter it into and then click the character on the keyboard.
- To check which field the character will appear in click the 'Which field?' link.
If you notice rogue special characters in your descriptions, such as 'Â' in your index terms. You will need to change the encoding on your browser from Western European to Unicode (UTF-8):
IE: open the 'page' menu, choose 'encoding', and select 'Unicode (UTF-8)'.
Firefox: 'view' menu, choose 'character encoding', select 'Unicode (UTF-8)'.
Please note: Firefox has an auto-detect for character encoding, which can reset your choice. If you find that your characters are reverting to incorrect displays, turn auto-detect off, or View ->Character encoding -> Customize List. Select UTF-8 in the right-hand list, and click move up to make it your default, or select Western (ISO-8859-1) and click remove.
Chrome: customise (spanner icon in top right) -> tools -> encoding 'Unicode (UTF-8)'.
You can choose to specify formatting, such as lists, a title, or additional paragraphs. Several features are built into the form to help with entering these XML tags.
- You can enter tags either by typing them or using the right-click menu.
- If you right click on a field the menu will appear. Some of the options also have sub-menus as illustrated below.
- Clicking on a tag type will enter the tag at the current cursor point or if an area of text is selected it will enclose the selected text inside the tags.
- If invalid XML is entered into a field, such as mismatched opening and closing tags, the background of the field will go red. If there is any invalid XML present in the form you will not be able to perform any actions such as saving, previewing or adding a component and you will not be able to navigate to another part of the record.
- When the XML is corrected the field will go white again. This will take a few seconds after you have stopped typing.