Code Monkey home page Code Monkey logo

wai-tutorials's Introduction

W3C WAI Tutorials

Netlify Status

Publication branch

The branch deployed to the website is the publication branch. More info on requesting deploys is in Updating WAI Website Resources

Translation Notes

Tutorials resources use a dynamic footer, using specific metadata set in the "front matter" of each page.

Example:

metafooter: true
editors:
  - Eric Eggert: "https://www.w3.org/People/yatil/"
  - Shadi Abou-Zahra: "https://www.w3.org/People/shadi/"
update_editors:
  - Brian Elton
contributing_participants:
  - see <a href="/WAI/tutorials/acknowledgements/">Acknowledgements</a>
support: Developed by the Education and Outreach Working Group (<a href="https://www.w3.org/groups/wg/eowg">EOWG</a>). Developed with support from the <a href="https://www.w3.org/WAI/ACT/">WAI-ACT project</a>, co-funded by the <strong>European Commission <abbr title="Information Society Technologies">IST</abbr> Programme</strong>.
  1. Translate content in editors, update_editors, contributing_participants and support.
    Note: Translate the Working Group name and leave the Working Group acronym in English.
  2. Add translations for the following terms, used by the footer, in translations.yml file located in wai-website-data repository:
  • "Editors:"
  • "Update Editor:"
  • "Status"
  • "Updated"
  • "first published"

wai-tutorials's People

Contributors

alexejrotar avatar amyrlam avatar anne-victoria avatar bappyasif avatar brianelton avatar bruce-usab avatar edwardball avatar hiroya-uga avatar hwahyeon avatar iadawn avatar me-shawna avatar mikewink avatar remibetin avatar shawna-slh avatar shawnthompson avatar shizukuichi avatar smndhm avatar stevealee avatar timkraut avatar yatil avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

wai-tutorials's Issues

Wrong navigation heading

Images Concepts Tutorial:

instead of

Images Tutorial:

because I renamed the page the title is derived from

Add note on who should provide alt text

Andrew:

Priority: strong for editor's discretion
Location: concepts and/or tips page
suggestion: emphasis that the document author is best placed to provide the alt text as they know why they included a particular image (rather than the person who might be publishing the information on the web)

Images concepts page "needs to" or "should"?

Most of the bullets say "needs to" and some say "should". Is that a deliberate distinction? If not, I think the same wording should be (or needs to be ;-) used for all of them.

Tables Concepts page intro too scarey/advanced?

Page: Tables Concepts https://w3c.github.io/wai-tutorials/tables/
Location: opening paragraph "Data tables need structural markup to distinguish between header and data cells and define the relationships between them...."

Is the opening too sentence scarey for newbies? At the end of the page we say "Many web authoring tools and content management systems (CMS) provide functions to define header cells during table creation without having to manually edit the code." -- Does that need to be communicated earlier?

Is the audience primarily people who will be doing markup, or not?

Provide more specific examples

OVERALL: Use the examples to provide specific examples to explain points. For example, in Irregular Tables, first example: "The scope value row is used on each cell to ensure that it cannot be mistaken as a header for other cells in the same column." -> "The scope value row is used on each cell to ensure that it cannot be mistaken as a header for other cells in the same column -- for example, in the example table below, Belgium should not be mistaken as the heading for France, Holland, etc."

Table Concepts images of tables

Page: Tables Concepts https://w3c.github.io/wai-tutorials/tables/
Location: pages list at the top (Simple tables... Caption & Summary)
Issues: 1. bullets, 2, number of table images:

  1. Bullets. I found it much easier to read with the normal bullets (like on https://w3c.github.io/wai-tutorials/images/ ) and the images underneath. I think having the table images first decreases readability. (also, would be better with hanging indents)
  2. Images. I envisioned having more than one image under each type - since they cover multiple types of tables...

"Ambiguous Tables"

Really dislike the name. Maybe "multi-directional tables"? Or "unstructured tables"?

Trebuchet font not displaying en dashes correctly

(This is not urgent and much more FYI.)

The en dash in the Trebuchet MS font is nearly indistinguishable from the hyphen, see:
en dash and hyphen are about the same width, the hyphen is slightly fatter

Here is the same example in Fira Sans:
The hyphen is much shorter than the en dash

And here in Arial:
hyphen much shorter than the en dash as well

As using an en dash implies meaning, we should think of using another font in the future.

/cc @slhenry

Wording: First Sentence

Shadi:

current wording: "Every image should have a text alternative that provides an equivalent alternative by describing the information or function represented in the image"
suggested revision: "Every image should have a text alternative that describes the information or function represented in the image"

Link to Irregular->First Example from simple tables

  • "if your table doesn't have a column header row, go to Irregular tables Example 1"
  • ”Due to how some assistive technology works, it is needed to use the scope attribute if there is only one columns of headers.“ —> Link

Tables Concepts page too scarey/advanced?

Page: Tables Concepts https://w3c.github.io/wai-tutorials/tables/
Location: opening paragraph "Data tables need structural markup to distinguish between header and data cells and define the relationships between them...."

Is the opening too sentence scarey for newbies? At the end of the page we say "Many web authoring tools and content management systems (CMS) provide functions to define header cells during table creation without having to manually edit the code." -- Does that need to be communicated earlier?

Is the audience primarily people who will be doing markup, or not?

Irregular page: Example 3: Text enhancements

Irregular page: Example 3 "Table with headers spanning multiple rows or columns". "In this example, some of the row header cells span two or more rows of data cells and one column header spans three columns." -> "In this example, some of the header cells span multiple rows or columns; for example, the Zodiac row header spans 3 rows, and the Sizes available column header spans 3 columns."

"In the table below, some of the header cells span multiple rows or columns; for example, the Zodiac row header spans 3 rows, and the Sizes available column header spans 3 columns."

Multi-Level, remove (new window) text

MINOR: In multi-level page, I'm seeing "Full code for Example 1: Table with multiple column headers in each column (new window)" - missing image? also, that's not on the other pages.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.