Difference between revisions of "Roma"
Jump to navigation
Jump to search
m (Minor Change: Warning that this is all about Roma Antiqua https://romaantiqua.tei-c.org/) |
|||
| (80 intermediate revisions by 22 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | + | = WARNING = | |
| − | + | This wiki page refers to the old version of Roma: https://romaantiqua.tei-c.org/ | |
| − | + | ||
| − | [http:// | + | == Synopsis == |
| − | + | ||
| − | [ | + | '''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 == | |
| − | + | ||
| − | [ | + | == 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 [https://www.docker.com Docker] which is available for most platforms. | |
| − | [http:// | + | |
| − | [http:// | + | == Source code and licensing == |
| − | + | Roma source code is hosted on Github, at https://github.com/TEIC/roma | |
| − | [ | + | |
| − | [http:// | + | == Support for TEI == |
| − | + | ||
| − | + | == Language(s) == | |
| − | + | ||
| − | [ | + | == Documentation == |
| − | [ | + | 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 [https://github.com/TEIC/Roma/issues 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 [https://github.com/TEIC/Roma/blob/dev/README.md project Readme]. | ||
| + | |||
| + | == Additional notes == | ||
| + | Also see [[OxGarage]] and [[Vesta]]. | ||
| + | |||
| + | [[Category:Tools]] | ||
Latest revision as of 20:40, 8 May 2023
Contents
- 1 WARNING
- 1.1 Synopsis
- 1.2 Features
- 1.3 User commentary
- 1.4 System requirements
- 1.5 Source code and licensing
- 1.6 Support for TEI
- 1.7 Language(s)
- 1.8 Documentation
- 1.9 Tech support
- 1.10 User community
- 1.11 Sample implementations
- 1.12 Current version number and date of release
- 1.13 History of versions
- 1.14 How to download or buy
- 1.15 Getting the Roma server running
- 1.16 Additional notes
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.
