| | 1 | = Typing conventions = |
| | 2 | == Setting up the document == |
| | 3 | For resources inside the MPIWG (which you can look at in the |
| | 4 | ECHO viewing environment), a template XML file can be |
| | 5 | created which contains the metadata and a body containing |
| | 6 | simply page breaks for each image there is in this resource. |
| | 7 | Thus, the transcription can be begun right away. |
| | 8 | |
| | 9 | This web application is available on the [http://toolbox/digitizing-tools/pages/bareEchoXml.iface toolbox] server. Of |
| | 10 | course, you need to know the server path of the resource. |
| | 11 | Please refer to the online documentation in the toolbox (the |
| | 12 | red icons with the white question mark). |
| | 13 | |
| | 14 | === Connection to the ECHO Schema and Autocompletion === |
| | 15 | All the documents that are to be inserted in the ECHO |
| | 16 | document viewer have to adhere to a standard. This standard |
| | 17 | is manifested in ECHO Schema for XML texts. Such a standard |
| | 18 | ensures that all elements in the document can be processed |
| | 19 | and displayed correctly. |
| | 20 | |
| | 21 | To facilitate the production of such a valid document, XML |
| | 22 | editors have the functionality to help you with entering the |
| | 23 | appropriate tags in the right places. The XML file contains |
| | 24 | a link to schema so that the editor can check the schema and |
| | 25 | tell you if you made a mistake and suggest the right tags. |
| | 26 | |
| | 27 | ==== Usage in XeMeL ==== |
| | 28 | We built a stripped-down version of the [http://www.eclipse.org Eclipse IDE], called |
| | 29 | XeMeL. This is a free and system-independent software to |
| | 30 | work with XML documents. You can find a version of it on |
| | 31 | the institute's software server. |
| | 32 | |
| | 33 | There is a version of the ECHO XML Schema in [https://it-dev.mpiwg-berlin.mpg.de/tracs/mpdl-project-content/raw-attachment/wiki/Harriot/harriot_xsd.zip XSD format] |
| | 34 | which can be used to get auto completion when working with |
| | 35 | the XML editor inside XeMeL. Thus, the structure of the |
| | 36 | document will always be valid. |
| | 37 | |
| | 38 | To enable it, the line |
| | 39 | {{{ |
| | 40 | xsi:schemaLocation="http://www.mpiwg-berlin.mpg.de/ns/echo/1.0/ harriot_xsd/echo.xsd " |
| | 41 | }}} |
| | 42 | |
| | 43 | has to be added to the =echo= element of the XML file, e. g. |
| | 44 | {{{ |
| | 45 | <echo |
| | 46 | xmlns="http://www.mpiwg-berlin.mpg.de/ns/echo/1.0/" |
| | 47 | xmlns:de="http://www.mpiwg-berlin.mpg.de/ns/de/1.0/" |
| | 48 | xmlns:dcterms="http://purl.org/dc/terms" |
| | 49 | xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| | 50 | xmlns:xhtml="http://www.w3.org/1999/xhtml" |
| | 51 | xmlns:mml="http://www.w3.org/1998/Math/MathML" |
| | 52 | xmlns:xlink="http://www.w3.org/1999/xlink" |
| | 53 | xmlns:xml="http://www.w3.org/XML/1998/namespace" |
| | 54 | xsi:schemaLocation="http://www.mpiwg-berlin.mpg.de/ns/echo/1.0/ harriot_xsd/echo.xsd " |
| | 55 | version="1.0RC"> |
| | 56 | }}} |
| | 57 | |
| | 58 | ==== Usage in Emacs ==== |
| | 59 | The [http://www.gnu.org/software/emacs/manual/html_mono/nxml-mode.html nxml-mode] in Emacs supports validation by using the |
| | 60 | RelaxNG version of the schema. You can download an [https://it-dev.mpiwg-berlin.mpg.de/tracs/mpdl-project-content/raw-attachment/wiki/Harriot/harriot_rnc.zip archive] |
| | 61 | of the stable version and extract it. To make Emacs make |
| | 62 | use of the schema, go into the buffer with the XML |
| | 63 | document, type C-c C-s C-f |
| | 64 | (rng-set-schema-file-and-validate) and enter the path to |
| | 65 | the {{{echo.rnc}}} file. You will be asked if this link should |
| | 66 | be saved to a file. If yes, a file called {{{schemas.xml}}} |
| | 67 | will be created that contains the link between the XML |
| | 68 | document and the schema. |
| | 69 | |
| | 70 | Please see the documentation of the nxml-mode for |
| | 71 | additional information, e. g. keyboard shortcuts. |
| | 72 | |
| | 73 | == Some basic rules for XML == |
| | 74 | There are some rules which have to be observed when dealing |
| | 75 | with XML texts. A nice collection can be found on the web |
| | 76 | pages of [http://www.w3schools.com/XML/xml_syntax.asp w3schools]. |
| | 77 | |
| | 78 | == Paragraphs and semantic units == |
| | 79 | To enter text into the document, some additional elements |
| | 80 | have to be included, because text must not stand on its own |
| | 81 | between page breaks. |
| | 82 | |
| | 83 | A headline is enclosed by {{{<head>}}} tags. The main text has to |
| | 84 | go into a paragraph ({{{<p>}}}), and inside this has to be a |
| | 85 | semantic unit ({{{<s>}}}). |
| | 86 | |
| | 87 | == Line breaks == |
| | 88 | Type a {{{ <lb/>}}} at the end of each line. Be careful to |
| | 89 | include a space between the last word and the tag. However, |
| | 90 | if the word is hyphenated, do not type a space. |
| | 91 | |
| | 92 | Theoretically, line breaks are not obligatory. If they are |
| | 93 | missing, lines are broken depending on the width of your |
| | 94 | browser's window. |
| | 95 | |
| | 96 | == XML entities == |
| | 97 | Some characters can not be typed directly. They have to be |
| | 98 | escaped like this: |
| | 99 | ||&||&|| |
| | 100 | ||<||<|| |
| | 101 | ||>||>|| |
| | 102 | ||"||"|| |
| | 103 | ||'||'|| |
| | 104 | |
| | 105 | == Language change == |
| | 106 | Paragraphs and semantic units can be set in other languages by |
| | 107 | giving them an attribute {{{xml:lang="lat"}}}. Please use the |
| | 108 | three-letter code of the appropriate language. Thus, the right |
| | 109 | dictionary will be used in the display environment. |
| | 110 | |
| | 111 | By using the {{{<foreign>}}} tag, you can also change the |
| | 112 | language of single words |
| | 113 | == Emphasis styles == |
| | 114 | ||= {{{style=".."}}} =||= Meaning =|| |
| | 115 | || it || Italics || |
| | 116 | || bf || Bold || |
| | 117 | || bf it || Bold italics || |
| | 118 | || sc || Small caps || |
| | 119 | || sc it || Small caps italics || |
| | 120 | || sub || Subscript || |
| | 121 | || super || Superscript || |
| | 122 | || red || Red || |
| | 123 | || fr || Fraktur || |
| | 124 | || rom || Antiqua || |
| | 125 | || sp || Sperrung || |
| | 126 | || ol || Overline || |
| | 127 | || ul || Underline || |
| | 128 | || st || Struck through || |
| | 129 | |
| | 130 | == Generating a table of contents with divisions == |
| | 131 | The text should not only be subdivided by headings, but also |
| | 132 | by {{{<div>}}} tags. The {{{div}}} structure, along with subsequent |
| | 133 | headings will be used to generate a table of contents in the |
| | 134 | ECHO document viewer. NB, this is only activated, if the |
| | 135 | {{{type}}} attribute of the {{{div}}} is either {{{"chapter"}}} or |
| | 136 | {{{"section"}}}. |
| | 137 | |
| | 138 | Otherwise, you are free to use any name for the type of |
| | 139 | divisions, e. g. {{{recipes}}} |
