Difference between revisions of "OxGarage"
(→Sample implementations: added oxgarage-paderborn.tei-c.org) |
(added Docker image as recommendation to →System requirements) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 33: | Line 33: | ||
== System requirements == | == System requirements == | ||
| − | A standard modern web browser is all that is required to make use of the Web Client. If you want to deploy the underlying system yourself you need | + | A standard modern web browser is all that is required to make use of the 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. A ready made Docker image is available at https://hub.docker.com/r/teic/oxgarage/. |
| + | |||
| + | Otherwise, you'll need to install the required dependencies (Java, Tomcat, OpenOffice, etc.) yourself. To build it you also need Maven and various java libraries. For more information see https://github.com/TEIC/oxgarage. | ||
== Source code and licensing == | == Source code and licensing == | ||
| Line 59: | Line 61: | ||
* Production version: http://www.tei-c.org/oxgarage/ | * Production version: http://www.tei-c.org/oxgarage/ | ||
| − | |||
* Development version: https://oxgarage-paderborn.tei-c.org/ | * Development version: https://oxgarage-paderborn.tei-c.org/ | ||
== Current version number and date of release == | == Current version number and date of release == | ||
| − | Version | + | [https://github.com/TEIC/oxgarage/releases/tag/v1.0.0 Version 1.0.0 July 2018] |
== History of versions == | == History of versions == | ||
| Line 73: | Line 74: | ||
Download either: | Download either: | ||
* from Github (https://github.com/TEIC/oxgarage) | * from Github (https://github.com/TEIC/oxgarage) | ||
| − | * as a | + | * as a Docker image from https://hub.docker.com/r/teic/oxgarage/ |
== Additional notes == | == Additional notes == | ||
Latest revision as of 12:13, 27 July 2018
Contents
- 1 Synopsis
- 2 Features
- 3 User commentary
- 4 System requirements
- 5 Source code and licensing
- 6 Support for TEI
- 7 Language(s)
- 8 Documentation
- 9 Tech support
- 10 User community
- 11 Sample implementations
- 12 Current version number and date of release
- 13 History of versions
- 14 How to download or buy
- 15 Additional notes
- 16 References
Synopsis
OxGarage is a web, and RESTful, service to manage the transformation of documents between a variety of formats. The majority of transformations use the Text Encoding Initiative format as a pivot format. It is a good tool for conversion from TEI to Word (.docx), or Word (.docx) to TEI, but also does many other formats.
There is a list of formats for conversion to and from which OxGarage supports. Some of these use XSLT-based transformations and others are provided by JODConverter.
Features
OxGarage can be used to
- Convert TEI documents to HTML, LaTeX, Word, OpenOffice, and ePub
- Process TEI ODD documents to make schemas or documentation
- Convert Word documents to TEI
- Transform some common XML formats (NLM, P4, Docbook) to or from TEI
- Manage any of the document conversions supported by OpenOffice
A user uploads a document, chooses the target format, OxGarage works out the pipeline of required transformation steps, performs them, and returns the resulting new document. For example, an ODD document can be turned into ePub by
- expanding the ODD file by merging with the TEI P5 source
- converting the resulting XML to TEI Lite for formatting
- transforming TEI Lite XML to HTML and packaging as ePub
OxGarage takes care of all three stages, the user does not need to know about the middle stage. All transformations using TEI are performed with XSLT 2.0 stylesheets, some other transformations use JODConverter and a headless OpenOffice instance.
The results for some transformations can be tweaked by choosing different output profiles. These are defined on the OxGarage server.
User commentary
Please sign all comments.
System requirements
A standard modern web browser is all that is required to make use of the Web Client. If you want to deploy the underlying system yourself the most convenient way is via Docker which is available for most platforms. A ready made Docker image is available at https://hub.docker.com/r/teic/oxgarage/.
Otherwise, you'll need to install the required dependencies (Java, Tomcat, OpenOffice, etc.) yourself. To build it you also need Maven and various java libraries. For more information see https://github.com/TEIC/oxgarage.
Source code and licensing
OxGarage source code is hosted on Github, at https://github.com/TEIC/oxgarage; is is a fork and extension of the EGE project (on Sourceforge: http://enrich-ege.sourceforge.net/) and is licensed under the GPL.
Support for TEI
The basic stylesheets provided with OxGarage (and ENRICH-EGE) use TEI as an output and pivot format.
Language(s)
The Web Client and Documentation is only provided in English
Documentation
See doc directory at https://github.com/TEIC/oxgarage
Tech support
Create an issue in GitHub ( https://github.com/TEIC/oxgarage/issues ) for best-effort support concerning the OxGarage customisation.
User community
Sample implementations
- Production version: http://www.tei-c.org/oxgarage/
- Development version: https://oxgarage-paderborn.tei-c.org/
Current version number and date of release
History of versions
How to download or buy
Download either:
- from Github (https://github.com/TEIC/oxgarage)
- as a Docker image from https://hub.docker.com/r/teic/oxgarage/
Additional notes
References
<references/>
