Skip to content

Commit 2d07d2b

Browse files
ihermaniherman
authored
Merge pull request #53 from w3c/thorium-reader
Thorium Reader test results
2 parents b60f103 + 922a6ce commit 2d07d2b

File tree

12 files changed

+258
-8
lines changed

12 files changed

+258
-8
lines changed

‎audiobooks/manifest_processing/reports/ThoriumReader.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"$name" : "Thorium Reader",
3+
"$description" : "Thorium Reader v1.5 plays Web Publications and LPF formatted publications.",
4+
"$href" : "https://www.edrlab.org/software/thorium-reader/",
5+
"a4.2.01" : true,
6+
"a4.2.02" : true,
7+
"a4.2.03" : true,
8+
"a4.2.04" : true,
9+
"a4.2.05" : false,
10+
"a5.01" : true,
11+
"a5.02" : true,
12+
"a5.4.01" : true,
13+
"a5.5.01" : true,
14+
"a5.5.02" : true,
15+
"a5.5.03" : true,
16+
"a5.6.01" : true,
17+
"a5.6.02" : true,
18+
"a5.7.01" : true,
19+
"a5.7.02" : true
20+
}

‎audiobooks/manifest_processing/reports/index.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22
"PubManifest",
33
"Manifest2Internal",
44
"audiobooks-js",
5-
"colibrio-reader-framework"
5+
"colibrio-reader-framework",
6+
"ThoriumReader"
67
]

‎audiobooks/ua_behaviours/reports/ThoriumReader.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"$name" : "Thorium Reader",
3+
"$description": "Thorium Reader v1.5 plays Web Publications and LPF formatted publications.",
4+
"$href" : "https://www.edrlab.org/software/thorium-reader/",
5+
"a8.1.01" : true,
6+
"a8.1.02" : true,
7+
"a8.1.03" : true,
8+
"a8.1.04" : false,
9+
"a8.2.01" : true,
10+
"a8.2.02" : true,
11+
"a8.2.03" : true,
12+
"a8.2.04" : true,
13+
"a8.3.01" : true,
14+
"a8.3.02" : true
15+
}

‎audiobooks/ua_behaviours/reports/index.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
[
2-
"AudiobooksPlayer"
2+
"AudiobooksPlayer",
3+
"ThoriumReader"
34
]

‎lpf/package_processing/reports/ThoriumReader.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"$name" : "Thorium Reader",
3+
"$description" : "Thorium Reader v1.5 plays Web Publications and LPF formatted publications.",
4+
"$href" : "https://www.edrlab.org/software/thorium-reader/",
5+
"l4.01" : true,
6+
"l5.01" : true,
7+
"l5.02" : true,
8+
"l6.01" : true,
9+
"l6.02" : true,
10+
"l6.03" : true,
11+
"l6.04" : true,
12+
"l6.05" : true,
13+
"l6.06" : true,
14+
"l6.07" : true,
15+
"l7.01" : true
16+
}

‎lpf/package_processing/reports/index.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[
2+
"ThoriumReader"
3+
]

‎lpf/package_processing/tests/index.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"date": "2020-01-05",
33
"title": "Tests related to LPF processing",
4-
"href": "https://www.w3.org/TR/2019/NOTE-lpf-20191205/",
4+
"href": "https://www.w3.org/TR/2020/NOTE-lpf-20200319/",
55
"tests": [
66
{
77
"section": "§4 Packaging format",
8-
"href": "https://www.w3.org/TR/2019/NOTE-lpf-20191205/#sec-zip",
8+
"href": "https://www.w3.org/TR/2020/NOTE-lpf-20200319/#sec-zip",
99
"tests": [
1010
{
1111
"id": "l4.01",
@@ -19,7 +19,7 @@
1919
},
2020
{
2121
"section": "§5. Compression of resources",
22-
"href": "https://www.w3.org/TR/2019/NOTE-lpf-20191205/#sec-compression",
22+
"href": "https://www.w3.org/TR/2020/NOTE-lpf-20200319/#sec-compression",
2323
"tests": [
2424
{
2525
"id": "l5.01",
@@ -39,7 +39,7 @@
3939
},
4040
{
4141
"section": "§6 File and directory structure",
42-
"href": "https://www.w3.org/TR/2019/NOTE-lpf-20191205/#sec-structure",
42+
"href": "https://www.w3.org/TR/2020/NOTE-lpf-20200319/#sec-structure",
4343
"tests": [
4444
{
4545
"id": "l6.01",
@@ -94,7 +94,7 @@
9494
},
9595
{
9696
"section": "§7 Obtaining a publication manifest",
97-
"href": "https://www.w3.org/TR/2019/NOTE-lpf-20191205/#sec-obtaining-manifest",
97+
"href": "https://www.w3.org/TR/2020/NOTE-lpf-20200319/#sec-obtaining-manifest",
9898
"tests": [
9999
{
100100
"id": "l7.01",

‎publication_manifest/manifest_processing/reports/ThoriumReader.json

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
{
2+
"$name" : "Thorium Reader",
3+
"$description" : "Thorium Reader v1.5 plays Web Publications and LPF formatted publications.",
4+
"$href" : "https://www.edrlab.org/software/thorium-reader/",
5+
"m4.01" : true,
6+
"m4.2.5.01" : true,
7+
"m4.2.5.02" : true,
8+
"m4.2.5.03" : true,
9+
"m4.3.01" : true,
10+
"m4.3.02" : true,
11+
"m4.4.01" : true,
12+
"m4.4.02" : true,
13+
"m4.4.03" : true,
14+
"m4.4.04" : true,
15+
"m4.4.05" : true,
16+
"m4.5.01" : true,
17+
"m4.5.02" : true,
18+
"m4.6.01" : true,
19+
"m4.6.02" : true,
20+
"m4.6.03" : true,
21+
"m4.7.1.1.01" : true,
22+
"m4.7.1.2.01" : true,
23+
"m4.7.1.2.02" : true,
24+
"m4.7.1.2.03" : true,
25+
"m4.7.1.3.01" : true,
26+
"m4.7.1.3.02" : true,
27+
"m4.7.1.3.03" : true,
28+
"m4.7.1.4.01" : true,
29+
"m4.7.1.4.02" : true,
30+
"m4.7.1.5.01" : true,
31+
"m4.7.1.5.02" : true,
32+
"m4.7.1.5.03" : true,
33+
"m4.7.1.5.04" : true,
34+
"m4.7.1.6.01" : true,
35+
"m4.7.1.6.02" : true,
36+
"m4.7.1.6.03" : true,
37+
"m4.7.1.6.04" : true,
38+
"m4.7.1.7.01" : true,
39+
"m4.7.1.7.02" : true,
40+
"m4.7.1.9.01" : true,
41+
"m4.7.1.9.02" : true,
42+
"m4.7.1.10.01" : true,
43+
"m4.7.1.11.01" : true,
44+
"m4.7.1.11.02" : true,
45+
"m4.7.1.11.03" : true,
46+
"m4.7.2.1.01" : true,
47+
"m4.7.2.1.02" : true,
48+
"m4.7.2.1.03" : true,
49+
"m4.7.2.1.04" : true,
50+
"m4.7.2.2.01" : true,
51+
"m4.7.2.2.02" : true,
52+
"m4.7.2.2.03" : true,
53+
"m4.7.2.3.01" : true,
54+
"m4.7.2.3.02" : true,
55+
"m4.7.2.3.03" : true,
56+
"m4.7.2.3.04" : true,
57+
"m4.7.2.3.05" : true,
58+
"m4.7.2.3.06" : true,
59+
"m4.7.2.3.07" : true,
60+
"m4.7.3.2.01" : true,
61+
"m4.7.3.2.02" : true,
62+
"m4.8.1.1.01" : true,
63+
"m4.8.1.1.02" : true,
64+
"m4.8.1.1.03" : true,
65+
"m4.8.1.2.01" : true,
66+
"m4.8.1.3.01" : true,
67+
"m4.8.1.3.02" : true,
68+
"m5.01" : true,
69+
"m5.02" : true,
70+
"m6.01" : true,
71+
"m6.02" : true,
72+
"m6.03" : true,
73+
"m6.04" : false,
74+
"m6.05" : true,
75+
"m6.06" : true,
76+
"m6.07" : false,
77+
"m6.08" : true
78+
}

‎publication_manifest/manifest_processing/reports/index.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@
33
"Manifest2Internal",
44
"audiobooks-js",
55
"PlayBooks",
6-
"colibrio-reader-framework"
6+
"colibrio-reader-framework",
7+
"ThoriumReader"
78
]

‎test_reports/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@
33
- [Implementation Report for the Processing of Publication and Audiobooks Manifests](https://w3c.github.io/publ-tests/test_reports/manifest_processing/index.html).
44
- [Implementation report for the Processing of Table of Contents](https://w3c.github.io/publ-tests/test_reports/toc_processing/). (This section of the specification is non normative.)
55
- [Implementation report for Audiobooks User Agent Behavior tests](https://w3c.github.io/publ-tests/test_reports/ua_behaviours/). (This section of the specification is non normative.)
6+
- [Implementation report for Lightweight Packaging tests](https://w3c.github.io/publ-tests/test_reports/lpf/). (This specification is a Working Group Note.)
67
- [Publication Manifest to EPUB Mapping Report](https://w3c.github.io/publ-tests/test_reports/epub_mapping/index.html). (This section of the specification is non normative.)

‎test_reports/lpf/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Implementation Report for the Processing of Lightweight Packaging (LPF)
2+
3+
- [Report in HTML](https://w3c.github.io/publ-tests/test_reports/lpf/).

‎test_reports/lpf/index.html

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8" />
5+
<title>Implementation Report for the Processing of Lightweight Packaging</title>
6+
<link href="https://www.w3.org/StyleSheets/TR/base" rel="stylesheet" />
7+
<link href="../manifest_processing/common/css/style.css" rel="stylesheet" />
8+
<script src="../manifest_processing/common/js/display_scores.js"></script>
9+
<script src="../common/js/doc-toc.js"></script>
10+
<script>
11+
const tests = [{
12+
test_index: '../../lpf/package_processing/tests/index.json',
13+
impl_index: '../../lpf/package_processing/reports/index.json',
14+
prefix: 'lpf'
15+
}];
16+
17+
async function display() {
18+
tests.forEach((block) => {
19+
const dummy = display_test_suite(block);
20+
})
21+
// Generate the TOC
22+
handleDocToc();
23+
}
24+
window.addEventListener('load', display);
25+
</script>
26+
</head>
27+
28+
<body>
29+
<header>
30+
<p>
31+
<a href="http://www.w3.org/">
32+
<img alt="W3C" height="48" src="https://www.w3.org/Icons/w3c_home" width="72" />
33+
</a>
34+
</p>
35+
<h1> Implementation Report for the Processing of Lightweight Packaging </h1>
36+
<nav role="doc-toc" data-options="dynamic max_depth=3 use_sections"></nav>
37+
</header>
38+
<main>
39+
<p>These tests, and the implementation report, refer to the <a
40+
href="https://www.w3.org/TR/2019/NOTE-lpf-20191205/">“Lightweight Packaging Format”</a>
41+
specification.</p>
42+
43+
<section>
44+
<h2>Test results</h2>
45+
46+
<p>The implementations that have been submitted for this report are:</p>
47+
48+
<dl id="lpf_implementations"> </dl>
49+
50+
<section>
51+
<h4>Test results overview</h4>
52+
<table id="lpf_results" class="zebra">
53+
<thead>
54+
<tr id="lpf_header_row">
55+
<th>No.</th>
56+
<th>Test</th>
57+
<th>Description</th>
58+
</tr>
59+
</thead>
60+
<tbody id="lpf_table_body"> </tbody>
61+
</table>
62+
</section>
63+
</section>
64+
65+
<section id="lpf_tests">
66+
<h2>Description of the individual tests</h2>
67+
</section>
68+
69+
<section>
70+
<h2>Contributing to the reports</h2>
71+
<p>The actions below are described as adding/modifying files; this should be understood as changes on
72+
submitter’s own copy which should then be submitted, via a Pull Request, to the test repository.</p>
73+
<section>
74+
<h3>Adding a new implementation report</h3>
75+
<ol>
76+
<li>Create a new JSON report file. The file format is simple: <ul>
77+
<li>a field <code>$name</code> with, as value, the name of the implementation (will be
78+
used as the column label for the results;</li>
79+
<li>a field <code>$description</code> with, as value, the short description of the
80+
implementation;</li>
81+
<li>an optional field <code>$href</code> with, as value, a URL to the implementation
82+
page;</li>
83+
<li>for each implemented test add a field with the test code and a boolean value on
84+
whether the test is passed or not (remove the entry if it was not used for
85+
testing).</li>
86+
</ul>
87+
</li>
88+
<li>Put the new report file into the <code>publication_manifest/toc_processing/reports/</code> folder (use, preferably the name of
89+
the implementation as file name for an easier management).</li>
90+
<li>Modify the <a href="../../lpf/package_processing/tests/index.json"><code>index.json</code></a> by adding
91+
the file name of the report file without the extension.</li>
92+
</ol>
93+
</section>
94+
<section>
95+
<h2>Modifying an existing implementation report</h2>
96+
<p>Provide a new pull request for the updated implementation JSON file.</p>
97+
</section>
98+
<section>
99+
<h3>Adding a new test</h3>
100+
<ol>
101+
<li>Add the new test to the <code>publication_manifest/toc_processing/tests/</code> directory in
102+
this repository following the numbering scheme used in the current tests for the names.</li>
103+
<li>Extend the <a href="../../lpf/package_processing/tests/index.json"
104+
><code>index.json</code></a> file
105+
with the relevant information.</li>
106+
</ol>
107+
</section>
108+
</section>
109+
</main>
110+
</body>
111+
</html>

0 commit comments

Comments
 (0)