|
| 1 | +<html> |
| 2 | +<head> |
| 3 | +<title>GoldenGATE</title> |
| 4 | +</head> |
| 5 | +<body> |
| 6 | + |
| 7 | + |
| 8 | +<h3><font face="Verdana">The Annotation Editor</font></h3> |
| 9 | +<font face="Verdana" size="2">The Annotation Editor is intended for handling the |
| 10 | +document markup. Since almost all markup goes betweeen words, it treats words as |
| 11 | +the atomic text units instead of individual characters. While this inhibits |
| 12 | +character wise text editing, it greatly simplifies creating XML tags because |
| 13 | +they are automatically placed at the word boundaries. An Annotation Editor has |
| 14 | +five different parts:</font><h4><font face="Verdana">The Editor (center)</font></h4> |
| 15 | +<font face="Verdana" size="2">The editor is the core part of the Annotation |
| 16 | +Editor. It displays the document text for markup editing, while the other parts |
| 17 | +(see below) provide options to make the editing process more convenient. However, |
| 18 | +the editor does not allow editing the text directly. All functions are based on |
| 19 | +selecting a part of the text and subsequently applying some action to it. These |
| 20 | +actions are accessible in several ways: Through the Edit menu of the main window, |
| 21 | +through the button panel of the Annotation Editor (see below), or through the |
| 22 | +context menu. The context menu is the only one of these ways that changes |
| 23 | +depending on the current selection. In particular, there are three different |
| 24 | +context menu states:</font> |
| 25 | +<ul> |
| 26 | +<li><font face="Verdana" size="2"><b>Part of the text selected:</b> When a part |
| 27 | + of the text is selected, the context menu provides options for annotating it (<b>Annotate</b>, |
| 28 | + <b>Annotate All</b>, <b> Document Part</b>), |
| 29 | + including instant access to the most recently used annotation types. It also |
| 30 | + provides functions for splitting the surrounding Annotation (<b>Split |
| 31 | + Annotation</b>), or for |
| 32 | + merging Annotations at least on tag of which is part of the selecion (<b>Merge |
| 33 | + Annotations</b>). The last part of |
| 34 | + the context menu allows editing the words of the text. This comprises the |
| 35 | + following functions:</font> |
| 36 | + <ul> |
| 37 | + <li><font face="Verdana" size="2"><b>Edit Tokens:</b> Character wise edit the |
| 38 | + plain text currently selected. This function exists to avoid switching to |
| 39 | + the Text Editor for small corrections.</font></li> |
| 40 | + <li><font face="Verdana" size="2"><b>Join Tokens:</b> Join the Tokens (i.e. |
| 41 | + words, numbers, punctuation) currently selected. While this results in |
| 42 | + subsequent words becoming one word, it will still split the text at clear |
| 43 | + word boundaries, e.g. before or after punctuation marks.</font></li> |
| 44 | + <li><font face="Verdana" size="2"><b>Copy Tokens:</b> Copy the currently |
| 45 | + selected words to the clipbourd.</font></li> |
| 46 | + <li><font face="Verdana" size="2"><b>Cut Tokens:</b> Cut the currently |
| 47 | + selected words from the text and store them in the clipbourd.</font></li> |
| 48 | + <li><font face="Verdana" size="2"><b>Swap Clipboard:</b> Replace the currently |
| 49 | + selected words with the content of the clipboard, and move the replaced |
| 50 | + words to the clipboard.</font></li> |
| 51 | + <li><font face="Verdana" size="2"><b>Paste Tokens:</b> Replace the currently |
| 52 | + selected words with the content of the clipboard.</font></li> |
| 53 | + <li><font face="Verdana" size="2"><b>Delete Tokens:</b> Remove the selected |
| 54 | + words from the document.</font></li> |
| 55 | + </ul> |
| 56 | + </li> |
| 57 | + <li><font face="Verdana" size="2"><b>Nothing selected, clicked on XML tag:</b> When |
| 58 | + opening the context menu on an XML tag, it provides funtions for opening the |
| 59 | + Annotation for direct editing (<b>Edit</b>), for removing it (<b>Remove</b>), and for |
| 60 | + transforming it to a Document Part (<b>Transform</b>). It also allows handling the |
| 61 | + content of the Annotation:</font> |
| 62 | + <ul> |
| 63 | + <li><font face="Verdana" size="2"><b>Copy Tokens:</b> Copy the content of the |
| 64 | + Annotation to the clipbourd.</font></li> |
| 65 | + <li><font face="Verdana" size="2"><b>Cut Tokens:</b> Cut the content of the |
| 66 | + Annotation from the text and store them in the clipbourd. Since the |
| 67 | + Annotation itself is empty after this operation, it is removed.</font></li> |
| 68 | + <li><font face="Verdana" size="2"><b>Delete Tokens:</b> Remove the content of |
| 69 | + the Annotation from the document. Since the Annotation itself is empty after |
| 70 | + this operation, it is removed.</font></li> |
| 71 | + </ul> |
| 72 | + </li> |
| 73 | + <li><font face="Verdana" size="2"><b>Nothing selected:</b> When |
| 74 | + opening the context menu in the text with nothing selected, it allows |
| 75 | + pasting the content of the clipboard at this location (<b>Paste Tokens</b>).</font> |
| 76 | + </li> |
| 77 | +</ul> |
| 78 | + |
| 79 | +<h4><font face="Verdana">The Button Panel (top)</font></h4> |
| 80 | +<font face="Verdana" size="2">The button panel is another way to access the most |
| 81 | +common functions of the Annotation Editor. In particular, it provides the basic |
| 82 | +functions for handeling Annotations:</font> |
| 83 | +<ul> |
| 84 | + <li><font face="Verdana" size="2"><b>Edit Selection:</b> Character wise edit the plain text currently selected in the Annotation Editor. This function exists to avoid switching to the Plain Text Editor for small |
| 85 | + corrections.</font></li> |
| 86 | + <li><font face="Verdana" size="2"><b>Annotate:</b> Create an Annotation (XML tag) enclosing the text passage currently selected.</font></li> |
| 87 | + <li><font face="Verdana" size="2"><b>Annotate All:</b> Create an Annotation (XML tag) enclosing every occurence of the text passage currently selected in the current document. |
| 88 | + This function is primarily intended for detail level markup (e.g. location or person names): Select the particular name once, annotate all its occurences in the entire document with a single |
| 89 | + click.</font></li> |
| 90 | + <li><font face="Verdana" size="2"><b>Mark Document Part:</b> Create a Document Part (XML tag, special type of Annotation) enclosing the text passage currently selected. |
| 91 | + This special type of Annotation is primarily intended for structural markup. It allows, for instance, editing an individual section of a document as if it was a document on its |
| 92 | + own.</font></li> |
| 93 | + <li><font face="Verdana" size="2"><b>Merge Annotations:</b> Merge neighbouring Annotations. Only Annotations of the same type can be merged. |
| 94 | + At least the end tag of the first Annotation to be merged, and at least the start tag of the last one, have to be selected for this function to |
| 95 | + work.</font></li> |
| 96 | + <li><font face="Verdana" size="2"><b>Split Annotation:</b> Split an Annotation into two. The inmost Annotation enclosing the currently selected text is determined the target of this operation. It is split at the word border before the selected text passage. Exacly one word or punctuation mark has to be selected for this function to |
| 97 | + work.</font></li> |
| 98 | + <li><font face="Verdana" size="2"><b>Edit Fonts:</b> Edit the displaying font, font size, and color of the document currently selected. These settings are independent for textual content and XML tags. This is in favor of making content easier to distinguish from markup. The default values for these settings are accessible through Preferences in the Window |
| 99 | + menu.</font></li> |
| 100 | +</ul> |
| 101 | + |
| 102 | +<h4><font face="Verdana">The Recent Action Panel (upper-left)</font></h4> |
| 103 | +<font face="Verdana" size="2">The recent action panel allows instantly repeating |
| 104 | +the most recently used actions, reusing the original parameters. This avoids, |
| 105 | +for instance, re-entering the Annotation type / XML element name when creating a |
| 106 | +new Annotation.</font> |
| 107 | + |
| 108 | +<h4><font face="Verdana">The Makro Panel (lower-left)</font></h4> |
| 109 | +<font face="Verdana" size="2">The makro panel provides access to Makros. A Makro |
| 110 | +consists of a an XML element name to annnotate selected text with, and some |
| 111 | +resource that is automatically applied to the newly created Annotation. |
| 112 | +Frequently used markup / editing sequences can be bundeled this way, making them |
| 113 | +one-click accessible. A good example for a useful Makro is marking up the |
| 114 | +selected text as a paragraph and subsequently applying the structural |
| 115 | +normalization to the content of the newly created tag.</font> |
| 116 | + |
| 117 | +<h4><font face="Verdana">The Layout Panel (right)</font></h4> |
| 118 | +<font face="Verdana" size="2">The layout panel allows showing / hiding the |
| 119 | +individual XML element tags contained in the document, and highlighting the tag |
| 120 | +content. This is in favor of clarity, e.g. for hiding detail level markup when |
| 121 | +working on the document structure. The left of the two checkboxes highlights the |
| 122 | +Annotation content, while the right one shows / hides the respective XML tags. A |
| 123 | +click on the XML element name / Annotation type will open a dialog for adjusting |
| 124 | +the color used for this type of Annotation.</font> |
| 125 | + |
| 126 | +</body> |
| 127 | +</html> |
0 commit comments