Template:Media table: Difference between revisions
From the Super Mario Wiki, the Mario encyclopedia
Jump to navigationJump to search
m (Sorry for so many edits. I found so many redundancies and ways to improve the usage sections.) |
m (Better documentation.) |
||
Line 42: | Line 42: | ||
|name3=Example | |name3=Example | ||
|pipe3=Example Media | |pipe3=Example Media | ||
|description3=Showing an example | |description3=Showing an example. | ||
|length3=0:12 | |length3=0:12 | ||
}} | }} | ||
==Usage== | ==Usage== | ||
The purpose of this template is to cleanly insert up to 30 audio and video files into pages. The following parameters may be defined when using it. | The purpose of this template is to cleanly insert up to 30 audio and video files into pages. The following parameters may be defined when using it. Replace <code>X</code> with a number between 1-30. | ||
*<code>typeX</code> - Should be set to either "audio" or "video", but can be ignored. However, it shouldn't because of [[MarioWiki:Proposals/Archive 47#Discourage OGG Extension (Not Format)|a proposal]]. See [[Help:Media]]. This parameter controls the icon displayed next to the file and how to handle the linked media. | |||
*<code>nameX</code> - The name that the file is uploaded under. It should omit the "File:" prefix and file extension (.ogg, .ogv, .oga). So for the file at "File:Example.ogv", this parameter would be defined as "Example". | |||
*<code>pipeX</code> - This should be the file's name as it will appear on the page. For instance, if a file is uploaded at "File:Example246.ogv", but it needs to appear on the page as simply "Example", <code>name</code> would be defined "Example246", and <code>pipe</code> "Example". In cases where <code>name</code> and <code>pipe</code> would be set to identical values, only <code>name</code> needs to be used. | |||
*<code>descriptionX</code> - A short description of the file that will appear with it on the page. | |||
*<code>lengthX</code> - HH:MM:SS format. Omit zeros please. | |||
*<code>capsX</code> - If the file extension is written in all caps (.OGG, .OGV, .OGA), this should be set to "on". If it is written in lowercase (.ogg, .ogv, .oga), it should be either left blank or set to "off". Note that a file extension containing a mix of capitals and lowercase is incompatible with this template. | |||
Note that for all the values, additional files can be added to the list by incrementing the number in the parameter. Up to thirty files can be included in one template. | Note that for all the values, additional files can be added to the list by incrementing the number in the parameter. Up to thirty files can be included in one template. | ||
Revision as of 23:43, May 4, 2017
Template:Media/OGVTemplate:Media/OGATemplate:Media/row
Usage
The purpose of this template is to cleanly insert up to 30 audio and video files into pages. The following parameters may be defined when using it. Replace X
with a number between 1-30.
typeX
- Should be set to either "audio" or "video", but can be ignored. However, it shouldn't because of a proposal. See Help:Media. This parameter controls the icon displayed next to the file and how to handle the linked media.nameX
- The name that the file is uploaded under. It should omit the "File:" prefix and file extension (.ogg, .ogv, .oga). So for the file at "File:Example.ogv", this parameter would be defined as "Example".pipeX
- This should be the file's name as it will appear on the page. For instance, if a file is uploaded at "File:Example246.ogv", but it needs to appear on the page as simply "Example",name
would be defined "Example246", andpipe
"Example". In cases wherename
andpipe
would be set to identical values, onlyname
needs to be used.descriptionX
- A short description of the file that will appear with it on the page.lengthX
- HH:MM:SS format. Omit zeros please.capsX
- If the file extension is written in all caps (.OGG, .OGV, .OGA), this should be set to "on". If it is written in lowercase (.ogg, .ogv, .oga), it should be either left blank or set to "off". Note that a file extension containing a mix of capitals and lowercase is incompatible with this template.
Note that for all the values, additional files can be added to the list by incrementing the number in the parameter. Up to thirty files can be included in one template.
Code documentation
Calls {{media/row}}, {{media/OGV}}, and {{media/OGA}} with a switch.