Latest revision as of 20:40, 8 May 2023

WARNING

This wiki page refers to the old version of Roma: https://romaantiqua.tei-c.org/

Synopsis

Roma is the web based TEI software for generating customisations from P5 ODD specifications. It was written by Arno Mittelbach and is loosely maintained by the TEI Council.

Roma's basic job is to construct an XML document, the TEI "ODD". To generate output (RELAXNG schemas, W3C schemas, HTML documentation, etc.), Roma relies on the OxGarage web service to provide the necessary transformations.

Historically, there has been a Roma CLI tool, but this is superseded by the appropriate ANT or Shell scripts provided by the TEI Stylesheets themselves.

Features

User commentary

Please sign all comments.

System requirements

A standard modern web browser is all that is required to make use of the Roma Web Client. If you want to deploy the underlying system yourself the most convenient way is via Docker which is available for most platforms.

Source code and licensing

Roma source code is hosted on Github, at https://github.com/TEIC/roma

Support for TEI

Language(s)

Documentation

For the web version, see Customizing the TEI with Roma.

For instructions on installing the command-line version under Mac OS X, see Roma CLI Instructions [note that the locations of stylesheet and roma have moved to github and the links given are out of date, cf. [1]].

As Sebastian wrote on TEI-L on 2009-12-21, "Always remember when considering Roma and friends that the variation is in the XSL stylesheets which it uses. So 99% of error reports and bug fixes are to do with the behaviour of odd2odd.xsl and odd2relax.xsl (etc). The XSL package changes much more frequently than Roma."

Tech support

Report problems either at the TEI-L list or in the GitHub issue tracker.

User community

Sample implementations

Production version: http://roma.tei-c.org/ (running on the main TEI server)
Development version: https://roma2.tei-c.org (currently running at Paderborn University)

Current version number and date of release

5.0.0 (2018-07-18)

History of versions

GitHub releases

https://github.com/TEIC/Roma/releases

old releases on SourceForge

https://sourceforge.net/projects/tei/files/Roma/

How to download or buy

There are two options.

a) Pull from Docker (recommended)

docker pull teic/roma

b) Download/Clone from GitHub (for developers)

see https://github.com/TEIC/Roma

Getting the Roma server running

The recommended way is to run Roma via Docker. Detailed instructions can be found in the project Readme.

Additional notes

Also see OxGarage and Vesta.

@@ Line 1: / Line 1: @@
+= WARNING =
+This wiki page refers to the old version of Roma: https://romaantiqua.tei-c.org/
 == Synopsis ==
-'''Roma''' is the TEI tool (a suite of XSLT stylesheets) for creating schemas and customisations from [http://www.tei-c.org/P5/ P5] [[ODD]] specifications. It was written by Arno Mittelbach and is maintained by Sebastian Rahtz.
+'''Roma''' is the web based TEI software for generating customisations from [http://www.tei-c.org/P5/ P5] [[ODD]] specifications. It was written by Arno Mittelbach and is loosely maintained by the TEI Council.
+Roma's basic job is to construct an XML document, the TEI "ODD". To generate output (RELAXNG schemas, W3C schemas, HTML documentation, etc.), Roma relies on the [[OxGarage]] web service to provide the necessary transformations.
+Historically, there has been a Roma CLI tool, but this is superseded by the appropriate ANT or Shell scripts provided by  the  [[Tei-xsl|TEI Stylesheets]] themselves.
 == Features ==
@@ Line 9: / Line 17: @@
 == System requirements ==
+A standard modern web browser is all that is required to make use of the Roma Web Client. If you want to deploy the underlying system yourself the most convenient way is via [https://www.docker.com Docker] which is available for most platforms.
 == Source code and licensing ==
+Roma source code is hosted on Github, at https://github.com/TEIC/roma
 == Support for TEI ==
@@ Line 17: / Line 27: @@
 == Documentation ==
-For instructions on installing the command-line version under Mac OS X, see [http://www.wwp.brown.edu/outreach/seminars/_current/handouts/roma_CLI_MacOS_X.html Roma CLI Instructions].  Besides this, just see the Debian packaging.
+For the web version, see [http://www.tei-c.org/Guidelines/Customization/use_roma.xml Customizing the TEI with Roma].
-For the web version, see [http://www.tei-c.org/Guidelines/Customization/use_roma.xml Customizing the TEI with Roma].
+For instructions on installing the command-line version under Mac OS X, see [http://www.wwp.northeastern.edu/outreach/seminars/_current/handouts/roma_CLI_MacOS_X.html Roma CLI Instructions] [note that the locations of stylesheet and roma have moved to github and the links given are out of date, cf. [http://lists.village.virginia.edu/pipermail/tei-council/2013/018680.html]].
 As Sebastian wrote on TEI-L on 2009-12-21, "Always remember when considering Roma and friends that the variation is in the XSL stylesheets which it uses. So 99% of error reports and bug fixes are to do with the behaviour of odd2odd.xsl and odd2relax.xsl (etc). The XSL package changes much more frequently than Roma."
 == Tech support ==
-Report problems either at the [[TEI-L]] list or in the [http://sourceforge.net/tracker/?group_id=106328&atid=644062 SourceForge bug tracker].
+Report problems either at the [[TEI-L]] list or in the [https://github.com/TEIC/Roma/issues GitHub issue tracker].
 == User community ==
 == Sample implementations ==
-http://www.tei-c.org/Roma/
+* Production version: http://roma.tei-c.org/ (running on the main TEI server)
+* Development version: https://roma2.tei-c.org (currently running at Paderborn University)
 == Current version number and date of release ==
-* 3.7 (2009-01-31)
+* 5.0.0 (2018-07-18)
 == History of versions ==
+=== GitHub releases ===
+https://github.com/TEIC/Roma/releases
+=== old releases on SourceForge ===
 https://sourceforge.net/projects/tei/files/Roma/
 == How to download or buy ==
-There are three options.
+There are two options.
-=== Download the zip file ===
-[https://sourceforge.net/projects/tei/files/Roma/ Sourceforge download] – a shell utility (requires [http://xmlsoft.org/XSLT/xsltproc2.html xsltproc], [http://thaiopensource.com/relaxng/trang.html trang] and  [[wikipedia:perl|perl]])
+=== a) Pull from Docker (recommended) ===
-=== Install the Debian package ===
+ docker pull teic/roma
-Install the appropriate [http://tei.oucs.ox.ac.uk/teideb/ Debian package] (which one?).
+=== b) Download/Clone from GitHub (for developers)  ===
-=== Get from Subversion ===
+see https://github.com/TEIC/Roma
-'''For many of those commands, you might need to run them as sudo.'''
+== Getting the Roma server running ==
-# Download the source from Subversion: <code>svn co https://tei.svn.sourceforge.net/svnroot/tei/trunk/ /path/to/local/directory/</code>
+The recommended way is to run Roma via Docker. Detailed instructions can be found in the [https://github.com/TEIC/Roma/blob/dev/README.md project Readme].
-# Install P5 (required in order to install Roma):
-## Put roma2.sh into the right place (since P5 installation requires it): <code>cp roma2.sh /usr/bin/roma2</code>
-## Install texlive-full (includes xelatex, which is required to install P5)
-## <code>cd /path/to/local/directory/P5/</code>
-## <code>make install</code>
-# Install Roma:
-## <code>cd ../Roma/</code>
-## <code>make install</code>
 == Additional notes ==
-Also see [[Vesta]].
+Also see [[OxGarage]] and [[Vesta]].
-Sebastian wrote to TEI-L on 2009-12-21, "I expect to do some fixes next year to allow the ODD processing to be carried out by web services, based on the EGE (http://dl.psnc.pl/software/EGE/). When that is working, my idea is to redo Roma to use the web services to do all its backoffice work, and so not need any local software at all."
-[[oXygen]] 13.1 onwards has all the Roma functionality built it. Load up your ODD, tell it to generate a schema.
 [[Category:Tools]]

Difference between revisions of "Roma"

Latest revision as of 20:40, 8 May 2023

Contents