(create some documentation for the template) |
(document this ball o' wax) |
||
| Line 1: | Line 1: | ||
This template is designed to be '''substituted''' to create [[QA:Release_validation_test_plan|validation testing]] result pages. It '''transcludes''' the [[Template:Release_validation_instructions]] template with parameter values that should be passed in at the point of creating a new results page, and '''substitutes'' the appropriate [[:Category:QA_test_matrix_templates|test matrix template]] for the test type it was passed. | This template is designed to be '''substituted''' to create [[QA:Release_validation_test_plan|validation testing]] result pages. It '''transcludes''' the [[Template:Release_validation_instructions]] template with parameter values that should be passed in at the point of creating a new results page, and '''substitutes''' the appropriate [[:Category:QA_test_matrix_templates|test matrix template]] for the test type it was passed. | ||
It does some semi-clever mucking about with parameters to produce a nice clean result. Please don't mess about with it unless you understand how it works; the Mediawiki [https://www.mediawiki.org/wiki/Transclusion Transclusion] and [https://en.wikipedia.org/wiki/Wikipedia:Substitution Substitution] pages are a good starting point. Please contact [[User:Adamwill|Adam Williamson]] before touching this page if you are at all unsure what you're doing. '''Using''' it to generate new results pages is just fine, though - see below. | It does some semi-clever mucking about with parameters to produce a nice clean result. Please don't mess about with it unless you understand how it works; the Mediawiki [https://www.mediawiki.org/wiki/Transclusion Transclusion] and [https://en.wikipedia.org/wiki/Wikipedia:Substitution Substitution] pages are a good starting point. Please contact [[User:Adamwill|Adam Williamson]] before touching this page if you are at all unsure what you're doing. '''Using''' it to generate new results pages is just fine, though - see below. | ||
Usage: <code><nowiki>{{subst:Validation_results|testtype=Base|release=21|milestone=Beta|compose=RC3}}</nowiki></code>, for example, as the entire contents of a new page, would generate the Base validation results page for Fedora 21 Beta RC3. | Usage: <code><nowiki>{{subst:Validation_results|testtype=Base|release=21|milestone=Beta|compose=RC3}}</nowiki></code>, for example, as the entire contents of a new page, would generate the Base validation results page for Fedora 21 Beta RC3. | ||
Revision as of 01:17, 23 September 2014
This template is designed to be substituted to create validation testing result pages. It transcludes the Template:Release_validation_instructions template with parameter values that should be passed in at the point of creating a new results page, and substitutes the appropriate test matrix template for the test type it was passed.
It does some semi-clever mucking about with parameters to produce a nice clean result. Please don't mess about with it unless you understand how it works; the Mediawiki Transclusion and Substitution pages are a good starting point. Please contact Adam Williamson before touching this page if you are at all unsure what you're doing. Using it to generate new results pages is just fine, though - see below.
Usage: {{subst:Validation_results|testtype=Base|release=21|milestone=Beta|compose=RC3}}, for example, as the entire contents of a new page, would generate the Base validation results page for Fedora 21 Beta RC3.