Skip to content
This repository has been archived by the owner on Aug 2, 2024. It is now read-only.

Commit

Permalink
Release 2.0.0 (#322)
Browse files Browse the repository at this point in the history
- Add support for WCAG 2.1

    - Add WCAG version selection at scope step
    - Add WCAG version filter at audit step
    - Add compatibility with previous saved reports when opening a report

- Add new feature import; (add data from other evaluation reports)

- Update W3C/WAI logo and navbar styles
  • Loading branch information
rvantonisse authored Jan 9, 2020
1 parent 1245ce8 commit c399416
Show file tree
Hide file tree
Showing 64 changed files with 7,179 additions and 1,051 deletions.
3 changes: 3 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ root = true
indent_style = space
indent_size = 2

[*.json]
indent_size = 4

# We recommend you to keep these unchanged
end_of_line = lf
charset = utf-8
Expand Down
Binary file removed app/images/Thumbs.db
Binary file not shown.
Binary file removed app/images/w3c.png
Binary file not shown.
1 change: 1 addition & 0 deletions app/images/w3c.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed app/images/wai.png
Binary file not shown.
1 change: 1 addition & 0 deletions app/images/wai.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions app/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,16 @@
<script src="scripts/services/changeLanguage.js"></script>
<script src="scripts/services/context/evalContextV1.js"></script>
<script src="scripts/services/context/evalContextV2.js"></script>
<script src="scripts/services/context/evalContextV3.js"></script>
<script src="scripts/services/knownTechnologies.js"></script>
<script src="scripts/services/reportStorage.js"></script>
<script src="scripts/services/evalLoader.js"></script>
<script src="scripts/services/evalWindow.js"></script>
<script src="scripts/services/fileReader.js"></script>
<script src="scripts/services/showSave.js"></script>
<script src="scripts/services/wcagSpecIdMap.js"></script>
<script src="scripts/services/types.js"></script>
<script src="scripts/services/helpers/isObjectLiteral.js"></script>

<script src="scripts/directives/criterion/criterionBody.js"></script>
<script src="scripts/directives/criterion/earlAssert.js"></script>
Expand Down Expand Up @@ -109,6 +113,7 @@
<script src="scripts/controllers/evaluation/report.js"></script>
<script src="scripts/controllers/viewReport.js"></script>
<script src="scripts/controllers/open.js"></script>
<script src="scripts/controllers/import.js"></script>
<script src="scripts/controllers/save.js"></script>
<script src="scripts/controllers/report/score.js"></script>
<script src="scripts/controllers/report/findings.js"></script>
Expand Down
45 changes: 23 additions & 22 deletions app/locale/EN/audit.json
Original file line number Diff line number Diff line change
@@ -1,31 +1,32 @@
{
"TITLE": "Step 4: Audit the Selected Sample",
"INTRO": "Record the outcome from evaluating the web pages selected in the previous step. Compare the results between the structured page and randomly selected pages, and if needed, adjust the selected sample in the previous step. More guidance on this step is provided in <a href={{link_em_4}}>WCAG-EM Step 4: Audit the Selected Sample</a>. <br> <strong>Note:</strong> For each WCAG 2.0 success criteria, you can enter 'Results for the entire sample' and you can enter results for individual web pages. You can choose to enter either or both. To enter individual results, select the web page(s) under 'Sample to Evaluate' (in the left column); then under the specific success criteria, select 'Show web pages to enter individual results'",
"INTRO_0": "",
"HD_SAMPLE_SELECT": "Sample to Evaluate",
"INF_AUDIT_SAMPLE": "This section lists the web pages you selected in the previous step. The web pages that are checked in this section are listed when 'Show web pages to enter individual results' is activated in the 'Success Criteria to Evaluate' section. You can show an individual web page that you are evaluating, or show several web pages at the same time. <br> The chainlink icon opens the web page in a separate browser window.",
"BTN_COLLAPSE_PAGES": "Hide web pages to enter individual results",
"BTN_COMPLETE_SELECTED": "Set selected to complete",
"BTN_UNCOMPLETE_SELECTED": "Set selected to incomplete",
"BTN_EXPAND_PAGES": "Show web pages to enter individual results",
"BTN_OPEN_SELECTED": "Open selected pages",
"NO_SAMPLE": "No sample available. Create a sample in step 2 and step 3.",
"TESTED": "Tested",
"HD_CRITERIA": "Success Criteria to Evaluate",
"INF_AUDIT_CRITERIA": "This section lists the WCAG 2.0 success criteria. Use the filter to show or hide success criteria of different levels (A, AA and AAA). You can select results as: 'Not checked', 'Passed', 'Failed', 'Not present', and 'Cannot tell'; and you can provide details, comments, or other observations made during evaluation in the accompanying text box.",
"FILTER": "Filter",
"PRINCIPLE": "Principle",
"NOTE": "Note",
"BTN_SHOW_TEXT": "Show criterion text",
"UNDERSTAND": "Understanding",
"BTN_UNCOMPLETE_SELECTED": "Set selected to incomplete",
"CLICK_TO_DELETE": "Click to delete",
"FILTER": "Show",
"FILTER_NEW_IN_WCAG21": "Added in WCAG 2.1",
"HD_CRITERIA": "Success Criteria to Evaluate",
"HD_SAMPLE_SELECT": "Sample to Evaluate",
"HOW_TO": "How to meet",
"SAMPLE_FINDINGS": "Results for the entire sample",
"BTN_EXPAND_PAGES": "Show web pages to enter individual results",
"BTN_COLLAPSE_PAGES": "Hide web pages to enter individual results",
"INF_AUDIT_CRITERIA": "This section lists the WCAG 2 success criteria. Use the filter to show or hide success criteria of different levels (A, AA and AAA). You can select results as: 'Not checked', 'Passed', 'Failed', 'Not present', and 'Cannot tell'; and you can provide details, comments, or other observations made during evaluation in the accompanying text box.",
"INF_AUDIT_SAMPLE": "This section lists the web pages you selected in the previous step. The web pages that are checked in this section are listed when 'Show web pages to enter individual results' is activated in the 'Success Criteria to Evaluate' section. You can show an individual web page that you are evaluating, or show several web pages at the same time. <br> The chainlink icon opens the web page in a separate browser window.",
"INTRO_0": "",
"INTRO": "Record the outcome from evaluating the web pages selected in the previous step. Compare the results between the structured page and randomly selected pages, and if needed, adjust the selected sample in the previous step. More guidance on this step is provided in <a href={{link_em_4}}>WCAG-EM Step 4: Audit the Selected Sample</a>. <br> <strong>Note:</strong> For each WCAG 2 success criteria, you can enter 'Results for the entire sample' and you can enter results for individual web pages. You can choose to enter either or both. To enter individual results, select the web page(s) under 'Sample to Evaluate' (in the left column); then under the specific success criteria, select 'Show web pages to enter individual results'",
"LABEL_OUTCOME": "Outcome",
"UNTESTED": "{{critCount}} untested",
"LABEL_PAGE_HANDLE": "Short page name",
"NO_PAGE_SELECTED": "No pages selected under Sample to Evaluate",
"NO_SAMPLE": "No sample available. Create a sample in step 2 and step 3.",
"NOTE": "Note",
"PLH_ASSERT_DESC": "Observations made during evaluation",
"CLICK_TO_DELETE": "Click to delete",
"LABEL_PAGE_HANDLE": "Short page name",
"PRINCIPLE": "Principle",
"RESULTS_FOR": "Results for",
"SAMPLE_FINDINGS": "Results for the entire sample",
"SELECT_ALL": "Select all web pages",
"RESULTS_FOR": "Results for"
}
"TESTED": "Tested",
"TITLE": "Step 4: Audit the Selected Sample",
"UNDERSTAND": "Understanding",
"UNTESTED": "{{critCount}} untested"
}
4 changes: 2 additions & 2 deletions app/locale/EN/explore.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"TITLE": "Step 2: Explore the Target Website",
"INTRO": "Explore the website to understand its purpose, functionality, and use. This step helps you determine which web pages to use for the evaluation in the next steps. Identify the web technologies used to provide the website and, if you want, take notes on other aspects of the website. Usually it is best to get input from the website owners and developers for this step. More guidance on this step is provided in <a href={{link_em_2}}>WCAG-EM Step 2: Explore the Target Website</a>.",
"HD_RELIEDUP_TECH": "Web Technologies Relied Upon",
"INF_RELIEDUP_TECH": "Identify the web technologies <a href={{link_relied_upon}}>relied upon according to WCAG 2.0</a> to provide the website. For more information, see <a href={{link_em_2d}}>WCAG-EM Step 2.d: Identify Web Technologies Relied Upon</a>.<br> Note: To add other technologies, select 'Others' and use the 'Web Technology' and 'Specification Address (URL)' field. The 'Specification Address (URL)' field should identify the web technology specification.",
"INF_RELIEDUP_TECH": "Identify the web technologies <a href={{link_relied_upon}}>relied upon according to WCAG 2</a> to provide the website. For more information, see <a href={{link_em_2d}}>WCAG-EM Step 2.d: Identify Web Technologies Relied Upon</a>.<br> Note: To add other technologies, select 'Others' and use the 'Web Technology' and 'Specification Address (URL)' field. The 'Specification Address (URL)' field should identify the web technology specification.",
"LABEL_TECH": "Web Technology",
"LABEL_TECH_SPEC": "Specification Address (URL)",
"PLH_TECH": "E.g. HTML5, CSS, DOM",
Expand All @@ -16,4 +16,4 @@
"LABEL_VARIETY_PAGE_TYPES": "Variety of web page types",
"INF_VARIETY_PAGE_TYPES": "You can use this field to take notes about the types (as opposed to instances) of web pages that you find on the web site. This includes notes about different styles, layouts, structures, and functionality provided on the website. For more information, see <a href={{link_em_2c}}>WCAG-EM Step 2.c: Identify the Variety of Web Page Types</a>.<br> Note: 'Web pages' include different 'web page states'; see definition of <a href={{link_page_state}}>web page states</a>.",
"LABEL_OTHER": "Others..."
}
}
5 changes: 5 additions & 0 deletions app/locale/EN/import.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"TITLE": "Import a WCAG EARL report",
"INTRO": "If you have used another application to generate a WCAG EARL-report that falls into the scope of this evaluation, you may be able to import these and add them to the evaluation audit result. The file itself should be: JSON-LD parseable, consist of objects in EARL format and evaluation tests should be related to WCAG.",
"LABEL_SELECT_FILE": "Select a JSON-LD file"
}
6 changes: 4 additions & 2 deletions app/locale/EN/nav.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
{
"MENU": "Menu",
"MENU_IMPORT": "Import",
"MENU_IMPORT_TITLE": "Start EARL report import wizzard",
"MENU_NEW": "New Report",
"MENU_OPEN": "Open",
"MENU_SAVE": "Save",
Expand All @@ -25,4 +27,4 @@
"STEP_REPORT": "Report Findings",
"STEP_VIEWREPORT": "View Report",
"BTN_BACK_TO_EVAL": "Back"
}
}
4 changes: 4 additions & 0 deletions app/locale/EN/scope.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
"INF_SITE_SCOPE_LI1": "'All web content of the online shop of Example Org. located at http://www.example.org/shop/'",
"INF_SITE_SCOPE_LI2": "'All web content of the mobile version of the public website of Example Org. located at http://m.example.org'",
"INF_SITE_SCOPE_1": "WCAG-EM Step 1.a: Define the Scope of the Website",
"LABEL_WCAG_VERSION": "WCAG Version",
"INFO_WCAG_VERSION": "Select the WCAG version to use. Version 2.1 (default) or 2.0",
"WCAG21": "WCAG 2.1",
"WCAG20": "WCAG 2.0",
"LABEL_CONFORMANCE_TGT": "Conformance target",
"INF_CONF_TGT": "Select a target WCAG 2 conformance level ('A', 'AA', or 'AAA') for the evaluation. For more information, see <a href={{link_em_1b}}>WCAG-EM Step 1.b: Define the Conformance Target</a>. This selection determines which conformance level filters are active by default in 'step 4: Audit the Sample'.",
"LABEL_SUPPORT_BASE": "Accessibility support baseline",
Expand Down
6 changes: 3 additions & 3 deletions app/locale/EN/start.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"TITLE": "WCAG-EM Report Tool",
"SUBTITLE": "Website Accessibility Evaluation Report Generator",
"INTRO_HD": "What this tool does",
"INTRO_1": "This tool helps you generate a report according to the <a href={{link_wcagem}}>Website Accessibility Conformance Evaluation Methodology (WCAG-EM)</a>. It does not perform any accessibility checks. It helps you follow the steps of WCAG-EM, to generate a <a href={{link_report}}>structured report</a> from the input that you provide. It is designed for experienced evaluators who know <a href={{link_wcag}}>Web Content Accessibility Guidelines (WCAG) 2.0</a> and are somewhat familiar with WCAG-EM. For an introduction to WCAG-EM, see the <a href={{link_conformance}}>WCAG-EM Overview</a>.",
"INTRO_1": "This tool helps you generate a report according to the <a href={{link_wcagem}}>Website Accessibility Conformance Evaluation Methodology (WCAG-EM)</a>. It does not perform any accessibility checks. It helps you follow the steps of WCAG-EM, to generate a <a href={{link_report}}>structured report</a> from the input that you provide. It is designed for experienced evaluators who know <a href={{link_wcag}}>Web Content Accessibility Guidelines (WCAG) 2</a> and are somewhat familiar with WCAG-EM. For an introduction to WCAG-EM, see the <a href={{link_conformance}}>WCAG-EM Overview</a>.",
"INTRO_2": "<strong>Note:</strong> This tool does not automatically save the information that you enter. To save your data in a file locally on your computer, use Windows shortcut keys Ctrl+S or Mac shortcut keys {{mac}} to open the Save dialog. (Or the 'Save' link at the top of the page will open the Save Evaluation Report page and from there the 'Save data file locally to your computer' link will open the Save dialog.)",
"USAGE_HD": "How this tool works",
"USAGE_LI1": "All functionality provided by this tool is now loaded and running locally in your web browser. You don't need an Internet connection beyond this point. When you close your web browser window, any unsaved data is lost.",
Expand All @@ -13,5 +13,5 @@
"TIPS_LI1": "You can go back and forth between the steps in any order. None of the fields are required.",
"TIPS_LI2": "To get more information about a field, select the {{info}} icon next to the field label.",
"TIPS_LI3": "The tool provides your report as HTML and CSS files. You can download these files from the 'View Report' page. You can then change the report content and visual design.",
"TIPS_LI4": "You can include in your report WCAG 2.0 success criteria beyond the conformance target. For example, the website is only required to meet Level AA, yet you want to also include Level AAA success criteria in the report. In step 4, use the level filter to show higher level criteria. Any criteria with a result will always be included in the report."
}
"TIPS_LI4": "You can include in your report WCAG 2 success criteria beyond the conformance target. For example, the website is only required to meet Level AA, yet you want to also include Level AAA success criteria in the report. In step 4, use the level filter to show higher level criteria. Any criteria with a result will always be included in the report."
}
13 changes: 9 additions & 4 deletions app/scripts/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@ angular.module('wcagReporter', [
$compileProvider
.aHrefSanitizationWhitelist(/^\s*(https?|data|blob):/);

$routeProvider.when('/', {
templateUrl: 'views/start.html',
controller: 'StartCtrl'
})
$routeProvider
.when('/', {
templateUrl: 'views/start.html',
controller: 'StartCtrl'
})
.when('/evaluation/scope', {
templateUrl: 'views/evaluation/scope.html',
controller: 'EvalScopeCtrl'
Expand Down Expand Up @@ -50,6 +51,10 @@ angular.module('wcagReporter', [
.when('/error', {
templateUrl: 'views/error.html'
})
.when('/import', {
templateUrl: 'views/import.html',
controller: 'ImportCtrl'
})
.otherwise({
redirectTo: '/error'
});
Expand Down
Loading

0 comments on commit c399416

Please sign in to comment.