This Wiki page is edited by participants of the WCAG Working Group. It does not necessarily represent consensus and it may have incorrect information or information that is not supported by other Working Group participants, WAI, or W3C. It may also have some very useful information.

Technique Template

From WCAG WG
Revision as of 16:35, 19 March 2012 by Cooper (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Please follow the Technique Instructions to create techniques. For this template, follow the instructions in and remove all <blockquote> elements. Starter content outside of <blockquote> generally also needs customizing.

Technique Category

Remove the <nowiki> from the category below, and replace "Technology" with the appropriate technology. See Category:Techniques for a list of technologies. Only use technologies from the list of categories there, unless you are creating the first technique for a new technology. Do not use the generic [[Category:Techniques]] unless you are completely unsure to which technology the technique belongs.

[[Category:Technology Techniques]]

Technique Status Category

Remove the <nowiki> from the category below, and replace "Technique Status" with the appropriate status. See Category:Technique Status for a list of currently used status. Only use a status category from that page unless you are sure there is a need to introduce a new one.

[[Category:Technique Status]]

Status

Include links to discussions, previous drafts, surveys, meeting minutes, or production status as appropriate. Add status updates to the bullet list to help with an at-a-glance audit trail.
  • New technique.
  • @@ Link to WBS when surveyed by group
  • @@ Notes on work still needed before the technique is ready to publish, such as user agent support notes, etc.

Applicability

Include information on when it is technically appropriate to use the technique.

{Technology} content with {relevant feature}.

WCAG references

Include a list of success criteria, conformance requirements or guidelines to which this technique relates. For each one, provide:
  • the ID or anchor for that item;
  • the number of the item;
  • the short name for the item;
  • whether the technique is sufficient, advisory, or a failure of the item.
It is not necessary to provide a live link to the guidelines, but if you do, double-check that the link points to the correct place. It is also not necessary to provide redundant links to the Understanding and How to Meet documents; those are done automatically by the generator later in the process. The suggested format for these references is in the sample item below.

User Agent and Assistive Technology Support Notes

Provide notes regarding known lack of support for this technique with particular user agents or assistive technologies.

Description

Main text of the technique. Techniques begin with "The objective of this technique is to..." and describe what the user should accomplish, then move on to how. Some techniques are best explained through examples, but an overview of the approach should still be provided in the description.

The objective of this technique is to...

Examples

Examples for the technique, or links to external examples. Provide a description of the example, and source code if applicable. Explanatory content can be intermixed with code samples.

If you are providing multiple examples, there are two approaches:

  • Simple examples can just be provided in a bulleted list.
  • More elaborate examples should have sub-headers for each example. Provide a descriptive title for the header but do not number them, this is done later in the process. Use the samples in this template for each example.

You can include links to working examples or upload examples (see "upload file" link under tools navbar) to the wiki as needed.

Description of example.

Code sample. Be sure to put a space at the beginning of each line, and manually wrap
lines so they don't push out to the right.

This technique is shown in operation in the working example of {technique or example title}. The source code of {technique or example title} is also available.

Resources

Provide a list of links to external resources, if any.

Related Techniques

Provide a list of related techniques. For techniques that are part of the published suite, a technique id (ex. H30) is sufficient. For techniques that exist only in the wiki, link to the wiki page.

Tests

Describe how to test reliably that the technique has been applied, or that it has not been applied. If there is more than one type of test procedure, copy the entire section including the "Tests" header, and provide information about the type of test in this space before the "Procedure" header.

Procedure

If there are any prerequisite tests, list passing them as a required first step in the procedure. Provide an ordered list of steps, with at least one step to check for a particular condition.
  1. step 1
  2. step 2
  3. check that xyz

Expected Results

Indicate which step(s) from the test procedure must evaluate to true. For failure techniques, use wording like "If check #2 is false, then this failure condition applies and the content fails this success criterion."
  • #3 is true

Test Files

Provide test files here. Currently, techniques do not reference test files, but we may do something with them in the future. Note that working examples (including source code) do not go here, they should be referenced in the examples section.