Skip to content

Commit 06a4dab

Browse files
Update README.md
1 parent 3866a2b commit 06a4dab

File tree

1 file changed

+1
-112
lines changed

1 file changed

+1
-112
lines changed

README.md

Lines changed: 1 addition & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -2,115 +2,4 @@ epub-accessibility-tests
22
========================
33
EPUB Content containing accessibility tests for reading systems
44

5-
## Index of materials
6-
7-
* `content/epub30-test-0301/`: Basic Functionality
8-
* `content/epub30-test-0302/`: Non-Visual Reading (ISBN 9781003410119)
9-
* `content/epub30-test-0303/`: Visual Adjustments
10-
* `content/epub30-test-0304/`: Read Aloud
11-
* `content/epub30-test-0320/`: Media Overlays
12-
* `content/epub30-test-0330/`: Math (longer book, not on site)
13-
* `content/epub30-test-0340/`: Extended Descriptions (longer book, not on site)
14-
* `content/epub30-test-0350/`: Extended Descriptions (basic)
15-
* `content/epub30-test-0360/`: Math (basic)
16-
17-
18-
## Current status
19-
20-
Some titles have updates in the repository that aren't yet live. No breaking changes are currently expected.
21-
22-
| title | repo version | epubtest.org version | notes |
23-
| ----- | ----------- | --------------------- | ----- |
24-
| Basic Functionality | 1.0.1 | 1.0.0 | [changes](https://github.com/daisy/epub-accessibility-tests/commit/cdea0e9362175418e2fad125c32fe682801c5b95)|
25-
| Non-Visual Reading | 1.0.1 | 1.0.0 | [changes](https://github.com/daisy/epub-accessibility-tests/commit/)|
26-
| Visual Adjustments | 1.0.1 | 1.0.0 | [changes](https://github.com/daisy/epub-accessibility-tests/commit/)|
27-
| Read Aloud | 1.0.1 | 1.0.0 | [changes](https://github.com/daisy/epub-accessibility-tests/commit/)|
28-
| Media Overlays | 1.0.1 | 1.0.0 | changes [1](https://github.com/daisy/epub-accessibility-tests/commit/), [2](https://github.com/daisy/epub-accessibility-tests/commit/f79ace317caeb634263edefa05a0fc6fcaeb1c22)|
29-
| Math | 1.1.1 | 1.1.1 | |
30-
| Extended Descriptions | 1.1.1 | 1.1.1 | |
31-
32-
## To build EPUBs:
33-
34-
Set the location of your [EPUBCheck](https://github.com/w3c/epubcheck) jar, e.g.
35-
```
36-
export EPUBCHECK=/Users/marisa/Downloads/epubcheck-4.2.0-rc/epubcheck.jar
37-
```
38-
39-
Or copy `example.env` as `.env` and set the environment variable there.
40-
41-
Run `build-all.sh` to run epubcheck and build EPUB files. The output appears in the `build` directory, named after the EPUB title plus the version number.
42-
43-
If you just need to build one book, run `build-one.sh foldername` where `foldername` is the directory containing the EPUB fileset for that book.
44-
45-
Full example (building one book):
46-
47-
```
48-
export EPUBCHECK=/Users/marisa/Downloads/epubcheck-4.2.0-rc/epubcheck.jar; ./build-one.sh ./content/epub30-test-0330
49-
```
50-
51-
## Structural requirements for these books
52-
53-
Use `EPUB`, not `OEPBS`, for the content directory, if you want to use the included build script.
54-
55-
### In the package document:
56-
57-
- a topic, from a pre-determined set of keywords
58-
- basic-functionality
59-
- non-visual-reading
60-
- read-aloud
61-
- visual-adjustments
62-
- media-overlays
63-
- extended-descriptions
64-
- math
65-
- the title goes in `dc:title`, e.g.
66-
```<dc:title>title</dc:title>```
67-
- the topic goes in `dc:subject`, e.g.
68-
```<dc:subject>media-overlays</dc:subject>```
69-
- a language, e.g ```<dc:language>fr</dc:language>```. Supported languages are:
70-
- en
71-
- fr
72-
- a version, in the form of MAJ.MIN.PATCH, e.g.
73-
```<meta property="schema:version">1.0.0</meta>```
74-
- a unique identifier (don't repeat across versions), e.g.
75-
``` <dc:identifier id="uid">com.github.epub-testsuite.epub30-test-0330-1.1.2</dc:identifier>```
76-
77-
### In the navigation document
78-
79-
All tests must have an entry in the navigation document. The entry must be a list item with `class='test'` and it must contain a link, e.g.
80-
```<li class="test"><a href="content.xhtml#test-id">Test Name</a></li>```
81-
82-
If you need to create an entry for something that is not a test, don't include `class='test'` on it, e.g.
83-
```<li><a href="supplement.xhtml">Supplemental Content</a></li>```
84-
85-
86-
### In the content document
87-
88-
Each test must be formatted exactly as:
89-
90-
```
91-
<section id="TEST-ID" class="test">
92-
<h2><span class="test-id">TEST-ID</span> <span class="test-title">TEST TITLE</span></h2>
93-
<p class="desc">TEST DESCRIPTION</p>
94-
<p class="eval">EVALUATION INSTRUCTIONS</p>
95-
</section>
96-
```
97-
98-
For example:
99-
100-
```
101-
<section id="file-010" class="test">
102-
<h2><span class="test-id">file-010</span> <span class="test-title">Operating system/Platform accessibility:</span></h2>
103-
<p class="desc">If you are using a hardware device, it can be started independently and essential accessibility for starting and exiting applications is available.</p>
104-
<p class="eval">Indicate Pass or Fail.</p>
105-
</section>
106-
```
107-
108-
## About versioning
109-
110-
The version number is formatted as MAJ.MIN.PATCH. The rules for how to use each are:
111-
112-
1. MAJ: Implies big changes, so use sparingly. At the moment, changes to MAJ or MIN both result in the epubtest.org ingestion system seeing the version as "new" and will list results for older version numbers as being out of date.
113-
114-
2. MIN: Same effect as MAJ but implies changes of a less drastic nature.
115-
116-
3. PATCH: For non-breaking changes. E.g. a French book that has version 1.2.4 is treated as being as recent as an English book with version 1.2.3. PATCH is useful for when you make a change that doesn't affect testing.
5+
This branch contains French versions of the books; however, they are not current with the content on the main branch.

0 commit comments

Comments
 (0)