Difference between revisions of "Template:Module"

From VideoLAN Wiki
Jump to navigation Jump to search
(New feature: free-form parameter "sc" for ShortCut(s) -- it feels ironic to spell out the word "shortcut")
(Allow shortcuts up to 11 (add "sc5", "sc6", "sc7", "sc8", "sc9", "sc10", "sc11"))
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
{| class="infobox bordered wikitable" style="width: 325px; font-size: 95%; margin-left: 1em; margin-bottom: 0.5em; float: right; border: 1px solid black; background: #eee;"
+
{| class="bordered wikitable template-module"
−
|- style="text-align: center; font-size: large;"
+
|- style="font-size: large;"
 
! scope="col" colspan="2" | Module: {{{name}}}
 
! scope="col" colspan="2" | Module: {{{name}}}
−
|- style="vertical-align: top;"
+
|-
 
! scope="row" | Type
 
! scope="row" | Type
−
| {{#switch:{{{type}}}<!--
+
| {{#switch:{{{type}}}
−
-->|Access = Access [[Category:Accesses]]<!--
+
  |Video subfilter
−
-->|Access demux = Access demux [[Category:Access demux]]<!--
+
  |Video sub-filter      = Video sub-filter
−
-->|Access filter = Access filter [[Category:Access filters]]<!--
+
  |#default              = {{{type}}}
−
-->|Access output = Access output [[Category:Access output]]<!--
+
}}{{#switch:{{{type}}}
−
-->|Audio output = Audio output [[Category:Audio output]]<!--
+
  |Access               = [[Category:Accesses]]
−
-->|Muxer = Muxer [[Category:Muxers]]<!--
+
  |Access demux         = [[Category:Access demux]]
−
-->|Services discovery = Services discovery [[Category:Services discovery]]<!--
+
  |Access filter         = [[Category:Access filters]]
−
-->|Stream output = Stream output [[Category:Stream output]]<!--
+
  |Access output         = [[Category:Access output]]
−
-->|Video filter = Video filter [[Category:Video filters]]<!--
+
  |Audio decoder        = [[Category:Audio decoders]]
−
-->|Video output = Video output [[Category:Video output]]<!--
+
  |Audio encoder        = [[Category:Audio encoders]]
−
-->|Video output filter = Video output filter [[Category:Video output filters]]<!--
+
  |Audio output         = [[Category:Audio output]]
−
-->|Video output splitter = Video output splitter [[Category:Video output splitters]]<!--
+
  |Muxer                 = [[Category:Muxers]]
−
-->|Video subfilter<!--
+
  |Packetizer            = [[Category:Packetisers]]
−
-->|Video sub-filter = Video sub-filter [[Category:Video sub-filters]]<!--
+
  |Packetiser            = [[Category:Packetisers]]
−
-->|Visualization<!--
+
  |Services discovery   = [[Category:Services discovery]]
−
-->|Visualisation = {{{type}}} [[Category:Visualisations]]<!--
+
  |Stream output         = [[Category:Stream output]]
−
-->|#default = {{{type}}} [[Category:Modules]]<!--
+
  |Video filter         = [[Category:Video filters]]
−
-->}}{{DEFAULTSORT:{{#titleparts:{{PAGENAME}}|0|2}}|noreplace}}
+
  |Video output         = [[Category:Video output]]
 +
  |Video output filter   = [[Category:Video output filters]]
 +
  |Video output splitter = [[Category:Video output splitters]]
 +
  |Video subfilter
 +
  |Video sub-filter     = [[Category:Video sub-filters]]
 +
  |Visualization
 +
  |Visualisation         = [[Category:Visualisations]]
 +
  |#default             = [[Category:Modules]]
 +
  }}
 
|-
 
|-
 
! scope="row" | First VLC version
 
! scope="row" | First VLC version
Line 28: Line 36:
 
|-
 
|-
 
! scope="row" | Last VLC version
 
! scope="row" | Last VLC version
−
| {{{last_version|-}}}{{#if:{{{last_version|}}}|{{DEFAULTSORT:†|noerror}}}}
+
| {{{last_version|-}}}
 +
  {{#if:{{{last_version|}}}
 +
  |{{DEFAULTSORT:†|noerror}}
 +
  |{{DEFAULTSORT:{{#titleparts:{{PAGENAME}}|0|2}}|noreplace}}
 +
  }}
 
|-
 
|-
 
! scope="row" | Operating system(s)
 
! scope="row" | Operating system(s)
Line 37: Line 49:
 
|-
 
|-
 
! scope="row" | Shortcut(s)
 
! scope="row" | Shortcut(s)
−
| {{{sc|-}}}
+
| {{#switch:{{{sc|}}}{{{sc2|}}}{{{sc3|}}}{{{sc4|}}}{{{sc5|}}}{{{sc6|}}}{{{sc7|}}}{{{sc8|}}}{{{sc9|}}}{{{sc10|}}}{{{sc11|}}}
−
|}
+
    |none                                = (none)
−
<noinclude>
+
    |{{{sc}}}                            = <code>{{{sc}}}</code>
−
<br />
+
    |{{{sc}}}{{{sc2}}}                  = <code>{{{sc}}}</code>, <code>{{{sc2}}}</code>
 +
    |{{{sc}}}{{{sc2}}}{{{sc3}}}          = <code>{{{sc}}}</code>, <code>{{{sc2}}}</code>, <code>{{{sc3}}}</code>
 +
    |{{{sc}}}{{{sc2}}}{{{sc3}}}{{{sc4}}} = <code>{{{sc}}}</code>, <code>{{{sc2}}}</code>, <code>{{{sc3}}}</code>, <code>{{{sc4}}}</code>
 +
    |{{{sc}}}{{{sc2}}}{{{sc3}}}{{{sc4}}}{{{sc5}}} = <code>{{{sc}}}</code>, <code>{{{sc2}}}</code>, <code>{{{sc3}}}</code>, <code>{{{sc4}}}</code>, <code>{{{sc5}}}</code>
 +
    |{{{sc}}}{{{sc2}}}{{{sc3}}}{{{sc4}}}{{{sc5}}}{{{sc6}}} = <code>{{{sc}}}</code>, <code>{{{sc2}}}</code>, <code>{{{sc3}}}</code>, <code>{{{sc4}}}</code>, <code>{{{sc5}}}</code>, <code>{{{sc6}}}</code>
 +
    |{{{sc}}}{{{sc2}}}{{{sc3}}}{{{sc4}}}{{{sc5}}}{{{sc6}}}{{{sc7}}} = <code>{{{sc}}}</code>, <code>{{{sc2}}}</code>, <code>{{{sc3}}}</code>, <code>{{{sc4}}}</code>, <code>{{{sc5}}}</code>, <code>{{{sc6}}}</code>, <code>{{{sc7}}}</code>
 +
    |{{{sc}}}{{{sc2}}}{{{sc3}}}{{{sc4}}}{{{sc5}}}{{{sc6}}}{{{sc7}}}{{{sc8}}} = <code>{{{sc}}}</code>, <code>{{{sc2}}}</code>, <code>{{{sc3}}}</code>, <code>{{{sc4}}}</code>, <code>{{{sc5}}}</code>, <code>{{{sc6}}}</code>, <code>{{{sc7}}}</code>, <code>{{{sc8}}}</code>
 +
    |{{{sc}}}{{{sc2}}}{{{sc3}}}{{{sc4}}}{{{sc5}}}{{{sc6}}}{{{sc7}}}{{{sc8}}}{{{sc9}}} = <code>{{{sc}}}</code>, <code>{{{sc2}}}</code>, <code>{{{sc3}}}</code>, <code>{{{sc4}}}</code>, <code>{{{sc5}}}</code>, <code>{{{sc6}}}</code>, <code>{{{sc7}}}</code>, <code>{{{sc8}}}</code>, <code>{{{sc9}}}</code>
 +
    |{{{sc}}}{{{sc2}}}{{{sc3}}}{{{sc4}}}{{{sc5}}}{{{sc6}}}{{{sc7}}}{{{sc8}}}{{{sc9}}}{{{sc10}}} = <code>{{{sc}}}</code>, <code>{{{sc2}}}</code>, <code>{{{sc3}}}</code>, <code>{{{sc4}}}</code>, <code>{{{sc5}}}</code>, <code>{{{sc6}}}</code>, <code>{{{sc7}}}</code>, <code>{{{sc8}}}</code>, <code>{{{sc9}}}</code>, <code>{{{sc10}}}</code>
 +
    |{{{sc}}}{{{sc2}}}{{{sc3}}}{{{sc4}}}{{{sc5}}}{{{sc6}}}{{{sc7}}}{{{sc8}}}{{{sc9}}}{{{sc10}}}{{{sc11}}} = <code>{{{sc}}}</code>, <code>{{{sc2}}}</code>, <code>{{{sc3}}}</code>, <code>{{{sc4}}}</code>, <code>{{{sc5}}}</code>, <code>{{{sc6}}}</code>, <code>{{{sc7}}}</code>, <code>{{{sc8}}}</code>, <code>{{{sc9}}}</code>, <code>{{{sc10}}}</code>, <code>{{{sc11}}}</code>
 +
    |#default                            = -
 +
  }}
 +
|}<noinclude>
 
Template for Documentation:Modules/* pages.
 
Template for Documentation:Modules/* pages.
 +
{{Clear}}
  
 
==Usage==
 
==Usage==
−
  <nowiki>{{Module
+
<pre>
−
   |type = module type
+
{{Module
 +
   |type         = module type
 
   |first_version = Version of VLC in which plugin first appeared
 
   |first_version = Version of VLC in which plugin first appeared
−
   |last_version = Version of VLC in which plugin last appeared before being removed
+
   |last_version = Version of VLC in which plugin last appeared before being removed
−
   |os = Operating system of the plugin
+
   |os           = Operating system of the plugin
−
   |description = A short, brief description of the plugin
+
   |description   = A short, brief description of the plugin
−
   |sc = Shortcut(s)
+
   |sc           = Shortcut
−
   }}</nowiki>
+
   |sc2          = Shortcut 2
 +
  |sc3          = Shortcut 3
 +
  |sc4          = Shortcut 4
 +
  ...
 +
  |sc11          = Shortcut 11
 +
}}
 +
</pre>
 +
Source code identifies shortcuts with <code>add_shortcut( "foo", "bar" )</code> in the module descriptor. Generally omit non-specific shortcuts. Pass the first shortcut to <code>'''<nowiki>|sc=</nowiki>'''</code>, a possible second to <code>'''<nowiki>|sc2=</nowiki>'''</code>, etc.<br />
 +
If <code>'''<nowiki>|sc=</nowiki>'''</code> is set to ''none'' <samp>(none)</samp> will be shown. No data is indicated with <samp>-</samp>.
 
[[Category:Modules|*]]<!-- To modify sortkey -->
 
[[Category:Modules|*]]<!-- To modify sortkey -->
 
[[Category:Templates]]
 
[[Category:Templates]]
 
</noinclude>
 
</noinclude>

Latest revision as of 09:01, 28 May 2019

Module: {{{name}}}
Type {{{type}}}
First VLC version -
Last VLC version -
Operating system(s) all
Description {{{description}}}
Shortcut(s) -

Template for Documentation:Modules/* pages.

Usage

 {{Module
  |type          = module type
  |first_version = Version of VLC in which plugin first appeared
  |last_version  = Version of VLC in which plugin last appeared before being removed
  |os            = Operating system of the plugin
  |description   = A short, brief description of the plugin
  |sc            = Shortcut
  |sc2           = Shortcut 2
  |sc3           = Shortcut 3
  |sc4           = Shortcut 4
  ...
  |sc11          = Shortcut 11
 }}

Source code identifies shortcuts with add_shortcut( "foo", "bar" ) in the module descriptor. Generally omit non-specific shortcuts. Pass the first shortcut to |sc=, a possible second to |sc2=, etc.
If |sc= is set to none (none) will be shown. No data is indicated with -.

Retrieved from "https://wiki.videolan.org/index.php?title=Template:Module&oldid=61621"