The official documentation is at: http://docs.alfresco.com
The outer page template mandates the following DOCTYPE:
Therefore output from .html format FreeMarker based Web Scripts must be compliant with XHTML 1.0 Strict format.
Minimum Compliance for Section 508 (36 CFR Part 1194)
To meet section 508 for accessibility of the new web client, the following points should be read and followed when writing HTML components for Alfresco 3.0.
- 194.22 (a) A text equivalent for every non-text element shall be provided (e.g., via 'alt', 'longdesc', or in element content).
- This is equivalent to WCAG 1.0 Checkpoint 1.1: 1.1 Provide a text equivalent for every non-text element (e.g., via 'alt', 'longdesc', or in element content). This includes: images, graphical representations of text (including symbols), animations (i.e. animated GIFs), images used as list bullets, spacers, graphical buttons, sounds and video. (Priority 1)
- Add alt='...' etc. to all appropriate tags.
- 1194.22 (c) Web pages shall be designed so that all information conveyed with color is also available without color, for example from context or markup.
- This is equivalent to WCAG 1.0 Checkpoint 2.1: 2.1 Ensure that all information conveyed with color is also available without color, for example from context or markup. (Priority 1)
- For example, where say red text is used to indicate a document is late for review, also indicate that it is late with alt text or inline text.
- 1194.22 (d) Documents shall be organized so they are readable without requiring an associated style sheet.
- This is equivalent to WCAG 1.0 Checkpoint 6.1: 6.1 Organize documents so they may be read without style sheets. For example, when an HTML document is rendered without associated style sheets, it must still be possible to read the document. (Priority 1)
- For example, turn off all CSS styling in the browser and ensure text is at least visible.
- 1194.22 (g) Row and column headers shall be identified for data tables.
- This is equivalent to WCAG 1.0 Checkpoint 5.1: 5.1 For data tables, identify row and column headers. (Priority 1)
- This is relevant for tabular data displayed in tables, it is not relevant for tables for alignment.
- 1194.22 (h) Markup shall be used to associate data cells and header cells for data tables that have two or more logical levels of row or column headers.
- This is equivalent to WCAG 1.0 Checkpoint 5.2: 5.2 For data tables that have two or more logical levels of row or column headers, use markup to associate data cells and header cells. (Priority 1)
- This is relevant for tabluar data displayed in tables, it is not relevant for tables for alignment.
- 1194.22 (k) A text-only page, with equivalent information or functionality, shall be provided to make a web site comply with the provisions of this part, when compliance cannot be accomplished in any other way. The content of the text-only page shall be updated whenever the primary page changes.
- This is equivalent to WCAG 1.0 Checkpoint 11.4: 11.4 If, after best efforts, you cannot create an accessible page, provide a link to an alternative page that uses W3C technologies, is accessible, has equivalent information (or functionality), and is updated as often as the inaccessible (original) page. (Priority 1)
- This is the mechanism is use when components cannot meet the minimum requirements for 508 due to technical limitations.
- 1194.22 (l) When pages utilize scripting languages to display content, or to create interface elements, the information provided by the script shall be identified with functional text that can be read by assistive technology.
- Testing should be performed with appropriate screen readers to ensure generated and dynamic HTML is output correctly.
- 1194.22 (m) When a web page requires that an applet, plug-in or other application be present on the client system to interpret page content, the page must provide a link to a plug-in or applet that complies with Â§1194.21(a) through (l).
- Not required? I.e. Flash is installed by default on most systems, if it is not installed we should use a fall-back mechanism rather than prompt for download - as a download link may not be acceptable to many system administrators.:
- 1194.22 (n) When electronic forms are designed to be completed on-line, the form shall allow people using assistive technology to access the information, field elements, and functionality required for completion and submission of the form, including all directions and cues.
- Ensure screen readers can access our generated Forms correctly. And ensure text or alt text is provided where appropriate. For example if an asterisk * is used to indicate a mandatory field, this must also be indicated via alf text on the element.
- 1194.22 (o) A method shall be provided that permits users to skip repetitive navigation links.
- Provide Anchor points where appropriate i.e. to enable a user to skip over a navigation tree rather than walking each element.
- 1194.22 (p) When a timed response is required, the user shall be alerted and given sufficient time to indicate more time is required.
- Do not use timed responses. FOR INVESTIGATION: do the pop-up and fade-out message dialogs work correctly with screen readers?