Difference between revisions of "Template:Module"

From VideoLAN Wiki
Jump to navigation Jump to search
m (Refactor to make editing easier (no effect))
(Allow shortcuts up to 11 (add "sc5", "sc6", "sc7", "sc8", "sc9", "sc10", "sc11"))
 
(5 intermediate revisions by the same user not shown)
Line 6: Line 6:
 
| {{#switch:{{{type}}}
 
| {{#switch:{{{type}}}
 
   |Video subfilter
 
   |Video subfilter
   |Video sub-filter = Video sub-filter
+
   |Video sub-filter     = Video sub-filter
   |#default         = {{{type}}}
+
   |#default             = {{{type}}}
 
  }}{{#switch:{{{type}}}
 
  }}{{#switch:{{{type}}}
 
   |Access                = [[Category:Accesses]]
 
   |Access                = [[Category:Accesses]]
Line 13: Line 13:
 
   |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 26: Line 30:
 
   |Visualisation        = [[Category:Visualisations]]
 
   |Visualisation        = [[Category:Visualisations]]
 
   |#default              = [[Category:Modules]]
 
   |#default              = [[Category:Modules]]
   }}{{DEFAULTSORT:{{#titleparts:{{PAGENAME}}|0|2}}|noreplace}}
+
   }}
 
|-
 
|-
 
! scope="row" | First VLC version
 
! scope="row" | First VLC version
Line 32: 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 41: 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 47: 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 54: Line 69:
  
 
==Usage==
 
==Usage==
  <nowiki>{{Module
+
<pre>
 +
{{Module
 
   |type          = module type
 
   |type          = module type
 
   |first_version = Version of VLC in which plugin first appeared
 
   |first_version = Version of VLC in which plugin first appeared
Line 64: Line 80:
 
   |sc3          = Shortcut 3
 
   |sc3          = Shortcut 3
 
   |sc4          = Shortcut 4
 
   |sc4          = Shortcut 4
   }}</nowiki>
+
   ...
 +
  |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 />
 
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>.
 
If <code>'''<nowiki>|sc=</nowiki>'''</code> is set to ''none'' <samp>(none)</samp> will be shown. No data is indicated with <samp>-</samp>.

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