Skip to main content link. Accesskey S
  • Log In
  • Help
  • IBM Logo
  • WebSphere Portal Family wiki
  • All Wikis
  • All Forums
  • Home
  • Product Documentation
  • Community Articles
  • Learning Center
  • IBM Redbooks
Community Articles Product Documentation Learning Center IBM Redbooks This category IBM Redbooks: Building a Sample Website Using IBM Web Content Manager 7.0 IBM Redbooks: Building and Implementing a Social Portal IBM Redbooks: Developing Exceptional Multi-Channel Web Experiences V7: IBM Web Content Manager Product Documentation V7: IBM WebSphere Portal Enable for z/OS Product Documentation V7: IBM WebSphere Portal Express Product Documentation V7: WebSphere Portal Product Documentation V8: IBM Web Content Manager Product Documentation V8: IBM WebSphere Portal Express Product Documentation V8: IBM WebSphere Portal Product Documentation (includes z/OS) Custom Search Scope...
Search
Community Articles > Accessibility > Developing accessible applications for IBM Web Content Manager 7.0.0.2 and 8.0
  • New Article
  • Share Show Menu▼
  • Subscribe Show Menu▼

About the Original Author

IBM contributorKerry Thompson
Contribution Summary:
  • Articles authored: 4
  • Articles edited: 0
  • Comments Posted: 3

Recent articles by this author

IBM Content Catalog V4.0

Content Template Catalog 4.0 is a complete toolkit for rapid development of IBM Web Content Manager sites on WebSphere Portal 8.0.0.1 and later, and a prescriptive approach for getting the best out of these products. Use the new Site Builder wizard to build a new site in minutes, with all of the ...

Accessibility statement

To be ready to create accessible web content and applications, the following software and skills are required.

Developing accessible applications for IBM WebSphere Portal 7.0.0.2 and 8.0

IBM WebSphere Portal 7.0.0.2 and 8.0 were developed and tested to be compliant with the Web Content Accessibility Guidelines (WCAG) 2.0. These versions of IBM WebSphere Portal neither enforce nor prevent compliance automatically. Knowing and understanding the requirements of WCAG 2.0 and ...

Developing accessible applications for IBM Web Content Manager 7.0.0.2 and 8.0

IBM Web Content Manager 7.0.0.2 and 8.0 were developed and tested to be compliant with the Web Content Accessibility Guidelines (WCAG) 2.0. These versions of IBM WebSphere Portal neither enforce nor prevent compliance automatically. Knowing and understanding the requirements of WCAG 2.0 and ...

Community articleDeveloping accessible applications for IBM Web Content Manager 7.0.0.2 and 8.0

Added by IBM contributor Kerry Thompson | Edited by IBM contributor Cali Clarke on December 10, 2012 | Version 17
  • Edit
  • More Actions Show Menu▼
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars
expanded Abstract
collapsed Abstract
IBM Web Content Manager 7.0.0.2 and 8.0 were developed and tested to be compliant with the Web Content Accessibility Guidelines (WCAG) 2.0. These versions of IBM WebSphere Portal neither enforce nor prevent compliance automatically. Knowing and understanding the requirements of WCAG 2.0 and incorporating them into your web pages, sites, and content is your responsibility. The suggestions in this article will help you understand how to create specific items in Web Content Manager presentation templates to ensure that they are accessible. IBM Web Content Manager 7.0.0.2 and 8.0 were developed and tested to be compliant with the Web Content Accessibility Guidelines (WCAG) 2.0. These versions of IBM WebSphere Portal neither enforce nor prevent compliance automatically. Knowing and understanding the requirements of WCAG 2.0 and incorporating them into your web pages, sites, and content is your responsibility. The suggestions in this article will help you understand how to create specific items in Web Content Manager presentation templates to ensure that they are accessible.
Tags: accessibility, A11y, compliance, CLF2, developing, Portal, web content, WCAG 2.0, Web Site Development, wcm, accessible
ShowTable of Contents
HideTable of Contents
  • 1 Understanding the four principles of accessibility
  • 2 About Web Content Manager templates
  • 3 Summary
  • 4 References

IBM® Web Content Manager 7.0.0.2 and 8.0 were developed and tested to be compliant with the Web Content Accessibility Guidelines (WCAG) 2.0. These versions of IBM WebSphere® Portal neither enforce nor prevent compliance automatically. Knowing and understanding the requirements of WCAG 2.0 and incorporating them into your web pages, sites, and content is your responsibility. The suggestions in this article will help you understand how to create specific items in Web Content Manager presentation templates to ensure that they are accessible.

Prerequisites for authoring accessible content

Understanding the four principles of accessibility


A web site that is compliant with WCAG 2.0 meets these standards of accessibility:

It is perceivable.
To be perceivable, a web application must provide content and a user interface that allows assistive technology to find the necessary components and present them to the user. Providing text alternatives for images is one example of a perceivable component.
It is operable.
An operable application can be run entirely from a keyboard, allows time-based and moving components to be paused or stopped, minimizes flashing elements, and provides easy ways for users to navigate through content and find their place.
It is understandable.
An application is understandable if it provides ways for assistive technology to interpret the content in the native language, including any specialized terms. It also provides help for using the application and in recovering from errors. An understandable application also behaves consistently on similar pages, doesn't change the context without warning, and labels items in the same way throughout.
It is robust.
A robust application is coded in a way that the tagging, naming, and properties for all components can be determined programmatically.

IBM Web Content Manager 7.0.0.2 and 8.0 content can be Level A or Level AA accessible, depending on the design choices you make. Level A is the minimum level of compliance. Level AA is a more rigorous level of compliance.

About Web Content Manager templates


Web Content Manager is an application that makes it easy to develop and maintain websites. Two types of templates ensure consistency within a web site. Authoring templates provides the authoring interface for content authors and specifies the metadata fields that content authors populate. The Presentation templates determine how the authoring template fields are represented in markup. Web Content Manager also allows you to ensure a consistent design across one or more web sites by providing reusable components that contain markup fragments. These fragments are pulled from one or more presentation templates to produce the final markup for a web page. This article discusses how to build components in presentation templates that comply with WCAG 2.0 Level A and Level AA.

To create an accessible web site, keep the WCAG 2.0 guidelines in mind as you create these individual items:
Image element
Link element
File resource element
Presentation template
HTML element
Menu element
Navigation element

Image element


Guideline:
1.1 Provide text alternatives for any non-text content so that it can be changed into other forms people need, such as large print, braille, speech, symbols or simpler language.

Technique:
When adding simple images to the web site, the component has the ability to add  alt and title tag attributes. With more complex accessibility standards, you may want to add attributes like long description or set the focus on the image through the keyboard. Follow these four steps to achieve the highest accessibility standards for images.

1. From the presentation template, use the tag helper to add a reference to an image component. The image component tag looks like this:

[Component id="1525e92f-3902-495f-957c-201c4bb49f25:NC93ZWIgY29udGVudC9pbWFnZXJlbmFtZQ==" name="web content/imagerename"]


This code renders the image with a title and alternative text.

2. Modify the tag to include format=”url”:

Component id="1525e92f-3902-495f-957c-201c4bb49f25:NC93ZWIgY29udGVudC9pbWFnZXJlbmFtZQ==" name="web content/imagerename" format="url"] 

This addition generates the URL to the image (imageURL). You will modify the URL in Step 4.

3. Add the HTML code for the image tag with the attribute you require:

<img title="my title" alt="my alternative text" src="imageURL" name="web content/imagerename" format="url"]" tabindex="0">


4. Replace the imageURL generated in step 2. The final result looks like this:

<img tabindex="0" longdesc=”URL” title="my title" alt="my alternative text" src="[Component id="1525e92f-3902-495f-957c-201c4bb49f25:NC93ZWIgY29udGVudC9pbWFnZXJlbmFtZQ==" name="web content/imagerename" format="url"]" >


You now have an image that keyboard navigation can focus on and that has a long description. You can use this method to add WAI-ARIA attributes if required.

Link element


Guideline:  
2.4 Provide ways to help users navigate, find content, and determine where they are.

Technique:
You can add more attributes to the link component or enable WAI-ARIA in the same way you modify image components.

1. From the presentation template, use the tag helper to add a reference to a link component. The link component tag looks like this:

[Component id="1305cc58-e984-4c3d-8800-98b2bb48da6b:NC93ZWIgY29udGVudC91cmwgLSBpYm0=" name="web content/url - ibm"]


2. Modify the tag to include format=”url”:
[Component id="1305cc58-e984-4c3d-8800-98b2bb48da6b:NC93ZWIgY29udGVudC91cmwgLSBpYm0=" name="web content/url - ibm" format="url"] 


This addition generates the URL to the image (url). You will modify this URL in Step 4.

3. Add the href tag with the attribute you require:

<a title="click here to go to the IBM website" href="url" >Go to the IBM website</a>


4. Replace the url generated in step 2. The final result looks like this:

<a title="click here to go to the IBM website" href="[Component id="1305cc58-e984-4c3d-8800-98b2bb48da6b" name="Web Content/URL - IBM" format="url"]" >Go to the IBM website</a>


You can use this technique to add any other attribute you need for the link element.

File resource element


Guideline:  
2.4 Provide ways to help users navigate, find content, and determine where they are.     

Technique:
You can use the same four-step method for adding attributes to the file resource element as you did for the image and link elements. The final tag looks like this:
<a href="[Component id="120c170a-6cab-4469-a8b7-6b011839e850:NC93ZWIgY29udGVudC9maWxlIHJlc291cmNlIGVsZW1lbnQgLSBsb25nIGRlc2NyaXB0aW9u" name="web content/file resource element - long description" format="url"]" title="Click here to download the brochure">Click here to download the brochure </a>

    

Presentation template


Guideline:  
2.4 Provide ways to help users navigate, find content, and determine where they are.

Technique:
The presentation template is the most important component because it produces the final markup for a web page. Web Content Manager administrators or site designers are responsible for providing the proper markup when using presentation templates that make the site accessible.

The following example shows basic mark-up code to help you get started implementing techniques to make your site accessible.

<!DOCTYPE html>

	<html>

	<body>

	   

	     <div role="banner">

	     The banner area

	     </div>

	

	     <div role="search">

	     The search area

	     </div>

	

	     <div role="navigation">

	     The navigation area

	     </div>

	

	     <div role="main">

	     The main content area

	     </div>

	

	     <div role="contentinfo">

	     The content info area

	     </div>

	

	</body>

	</html


HTML element


Guideline:
3.2 Make Web pages appear and operate in predictable ways.
    
Technique:
You can use the HTML element to create reusable components for the website that contain markup fragments. Web Content Manager administrators or site designers are responsible for providing the proper markup when using HTML elements that make the site accessible.


Menu element


Guideline:
4.1 Maximize compatibility with current and future user agents, including assistive technologies.

Technique:
Web Content Manager administrators or site designers are responsible for providing the proper markup for a menu element. The following example shows markup code that includes some basic WAI-ARIA roles to enhance accessibility.
    
Header: <ul role="menu"><li role="menuitem">

	Separator: </li><li role="menuitem">

	Footer: </li></ul>

	Navigator result design 1:[Property context="autofill" type="content" field="title"]

    

Navigation element


Guideline:
4.1 Maximize compatibility with current and future user agents, including assistive technologies.

Technique:
Web Content Manager administrators or site designers are responsible for providing the proper markup for a navigation element. The following example shows markup code that includes some basic WAI-ARIA roles to enhance accessibility.
    
 
Header: <ul role="menu">

	 Separator: <li role="menuitem">

	 Footer: </li></ul>

	 Navigator result design 1:[Property context="autofill" type="content" field="title"]

    

Summary


Web Content Manager has many reusable design elements that allow you to give users accessible web sites and pages. Becoming familiar with the WCAG 2.0 and WAI-ARI specifications can be very useful in developing your own accessible web sites.

References


Web Content Accessibility Guidelines 2.0external link

W3C WAI-ARIA documentationexternal link

W3C Roadmap for Accessible Rich Internet Applicationsexternal link

W3C WAI-ARIA Authoring Practicesexternal link

DOJO Accessibility Design Requirementsexternal link

IBM Web Content Manager 8 Product Documentationexternal link

IBM Web Content Manager 7 Product Documentationexternal link

Developing an Exceptional Web Experienceexternal link


  • Edit
  • More Actions Show Menu▼


expanded Attachments (0)
collapsed Attachments (0)
Edit the article to add or modify attachments.
expanded Versions (17)
collapsed Versions (17)
Version Comparison     
VersionDateChanged by              Summary of changes
This version (17)Dec 10, 2012 9:49:04 AMCali Clarke  IBM contributor
16Jun 12, 2012 4:58:49 PMAmanda J Bauman  IBM contributor
15Jun 12, 2012 4:57:59 PMAmanda J Bauman  IBM contributor
14Jun 12, 2012 4:57:26 PMAmanda J Bauman  IBM contributor
13Jun 12, 2012 4:11:14 PMKerry Thompson  IBM contributortypo
12May 30, 2012 2:50:42 PMKerry Thompson  IBM contributortrying to fix word-wrap problem
11May 30, 2012 2:49:03 PMKerry Thompson  IBM contributortrying to fix word-wrap problem
10May 30, 2012 1:03:41 PMKerry Thompson  IBM contributortrying to fix word wrap problem
9May 23, 2012 11:40:45 AMKerry Thompson  IBM contributorjust cleaning up formatting in these early versions
8May 23, 2012 11:38:38 AMKerry Thompson  IBM contributor
7May 23, 2012 11:36:34 AMKerry Thompson  IBM contributor
6May 23, 2012 11:36:30 AMKerry Thompson  IBM contributor
5May 23, 2012 11:36:01 AMKerry Thompson  IBM contributor
4May 23, 2012 11:33:46 AMKerry Thompson  IBM contributor
3May 22, 2012 3:30:37 PMKerry Thompson  IBM contributor
1May 22, 2012 2:14:56 PMKerry Thompson  IBM contributor
1May 22, 2012 2:15:38 PMKerry Thompson  IBM contributorMinor Change
expanded Comments (0)
collapsed Comments (0)
Copy and paste this wiki markup to link to this article from another article in this wiki.
Go ElsewhereStay ConnectedHelpAbout
  • IBM Collaboration Solutions wikis
  • IBM developerWorks
  • IBM Software support
  • Twitter LinkIBMSocialBizUX on Twitter
  • FacebookIBMSocialBizUX on Facebook
  • ForumsLotus product forums
  • BlogsIBM Social Business UX blog
  • Community LinkIBM Collaboration Solutions
  • Wiki Help
  • Forgot user name/password
  • Wiki design feedback
  • Content feedback
  • About the wiki
  • About IBM
  • Privacy
  • Accessibility
  • IBM Terms of use
  • Wiki terms of use