accessibility.rst 2.7 KB

  1. Accessibility
  2. =============
  3. This page aims to list and document accessibility rules and best practices, to help core and plugins developpers to make Elgg the most accessible social engine framework that everyone dreams of.
  4. .. note::
  5. This is an ongoing work, please contribute on `Github <>`_ if you have some skills in this field!
  6. Resources + references
  7. ----------------------
  8. - `Official WCAG Accessibility Guidelines Overview <>`_
  9. - `Official WCAG Accessibility Guidelines <>`_
  10. - `Resources for planning and implementing for accessibility <>`_
  11. - `Practical tips from the W3C for improving accessibility <>`_
  12. - `Preliminary review of websites for accessibility <>`_
  13. - `Tools for checking the accessibility of websites <>`_
  14. - `List of practical techniques for implementing accessibility <>`_ (It would be great if someone could go through this and filter out all the ones that are relevant to Elgg)
  15. Tips for implementing accessibility
  16. -----------------------------------
  17. - All accessibility-related tickets reported to trac should be tagged with "a11y", short for "accessibility"
  18. - Use core views such as ``output/*``, and ``input/*`` to generate markup, since we can bake a11y concerns into these views
  19. - All images should have a descriptive ``alt`` attribute. Spacer or purely decorative graphics should have blank ``alt`` attributes
  20. - All ``<a>`` tags should have text or an accessible image inside. Otherwise screen readers will have to read the URL, which is a poor experience ``<a>`` tags should contain descriptive text, if possible, as opposed to generic text like "Click here"
  21. - Markup should be valid
  22. - Themes should not reset "outline" to nothing. ``:focus`` deserves a special visual treatment so that handicapped users can know where they are
  23. Tips for testing accessibility
  24. ------------------------------
  25. - Use the tools linked to from the resources section. `Example report for on June 16, 2012 <>`_
  26. - Try different font-size/zoom settings in your browser and make sure the theme remains usable
  27. - Turn off css to make sure the sequential order of the page makes sense
  28. Documentation objectives and principles
  29. ---------------------------------------
  30. - Main accessibility rules
  31. - collect and document best practices
  32. - Provide code examples
  33. - Keep the document simple and usable
  34. - Make it usable for both beginner developpers and experts (from most common and easiest changes to elaborate techniques)