EDITOR is an application for annotating scholarly digital editions. It helps you create, edit, manage, display and visualize the annotations. In visualizing annotations and the edition that they refer to, EDITOR should also help in the process of forming and testing hypotheses about the texts under investigation. At present, this is still a vision for the future rather than a reality.
EDITOR consists of two main parts: an annotation entry tool and an annotation display component. The annotation tool runs from the researcher's desktop. The display component runs on a web server, from within the i-Tor CMS. This help file is mainly directed at helping you work with the annotation entry tool.
EDITOR assumes that the edition has an XML source format. Annotations should refer to this source format rather than to the web pages. The web pages are just transitory representations of the information stored in the XML source format.
What a researcher needs to use the EDITOR annotation entry tool is:
The EDITOR display tool is still in a very early stage of development. More information about EDITOR is available from the project's website at http://www.huygensinstituut.knaw.nl/projects/editor.
TopThe installation of the EDITOR annotation entry tool consists of the following steps:
The edition XML files will usually be downloaded from an edition institute's website, but may in fact be created that knows how to create XML. We anticipate they will usually be based on the guidelines of the Text Encoding Initiative, but this is not mandatory.
There are some unresolved difficulties in using internal entities defined in an external DTD file. We recommend entities to be defined in the internal DTD subset. If this should prove impossible, for entity resolution purposes EDITOR will try to locate your DTD file in the directory editor-xxx-yyy/jrex-gre/res/dtd. You may want to place it there manually.
The XML file will usually refer to a CSS file which defines the XML's layout in EDITOR. If the edition XML file is downloaded from an edition institute, the institute will probably provide a suitable CSS file. Otherwise, a sample CSS file may be downloaded from [to be added].
[Future: EDITOR name space]
TopThe picture below shows the EDITOR window layout.
In the picture, we see the following window components:
The annotations made using EDITOR are stored in annotation sets. The file menu is used to create, open, and save annotation sets. Selecting the 'New Annotation Set' option will open the Create New Annotation set window, where the user will be prompted for the XML edition to be used, and for a name and a description of the annotation set. The 'Properties' option will show the Annotation set properties. On the annotation set properties window, you can change the XML edition which the annotation set refers to (it is your own responsibility to insure that the file locations which the annotation set refers to are present in the file you select). The 'Recently Used' option will show recently used annotation sets.
The Search Menu has a single option: Find in Text Edition. It will take you to the Find window.
The Annotation Type menu has two options, which will take you to the Create New Annotation Type window and the Annotation Type Overview window.
The Annotation menu has two options. The create annotation option will show a submenu with available annotation types. Selecting one of the types will open the Create Annotation Window. The Overview option will toggle (=either open or close, depending on the present status) the display of the annotation type overview window.
The Help menu contains options for showing this help file and for taking you to the EDITOR website.
TopAnnotations are created form either the tree view panel or the presentation panel. To create an annotation select either an element node in the tree or some text in the presentation view. Then annotate the selected text or node using either the Annotation menu, right-clicking with the mouse or the context-menu keyboard shortcut. You will be prompted to make a selection from the available annotation types and then taken to the Create Annotation Window.
Depending on the CSS stylesheet in use, some of the text in the presentation panel may have been generated by the stylesheet, in some cases from attribute values in the XML file. This generated text cannot be selected for annotation. This is typically the case for page or column numbers. To annotate pages or columns, use the tree view rather than the presentation panel.
To annotate structural elements rather than text fragments, it is advisable to use the tree panel rather than the presentation panel. Selecting the element through the tree panel will select precisely what is needed, and is less prone to error and possibly later maintenance difficulties. It is also easier for later use in the EDITOR display component.
TopCreated annotations will show up in the tree panel (as bullets, using the color defined on the Create Annotation Type panel), or in the presentation view using brackets. Annotations of empty XML elements will only be shown in the tree panel. Annotations are also shown on the Annotation overview panel.
From each of these locations, the annotations can be selected for display or edit. In the presentation panel, click on off the brackets (⌈⌉); in the tree panel, select the annotation and bring up the context menu using a right mouseclick or the keyboard.
TopEDITOR is distributed under the following license:
/* * This file is part of EDITOR: * The Edition as a Digital Instrument for Text-based Open Research * * Copyright (C) 2005 Huygens Instituut, KNAW, The Netherlands * http://www.huygensinstituut.knaw.nl/ * * EDITOR is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * EDITOR is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * * See the COPYING file located in the top-level-directory of * the archive of this library for complete text of license. */Top
EDITOR is being developed by the I&A department at the Royal Dutch Academy of Arts and Sciences (KNAW). Initial development is funded by a grant from the KNAW digitisation fund.
Editor uses the following software components:
Directly:
Indirectly:
| Commons-Logging | http://jakarta.apache.org/commons/logging/ |
| Icu4j | http://icu.sourceforge.net/ |
| Jython | http://www.jython.org/ |
EDITOR is meant to be useful to all those that create or use scholarly digital editions. We welcome any thoughts or questions you may have. Please mail to peter.boot@huygensinstituut.knaw.nl.