Bug 148110 - [UI] Accessibility errors in PDE user doc
Summary: [UI] Accessibility errors in PDE user doc
Status: RESOLVED INVALID
Alias: None
Product: PDE
Classification: Eclipse Project
Component: Doc (show other bugs)
Version: 3.2   Edit
Hardware: PC Windows 2000
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: PDE-Doc-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: accessibility
Depends on:
Blocks:
 
Reported: 2006-06-21 16:13 EDT by Karice McIntyre CLA
Modified: 2009-05-12 14:38 EDT (History)
2 users (show)

See Also:


Attachments
zip of generated reports (1.59 KB, application/zip)
2006-06-21 16:15 EDT, Karice McIntyre CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Karice McIntyre CLA 2006-06-21 16:13:44 EDT
I used a software tool to run accessibility checks of the content in the <> Doc and found some problems.  I will attach the reports, with a list of the problems sorted by severity (most severe first).  Each problem lists the file, line number, severity and error.

Please have a look at the reports and act as follows:
1. Fix problems with severity SV(severe violation) and V(violation) first.  
2. Investigate whether problems marked with severity PSV(possible severe violation) and PV(possible violation) are truly problems and fix as required.
3. Optionally correct problems marked with severity I(informational); often these are deprecations.

Some of the errors in the /reference files of the step1-report appear to be due to the javadoc generator so you can ignore these ones.  I will be logging a bug against JDT for this.

The error in the step4-report file is severe - should try to fix this one asap.
Comment 1 Karice McIntyre CLA 2006-06-21 16:15:43 EDT
Created attachment 45038 [details]
zip of generated reports 

These reports list the file name, describe the error and report the line number on which the error exists.
Comment 2 Karice McIntyre CLA 2006-06-22 11:26:00 EDT
After looking more closely at the errors that are reported, I would say that fixing the errors marked SV (severe) in the step1-report (there are none for PDE) and all errors in the step4-report are the most important to fix.  The rest I will leave up to you to make a call on.
Comment 3 Mike Pawlowski CLA 2007-06-14 13:15:27 EDT
Hi Karice,

Thanks for the report, it is something we should look into.
However, a lot of the PDE Guide documentation has been changed or rewritten.
Would it be possible to get a copy of the software tool you are using to run the accessibility checks? (without making the IBM legal gods angry ;) ).


Comment 4 Karice McIntyre CLA 2007-06-14 15:07:35 EDT
Tod is now your accessibility contact (I have since changed roles).  I will provide him with the info.  
Comment 5 Curtis Windatt CLA 2008-11-17 10:30:49 EST
Pinging Karice, do you know who the current accessibility contact is?  I don't think it is Tod currently.

PDE has rewritten a lot of the doc to make it more consistent with the rest of the Eclipse platform.  It would be nice to run an accessibility tool to see what is still a problem.  Otherwise we should close this bug.
Comment 6 Curtis Windatt CLA 2009-05-12 14:38:26 EDT
The guide has changed too much for the information on this bug to be valid.