Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Webpage update #511

Merged
merged 23 commits into from
May 9, 2022
Merged
Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
7eaab4e
Updating metadata and tagline
martinpub Apr 11, 2022
7aea3b6
Moving About section to top for introduction, and upgrading Resources…
martinpub Apr 11, 2022
edb22af
Updating the about section
martinpub Apr 11, 2022
1013eca
Removing outdated links in Resources
martinpub Apr 14, 2022
be416b6
Fixing/updating the Resources section
martinpub Apr 14, 2022
b84fca5
Moving note outside of link
martinpub Apr 14, 2022
7e61e8a
Updating introduction on Installation and rearranging the section so …
martinpub Apr 20, 2022
19580b9
"a" --> "an"
martinpub Apr 20, 2022
2ac06fd
Em dash where appropriate
martinpub Apr 20, 2022
db0b750
Capitalization of Nordic Migrator
martinpub Apr 20, 2022
1dc450e
Syntax mistake in list
martinpub Apr 20, 2022
dd80cd7
Updating version number and changing Maven central link to the Maven …
martinpub Apr 26, 2022
8ac1714
Changing Pipeline version to v1.14.1
martinpub Apr 26, 2022
a2805c5
Updating current Docker commands to use latest versions of the Nordic…
martinpub Apr 26, 2022
5ec6c3b
Moving 2015-1 schemadocs to separate subdir
martinpub Apr 26, 2022
cb3230c
Adding 2020-1 validation rules documentation in page list
martinpub Apr 26, 2022
b0f6cdd
Adding HTML doc tables for 2020-1 validation rules
martinpub Apr 26, 2022
d0bf6da
Fixing rule naming in nav-ncx schemadoc (XSLT filtering flaw to be ad…
martinpub May 2, 2022
761facd
Adding home link to h1
martinpub May 2, 2022
ab1685e
Further updates to the web page (mainly Docker instructions)
martinpub May 3, 2022
2261495
Typo fix
martinpub May 4, 2022
b5d056d
Making Additional notes a list and adding a note on validation rulese…
martinpub May 4, 2022
a233d16
Minor correction about meta tag location (package.opf)
martinpub May 4, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
168 changes: 66 additions & 102 deletions index.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions schemadoc/index.html → schemadoc/2015-1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta charset="utf-8" />
<title>Schematron documentation for Nordic EPUB3/DTBook Migrator</title>
<title>Schematron documentation for Nordic EPUB3/DTBook Migrator, 2015-1 ruleset</title>
<link href="http://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css" rel="stylesheet" />
</head>
<body>
<div class="container">
<h1>Schematron documentation for Nordic EPUB3/DTBook Migrator</h1>
<h1>Schematron documentation for Nordic EPUB3/DTBook Migrator, 2015-1 ruleset</h1>
<ul>

<li><a href="nordic2015-1.nota-single-file.html">nordic2015-1.nota-single-file.sch: Nordic EPUB3 and HTML5 rules</a></li>
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
23 changes: 23 additions & 0 deletions schemadoc/2020-1/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta charset="utf-8" />
<title>Schematron documentation for Nordic EPUB3/DTBook Migrator, 2020-1 ruleset</title>
<link href="http://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css" rel="stylesheet" />
</head>
<body>
<div class="container">
<h1>Schematron documentation for Nordic EPUB3/DTBook Migrator, 2020-1 ruleset</h1>
<ul>
<li><a href="nordic2020-1.opf.html">nordic2020-1.opf.sch: Nordic EPUB3 Package Document rules</a></li>
<li><a href="nordic2020-1.opf-and-html.html">nordic2020-1.opf-and-html.sch: Nordic EPUB3 Package Document and Content Document cross-reference rules</a></li>
<li><a href="nordic2020-1.nav-ncx.html">nordic2020-1.nav-ncx.sch: Nordic EPUB3 Navigation Document and NCX rules</a></li>
<li><a href="nordic2020-1.html">nordic2020-1.sch: Nordic EPUB3 and HTML5 rules</a></li>
<li><a href="nordic2020-1.nav-references.html">nordic2020-1.nav-references.sch: Nordic EPUB3 Navigation Document content reference rules</a></li>
</ul><br />
<footer><em>Last updated: 2022-04-26</em></footer><br /><br /><br />
</div>
</body>
</html>
508 changes: 508 additions & 0 deletions schemadoc/2020-1/nordic2020-1.html

Large diffs are not rendered by default.

158 changes: 158 additions & 0 deletions schemadoc/2020-1/nordic2020-1.nav-ncx.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
<?xml version="1.0" encoding="UTF-8"?><html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Schematron rules for Nordic EPUB 2020-1</title><style>
body{
font-family: Arial, Helvetica, sans-serif;
font-size: 12px;
max-width: 95%;
margin: auto;
}
h1{
text-align: center;
font-size: 1.5rem;
margin-top: 1rem;
margin-bottom: 2rem;
}
table,
th,
td{
border: 0.1rem solid #ddd;
border-collapse: collapse;
padding: 0.5rem;
}
table{
margin-bottom: 2rem
}
tr:nth-child(even){
background-color: #f2f2f2;
}
tbody tr:hover{
background-color: #ddd;
}
thead{
background-color: #1D393C;
color: white;
}
td:first-child{
white-space: nowrap;
}
footer{
margin-top: 1rem;
margin-bottom: 1rem;
text-align: center;
font-size: 0.8rem;
}</style></head>
<body>
<h1>Schematron rules for Nordic EPUB 2020-1</h1>
<table>
<thead>
<tr>
<th>Rule</th>
<th>Global description</th>
<th>Detailed description</th>
</tr>
</thead>
<tbody>
<tr>
<td>nav_ncx_1_a</td>
<td>navdoc toc items must exist in the ncx</td>
<td>[nordic_nav_ncx_1_a] toc items in the navigation document must also occur in the NCX. <br /></td>
</tr>
<tr>
<td>nav_ncx_2_a</td>
<td>navdoc page-list items must exist in the ncx</td>
<td>[nordic_nav_ncx_2_a] page references in the navigation document must also occur as pageTarget items in the NCX. <br /></td>
</tr>
<tr>
<td>nav_ncx_3_a</td>
<td>ncx toc items must exist in the navdoc, and must follow the same structure and order as in the navdoc</td>
<td>[nordic_nav_ncx_3_a] toc items in the NCX must also occur in the navigation document.<br />
[nordic_nav_ncx_3_b] The navPoint in the NCX (

) has

ancestors

, while the corresponding item in the navigation document (

) has

ancestors

. The item in the navigation document and the navPoint in the NCX must have the same number of ancestors. Maybe the item are
placed on the wrong nesting level or under the wrong headline.
<br />
[nordic_nav_ncx_3_c] The navPoint in the NCX (

) has

preceding siblings



, while the corresponding item in the navigation document (

) has

preceding siblings



. The item in the navigation document and the navPoint in the NCX must have the same number of preceding siblings. Maybe the
items are not placed in the correct order or maybe some of the preceding items are missing.
<br /></td>
</tr>
<tr>
<td>nav_ncx_4_a</td>
<td>ncx page-list items must exist in the navdoc, and must follow the same order as in the navdoc</td>
<td>[nordic_nav_ncx_4_a] pageTarget items in the NCX must also occur as page references in the navigation document. <br />
[nordic_nav_ncx_4_b] The pageTarget in the NCX (

) has

preceding siblings



, while the page reference in the navigation document (

) has

preceding siblings



. The page reference in the navigation document and the pageTarget in the NCX must have the same number of preceding siblings.
Maybe the items are not placed in the correct order or maybe some of the preceding items are missing.
<br /></td>
</tr>
<tr>
<td>nav_ncx_5</td>
<td>navdoc references must all be unique</td>
<td>[nordic_nav_ncx_5] Two references in the toc of the navigation document can not point to the same location in the content.
[nordic_nav_ncx_5] Two references among the landmarks in navigation document can not point to the same location in the content.
<br /></td>
</tr>
<tr>
<td>nav_ncx_6</td>
<td>ncx references must all be unique</td>
<td>[nordic_nav_ncx_6] Two references in the NCX (navPoint or pageTarget) can not point to the same
location in the content. <br /></td>
</tr>
<tr>
<td>nav_ncx_7</td>
<td>toc headline must be the same in the ncx and navdoc</td>
<td>[nordic_nav_ncx_7] The navLabel in the NCX navMap must correspond to the h[x] in the toc in the navigation document. The NCX
navLabel has the value "", while the page-list h[x] in the navigation document .<br /></td>
</tr>
<tr>
<td>nav_ncx_8</td>
<td>page-list headline must be the same in the ncx and navdoc</td>
<td>[nordic_nav_ncx_8] The navLabel in the NCX pageList must correspond to the h[x] in the page-list in the navigation document.
The NCX navLabel has the value "", while the page-list h[x] in the navigation document .<br /></td>
</tr>
</tbody>
</table>
</body>
</html>
99 changes: 99 additions & 0 deletions schemadoc/2020-1/nordic2020-1.nav-references.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
<?xml version="1.0" encoding="UTF-8"?><html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Schematron rules for Nordic EPUB 2020-1</title><style>
body{
font-family: Arial, Helvetica, sans-serif;
font-size: 12px;
max-width: 95%;
margin: auto;
}
h1{
text-align: center;
font-size: 1.5rem;
margin-top: 1rem;
margin-bottom: 2rem;
}
table,
th,
td{
border: 0.1rem solid #ddd;
border-collapse: collapse;
padding: 0.5rem;
}
table{
margin-bottom: 2rem
}
tr:nth-child(even){
background-color: #f2f2f2;
}
tbody tr:hover{
background-color: #ddd;
}
thead{
background-color: #1D393C;
color: white;
}
td:first-child{
white-space: nowrap;
}
footer{
margin-top: 1rem;
margin-bottom: 1rem;
text-align: center;
font-size: 0.8rem;
}</style></head>
<body>
<h1>Schematron rules for Nordic EPUB 2020-1</h1>
<table>
<thead>
<tr>
<th>Rule</th>
<th>Global description</th>
<th>Detailed description</th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>All headings in the book must be referenced from the navigation document</td>
<td>[nordic_nav_references_1] All headings in the content documents must be referenced exactly once in the navigation document.
In the content document
"", the "" element is
from the navigation document.<br />[nordic_nav_references_1] The
text for the heading in the navigation document ("") should match the headline in the content document ("" at )<br /></td>
</tr>
<tr>
<td>2</td>
<td>The toc must be in reading order and nested correctly</td>
<td>[nordic_nav_references_2a] All references from the navigation document must reference a sectioning element in one of the content
documents:
<br />[nordic_nav_references_2a] All references from the navigation document must reference exactly one sectioning element in one
of the
content documents, there are multiple sections matching the href="" in ; <br />[nordic_nav_references_2b] The nesting of headlines in the content does not match the
nesting of headlines in the navigation document. The toc item `` in the navigation document is not nested at the correct
level. The referenced document () occurs in the navigation document at nesting depth (). The referenced headline () occurs
in the navigation document at nesting depth (). The referenced headline (`&lt;&gt;&lt;/&gt;) occurs in the content document as a ``
which implies that it should be referenced at nesting depth in the
navigation document.<br /></td>
</tr>
<tr>
<td>3</td>
<td>All pagebreaks in the book must be referenced from the navigation document</td>
<td>[nordic_nav_references_3] All pagebreaks in the content documents must be referenced exactly once in the navigation document.
In the content document
"", the pagebreak "" is from the navigation document.<br />[nordic_nav_references_3] The page number for
the pagebreak in the navigation document ("") should match the page number of the referenced pagebreak in the
content document ("" at )<br /></td>
</tr>
<tr>
<td>4</td>
<td>The page-list must be in reading order</td>
<td>[nordic_nav_references_4] The page list in the navigation document must reference the pagebreaks in the correct order.
The pagebreak with id="" in the document "" is referenced from the navigation document
after the pagebreak with id="" in the document "", but in the content document it occurs before it.<br /></td>
</tr>
</tbody>
</table>
</body>
</html>
Loading