(explain the onlyinclude trick) |
(mark as a wikitcms core page, tweak the contact info for raptor/bus factor) |
||
| Line 1: | Line 1: | ||
{{Wikitcms_core}} | |||
This template is designed to be '''substituted''' to create [[QA:Release_validation_test_plan|validation testing]] result pages. It will cause the page that substitutes it to '''transclude''' the [[Template:Release_validation_instructions]] template with parameter values that should be passed in at the point of creating a new results page, and '''substitute''' the appropriate [[:Category:QA_test_matrix_templates|test matrix template]] for the test type it was passed. Do not transclude this page! Always substitute it! | This template is designed to be '''substituted''' to create [[QA:Release_validation_test_plan|validation testing]] result pages. It will cause the page that substitutes it to '''transclude''' the [[Template:Release_validation_instructions]] template with parameter values that should be passed in at the point of creating a new results page, and '''substitute''' the appropriate [[:Category:QA_test_matrix_templates|test matrix template]] for the test type it was passed. Do not transclude this page! Always substitute it! | ||
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. | ||
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 Substitution pages are a good starting point. Please contact [[ | 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 Substitution pages are a good starting point. Please contact [[QA]] before touching this page if you are at all unsure what you're doing ([[User:Adamwill|Adam Williamson]] is the original designer of this system). '''Using''' it to generate new results pages is just fine, though - see above. | ||
The weird (only(includeonly)(/includeonly)include) blocks are a trick used to get (onlyinclude) and (/onlyinclude) tags into the actual result pages when they're generated - the empty "includeonly" blocks ''and the tags themselves'' drop out on substitution, leaving the 'complete' onlyinclude tags in the substituting page, where they'll be respected when '''that''' page itself is included in another. This is used for the Results Summary pages, so that when they transclude the individual result pages, only the result tables are shown, not the surrounding explanatory text. | The weird (only(includeonly)(/includeonly)include) blocks are a trick used to get (onlyinclude) and (/onlyinclude) tags into the actual result pages when they're generated - the empty "includeonly" blocks ''and the tags themselves'' drop out on substitution, leaving the 'complete' onlyinclude tags in the substituting page, where they'll be respected when '''that''' page itself is included in another. This is used for the Results Summary pages, so that when they transclude the individual result pages, only the result tables are shown, not the surrounding explanatory text. | ||
Revision as of 23:10, 21 January 2015
This page is a core component of the Wikitcms system for storing release validation testing results in the Fedora wiki. This system relies on specific expectations regarding page naming, contents, and categorization. Please take special care when editing this page, especially if you change any element of wiki syntax, especially templating elements. If you are at all unsure about the consequences of your planned change, please contact the QA group before applying it.
This template is designed to be substituted to create validation testing result pages. It will cause the page that substitutes it to transclude the Template:Release_validation_instructions template with parameter values that should be passed in at the point of creating a new results page, and substitute the appropriate test matrix template for the test type it was passed. Do not transclude this page! Always substitute it!
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.
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 QA before touching this page if you are at all unsure what you're doing (Adam Williamson is the original designer of this system). Using it to generate new results pages is just fine, though - see above.
The weird (only(includeonly)(/includeonly)include) blocks are a trick used to get (onlyinclude) and (/onlyinclude) tags into the actual result pages when they're generated - the empty "includeonly" blocks and the tags themselves drop out on substitution, leaving the 'complete' onlyinclude tags in the substituting page, where they'll be respected when that page itself is included in another. This is used for the Results Summary pages, so that when they transclude the individual result pages, only the result tables are shown, not the surrounding explanatory text.