This repository has been archived by the owner on Apr 26, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 16
/
BestPractices.html
172 lines (155 loc) · 7.22 KB
/
BestPractices.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US" xml:lang="en-US">
<head>
<meta charset="utf-8" />
<title>Best Practices</title>
<script src="https://www.w3.org/Tools/respec/respec-w3c-common" class="remove"></script>
<script src="../common/biblio.js" class="remove"></script>
<script src="../common/dfn-crossref.js" class="remove"></script>
<script src="../common/confreq-permalinks.js" class="remove"></script>
<link href="../common/css/common.css" rel="stylesheet" type="text/css" />
<script class="remove">
var respecConfig = {
wg: "EPUB 3 Community Group",
specStatus: "CG-DRAFT",
noRecTrack: true,
shortName: "epub-bestpractices",
contributors: [
{
name: "Rachel Comerford",
company: "Macmillan Learning"
},
{
name: "Laura Brady",
company: "Brady Type"
},
{
name: "Tzviya Siegman",
company: "Wiley"
},
{
name: "Bill Kasdorf",
company: ""
},
{
name: "Liisa McCloy-Kelley",
company: "Penguin Random House"
},
{
name: "Mike Baker",
company: "Houghton Mifflin Harcourt"
},
{
name: "George Kerscher",
company: "DAISY, Benetech"
},
{
name: "Kevin Callahan",
company: "BNGO Books"
}
],
processVersion: 2017,
includePermalinks: true,
permalinkEdge: true,
permalinkHide: false,
diffTool: "http://www.aptest.com/standards/htmldiff/htmldiff.pl",
localBiblio: biblio,
preProcess: [fixDefinitionCrossrefs, addConformanceLinks]
};
</script>
</head>
<body>
<section id="abstract">
<p>This will be the temporary home to Best Practices documentation until a location and method for hosting and updating this material is agreed on.</p>
</section>
<section id="sec-resources">
<h1>Current Resources</h1>
<section id="sec-overview-purpose-and-scope" class="informative">
<p>There are a number of best practices documents and resources available for epub3.</p>
<p>The goal of this space is to pull together a list of these locations and documents in order to create a single universal resource for users.</p>
<p>Please add existing resources to pull from here:</p>
<ul>
<li>DAISY: http://kb.daisy.org/publishing/docs/html/tables.html</li>
<li>DAISY: http://www.daisy.org/z3986-structure-guidelines</li>
<li>ePUB for education: https://w3c.github.io/publ-cg/education/epub-education.html#sec-overview</li>
<li>IEEE: http://ieee-adb.org</li>
<li>IDPF: https://idpf.github.io/epub-guides/package-metadata/</li>
<li>epub for education structural semantics: http://www.idpf.org/epub/profiles/edu/structure/</li>
<li>EBPAJ EPUB guideline: http://ebpaj.jp/counsel/guide</li>
</ul>
</section>
</section>
<section id="sec-roles">
<section id="sec-overview-roles" class="informative">
<h1>Roles</h1>
<h2>BISG</h2>
<ul>
<li>Help identify variations in market needs (higher ed versus trade, etc)</li>
<li>Gather existing best practices documentation</li>
<li>Identify pain points in implementation</li>
<li>Socialize best practices documentation as it is finalized to members</li>
</ul>
<h2>W3C Community Group</h2>
<ul>
<li>Cull recommendations from existing documentation</li>
<li>Test recommendations were necessary</li>
<li>Document results</li>
<li>Create, host, and manage final Best Practices artifact (location and style tbd)</li>
</ul>
</section>
</section>
<section id="sec-Requests">
<h1>Requests for Best Practices</h1>
<section id="sec-requests-BISG-members" class="informative">
<p>Best practices requests have been made by the publishing community in the following fields:</p>
<ul>
<li> CSS </li>
<ul>
<li>css3 layout</li>
<li>column implementation</li>
<li>Fallbacks for some of the newer epub3 toolset (columns, flexbox)</li>
<li>a quality community developed "CSS reset" that guaranteed sufficient margins, good font size, etc. would be helpful</li>
</ul>
<li>Accessibility</li>
<ul>
<li>easy ways to implement accessibility</li>
<li>nuances of accessibility</li>
<li>how best to include the correct metadata pertaining to accessibility</li>
<li>trade publication accessibility</li>
<li>alt text best practices</li>
<li>video captions</li>
<li>proper heading structure</li>
<li>"practical" a11y</li>
</ul>
<li>Cross-platform compatibility/interoperability of available ePub3 functionality: what works for iOS does not always work for Kindle.</li>
<li>Math display</li>
<li> Images </li>
<ul>
<li>image sizing</li>
<li>complex image handling</li>
<li>resolution, size, file types</li>
</ul>
<li>navigation</li>
<li>embedding fonts</li>
<li>characters/encoding</li>
<li>page numbering/pagelist</li>
<li>audio/video display</li>
<li>tables</li>
<li>margin notes/flowing in marginal elements</li>
<li>markup of non-structural headings (e.g. over blockquotes and lists)</li>
<li>use of aria-vs-epubtype attributes</li>
<li>proper use of @class, @role, and @data</li>
<li>proper use of rel</li>
<li>relationship of EPUB and schema.org</li>
<li>footnotes, endnotes, and marginal notes (up to all 3 in one document)</li>
<li>linking to ranges (sometimes extensive)</li>
<li>reference citations</li>
<li>inclusion of DOI for the EPUB</li>
<li>reader specific elements</li>
<li>language variety</li>
<li>advanced html5</li>
</ul>
</section>
</section>
</body>
</html>