TEITOK Help Pages

XML Layout Editor

The XML Layout Editor is meant for two purposes: to get a quick overview of the annotations present in your TEI/XML document, and to edit the existing annotations or add new ones. It does this by displaying (part of) the text of the document, with an interface to let you see information about existing nodes, select existing nodes to edit or remove them, and select words to add an annotation to them.

Layout Information

By hovering your mouse over the text, the interface will display about the node you are hovering over. It does that in three ways: firstly, it highlights the (lowest) target node in the XML in yellow. So if you hover over a word, it will highlight the word. While if you hover between wors in a sentence, it will hightlight the sentence. Secondly, below the text it will display the navigation panel for the node - so if you hover over a word inside a sentence in a pararaph, it will show
text > p > s > tok
And finally, it will show a popup with the same navigation information, presented vertically, with all attributes of all nodes.

Apart from hovering information, you can also display the nodes in XML notation in the text. By default, all annotations are hidden. But from the selection panel on the bottom of the screen, you can select which annotations to show. If we for instance select to show <name> annotations, all names in the text will be outline, by putting <name> before the node and </name> after the node. Furthermore, it will display all names in a colour, corresponding to the color of the button. Furthermore, by hovering over the <name> button, all names in the document will get highlighted in that same color. Since elements can have only one color, if you select multiple levels of annotations, the words will get the colour of the lowest corresponding node. So if I select both names and sentences, all words that are not in a name will be one colour (say green), while all the words that are will be changed from green into the color for names (say blue).

Adding Annotations

In order to create a new annotation, select one or more words in the text - either by dragging or by selecting the first word, and then selecting the last word while holding down the shift key. The words you selected will be highlighted in blue. Since the new node cannot cross with existing nodes, the selection will be expanded as required to allow for the insertion of the new node. So if you select two words in two different sentences, it will select the two entire sentences. And if you select a word in a sentence plus the first word in a name, it will select the entire name.

Once you select a range of words, the interface will show a pop-up that lets you select a TEI/XML tag, and insert it in the XML around the words you selected. If you want to insert an empty tag, like a linebreak <lb/>, select the first word after the place where you want to insert it, and in the pop-up select the "before" tag. Instead of inserting a node around the selected words, this will insert an empty tag in front of them. The list of tags contains all the recommendable text-level TEI tags for TEITOK documents. To see the entire list of tags with their official description, clik on the "show all recommendable tags" on the bottom of the page.

Editing Annotations

In order to edit or remove an existing annotation, select to display the tag, and then click on the XML tag itself, not the word. This will show a pop-up that lets you remove the selected annotation (after verification), as well as edit it. The edit mode will let you edit any attributes that are either defined for the tags in the TEI tag definition file (teitags.xml), or in the xmlfile section of the project settings. Depending on how the attribute is defined, you can either type in the value, or select it from the list of predefined values.

More Options

By default, only the raw text is displayed, stripped of all typesetting to put the full focus on the XML layout. But there is a button on the bottom that will toggle the typesettings elements back on, which will display the text as it would in the text view.

You can also list all occurrences of a specific tag - either by going to the edit screen of a specific annotation, and then select 'list all X', or by selecting 'show all tags' from the bottom of the main screen. This will list all the predefined TEI tags with their explanation - and those that occur in the XML document will be clickable. From the list of all occurrences, you can select an attribute that you want to edit for all of the annotations on the list.

Back to index