Note: You are currently viewing documentation for Moodle 1.9. Up-to-date documentation for the latest stable version is available here: Student projects/Automatic accessibility checking.

Student projects/Automatic accessibility checking: Difference between revisions

From MoodleDocs
No edit summary
No edit summary
 
(44 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<p class="note">'''Note''': This page outlines ideas for the Automatic accessibility checking project. It's a ''specification under construction''! If you have any comments or suggestions, please add them to the [[Talk:Student projects/Automatic accessibility checking|page comments]].''</p>
__NOTOC__


'''This project was an original [[GSOC/2008#Automatic_accessibility_checking|GSoC 2008]] project, but it was cancelled because the student failed to deliver sufficient code.'''


The objective of this project is to make a tool that can check Moodle´s accessibility automatically before realising a version.
<p class="note">This page is a ''specification under construction''! If you have any comments or suggestions, please [[Talk:Student projects/Automatic accessibility checking|share them with us]].''</p>


'''Project Outline:'''
__TOC__
Create a button that will pull the source and submit it to a validation service. The errors and warnings will be pulled back to the page, and displayed in a simple GUI. This will be accomplished by AJAX.
==Original Idea==
<p>This tool is used to make validating Moodle pages on the fly. It is a one click system on the client that takes the html source of the current page and submits it to W3C for validation. It then returns the errors and warnings in a simple GUI for easy reading and fixing.</p>


===JavaScript Version===
* Multi-browser support
* Handling html source code in a JavaScript variable. (addslashes would be something to look into for JavaScript)


'''Abstract flow:'''
===PHP Version===
*Send Request
* Ajax calls conflict when given the correct state. ''Reproduce - unknown''
**Get Source
***Die (If unable to grab source)
**Submit Source
***Die (If unable to communicate with the validation server)
**Retrieve Errors
***Die (If unable to read errors)
**Display Errors


==Tasks==
'''ToDo'''
* Make an experimental option in Moodle Admin to activate/deactivate
* Ability to include on every page


'''UML Diagram:'''
'''Done'''
*Version 1
* Research
**[http://www.closethatdoor.com/moodle/uml_dia.png Image PNG]
** What is the maximum length of a POST with multipart/form-data? ''8M post data, and 2M upload data.''
----
* Core Development
 
** UML
 
*** UML version 1
'''GUI:'''
** PoC
*Version 1
*** PoC in Javascript of how to use a concrete SOAP library
**[http://www.closethatdoor.com/not_valid.png Image PNG]
*** Javascript Skeleton Version 1 (directly to the recycle bin)
----
*** PoC in Javascript on how to take the whole source code of the current HTML.
 
*** PoC in PHP of W3C SOAP API Version 2: uploaded_file method. The document to validate, POSTed as multipart/form-data.
 
**** Fix browser capability for the PoC in Javascript (Get complete source) Tested in IE 7, Firefox 2, Firefox 3 on a Windows XP Pro, still looking for a user with Mac osX.
'''Code:'''
*** PoC in JAvascript on how to take the whole source code of the current HTML from an external javascript file.
*Version 1
*** PoC in PHP of W3C SOAP API Version 1: URI method
**[http://www.closethatdoor.com/moodle/moodle_func_js.zip Javascript ZIP]
* GUI
----
** Draw version 1
 
** GUI version 2
 
'''Future Extensions:'''
Create code so it is easy to edit and create extensions on to it. The GUI will be easily updated to include future options.


==See also==
==See also==
 
*Bug Tracker: MDL-15589
*[[GSOC/2008]]
*[[GSOC/2008]]
*[http://code.google.com/soc/2008/moodle/appinfo.html?csaid=33AE1548BF81E3CF Automatic accessibility checking application abstract]  
*[http://code.google.com/soc/2008/moodle/appinfo.html?csaid=33AE1548BF81E3CF Automatic accessibility checking application abstract]  

Latest revision as of 16:13, 17 December 2008


This project was an original GSoC 2008 project, but it was cancelled because the student failed to deliver sufficient code.

This page is a specification under construction! If you have any comments or suggestions, please share them with us.

Original Idea

This tool is used to make validating Moodle pages on the fly. It is a one click system on the client that takes the html source of the current page and submits it to W3C for validation. It then returns the errors and warnings in a simple GUI for easy reading and fixing.

JavaScript Version

  • Multi-browser support
  • Handling html source code in a JavaScript variable. (addslashes would be something to look into for JavaScript)

PHP Version

  • Ajax calls conflict when given the correct state. Reproduce - unknown

Tasks

ToDo

  • Make an experimental option in Moodle Admin to activate/deactivate
  • Ability to include on every page

Done

  • Research
    • What is the maximum length of a POST with multipart/form-data? 8M post data, and 2M upload data.
  • Core Development
    • UML
      • UML version 1
    • PoC
      • PoC in Javascript of how to use a concrete SOAP library
      • Javascript Skeleton Version 1 (directly to the recycle bin)
      • PoC in Javascript on how to take the whole source code of the current HTML.
      • PoC in PHP of W3C SOAP API Version 2: uploaded_file method. The document to validate, POSTed as multipart/form-data.
        • Fix browser capability for the PoC in Javascript (Get complete source) Tested in IE 7, Firefox 2, Firefox 3 on a Windows XP Pro, still looking for a user with Mac osX.
      • PoC in JAvascript on how to take the whole source code of the current HTML from an external javascript file.
      • PoC in PHP of W3C SOAP API Version 1: URI method
  • GUI
    • Draw version 1
    • GUI version 2

See also

Retrieved from "https://docs.moodle.org/19/en/index.php?title=Student_projects/Automatic_accessibility_checking&oldid=48255"
Powered by MediaWiki