TEIWiki - User contributions [en]

Editors

2018-11-07T10:53:15Z

Pietro Maria Liuzzo:

Periodically the question of which editor to use for TEI tasks arises on the TEI mailing list. There is no single answer to this question, but this page attempts to help you frame the question correctly.

Before thinking about an editor, you should think about who is going to be using it, how often, for what and where.

Those from a technical background are already likely to have a preferred programmable editor. Those from a non-technical background are likely to be more interested in ease of use. Occasional or temporary users are going to what a program that works as similarly as possible to the other applications they use, whereas full-time permanent users are more likely to get a benefit from more powerful editor, even if it has a learning curve. Projects which use large XML files need to be aware that some editors struggle with large XML files. The sed editor (see below) is a special case, allowing for truly arbitrary sizes. Users who need to edit files directly on remote servers may need vt100-capable editors (emacs, vi, sed, etc).

'''If you are a teacher looking for an editor suitable for TEI instruction, have a look at the list of features that are seen as the minimal set needed for a [[Editor for teaching TEI - features|"student version" of a commercial editor]]. This feature set is under discussion and you are welcome to take part in it.'''

The following table an be sorted by several keys. You can accomplish that by clicking on the symbol in the relevant table header cell. Javascript needs to be enabled for the dynamic sorting to work. You can sort by a secondary key with the Shift key pressed.

== Table of Editors ==

{| class="wikitable sortable" border="1"
|+Editors for TEI
|-
! Name !! Operating Systems or Environments !! [http://en.wikipedia.org/wiki/FLOSS FLOSS]? !! Explicit support for XML !! Explicit support for TEI !! class="unsortable"|URL !!Projects Using !! Beginner-friendliness<br/>(scale 1-10, 1=hard) !! [http://en.wikipedia.org/wiki/Right-to-left RTL] support !! Notes
|-
| Ace|| Web-based || Yes || Yes, but primitive and buggy || No || [http://ace.ajax.org/] || [[ANGLES]] || 2 || ||
|-
| [[ANGLES]]|| Web-based || Yes || In-progress || ? || [http://umd-mith.github.com/angles/] || || || || The [https://securegrants.neh.gov/publicquery/Download.aspx?data=EbwGdSyLkD7zoB3W75cvd%2bXST%2bWypC%2blxN287EYCLJwL%2fBHyeaDHU3RDLrfbJLx%2b1ItCBTsjaJWE63FMYJfoM3kRWI6WIx3tbxFY0YxJWCwUaJYoXKOUXjj912Gj3rBbZPl64VCB8sIYhhUUUvZJSw%3d%3d white paper] released as part of the NEH grant which funded ANGLES' development indicates that development has ceased. This editor is based on the [http://ace.ajax.org/ Ace] editor.
|-
| Atom || Win, Linux, MacOS || Yes || Yes || No || [https://atom.io/] || [[ATOM]] || 2 || || Needs the package [https://atom.io/packages/linter-autocomplete-jing] to validate with a declared schema.
|-
| CodeMirror|| Web-based || Yes || Yes, but primitive and buggy || No || [http://codemirror.net/] || XET || 2 || || Cannot support namespaces without an architectural change due to the absence of lookahead for modes.
|-
| Emeditor || Win || No|| No || No || [http://www.emeditor.com] ||[http://www.lib.umich.edu/tcp/ TCP]|| 9 || || PRO: large-file support, utf-8 support, diff.
|-
| [[Editix]]|| Win, Linux, MacOS || No || Yes || No || [http://www.editix.com/] || || || || A free Lite version exists.
|-
| EditPad Pro || Win ||No || No || No || [http://www.editpadpro.com] ||[http://www.lib.umich.edu/tcp/ TCP]|| 8 || || PRO: UTF-8 support, excellent character-encoding conversions, syntax coloring, regex search/replace, XML 'content folding', handles large files well. CON: no search-in-files, sort, uniq, or diff.
|-
| EditTEI|| all (Java) || No || No || No || [http://www.digiscrib.com/Fra/Edittei.html] || || || || Claiming many features, accessible after registration.
|-
| [[Emacs]] || Mac, Win, Linux, Solaris || Yes || Yes || No || [http://savannah.gnu.org/projects/emacs/] || [http://www.nzetc.org/ NZETC] [http://www.wwp.brown.edu/ WWP]|| 3 || || (See also [[TEIEmacs]]) Best mode for TEI XML is nXML, using RELAX NG compact schemas. For Mac look for Aquamacs package
|-
| epcEdit || Win, Linux, Solaris || No || Yes || No || [http://www.epcedit.com] ||[http://www.lib.umich.edu/tcp/ TCP]|| 7 || || Free; also supports SGML; feels a bit like XMetaL
|-
| Essential XML Editor (formerly Open XML Editor) || Win || Yes || Yes || No || [http://www.philo.de/xmledit/] || || 8 || || Text-based editing, DTD validation, various input encodings but output only in UTF-8, plugin of Saxon XSLT processor and hex editor possible; plugin of Jing, Libxml2 and MSV (W3C-schema, RelaxNG validation) possible only in purchased version
|-
| [[Exchanger XML Editor]]||all (Java) || || || No || [http://www.exchangerxml.com/editor/] || || || || Heavily obsolete (as of Feb'15), won't run on a new Java installation
|-
| [[FontoXML]] || Web-based || No || Yes || Yes || [http://www.FontoXML.com]|| || 9 || 2014 || Web-based XML editor, including a TEI-edition. FontoXML integrates seamlessly into most web content management systems and workflow software.
|-
| [[Geany]] || all || Yes || Yes || No || [http://www.geany.org] || || || || Geany is a cross-platform IDE suitable for XML and HTML, C, Java, PHP, HTML, Python, Perl and Pascal.
|-
| [[jEdit]] || all (Java) || Yes || Yes || Yes || [http://www.jedit.org/] || [http://www.nzetc.org/ NZETC] || 7 || || XML use requires plugins, and only supports DTDs
|-
| Liquid XML Editor|| Win || No || Yes || No || [http://www.liquid-technologies.com/xml-editor.aspx/] || || || || Features of the XML Editor include Validation, XML Syntax Highlighting and Multi-step undo/redo.
|-
| [[Notepad++]]|| Win || Yes || Yes || No || [http://notepad-plus.sourceforge.net/] || [http://www.lib.umich.edu/tcp/ TCP] || 9 || || Freeware. XML support via XMLTools plugin. Basic editor made more versatile by plugin system (eg. Base64 encode-decode, hex editor, etc)
|-
| Office suite + OxGarage || All || ?|| Yes || Yes || [http://www.oucs.ox.ac.uk/oxgarage/]|| || 9 || || Users edit using standard office suite and documents converted to TEI via webservice
|-
| [[oXygen]] || all (Java) || No || Yes || Yes || [http://www.oxygenxml.com/] ||[http://www.wwp.brown.edu/ WWP] [http://www.digitalhumanities.org/dhq/ DHQ] || 8 || in Editor, possibly in Author || Can validate using DTD, W3C schema, RELAX NG, and Schematron; can run XSL transformations on file; WYSIWYG mode using CSS; support for TEI ODD files (editing and schema generation)
|-
| [[Sacodeyl Annotator]]|| all (Java) || || || || [http://www.um.es/sacodeyl/en/pages/software.htm#annotator] || || || ||
|-
| sed || Mac, Win, Linux, Solaris || Yes || No || No || [http://www.grymoire.com/Unix/Sed.html] || || -1 || || Handles with ease files a order of magnitude larger than the system RAM
|-
| [[Serna]]|| || No || Yes || unknown || [http://www.serna-xmleditor.com/] || || || yes || Part of Corena studio now.
|-
| [[Serna|Serna Free]]|| || Yes || Yes || Yes || [https://sourceforge.net/projects/sernafree/] || || || yes || [http://en.wikipedia.org/wiki/Syntext_Serna Wikipedia] reports that the free version of Serna is no longer "distributed." This probably means that the parent company no longer expends any resources on it. The source code of the free version is still available under a GPL license, hosted on Sourceforge.
|-
| [[TextMate]]|| MacOS || No || || No || [http://macromates.com/] || || || || An extension is needed for XML editing
|-
| TextPad || Win || No || No || No || [http://www.textpad.com] ||[http://www.lib.umich.edu/tcp/ TCP]|| 9 || || PRO: simple interface, powerful regex/multi-file replace, search-in-files, primary and secondary sort, uniq, diff, hotlinked search results, syntax coloring. CON: no utf-8 support.
|-
| UltraEdit || Win, Linux || No || Yes || No || [http://www.ultraedit.com/] || || 9 || || customizable for TEI-support; can handle extremely large files; powerful regex/multi-file replace; macro recording
|-
| vi || Mac, Win, Linux, Solaris || Yes || No || No || [http://www.vim.org/] || || 1 || || Ships on all POSIX systems (linux, solaris, BSD, etc) as standard, thus the lowest common denominator editor for server configuration
|-
| [[Wed]] || Web-based || Yes || Yes || Yes || [http://mangalam-research.github.io/wed/] || [https://btw.mangalamresearch.org/ BTW] || 7 || Not as of version 0.20.0 || Provides validation and guided editing. Understands RNG. Can be customized for specific projects. Can show XML structures in a way that mirrors the XML (labels showing location of open and close tags) or stylistically (e.g. headings in bold) in a single view.
|-
| [[XML Copy Editor]] || Win, Ubuntu || Yes || Yes || Yes || [http://xml-copy-editor.sourceforge.net/] ||[http://www.lib.umich.edu/tcp/ TCP]|| 7 || || Free; validates to DTD, XSD, Relax.ng
|-
| XMLBlueprint|| Win || || || || [http://www.xmlblueprint.com/] || || || ||
|-
| XMLMax || Win || No || Yes || No || [http://www.xponentsoftware.com/] || || 8 || || Unlimited XML file size support with low memory requirement. XML parsing with error reporting and fixing. Collapsable treeview, DTD and XML schema validation. XPATH and XSLT.
|-
| [[XMLmind]]|| all (Java) || No || Yes || No || [http://www.xmlmind.com/xmleditor/] || || || no || An evaluation version can be used for 30 days. The last free version is/was the 5.4.0 personal edition.
|-
| XPontus || all (Java) || Yes || Yes || No || [http://xpontus.sourceforge.net] || || || || XPontus XML Editor is a simple XML Editor oriented towards text editing. It can perform validation(DTD, XML Schema, Relax NG, Batch XML validation), XSL transformations(HTML, XML, PDF, SVG), schema/DTD generation, XML/DTD/HTML/XSL code completion, code formatting and much more. Plugin based.
|-
| [[XMLSpy]]|| all (Java) || No || Yes || No || [http://www.altova.com/xml-editor/] || || || yes || Fully functional free 30-day trial versions are offered.
|-
| XMLwriter|| Win || || || || [http://xmlwriter.net/] || || || ||
|-
|}

== Humour ==

Tension between emacs and vi users is longstanding and well summarised on the [http://en.wikipedia.org/wiki/Editor_war Editor war] Wikipedia page. vi was included in the [http://en.wikipedia.org/wiki/POSIX POSIX] standard, whereas emacs was not, perhaps because vi was historically available in multiple implementations from multiple vendors. The following cartoon illustrates the commonly-held assumptions that emacs and vi are very powerful but obscure while their competitors make users do all the work.

[[Image:0xbabaf000l.png|Copyright (c) 2007 Laurent Gregoire http://tnerual.eriogerg.free.fr/0xBABAF000L/10_en.html]]

[[Category:Tools]]
[[Category:Editing tools| ]]

TEI manuscript catalogues

2017-09-27T09:51:56Z

Pietro Maria Liuzzo:

This page is a location to record manuscript catalogues which use TEI as a source, preservation, or output format. Please feel free to add any others that you know of -- Perhaps inserting them alphabetically by name?

----
* '''Name:''' Digital Averroes Research Environment (DARE)
* '''URL:''' http://dare.uni-koeln.de/
* '''Is TEI Available?''' Yes
* '''Description of Catalogue/Project:''' The Digital Averroes Research Environment (DARE) collects and edits the works of the Andalusian Philosopher Averroes or Abū l-Walīd Muḥammad Ibn Aḥmad Ibn Rušd, born in Cordoba in 1126, died in Marrakesh in 1198. DARE makes accessible online digital editions of Averroes's works, and images of all textual witnesses, including manuscripts, incunabula, and early prints. Averroes's writings and the scholarly literature are documented in a bibliographical database.
* '''Notes on use of TEI:''' Bibliographically and structurally, the content of the digital library of Averroes works will be described on the basis of the established standard OAI/PMH and the texts are to be encoded in XML in accordance to the guidelines of the Text Encoding Initiative (TEI P5).
----

----
* '''Name:''' FIHRIST
* '''URL:''' http://www.fihrist.org.uk/
* '''Is TEI Available?''' Yes -- TEI XML download of individual manuscript descriptions
* '''Description of Catalogue/Project:''' The FIHRIST catalogue provides a searchable interface to TEI XML manuscript descriptions from some of the major manuscript collections in the UK. With the continuing contribution of manuscript records from UK libraries, Fihrist aims to become a union catalogue for manuscripts in Arabic script. Partners include: Bodleian Library - University of Oxford, British Library, Cambridge University Library, The Islamic Manuscript Association, The Royal Asiatic Society of Great Britain and Ireland, SOAS - University of London, University of Birmingham, The John Rylands University Library - University of Manchester, Wellcome Library. See http://www.fihrist.org.uk/about for more information.
* '''Notes on use of TEI:''' The FIHRIST Schema was a customisation for Islamic manuscripts based on the [http://code.google.com/p/tei-enrich/ ENRICH TEI ODD customisation for western manuscript description] created for the [http://enrich.manuscriptorium.com/ ENRICH project].
----

----
* '''Name:''' Guide to Medieval and Renaissance Manuscripts in the Huntington Library (2003)
* '''URL:''' http://bancroft.berkeley.edu/digitalscriptorium/huntington/toc.html
* '''Is TEI Available?''' No
* '''Description of Catalogue/Project:''' This static web segment translates the two-volume printed ''Guide'' to TEI-XML and thence to HTML. There is a simple search facility; users are encouraged also to consult the indexes of authors, scribes, artists, places, dates, and titles, which have been converted from print and linked. Since the project doesn't say: it was led by Consuelo Dutschke, with encoding and best-practices contributions by Sharon Goetz and XSL rendering by Liz Shaw.
* '''Notes on use of TEI:''' HEHweb uses a customization of TEI P4 based upon MASTER and TEIMMSS drafts and discussions that were not yet final. Its use of <msDesc> and child elements follows the 1989 printed Huntington catalogue and is a recognizable early cousin of the P5 msDesc module.
----

----
* '''Name:''' Register of Early Modern Slovenian Manuscripts
* '''URL:''' http://ezb.ijs.si/nrss/
* '''Is TEI Available?''' Yes
* '''Description of Catalogue/Project:''' The web portal presents Slovenian manuscripts from the Baroque and Enlightenment periods. The on-line Register in open access comprises manuscript descriptions of the first 100 manuscripts, researched so far, and 7.000+ digital images. The system, based on Fedora Commons, enables browsing the manuscript descriptions and associated facsimiles, as well as complex searches over structured data, including taxonomies of text types and social contexts (monastic, diocesan, civil etc.) in which the manuscripts came into existence. Even as work in progress, the repository demonstrates the variety and longevity of manuscript culture in early modern period and its important role in Slovenian literature.
* '''Notes on use of TEI:''' No modifications.
----

----
* '''Name:''' Saramusik
* '''URL:''' http://www.saramusik.org
* '''Is TEI Available?''' No
* '''Description of Catalogue/Project: ''' SARAMusiK is an arabic catalogue project of known arabic manuscripts on Music. It is based on different paper catalogues. This catalogue is extented to include a critical edition of the texts.
* '''Notes on use of TEI:''' The main data is filled using a php/mysql database. The body text of the critical edition is stored using the TEI format. All output is in a TEI format.
----

----
* '''Name:''' Syriaca.org
* '''Project Status:''' In development
* '''URL:''' http://www.syriaca.org/
* '''URL:''' https://github.com/srophe/manuscripts/
* '''Is TEI Available?''' Yes -- TEI XML download of the whole repository on [https://github.com/srophe/manuscripts/ github].
* '''Description of Catalogue/Project:''' Syriaca.org is currently in active development. We aim to provide TEI records for Syriac manuscripts and also to serialize our data through RDF using the RDF crosswalks of [http://mesa.performantsoftware.com/ The Medieval Electronic Scholarly Alliance]. Our project is intentionally modeled after the very successul FIHRIST catalogue. We plan to eventually provide a similar searchable interface to TEI XML manuscript descriptions for multiple Syriac holdings at institutions around the world. We are currently actively cataloging the Syriac holdings of the British Library (using Wright's catalogue) and the holdings of American institutions (based on Clemons' checklist).
* '''Notes on use of TEI:''' The Syriaca.org Schema is a customization for Syriac manuscripts based on the [http://www.fihrist.org.uk/ Fihrist Schema], which was itself a customization of [http://code.google.com/p/tei-enrich/ ENRICH TEI ODD customisation for western manuscript description] created for the [http://enrich.manuscriptorium.com/ ENRICH project].
----

----
* '''Name:''' Manuscript database of the Herzog August Bibliothek Wolfenbüttel
* '''URL:''' http://diglib.hab.de/?db=mss
* '''Is TEI Available?''' yes
* '''Description of Catalogue/Project:''' Basically it shall have descriptions of '''all''' manuscripts of the HAB.
* '''Notes on use of TEI:''' The mssDB differentiates between a socalled Signaturdokument (roughly: Shelfmark file) and catalogue(s). The Shelfmark file represents the manuscript itself, containing the most important bits of information on the ms only, <facsimile> and references to descriptions. The descriptions are representations of a (usually printed) catalogue in electronic form thus preserving the historical form and information of that very catalogue entry. We use an ODD based upon the ENRICH ODD, taking it further e.g. by offering value lists on several attributes. The ODD is available at http://diglib.hab.de/rules/schema/ER/v0.4/europeana-regia.xml
----

----
* '''Name:''' e-codices - Virtual Manuscript Library of Switzerland
* '''URL:''' http://www.e-codices.unifr.ch
* '''Is TEI Available?''' yes
* '''Description of Catalogue/Project:''' The goal of e-codices is to provide access to all medieval and selected early modern manuscripts of Switzerland via a virtual library. It contains almost 1000 mss from 42 institutions.
* '''Notes on use of TEI:'''
----

----
* '''Name:''' Beta maṣāḥǝft: Manuscripts of Ethiopia and Eritrea
* '''Project Status:''' in development
* '''URL:'''
* '''Is TEI Available?''' Yes -- TEI XML download of the whole repository on [https://github.com/BetaMasaheft/Manuscripts github]
* '''Description of Catalogue/Project:''' The project Beta maṣāḥǝft: Manuscripts of Ethiopia and Eritrea (Schriftkultur des christlichen Äthiopiens: eine multimediale Forschungsumgebung) is a long-term project funded within the framework of the Academies' Programme (coordinated by the Union of the German Academies of Sciences and Humanities) under survey of the Akademie der Wissenschaften in Hamburg. The funding will be provided for 25 years, from 2016–2040. The project is hosted by the Hiob Ludolf Centre for Ethiopian Studies at the University of Hamburg. It aims at creating a virtual research environment that shall manage complex data related to predominantly Christian manuscript tradition of the Ethiopian and Eritrean Highlands.
* '''Notes on use of TEI:''' [https://github.com/BetaMasaheft/Documentation/wiki/guidelines Project Guidelines Documentation]
----



----
* '''Name:'''
* '''Project Status:''' (e.g. completed, ongoing, in development, no longer actively maintained, etc).
* '''URL:'''
* '''Is TEI Available?'''
* '''Description of Catalogue/Project:'''
* '''Notes on use of TEI:'''
----

[[category:SIG:Manuscripts]]
[[category:Markup]]