Pchtmlcheck

From ProgClub
Revision as of 03:24, 15 June 2014 by John (talk | contribs) (Notes for developers: Notes about public URLs.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Pchtmlcheck is the ProgClub HTML validator software. That's the software that allows you to verify HTML content is valid. For other projects see projects.

Status

Version 0.1 released!

Administration

Contributors

Members who have contributed to this project. Newest on top.

All contributors have agreed to the terms of the Contributor License Agreement. This excludes any upstream contributors who tend to have different administrative frameworks.

Copyright

Copyright 2014, Contributors.

License

Licensed under the New BSD license.

Resources

Downloads

You can download v0.1.

Source code

The repository can be browsed online:

https://www.progclub.org/pcrepo/pchtmlcheck/branches/0.1

The latest stable released version of the code is available from:

https://www.progclub.org/svn/pcrepo/pchtmlcheck/tags/latest/0.1

Or if you want the latest versions for development purposes:

https://www.progclub.org/svn/pcrepo/pchtmlcheck/branches

Links

Specifications

Functional specification

The functional specification describes what the project does.

The project takes a HTML snippet and then uses the w3.org validator to verify the validity of the HTML content.

Technical specification

The technical specification describes how the project works.

There is a frame-set page which loads a form in the top frame for specifying and submitting HTML snippets and then a report on the HTML snippet from the W3C Validator in the bottom frame after submission.

Notes

Notes for implementers

If you are interested in incorporating this software into your project, here's what you need to know:

You need to copy config-example.php to config.php then specify a 'WORKSPACE', being a directory the software can cache HTML snippets in and specify 'SHOW' which is the public URL to the web/show.php file.

Notes for developers

If you're looking to set up a development environment for this project here's what you need to know:

Get the software versions by checking out https://www.progclub.org/svn/pcrepo/pchtmlcheck/branches and configure per directions above for implementers.

Note: the URL specified in your 'SHOW' setting will need to be a public web URL -- you can't validate HTML that can't be reached by validator.w3.org. (If someone wanted to fix that, it's totally possible and would be rather cool...)

Tasks

TODO

Things to do, in rough order of priority:

N/A -- all done!

Done

Stuff that's done. Latest stuff on top.

  • JE 2014-06-15: released a 0.1 version
  • JE 2014-06-15: created project in svn
  • JE 2014-06-15: created project page