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: @@
-'''This page needs to be updated to reflect the move from SourceForge to GitHub.'''
+= 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 loosely maintained by the TEI Council.
+'''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 11: / 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 19: / Line 27: @@
 == Documentation ==
-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]].  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."
@@ Line 49: / Line 57: @@
 == How to download or buy ==
-There are three options.
+There are two options.
-=== a) Download the zip file ===
+=== a) Pull from Docker (recommended) ===
-[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]])
+ docker pull teic/roma
-=== b) Install the Debian package ===
+=== b) Download/Clone from GitHub (for developers)  ===
-Install the <code>tei-roma</code> Debian package from [http://tei.oucs.ox.ac.uk/teideb/ the list of Debian packages].
+see https://github.com/TEIC/Roma
-=== c) Get from Subversion ===
-'''For many of those commands, you might need to run them as sudo.'''
-# Download the source from Subversion: <code>svn co https://tei.svn.sourceforge.net/svnroot/tei/trunk/ /path/to/local/directory/</code>
-# 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>
 == Getting the Roma server running ==
-The PHP application which provides basic graphical editing of ODD files is not quite old and not regularly maintained,
+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].
-but it remains the only graphical ODD editor available (at the time of writing, 2015-07), so it is still widely used.
-Any Council member working on maintenance of the Roma php application will first need to get it running. These are some
-basic notes by Martin Holmes on experiences getting it working on Ubuntu 14.04 for the purposes of working on a minor
-bug in July 2015.
-# Make sure you have all the regular TEI packages installed, as well as trang.
-# Get Apache installed and running with PHP5, including the <code>php5-xsl</code> and <code>php5-curl</code> modules (which are not installed by default).
-# Get the Roma source from the latest build on e.g. [http://teijenkins.hcmc.uvic.ca/job/Roma/] (what you need is tei-roma-x.xx.zip). Unzip the contents into a directory in the web server root.
-# Copy roma/config-dist.php to roma/config.php, and make any changes you need to. I added these lines to help me with debugging at the top:
-   ini_set('display_startup_errors',1);
-   ini_set('display_errors',1);
-   error_reporting(E_ERROR);
-Note that adding more aggressive debugging options such as E_NOTICE will actually screw up the schemas you generate, because you'll get lots of PHP error messages at the top of your schemas; the source
 == Additional notes ==
 Also see [[OxGarage]] and [[Vesta]].
-[[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