Skip to content

Commit cf12578

Browse files
committed
update
1 parent 3421c88 commit cf12578

File tree

1 file changed

+21
-40
lines changed

1 file changed

+21
-40
lines changed

README.md

Lines changed: 21 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,36 @@
44
![tests](https://github.com/scdh/ox4alea/actions/workflows/test-main.yml/badge.svg)
55

66

7-
An <oXygen/> extension developed for the edition of the works of
8-
Ibn Nubata al Misri by the ALEA research group.
7+
An <oXygen/> extension developed for the [edition of the works of
8+
Ibn Nubata al Misri by the ALEA research
9+
group](https://www.uni-muenster.de/ALEA/DFGlangfristvorhaben/index.html).
910

1011
## Installation
1112

12-
Install from [https://scdh.github.io/ox4alea/descriptor.xml](https://scdh.github.io/ox4alea/descriptor.xml).
13+
Install from
14+
15+
```
16+
https://scdh.github.io/ox4alea/descriptor.xml
17+
```
18+
1319

1420
The framework can be installed with <oXygen/>'s installation and
1521
update mechanism. Therefore, the above URL has to be entered into
1622
the form "Show addons from:" of the dialogue box from "Help" ->
1723
"Install new addons...".
1824

19-
This framework works on top of oXbytei and oXbytao, which must also be
25+
This framework works on top of
26+
[oXbytei](https://github.com/scdh/oxbytei) and
27+
[oXbytao](https://github.com/scdh/oxbytei), which must also be
2028
installed.
29+
2130
```
22-
https://scdh.zivgitlabpages.uni-muenster.de/hees-alea/oxygen-framework/descriptor.xml
31+
https://scdh.github.io/oxbytei/descriptor.xml
2332
```
2433

25-
- [oXbytei](https://github.com/SCDH/oxbytei)
26-
- [oXbytao](https://github.com/SCDH/oxbytoa)
34+
```
35+
https://scdh.github.io/oxbytao/descriptor.xml
36+
```
2737

2838
Alternative installation methods are explained in [oXbytei's
2939
documentation](https://github.com/SCDH/oxbytei#installation) and can
@@ -42,11 +52,12 @@ of oXbytei and oXbytao.
4252
bibliography and presents them for selection
4353
- etc.
4454

45-
- an HTML preview with a line-referencing critical apparatus and two
46-
column text presentation for verses with caesura
47-
4855
- transformations useful for editing multiple recensions of the same text
4956

57+
- this framework comes packed with the [SEED TEI
58+
Transformations](https://github.com/scdh/seed-tei-transformations)
59+
for generating the HTML previews
60+
5061
### Project specific CSS ###
5162

5263
In order to get nice rendering in author mode, you should provide CSS
@@ -73,36 +84,6 @@ for the used languages through the project specific CSS file (see
7384
}
7485
```
7586

76-
77-
## Unit Tests
78-
79-
There are unit tests for the XSL transformations based on
80-
[`XSpec`](https://github.com/xspec/xspec) in `test/xspec`. The tests
81-
can easily be run with maven from the root directory of the
82-
repository:
83-
84-
mvn test
85-
86-
Maven will install all required packages for running the tests,
87-
e.g. `XSpec` and `Saxon-HE`. A detailed test report can be viewed with
88-
the browser in `target/xspec-reports/index.html`.
89-
90-
The test suite or single tests can also be run from the root of this
91-
repository with
92-
93-
<path-to/xspec.sh> -catalog catalog.xml test/xspec/*.xspec
94-
95-
This requires `XSpec` and `Saxon-HE` and the [XML
96-
Resolver](https://mvnrepository.com/artifact/xml-resolver/xml-resolver)
97-
installed. Provided that you've run maven before and maven caches its
98-
downloads under the `~/.m2/repository` folder you can set an
99-
environment variable as follows:
100-
101-
export SAXON_CP=~/.m2/repository/net/sf/saxon/Saxon-HE/9.9.1-6/Saxon-HE-9.9.1-6.jar:~/.m2/repository/xml-resolver/xml-resolver/1.2/xml-resolver-1.2.jar
102-
103-
The test result is in `test/xspec/xspec/*-review.html`.
104-
105-
10687
# License #
10788

10889
GPL v3

0 commit comments

Comments
 (0)