Skip to content

Commit c6e7176

Browse files
author
michael-n-cooper
committed
Add generator for Understanding
Closes #832 and also extra insurance on addressing of #376 XSLT-based generator 'cause that's what I know how to write, run via Ant Includes fixes to ported 2.0 Understanding content to work with latest structure
1 parent 1336b14 commit c6e7176

84 files changed

Lines changed: 1095 additions & 518 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎build.xml‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!-- This is a build file for Apache ant (http://ant.apache.org/). This has been tested with Ant 1.7. -->
3+
<project name="wcag21" basedir="." default="usage">
4+
5+
<description>Generate WCAG 2.1 and related documents</description>
6+
7+
<!-- Load overriding properties -->
8+
<xmlproperty file="build.properties" keeproot="false" semanticattributes="true"/>
9+
10+
<!-- The following properties need to be set appropriately before doing a build - they should all be overridden by the above property file, but are kept here to serve as defaults -->
11+
<property name="outputdir" location="." description="Directory within which the output folders are created, normally &quot;../YYYY&quot; unless doing TR in which case it is &quot;../../../TR/&lt;YYYY&gt;&quot;"/>
12+
<property name="uri.prefix" value="file:///" description="Prefix if any that must be prepended to URIs to make it resolve on the platform"/>
13+
14+
<property name="xslt.factory" value="net.sf.saxon.TransformerFactoryImpl" description="Class name of the XSLT transformer factory, which sets which XSLT engine to use; must be an XSLT 2.0 processor"/>
15+
16+
<!-- The following properties usually do not need to be adjusted -->
17+
<property name="inputdir.guidelines" location="guidelines"/>
18+
<property name="inputdir.understanding" location="understanding"/>
19+
<property name="inputdir.techniques" location="techniques"/>
20+
21+
<property name="outputdir.guidelines" location="${outputdir}/guidelines"/>
22+
<property name="outputdir.understanding" location="${outputdir}/understanding"/>
23+
<property name="outputdir.techniques" location="${outputdir}/techniques"/>
24+
25+
<target name="usage">
26+
<echo level="info">Usage: &quot;ant &lt;target&gt;&quot; to execute a build task
27+
Enter &quot;ant -projecthelp&quot; to get list of available build tasks</echo>
28+
</target>
29+
30+
<target name="init"></target>
31+
32+
<target name="clean" description="Clean up any temp files">
33+
<delete file="${inputdir.guidelines}/index-flat.html" failonerror="false"/>
34+
<delete file="${inputdir.guidelines}/wcag21.xml" failonerror="false"/>
35+
<delete file="output.html" failonerror="false"/>
36+
<delete dir="output" failonerror="false"/>
37+
</target>
38+
39+
<target name="flatten" depends="init" description="Build a copy of guidelines with all data-include files incorporated">
40+
<makeurl file="${basedir}/guidelines/" property="base.guidelines"/>
41+
<xslt in="${inputdir.guidelines}/index.html" out="${inputdir.guidelines}/index-flat.html" style="xslt/flatten-document.xslt">
42+
<factory name="${xslt.factory}"/>
43+
<param name="base" expression="${base.guidelines}"/>
44+
</xslt>
45+
</target>
46+
47+
<target name="guidelines-xml" depends="flatten" description="Build an XML representation of the guidelines">
48+
<xslt in="${inputdir.guidelines}/index-flat.html" out="${inputdir.guidelines}/wcag21.xml" style="xslt/generate-structure-xml.xslt">
49+
<factory name="${xslt.factory}"/>
50+
</xslt>
51+
</target>
52+
53+
<!-- Understanding -->
54+
<target name="generate-understanding" depends="guidelines-xml">
55+
<makeurl file="${basedir}/understanding/" property="base.understanding"/>
56+
<mkdir dir="${basedir}/output/"/>
57+
<makeurl file="${basedir}/output/" property="output.dir"/>
58+
<echo message="${output.dir}"/>
59+
<xslt in="${inputdir.guidelines}/wcag21.xml" out="output.html" style="xslt/generate-understanding.xslt" force="true">
60+
<factory name="${xslt.factory}"/>
61+
<param name="base.dir" expression="${base.understanding}"/>
62+
<param name="output.dir" expression="${output.dir}"/>
63+
</xslt>
64+
<copy file="understanding/understanding.css" todir="output/"/>
65+
</target>
66+
67+
<target name="understanding" depends="generate-understanding, clean" description="Generate formatted Understanding docs"></target>
68+
69+
<!-- Everything -->
70+
<target name="all" depends="init" description="Generate entire suite"/>
71+
72+
<!-- === Sanity check === -->
73+
<target name="sanity" depends="init" description="Identifies inconsistencies in documents"></target>
74+
75+
</project>

‎understanding/20/abbreviations.html‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ <h1>Understanding Abbreviations</h1>
99
<blockquote class="scquote" data-include="../../sc/20/abbreviations.html">SC text</blockquote>
1010

1111

12-
<section class="intent" id="abbreviations-intent">
12+
<section id="intent">
1313
<h2>Intent of Abbreviations</h2>
1414

1515

1616
<p>The intent of this Success Criterion is to ensure that users can access the expanded
1717
form of abbreviations.
1818
</p>
1919

20-
<section class="benefits" id="abbreviations-benefits">
20+
<section id="benefits">
2121
<h3>Benefits of Abbreviations</h3>
2222

2323

@@ -79,7 +79,7 @@ <h3>Benefits of Abbreviations</h3>
7979

8080
</section>
8181

82-
<section class="examples" id="abbreviations-examples">
82+
<section id="examples">
8383
<h2>Examples of Abbreviations</h2>
8484

8585

@@ -164,7 +164,7 @@ <h2>Examples of Abbreviations</h2>
164164

165165
</section>
166166

167-
<section class="resources" id="abbreviations-resources">
167+
<section id="resources">
168168
<h2>Resources for Abbreviations</h2>
169169

170170

@@ -186,11 +186,11 @@ <h2>Resources for Abbreviations</h2>
186186

187187
</section>
188188

189-
<section class="techniques" id="abbreviations-techniques">
189+
<section id="techniques">
190190
<h2>Techniques for Abbreviations</h2>
191191

192192

193-
<section class="sufficient" id="abbreviations-sufficient">
193+
<section id="sufficient">
194194
<h3>Sufficient Techniques for Abbreviations</h3>
195195

196196

@@ -347,7 +347,7 @@ <h4>Situation B: If the abbreviation means different things within the same Web
347347

348348
</section>
349349

350-
<section class="advisory" id="abbreviations-advisory">
350+
<section id="advisory">
351351
<h3>Additional Techniques (Advisory) for Abbreviations</h3>
352352

353353

@@ -379,7 +379,7 @@ <h3>Additional Techniques (Advisory) for Abbreviations</h3>
379379

380380
</section>
381381

382-
<section class="failure" id="abbreviations-failure">
382+
<section id="failure">
383383
<h3>Common Failures for Abbreviations</h3>
384384

385385

‎understanding/20/adaptable.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ <h1>Understanding Adaptable</h1>
99
<blockquote class="scquote" data-include="../../sc/20/adaptable.html">SC text</blockquote>
1010

1111

12-
<section class="intent" id="adaptable-intent">
12+
<section id="intent">
1313
<h2>Intent of Adaptable</h2>
1414

1515

‎understanding/20/audio-control.html‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ <h1>Understanding Audio Control</h1>
99
<blockquote class="scquote" data-include="../../sc/20/audio-control.html">SC text</blockquote>
1010

1111

12-
<section class="intent" id="audio-control-intent">
12+
<section id="intent">
1313
<h2>Intent of Audio Control</h2>
1414

1515

@@ -39,7 +39,7 @@ <h2>Intent of Audio Control</h2>
3939
<a href="#visual-audio-contrast-noaudio"></a>.
4040
</p>
4141

42-
<section class="benefits" id="audio-control-benefits">
42+
<section id="benefits">
4343
<h3>Benefits of Audio Control</h3>
4444

4545

@@ -61,7 +61,7 @@ <h3>Benefits of Audio Control</h3>
6161

6262
</section>
6363

64-
<section class="examples" id="audio-control-examples">
64+
<section id="examples">
6565
<h2>Examples of Audio Control</h2>
6666

6767

@@ -89,17 +89,17 @@ <h2>Examples of Audio Control</h2>
8989

9090
</section>
9191

92-
<section class="resources" id="audio-control-resources">
92+
<section id="resources">
9393
<h2>Resources for Audio Control</h2>
9494

9595

9696
</section>
9797

98-
<section class="techniques" id="audio-control-techniques">
98+
<section id="techniques">
9999
<h2>Techniques for Audio Control</h2>
100100

101101

102-
<section class="sufficient" id="audio-control-sufficient">
102+
<section id="sufficient">
103103
<h3>Sufficient Techniques for Audio Control</h3>
104104

105105

@@ -151,7 +151,7 @@ <h3>Sufficient Techniques for Audio Control</h3>
151151

152152
</section>
153153

154-
<section class="advisory" id="audio-control-advisory">
154+
<section id="advisory">
155155
<h3>Additional Techniques (Advisory) for Audio Control</h3>
156156

157157

@@ -168,7 +168,7 @@ <h3>Additional Techniques (Advisory) for Audio Control</h3>
168168

169169
</section>
170170

171-
<section class="failure" id="audio-control-failure">
171+
<section id="failure">
172172
<h3>Common Failures for Audio Control</h3>
173173

174174

‎understanding/20/audio-description-or-media-alternative-prerecorded.html‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ <h1>Understanding Audio Description or Media Alternative (Prerecorded)</h1>
99
<blockquote class="scquote" data-include="../../sc/20/audio-description-or-media-alternative-prerecorded.html">SC text</blockquote>
1010

1111

12-
<section class="intent" id="audio-description-or-media-alternative-prerecorded-intent">
12+
<section id="intent">
1313
<h2>Intent of Audio Description or Media Alternative (Prerecorded)</h2>
1414

1515

@@ -76,7 +76,7 @@ <h2>Intent of Audio Description or Media Alternative (Prerecorded)</h2>
7676
<a href="#media-equiv-text-doc"></a>.
7777
</p>
7878

79-
<section class="benefits" id="audio-description-or-media-alternative-prerecorded-benefits">
79+
<section id="benefits">
8080
<h3>Benefits of Audio Description or Media Alternative (Prerecorded)</h3>
8181

8282

@@ -93,7 +93,7 @@ <h3>Benefits of Audio Description or Media Alternative (Prerecorded)</h3>
9393

9494
</section>
9595

96-
<section class="examples" id="audio-description-or-media-alternative-prerecorded-examples">
96+
<section id="examples">
9797
<h2>Examples of Audio Description or Media Alternative (Prerecorded)</h2>
9898

9999

@@ -161,7 +161,7 @@ <h2>Examples of Audio Description or Media Alternative (Prerecorded)</h2>
161161

162162
</section>
163163

164-
<section class="resources" id="audio-description-or-media-alternative-prerecorded-resources">
164+
<section id="resources">
165165
<h2>Resources for Audio Description or Media Alternative (Prerecorded)</h2>
166166

167167

@@ -201,11 +201,11 @@ <h2>Resources for Audio Description or Media Alternative (Prerecorded)</h2>
201201

202202
</section>
203203

204-
<section class="techniques" id="audio-description-or-media-alternative-prerecorded-techniques">
204+
<section id="techniques">
205205
<h2>Techniques for Audio Description or Media Alternative (Prerecorded)</h2>
206206

207207

208-
<section class="sufficient" id="audio-description-or-media-alternative-prerecorded-sufficient">
208+
<section id="sufficient">
209209
<h3>Sufficient Techniques for Audio Description or Media Alternative (Prerecorded)</h3>
210210

211211

@@ -358,7 +358,7 @@ <h3>Sufficient Techniques for Audio Description or Media Alternative (Prerecorde
358358

359359
</section>
360360

361-
<section class="advisory" id="audio-description-or-media-alternative-prerecorded-advisory">
361+
<section id="advisory">
362362
<h3>Additional Techniques (Advisory) for Audio Description or Media Alternative (Prerecorded)</h3>
363363

364364

@@ -384,7 +384,7 @@ <h3>Additional Techniques (Advisory) for Audio Description or Media Alternative
384384

385385
</section>
386386

387-
<section class="failure" id="audio-description-or-media-alternative-prerecorded-failure">
387+
<section id="failure">
388388
<h3>Common Failures for Audio Description or Media Alternative (Prerecorded)</h3>
389389

390390

‎understanding/20/audio-description-prerecorded.html‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ <h1>Understanding Audio Description (Prerecorded)</h1>
99
<blockquote class="scquote" data-include="../../sc/20/audio-description-prerecorded.html">SC text</blockquote>
1010

1111

12-
<section class="intent" id="audio-description-prerecorded-intent">
12+
<section id="intent">
1313
<h2>Intent of Audio Description (Prerecorded)</h2>
1414

1515

@@ -47,7 +47,7 @@ <h2>Intent of Audio Description (Prerecorded)</h2>
4747

4848
</div>
4949

50-
<section class="benefits" id="audio-description-prerecorded-benefits">
50+
<section id="benefits">
5151
<h3>Benefits of Audio Description (Prerecorded)</h3>
5252

5353

@@ -64,7 +64,7 @@ <h3>Benefits of Audio Description (Prerecorded)</h3>
6464

6565
</section>
6666

67-
<section class="examples" id="audio-description-prerecorded-examples">
67+
<section id="examples">
6868
<h2>Examples of Audio Description (Prerecorded)</h2>
6969

7070

@@ -114,7 +114,7 @@ <h2>Examples of Audio Description (Prerecorded)</h2>
114114

115115
</section>
116116

117-
<section class="resources" id="audio-description-prerecorded-resources">
117+
<section id="resources">
118118
<h2>Resources for Audio Description (Prerecorded)</h2>
119119

120120

@@ -154,11 +154,11 @@ <h2>Resources for Audio Description (Prerecorded)</h2>
154154

155155
</section>
156156

157-
<section class="techniques" id="audio-description-prerecorded-techniques">
157+
<section id="techniques">
158158
<h2>Techniques for Audio Description (Prerecorded)</h2>
159159

160160

161-
<section class="sufficient" id="audio-description-prerecorded-sufficient">
161+
<section id="sufficient">
162162
<h3>Sufficient Techniques for Audio Description (Prerecorded)</h3>
163163

164164

@@ -256,7 +256,7 @@ <h3>Sufficient Techniques for Audio Description (Prerecorded)</h3>
256256

257257
</section>
258258

259-
<section class="advisory" id="audio-description-prerecorded-advisory">
259+
<section id="advisory">
260260
<h3>Additional Techniques (Advisory) for Audio Description (Prerecorded)</h3>
261261

262262

@@ -287,7 +287,7 @@ <h3>Additional Techniques (Advisory) for Audio Description (Prerecorded)</h3>
287287

288288
</section>
289289

290-
<section class="failure" id="audio-description-prerecorded-failure">
290+
<section id="failure">
291291
<h3>Common Failures for Audio Description (Prerecorded)</h3>
292292

293293

0 commit comments

Comments
 (0)