Re: Update PHPT details page.
| From: | zoe | Date: | Wed, 06 May 2009 08:43:22 +0000 |
| Subject: | Re: Update PHPT details page. | ||
| References: | 1 | Groups: | php.qa |
| Request: | Send a blank email to php-qa+get-64873@lists.php.net to get a copy of this message | ||
Eric Stewart wrote:
I've recently completed some documentation on the PHPT file layout. This is somewhat similar to http://qa.php.net/phpt_details.php in that it lists sections available for use in PHPT files. But this new document includes sections not covered and it includes much more information such as: description, whether it's a required section, requirements for the section, which test scripts support the section, format, sample snippets of the section in use and full test samples backing the sample snippets. I originally wrote this in preparation for the Atlanta TestFest event. Zoe has asked if I would consider converting this document for use as a replacement for the current PHPT details page on the QA site. I agree with him as I wrote this out of a necessity for better documentation and I think it best serves the community by becoming apart of the QA site rather than a link or article off my site. But I'm not one to make unilateral decisions in regards to any of my actions within the PHP community. So I now bring this to the attention of the QA team and ask for your approval. Here is a link to a zip file containing a text version of the document (Test File Layout.txt). It also includes the sample tests for which I used to generate the snippets. If approved, the details page will include links to the sample_tests. These sample tests will be new PHP pages created and stored within a sample_tests folder on the QA site. They will include the QA headers and footers and a link back to the referring details page. http://www.ericstewart.org/public/20090503/PHPT.zip Your "yes" or "no" vote and any feedback will be greatly appreciated. Eric has done the work to integrate this with the existing QA pages, I've put a pre-view here http://www.zapt.info/phpt/qaweb/phpt_details.php, the fact that the formatting isn't quite right is my fault not Eric's, it does display correctly when integrated properly into the QA pages. I think this is a significant improvement to the existing text.I would like to propose that Eric's karma (originally obtained as part of last year's TestFest) is extended to include qaweb, if there are no -1 votes for this over the next 24 hours I will ask Derick to extend Eric's karma. Zoe