Roma - Revision history

James: Minor Change: Warning that this is all about Roma Antiqua https://romaantiqua.tei-c.org/

2023-05-08T18:40:21Z

Minor Change: Warning that this is all about Roma Antiqua https://romaantiqua.tei-c.org/

← Older revision		Revision as of 18:40, 8 May 2023
Line 1:		Line 1:

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

	== Synopsis ==		== Synopsis ==

Pstadler: all information updated, removed header note

2018-07-27T10:00:58Z

all information updated, removed header note

← Older revision		Revision as of 10:00, 27 July 2018
Line 1:		Line 1:
	~~'''This page needs to be updated to reflect the move from SourceForge to GitHub.'''~~

	== Synopsis ==		== Synopsis ==

Pstadler: removed note regarding oXygen (since that belongs to the Stylesheets, not Roma) from /* Additional notes */

2018-07-27T09:59:47Z

removed note regarding oXygen (since that belongs to the Stylesheets, not Roma) from Additional notes

← Older revision		Revision as of 09:59, 27 July 2018
Line 71:		Line 71:
	== Additional notes ==		== Additional notes ==
	Also see [[OxGarage]] and [[Vesta]].		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]]		[[Category:Tools]]

Pstadler: updated /* Getting the Roma server running */

2018-07-27T09:58:31Z

updated Getting the Roma server running

@@ Line 67: / Line 67: @@
 == 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].
 == Additional notes ==

Pstadler: updated /* How to download or buy */

2018-07-27T09:55:18Z

updated How to download or buy

← Older revision		Revision as of 09:55, 27 July 2018
Line 55:		Line 55:
	== How to download or buy ==		== 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 ==		== Getting the Roma server running ==

Pstadler: add information about Roma CLI to /* Synopsis */

2018-07-27T09:49:20Z

add information about Roma CLI to Synopsis

← Older revision		Revision as of 09:49, 27 July 2018
Line 6:		Line 6:

	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.		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 ==		== Features ==

Pstadler: update /* Synopsis */

2018-07-27T09:43:15Z

update Synopsis

← Older revision		Revision as of 09:43, 27 July 2018
Line 3:		Line 3:
	== Synopsis ==		== 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.

	== Features ==		== Features ==

Pstadler: add information to /* System requirements */

2018-07-27T09:33:58Z

add information to System requirements

← Older revision		Revision as of 09:33, 27 July 2018
Line 11:		Line 11:

	== System requirements ==		== 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 ==		== Source code and licensing ==

Pstadler: add section /* Source code and licensing */

2018-07-27T09:29:23Z

add section Source code and licensing

← Older revision		Revision as of 09:29, 27 July 2018
Line 13:		Line 13:

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

	== Support for TEI ==		== Support for TEI ==

Pstadler: /* Documentation */

2018-07-27T09:26:34Z

Documentation

← Older revision		Revision as of 09:26, 27 July 2018
Line 19:		Line 19:

	== Documentation ==		== 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."		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."