Skip to content

Commit a66103c

Browse files
ruoxiranruoxiran
committed
miniapp a11y doc pattern
1 parent 4541d91 commit a66103c

File tree

4 files changed

+154
-0
lines changed

4 files changed

+154
-0
lines changed

‎.DS_Store

8 KB
Binary file not shown.

‎specs/.DS_Store

8 KB
Binary file not shown.

‎specs/maur/index.html

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<!DOCTYPE html>
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
3+
<head>
4+
<meta charset="utf-8" />
5+
<title>Miniapp Accessibility User Requirements</title>
6+
<script src="https://www.w3.org/Tools/respec/respec-w3c-common" class="remove"></script>
7+
<script src="respec-config.js" class="remove"></script>
8+
</head>
9+
<body>
10+
<section id="abstract">
11+
<h2>Abstract</h2>
12+
<p>This document lists user needs and requirements for people with disabilities when using miniapps. These user needs should drive accessibility requirements in various related specifications and the overall architecture that enables it. It defines the term user needs as used throughout the document and then goes on to list a range of these user needs and their related requirements. The document also maps the user needs and requirements presented in this document with other related specifications.</p>
13+
14+
<p>This document is most explicitly not a collection of baseline requirements. It is also important to note that some of the requirements may be implemented at a system or platform level, and some may be authoring requirements.</p>
15+
</section>
16+
17+
<section id="sotd"></section>
18+
<section>
19+
<h2>Introduction</h2>
20+
21+
<p></p>
22+
23+
24+
<section>
25+
<h2>What is the miniapp?</h2>
26+
<p></p>
27+
</section>
28+
29+
<section>
30+
<h3>User needs definition</h3>
31+
32+
<p></p>
33+
</section>
34+
</section>
35+
<section>
36+
<h2>User needs and requirements</h2>
37+
<p>The following outlines a range of user needs and requirements.</p>
38+
<section>
39+
<h3>Miniapp entrance</h3>
40+
<ul>
41+
<li><strong>User Need 1</strong>: a screen reader user needs to know where could find the miniapp</li>
42+
<li><strong>REQ 1</strong>: Provide alternative entry method.</li>
43+
<li><strong>REQ 2</strong>: </li>
44+
</ul>
45+
</section>
46+
<section>
47+
<h3>more user needs and requirements to be added</h3>
48+
<p>...</p>
49+
</section>
50+
<section>
51+
<h3>more user needs and requirements to be added</h3>
52+
<p>...</p>
53+
</section>
54+
</section>
55+
<section>
56+
<h2>Mapping user needs with related specifications</h2>
57+
<p></p>
58+
</section>
59+
<section class="appendix">
60+
<h2>Acknowledgment</h2>
61+
</section>
62+
63+
64+
</body>
65+
</html>

‎specs/maur/respec-config.js

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
var respecConfig = {
2+
// embed RDFa data in the output
3+
trace: true,
4+
useExperimentalStyles: true,
5+
doRDFa: '1.1',
6+
includePermalinks: true,
7+
permalinkEdge: true,
8+
permalinkHide: false,
9+
noRecTrack: true,
10+
tocIntroductory: true,
11+
// specification status (e.g., WD, LC, NOTE, etc.). If in doubt use ED.
12+
// subtitle: "Alternatives to Visual Turing Tests on the Web",
13+
specStatus: "NOTE",
14+
//crEnd: "",
15+
//perEnd: "",
16+
//diffTool: "",
17+
18+
// the specifications short name, as in https://www.w3.org/TR/short-name/
19+
shortName: "maur",
20+
21+
22+
// if you wish the publication date to be other than today, set this
23+
//publishDate: "2014-12-11",
24+
copyrightStart: "2020",
25+
//license: "w3c-software-doc",
26+
27+
// if there is a previously published draft, uncomment this and set its YYYY-MM-DD date
28+
// and its maturity status
29+
// previousPublishDate: "2005-11-23",
30+
// previousMaturity: "NOTE",
31+
//prevRecURI: "",
32+
//previousDiffURI: "",
33+
34+
// if there a publicly available Editors Draft, this is the link
35+
edDraftURI: "https://w3c.github.io/miniapp/specs/maur/",
36+
37+
// if this is a LCWD, uncomment and set the end of its review period
38+
// lcEnd: "2012-02-21",
39+
40+
// editors, add as many as you like
41+
// only "name" is required
42+
editors: [
43+
{
44+
name: "Ruoxi Ran",
45+
mailto: "ran@w3.org",
46+
url: 'https://www.w3.org',
47+
company: "W3C",
48+
companyURI: "https://www.w3.org",
49+
w3cid: 10568
50+
}
51+
],
52+
53+
// authors, add as many as you like.
54+
// This is optional, uncomment if you have authors as well as editors.
55+
// only "name" is required. Same format as editors.
56+
57+
//authors: [
58+
// { name: "Your Name", url: "http://example.org/",
59+
// company: "Your Company", companyURI: "http://example.com/" },
60+
//],
61+
62+
/*
63+
alternateFormats: [
64+
{ uri: 'wcag21-diff.html', label: "Diff from Previous Recommendation" } ,
65+
{ uri: 'wcag21.ps', label: "PostScript version" },
66+
{ uri: 'wcag21.pdf', label: "PDF version" }
67+
],
68+
*/
69+
70+
// errata: 'https://www.w3.org/2010/02/rdfa/errata.html',
71+
72+
// name of the WG
73+
wg: "miniapp Working Group",
74+
75+
// URI of the public WG page
76+
//wgURI: "https://www.w3.org/WAI/APA/",
77+
78+
// name (with the @w3c.org) of the public mailing to which comments are due
79+
wgPublicList: "public-miniapp",
80+
81+
// URI of the patent status for this WG, for Rec-track documents
82+
// !!!! IMPORTANT !!!!
83+
// This is important for Rec-track documents, do not copy a patent URI from a random
84+
// document unless you know what you're doing. If in doubt ask your friendly neighbourhood
85+
// Team Contact.
86+
wgPatentURI: "",
87+
maxTocLevel: 4
88+
89+
};

0 commit comments

Comments
 (0)