Skip to content

Commit

Permalink
Accessibility Project - Pre-assessments
Browse files Browse the repository at this point in the history
WET-380 Ajax Fetch Working Example

Content - Follow us, Lowest topic section, HTML cleanup - Code maintenance and fixing/adjusting examples (wet-boew#2196)

* Theme: Remove hardcoded post-JS HTML markup
* Remove the following hardcoded markup:
  * wb-init and wb-*-inited classes
  * wb-auto-* IDs
    * Note: Fixes broken local links caused by duplicate IDs
* Update modified dates of:
  * Pages containing affected code samples
  * Pages that reference updated samples/includes
* Spinoff of wet-boew#2179
* Content - Ajust template with the follow-us include and added example of secondary-menu
* Theme: Update page modified dates with post-JS changes
* Bump initial commit's page modified dates to current date
* Change modified dates in several extra pages that are now using the old follow-us include (components/gc-follow-us/follow.html, _includes/components/gc-follow-us/follow.html) via @duboisp's commit

GCWeb - Content - Remove hardcoded post-JS HTML markup,
GCWeb - Content - Adjusted the follow us component used on various page to match the stable example vs beta template,
GCWeb - Content - Adding working example with secondary navigation (fixing the lowest-topic section example)
GCWeb Jekyll - Minor - Add basic support for content with a secondary menu

---------

Co-authored-by: Pierre Dubois <[email protected]>

Step by step navigation: adding documentation

méli-mélo 2023-09-menu - Initial commit (wet-boew#2247)

Co-authored-by: gjb-pch <[email protected]>

Page feedback: hiding page feedback by default and updating doc>
>

Co-authored-by: Pierre Dubois <[email protected]>

Release v13.8.0

GC Tables: Improve display for empty cells

Méli-mélo - Initial commit for: 2023-09-distance-calculator and 2023-09-collection-sort (wet-boew#2245)

Initial commit of new méli-mélo project

* 2023-09-distance-calculator: Initial commit
* 2023-09-collection-sort: Initial commit

Release v13.9.0

docs: Update guidance links in feedback docs

WET-347

Fonts: fixing font loading

Update campaign-menu.js

Update to set focus on menu item

Feedback: updating doc to add migration from RAP to PFT

Release v13.9.1

Content - Review of a few components metadata (wet-boew#2261)

Reviewed the component title and description for:
* gc-subway
* header-rwd

Content - Review of a few components metadata

Content - Feedback - Update documentation (wet-boew#2262)

* Content - Feedback - Update documentation

* Apply updates to implementation as discussed with DTO during office hours
* Improved the code sample displayed in the working example
* Fix the grunt script to not rely on a generated file when initiating any task
* Updated the generated content

* Content - Feedback - Apply suggestions from code review

Co-authored-by: Garneauma <[email protected]>

* Content - Feedback - Update ajax URL in code sample

---------

Co-authored-by: Garneauma <[email protected]>

WET-410 Created a wet-boew section in GCWeb github

Changes to pre-assesments for components:
language
wb-tabs
gc-topic
gcweb-menu
  • Loading branch information
SebastianBurke committed Nov 7, 2023
1 parent cb8dc51 commit 7efcc0f
Show file tree
Hide file tree
Showing 184 changed files with 10,774 additions and 1,505 deletions.
80 changes: 47 additions & 33 deletions Gruntfile.coffee
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ module.exports = (grunt) ->
"concat:components"
"concat:templates"
"concat:sites"
"concat:wet-boew"
"clean:wetboew_demos"
"copy:wetboew_demos"
]
Expand Down Expand Up @@ -412,12 +413,16 @@ module.exports = (grunt) ->
a11yReportByTestRequirement = {};
acrReportByConformity = {}

reportConf = grunt.file.readJSON( "_data/reporting.json" )
reportConf = grunt.file.readJSON( this.data.reporting )
dataSites = grunt.file.readJSON( this.data.sites )
dataComponents = grunt.file.readJSON( this.data.components )
dataCommons = grunt.file.readJSON( this.data.common )
dataTemplates = grunt.file.readJSON( this.data.templates )

a11yReportByComponent = processComponentReporting( grunt, "sites", this.data.sites, a11yReportByTestRequirement, acrReportByConformity, reportConf )
a11yReportByComponent = a11yReportByComponent.concat( processComponentReporting( grunt, "components", this.data.components, a11yReportByTestRequirement, acrReportByConformity, reportConf ) )
a11yReportByComponent = a11yReportByComponent.concat( processComponentReporting( grunt, "common", this.data.common, a11yReportByTestRequirement, acrReportByConformity, reportConf ) )
a11yReportByComponent = a11yReportByComponent.concat( processComponentReporting( grunt, "templates", this.data.templates, a11yReportByTestRequirement, acrReportByConformity, reportConf ) )
a11yReportByComponent = processComponentReporting( grunt, "sites", dataSites, a11yReportByTestRequirement, acrReportByConformity, reportConf )
a11yReportByComponent = a11yReportByComponent.concat( processComponentReporting( grunt, "components", dataComponents, a11yReportByTestRequirement, acrReportByConformity, reportConf ) )
a11yReportByComponent = a11yReportByComponent.concat( processComponentReporting( grunt, "common", dataCommons, a11yReportByTestRequirement, acrReportByConformity, reportConf ) )
a11yReportByComponent = a11yReportByComponent.concat( processComponentReporting( grunt, "templates", dataTemplates, a11yReportByTestRequirement, acrReportByConformity, reportConf ) )


#
Expand Down Expand Up @@ -523,10 +528,12 @@ module.exports = (grunt) ->

"a11y-report":
all:
sites: @file.readJSON "_data/sites.json"
components: @file.readJSON "_data/components.json"
templates: @file.readJSON "_data/templates.json"
common: @file.readJSON "_data/common.json"
# Read those genrated json file only at runtime of the task
sites: "_data/sites.json"
components: "_data/components.json"
templates: "_data/templates.json"
common: "_data/common.json"
reporting: "_data/reporting.json"

clean:
dist: [ "dist"]
Expand All @@ -553,11 +560,11 @@ module.exports = (grunt) ->
stripBanners: true
banner: "<%= banner %>"
src: [
"{sites,common,components,templates}/**/*.js"
"!{sites,common,components,templates}/**/test.js"
"!{sites,common,components,templates}/**/assets"
"!{sites,common,components,templates}/**/demo"
"!{sites,common,components,templates}/**/demos"
"{sites,common,components,templates,wet-boew}/**/*.js"
"!{sites,common,components,templates,wet-boew}/**/test.js"
"!{sites,common,components,templates,wet-boew}/**/assets"
"!{sites,common,components,templates,wet-boew}/**/demo"
"!{sites,common,components,templates,wet-boew}/**/demos"
]
dest: "<%= themeDist %>/js/theme.js"
common:
Expand All @@ -581,6 +588,13 @@ module.exports = (grunt) ->
separator: ","
src: "templates/**/index.json-ld"
dest: "_data/templates.json"
"wet-boew":
options:
banner: "["
footer: "]\n"
separator: ","
src: "wet-boew/**/index.json-ld"
dest: "_data/wet-boew.json"
sites:
options:
banner: "["
Expand Down Expand Up @@ -709,14 +723,14 @@ module.exports = (grunt) ->
layouts:
expand: true
flatten: true
src: "{sites,components,templates,docs}/**/layouts/**.*"
src: "{sites,components,templates,docs,wet-boew}/**/layouts/**.*"
dest: "<%= jekyllDist %>/_layouts"
includes:
files: [
expand: true
src: [
"{sites,components,templates}/**/*-{includes,inc}/**.html"
"!{sites,components,templates}/**/includes/**.*"
"{sites,components,templates,wet-boew}/**/*-{includes,inc}/**.html"
"!{sites,components,templates,wet-boew}/**/includes/**.*"
]
dest: "<%= jekyllDist %>/_includes"
rename: (dest, src) ->
Expand All @@ -727,21 +741,21 @@ module.exports = (grunt) ->
,
expand: true
src: [
"{sites,components,templates}/**/includes/**.*"
"{sites,components,templates,wet-boew}/**/includes/**.*"
]
dest: "<%= jekyllDist %>/_includes"
rename: (dest, src) ->
dest + src.substring( src.indexOf('/') ).replace( '/includes/', '/' )
,
expand: true
src: "{sites,components,templates}/*/include.html"
src: "{sites,components,templates,wet-boew}/*/include.html"
dest: "<%= jekyllDist %>/_includes"
rename: (dest, src) ->
dest + "/" + src.replace( '/include.html', '.html' )
]
samples:
expand: true
src: "{sites,common,components,templates}/**/samples/**.*"
src: "{sites,common,components,templates,wet-boew}/**/samples/**.*"
dest: "_includes"
rename: (dest, src) ->
dest + "/" + src.replace( 'samples/', '' )
Expand All @@ -764,15 +778,15 @@ module.exports = (grunt) ->
expand: true
flatten: true
src: [
"{sites,common,components,templates}/**/fonts/**.*"
"{sites,common,components,templates,wet-boew}/**/fonts/**.*"
"!**/*.scss"
]
dest: "<%= themeDist %>/fonts"
assets:
expand: true
src: [
"{sites,common,components,templates}/**/assets/**.*"
"{sites,common,components,templates}/**/assets/**/*.*"
"{sites,common,components,templates,wet-boew}/**/assets/**.*"
"{sites,common,components,templates,wet-boew}/**/assets/**/*.*"
]
dest: "<%= themeDist %>/assets"
rename: (dest, src) ->
Expand All @@ -787,7 +801,7 @@ module.exports = (grunt) ->
depsJS_custom:
expand: true
flatten: true
src: "{sites,common,components,templates}/deps/**.js"
src: "{sites,common,components,templates,wet-boew}/deps/**.js"
dest: "<%= themeDist %>/deps-js"
depsJS:
expand: true
Expand Down Expand Up @@ -1051,13 +1065,13 @@ module.exports = (grunt) ->
quiet: true
all:
src: [
"{sites,common,components,templates}/**/*.js"
"{sites,common,components,templates,wet-boew}/**/*.js"
]
jsonlint:
all:
src: [
"{sites,common,components,templates}/**/*.json",
"{sites,common,components,templates}/**/*.json-ld"
"{sites,common,components,templates,wet-boew}/**/*.json",
"{sites,common,components,templates,wet-boew}/**/*.json-ld"
]
options: {
indent: "\t"
Expand All @@ -1068,7 +1082,7 @@ module.exports = (grunt) ->
all:
expand: true
src: [
"{sites,common,components,templates}/**/*.scss"
"{sites,common,components,templates,wet-boew}/**/*.scss"
"!*-jekyll.scss"
"!node_modules"
]
Expand All @@ -1088,7 +1102,7 @@ module.exports = (grunt) ->
"Rakefile"

# Folders
"{sites,common,components,templates}/**"
"{sites,common,components,templates,wet-boew}/**"

#
# Exemptions...
Expand All @@ -1098,17 +1112,17 @@ module.exports = (grunt) ->
"!Gemfile.lock"

# Web contents
"!{sites,common,components,templates}/**/*.md"
"!{sites,common,components,templates,wet-boew}/**/*.md"
# "{sites,components,templates}/*/*.{md,html}"
# "{sites,components,templates}/*.{md, html}"
# "!{sites,components,templates}/*/**/*.{md,html}"

# Images
"!{sites,common,components,templates}/**/*.{jpg,png,ico}"
"!{sites,common,components,templates}/*.{ico,jpg,png}"
"!{sites,common,components,templates,wet-boew}/**/*.{jpg,png,ico}"
"!{sites,common,components,templates,wet-boew}/*.{ico,jpg,png}"

# External fonts
"!{sites,common,components,templates}/**/*.{eot,svg,ttf,woff}"
"!{sites,common,components,templates,wet-boew}/**/*.{eot,svg,ttf,woff}"

# Docker environment file
# File that gets created/populated in a manner that goes against .editorconfig settings during the main Travis-CI build.
Expand Down
2 changes: 1 addition & 1 deletion _data/a11yComponents.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"name":"Archived - template","a11y":[],"acr":[]},{"name":"Authentication","a11y":[],"acr":[]},{"name":"Breadcrumb trail","a11y":[],"acr":[]},{"name":"Feedback area","a11y":[],"acr":[]},{"name":"Footer","a11y":[{"allStates":["earl:passed","earl:inapplicable"],"date":"2022-12-02","isPartial":false,"testRequirementNotCovered":[],"state":"Pass","link":"sites/footers/reports/a11y-1.json"}],"acr":[]},{"name":"GCWeb Menu","a11y":[],"acr":[]},{"name":"Header","a11y":[],"acr":[]},{"name":"Helpers","a11y":[],"acr":[]},{"name":"Language toggle link","a11y":[],"acr":[]},{"name":"Page details","a11y":[],"acr":[]},{"name":"Skip links","a11y":[],"acr":[]},{"name":"Checkboxes and radio buttons","a11y":[],"acr":[]},{"name":"Download link","a11y":[],"acr":[]},{"name":"Featured link - Documentation and working example","a11y":[],"acr":[]},{"name":"Context-specific features","a11y":[{"allStates":["earl:untested","earl:inapplicable"],"date":"2023-06-30","isPartial":false,"testRequirementNotCovered":[],"state":"Mixed","link":"components/gc-features/reports/pre-a11y-1.json"},{"allStates":["earl:passed","earl:inapplicable"],"date":"2023-08-23","isPartial":false,"testRequirementNotCovered":[],"state":"Pass","link":"components/gc-features/reports/pre-a11y-2.json"}],"acr":[]},{"name":"Feeds plugin GC override","a11y":[],"acr":[]},{"name":"Most requested - Documentation and working example","a11y":[],"acr":[]},{"name":"Services and information","a11y":[],"acr":[]},{"name":"Subway map menu","a11y":[],"acr":[]},{"name":"GC tables","a11y":[],"acr":[]},{"name":"Table of Contents","a11y":[],"acr":[]},{"name":"Well header responsive","a11y":[],"acr":[]},{"name":"Other components","a11y":[],"acr":[]},{"name":"Labels","a11y":[],"acr":[]},{"name":"List - Additional style","a11y":[],"acr":[]},{"name":"Chat wizard","a11y":[],"acr":[]},{"name":"Data JSON","a11y":[],"acr":[]},{"name":"Do action","a11y":[],"acr":[]},{"name":"Fieldflow","a11y":[],"acr":[]},{"name":"JSON Manager","a11y":[],"acr":[]},{"name":"Datalist dynamic suggestion","a11y":[],"acr":[]},{"name":"URL Mapping","a11y":[],"acr":[]},{"name":"wb5-click postback converter","a11y":[],"acr":[]},{"name":"Well bold","a11y":[],"acr":[]},{"name":"Alert","a11y":[],"acr":[]},{"name":"Color (Foreground/Background)","a11y":[],"acr":[]},{"name":"List","a11y":[],"acr":[]},{"name":"Scaffolding","a11y":[],"acr":[]},{"name":"Tables","a11y":[],"acr":[]},{"name":"Advanced Service - Probably deprecated","a11y":[],"acr":[]},{"name":"Campaign name","a11y":[],"acr":[]},{"name":"Home","a11y":[],"acr":[]},{"name":"Other template","a11y":[],"acr":[]},{"name":"Index","a11y":[],"acr":[]},{"name":"Institutional profile","a11y":[],"acr":[]},{"name":"Laws and regulations pages","a11y":[],"acr":[]},{"name":"Local navigation","a11y":[],"acr":[]},{"name":"Ministerial profile","a11y":[],"acr":[]},{"name":"News","a11y":[],"acr":[]},{"name":"Organizational profile","a11y":[],"acr":[]},{"name":"Search results","a11y":[],"acr":[]},{"name":"Server error message","a11y":[],"acr":[]},{"name":"Splash page - Canada.ca","a11y":[],"acr":[]},{"name":"Thematic","a11y":[],"acr":[]},{"name":"Beta - Theme, Topic","a11y":[],"acr":[]},{"name":"Topic","a11y":[],"acr":[]}]
[{"name":"Archived - template","a11y":[],"acr":[]},{"name":"Authentication","a11y":[],"acr":[]},{"name":"Breadcrumb trail","a11y":[],"acr":[]},{"name":"Feedback area","a11y":[],"acr":[]},{"name":"Footer","a11y":[{"allStates":["earl:passed","earl:inapplicable"],"date":"2022-12-02","isPartial":false,"testRequirementNotCovered":[],"state":"Pass","link":"sites/footers/reports/a11y-1.json"}],"acr":[]},{"name":"GCWeb Menu","a11y":[],"acr":[]},{"name":"Header","a11y":[],"acr":[]},{"name":"Helpers","a11y":[],"acr":[]},{"name":"Language toggle link","a11y":[],"acr":[]},{"name":"Page details","a11y":[],"acr":[]},{"name":"Secondary/Local menu","a11y":[],"acr":[]},{"name":"Skip links","a11y":[],"acr":[]},{"name":"Checkboxes and radio buttons","a11y":[],"acr":[]},{"name":"Download link","a11y":[],"acr":[]},{"name":"Featured link - Documentation and working example","a11y":[],"acr":[]},{"name":"Context-specific features","a11y":[{"allStates":["earl:untested","earl:inapplicable"],"date":"2023-06-30","isPartial":false,"testRequirementNotCovered":[],"state":"Mixed","link":"components/gc-features/reports/pre-a11y-1.json"},{"allStates":["earl:passed","earl:inapplicable"],"date":"2023-08-23","isPartial":false,"testRequirementNotCovered":[],"state":"Pass","link":"components/gc-features/reports/pre-a11y-2.json"}],"acr":[]},{"name":"Feeds plugin GC override","a11y":[],"acr":[]},{"name":"Most requested - Documentation and working example","a11y":[],"acr":[]},{"name":"Services and information","a11y":[],"acr":[]},{"name":"Step by Step navigation","a11y":[],"acr":[]},{"name":"Break up long and complex content into pages that each focus on a step or specific answer people need before moving to the next step or section.","a11y":[],"acr":[]},{"name":"GC tables","a11y":[],"acr":[]},{"name":"Table of Contents","a11y":[],"acr":[]},{"name":"Support use case for promotional page header or panel section header the width of the well header is readjusted based on the view port.","a11y":[],"acr":[]},{"name":"Other components","a11y":[],"acr":[]},{"name":"Labels","a11y":[],"acr":[]},{"name":"List - Additional style","a11y":[],"acr":[]},{"name":"Chat wizard","a11y":[],"acr":[]},{"name":"Data JSON","a11y":[],"acr":[]},{"name":"Do action","a11y":[],"acr":[]},{"name":"Fieldflow","a11y":[],"acr":[]},{"name":"JSON Manager","a11y":[],"acr":[]},{"name":"Datalist dynamic suggestion","a11y":[],"acr":[]},{"name":"URL Mapping","a11y":[],"acr":[]},{"name":"wb5-click postback converter","a11y":[],"acr":[]},{"name":"Well bold","a11y":[],"acr":[]},{"name":"Ajax Fetch","a11y":[],"acr":[]},{"name":"Alert","a11y":[],"acr":[]},{"name":"Alignment","a11y":[],"acr":[]},{"name":"Buttons","a11y":[],"acr":[]},{"name":"Color (Foreground/Background)","a11y":[],"acr":[]},{"name":"List","a11y":[],"acr":[]},{"name":"Scaffolding","a11y":[],"acr":[]},{"name":"Share widget","a11y":[{"allStates":["earl:passed","earl:inapplicable","earl:untested"],"date":"2023-07-06","isPartial":false,"testRequirementNotCovered":[],"state":"Mixed","link":"common/share/reports/pre-ally-1.json"}],"acr":[]},{"name":"Tables","a11y":[],"acr":[]},{"name":"Basic HTML","a11y":[],"acr":[]},{"name":"Advanced Service - Probably deprecated","a11y":[],"acr":[]},{"name":"Campaign name","a11y":[],"acr":[]},{"name":"Content page","a11y":[],"acr":[]},{"name":"Home","a11y":[],"acr":[]},{"name":"Other template","a11y":[],"acr":[]},{"name":"Index","a11y":[],"acr":[]},{"name":"Institutional profile","a11y":[],"acr":[]},{"name":"Laws and regulations pages","a11y":[],"acr":[]},{"name":"Lowest topic (with secondary navigation)","a11y":[],"acr":[]},{"name":"Ministerial profile","a11y":[],"acr":[]},{"name":"News","a11y":[],"acr":[]},{"name":"Organizational profile","a11y":[],"acr":[]},{"name":"Search results","a11y":[],"acr":[]},{"name":"Server error message","a11y":[],"acr":[]},{"name":"Splash page - Canada.ca","a11y":[],"acr":[]},{"name":"Thematic","a11y":[],"acr":[]},{"name":"Beta - Theme, Topic","a11y":[],"acr":[]},{"name":"Topic","a11y":[],"acr":[]}]
2 changes: 1 addition & 1 deletion _data/a11yTestRequirement.json

Large diffs are not rendered by default.

127 changes: 127 additions & 0 deletions _data/common.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,39 @@
[{
"@context": {
"@version": 1.1,
"dct": "http://purl.org/dc/terms/",
"title": { "@id": "dct:title", "@container": "@language" },
"description": { "@id": "dct:description", "@container": "@language" },
"modified": "dct:modified"
},
"title": {
"en": "Ajax Fetch",
"fr": "Récupération de ressource via Ajax"
},
"description": {
"en": "Fetch data using Ajax",
"fr": "Récupération de données via Ajax"
},
"modified": "2023-08-25",
"componentName": "ajax-fetch",
"processing": "baseline",
"status": "stable",
"pages": {
"examples": [
{
"title": "Ajax Fetch",
"language": "en",
"path": "ajax-fetch-en.html"
},
{
"title": "Récupération de ressource via Ajax",
"language": "fr",
"path": "ajax-fetch-fr.html"
}
]
}
}
,{
"@context": {
"@version": 1.1,
"dct": "http://purl.org/dc/terms/",
Expand Down Expand Up @@ -68,6 +103,40 @@
]
}
}
,{
"@context": {
"@version": 2.0,
"dct": "http://purl.org/dc/terms/",
"title": { "@id": "dct:title", "@container": "@language" },
"description": { "@id": "dct:description", "@container": "@language" },
"modified": "dct:modified"
},
"title": {
"en": "Buttons",
"fr": "Boutons"
},
"description": {
"en": "Buttons page including working examples to test how various button styles appear and function",
"fr": "Page des boutons comprenant des exemples de travail pour tester l'apparence et le fonctionnement de divers styles de boutons."
},
"modified": "2023-06-09",
"componentName": "button",
"status": "stable",
"pages": {
"examples": [
{
"title": "Buttons",
"language": "en",
"path": "button-en.html"
},
{
"title": "Boutons",
"language": "fr",
"path": "button-fr.html"
}
]
}
}
,{
"@context": {
"@version": 2.0,
Expand Down Expand Up @@ -182,6 +251,64 @@
]
}
}
,{
"@context": {
"@version": 1.1,
"dct": "http://purl.org/dc/terms/",
"title": { "@id": "dct:title", "@container": "@language" },
"description": { "@id": "dct:description", "@container": "@language" },
"modified": "dct:modified"
},
"title": {
"en": "Share widget",
"fr": "Gadget de partage"
},
"description": {
"en": "Facilitates sharing Web content on social media platforms.",
"fr": "Permet à l'utilisateur de partager un contenu Web sur les plateformes de médias sociaux."
},
"modified": "2023-09-06",
"componentName": "share",
"status": "stable",
"pages": {
"examples": [
{
"title": "Share widget",
"language": "en",
"url": "https://wet-boew.github.io/gcweb-compiled-demos/wetboew-demos/share/share-en.html"
},
{
"title": "Gadget de partage",
"language": "fr",
"url": "https://wet-boew.github.io/gcweb-compiled-demos/wetboew-demos/share/share-fr.html"
}
],
"docs": [
{
"title": "Share widget",
"language": "en",
"url": "https://wet-boew.github.io/wet-boew/docs/ref/share/share-en.html"
},
{
"title": "Gadget de partage",
"language": "fr",
"url": "https://wet-boew.github.io/wet-boew/docs/ref/share/share-fr.html"
}
],
"reports": [
{
"title": "Accessibility assessment #1 - Share widget",
"language": "en",
"path": "reports/ally-1-en.html"
},
{
"title": "Assessment d'accessibilité #1 - Gadget de partage",
"language": "fr",
"path": "reports/ally-1-fr.html"
}
]
}
}
,{
"@context": {
"@version": 1.1,
Expand Down
Loading

0 comments on commit 7efcc0f

Please sign in to comment.