#6 Update documentation & website

[Paul Walker]

The documentation and website could do with a little updating - for example, they make reference to the old forum rather than the new discussion lists and ticket trackers. While we're in here, we might as well take the opportunity to tidy up the HTML so it passes the W3C validator

[Paul Walker]

I'm making progress updating the documentation so it validates as XHTML 1.0 Strict - I'll start doing commits into an SVN branch shortly...

[Paul Walker]

The attached patch file updates all the src documentation files to XHTML 1.0 Strict.

This has been commited to the SVN branch in [r129]

[Paul Walker]

The attached patch file tidies up a couple of <pre> code blocks

This has been commited to the SVN branch in [r130]

[Paul Walker]

The attached patch file modifies the build_docs script so the output is valid XHTML 1.0 Strict.

This has been committed to the SVN branch in [r131]

[Paul Walker]

The attached patch file updates the main website page index.html to be valid XHTML 1.0 Strict.

This has been committed to the SVN branch in [r134]

[Paul Walker]

The attached patch file updates content of the main website page index.html. No significant changes, just bringing it up to date.

Committed to the SVN development branch in [r135]

[Paul Walker]

Updated some of the content in the dev branch in [r136]. No major changes, just bringing it up to date

[Paul Walker]

Added a new file to maintain the copyright years for the documentation [r137]. This will allow it to be maintained more accurately, rather than just "2000 - [year it was last built]". (The years in copyright notices are supposed to be the years the work was published with a significant change, a range should only be used if it was published every year in that range)

[Paul Walker]

Updated the instructions for writing documentation [r138]

[Paul Walker]

Fixed a bug introduced in the dev branch in [r127] which meant the navigation bar in the documentation was lost (fixed in [r139])

[Paul Walker]

The clean_html functionality in the build_docs script was stripping out
tags and table styling attributes. Since they get removed, there's no point them being in the source, so I've removed them to avoid confusion [r141]

[Paul Walker]

Some upper-case attributes in the build_docs scripts were making the resultant XHTML invalid. Fixed in [r142]

[Paul Walker]

Fixed another couple of issues that meant the build_docs script wasn;t building valid XHTML [r143]

[Paul Walker]

Since all the source documentation files are now clean and valid XHTML, there's no need to do extra cleaning in the build-docs script. Therefore it has been removed in [r144]

[Paul Walker]

There were two copies of the built documentation in the project source - one in \documentation and one in \website\Doc. To remove this duplication (and storing "built" files in SVN), I've removed the files from \website\Doc and modified the build_docs.pl script so it builds the files to both locations. [r145]

[Paul Walker]

OK, so I think we're done on this. I've just merged it into my working copy of trunk. I'll do another check to make sure it all looks OK and is valid XHTML, then will commit it.

[Paul Walker]

Merged into the trunk in [r146]

[Paul Walker]

Forgot to exclude all the built files from SVN, so fixed that in the branch with [r147] and merged into trunk in [r148]

[Paul Walker]

Now this ticket is essentially complete and in the trunk, the branch has been deleted in [r149]