Difference between revisions of "Template:Module"

From VideoLAN Wiki
Jump to navigation Jump to search
(Experimental feature: parameter "type2" can be specified (for e.g. Documentation:Modules/jack))
(Allow shortcuts up to 11 (add "sc5", "sc6", "sc7", "sc8", "sc9", "sc10", "sc11"))
 
(3 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
|-
 
|-
 
! scope="row" | Type
 
! scope="row" | Type
| {{#if:{{{type2|}}}
+
| {{#switch:{{{type}}}
  |
+
  |Video subfilter
<!---->*{{#switch:{{{type}}}
+
  |Video sub-filter      = Video sub-filter
        |Video subfilter
+
   |#default              = {{{type}}}
        |Video sub-filter      = Video sub-filter
+
}}{{#switch:{{{type}}}
        |#default              = {{{type}}}
 
        }}
 
<!---->*{{#switch:{{{type2}}}
 
        |Video subfilter
 
        |Video sub-filter      = Video sub-filter
 
        |#default              = {{{type2}}}
 
        }}
 
   | {{#switch:{{{type}}}
 
      |Video subfilter
 
      |Video sub-filter      = Video sub-filter
 
      |#default              = {{{type}}}
 
    }}
 
  }}
 
  {{#switch:{{{type}}}
 
 
   |Access                = [[Category:Accesses]]
 
   |Access                = [[Category:Accesses]]
 
   |Access demux          = [[Category:Access demux]]
 
   |Access demux          = [[Category:Access demux]]
 
   |Access filter        = [[Category:Access filters]]
 
   |Access filter        = [[Category:Access filters]]
 
   |Access output        = [[Category:Access output]]
 
   |Access output        = [[Category:Access output]]
 +
  |Audio decoder        = [[Category:Audio decoders]]
 +
  |Audio encoder        = [[Category:Audio encoders]]
 
   |Audio output          = [[Category:Audio output]]
 
   |Audio output          = [[Category:Audio output]]
 
   |Muxer                = [[Category:Muxers]]
 
   |Muxer                = [[Category:Muxers]]
 +
  |Packetizer            = [[Category:Packetisers]]
 +
  |Packetiser            = [[Category:Packetisers]]
 
   |Services discovery    = [[Category:Services discovery]]
 
   |Services discovery    = [[Category:Services discovery]]
 
   |Stream output        = [[Category:Stream output]]
 
   |Stream output        = [[Category:Stream output]]
Line 40: Line 30:
 
   |Visualisation        = [[Category:Visualisations]]
 
   |Visualisation        = [[Category:Visualisations]]
 
   |#default              = [[Category:Modules]]
 
   |#default              = [[Category:Modules]]
  }}
 
  {{#switch:{{{type2}}}
 
  |Access                = [[Category:Accesses]]
 
  |Access demux          = [[Category:Access demux]]
 
  |Access filter        = [[Category:Access filters]]
 
  |Access output        = [[Category:Access output]]
 
  |Audio output          = [[Category:Audio output]]
 
  |Muxer                = [[Category:Muxers]]
 
  |Services discovery    = [[Category:Services discovery]]
 
  |Stream output        = [[Category:Stream output]]
 
  |Video filter          = [[Category:Video filters]]
 
  |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]]
 
 
   }}
 
   }}
 
|-
 
|-
Line 77: Line 49:
 
|-
 
|-
 
! scope="row" | Shortcut(s)
 
! scope="row" | Shortcut(s)
| {{#switch:{{{sc|}}}{{{sc2|}}}{{{sc3|}}}{{{sc4|}}}
+
| {{#switch:{{{sc|}}}{{{sc2|}}}{{{sc3|}}}{{{sc4|}}}{{{sc5|}}}{{{sc6|}}}{{{sc7|}}}{{{sc8|}}}{{{sc9|}}}{{{sc10|}}}{{{sc11|}}}
 
     |none                                = (none)
 
     |none                                = (none)
 
     |{{{sc}}}                            = <code>{{{sc}}}</code>
 
     |{{{sc}}}                            = <code>{{{sc}}}</code>
Line 83: Line 55:
 
     |{{{sc}}}{{{sc2}}}{{{sc3}}}          = <code>{{{sc}}}</code>, <code>{{{sc2}}}</code>, <code>{{{sc3}}}</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}}} = <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                            = -
 
     |#default                            = -
 
   }}
 
   }}
Line 101: Line 80:
 
   |sc3          = Shortcut 3
 
   |sc3          = Shortcut 3
 
   |sc4          = Shortcut 4
 
   |sc4          = Shortcut 4
 +
  ...
 +
  |sc11          = Shortcut 11
 
  }}
 
  }}
 
</pre>
 
</pre>

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 -.