Template:Module: Difference between revisions

From VideoLAN Wiki
Jump to navigation Jump to search
m Refactor (slightly faster)
Experimental feature: parameter "type2" can be specified (for e.g. Documentation:Modules/jack)
Line 4: Line 4:
|-
|-
! scope="row" | Type
! scope="row" | Type
| {{#switch:{{{type}}}
| {{#if:{{{type2|}}}
  |
<!---->*{{#switch:{{{type}}}
        |Video subfilter
        |Video sub-filter      = Video sub-filter
        |#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 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 subfilter
   |Video sub-filter      = Video sub-filter
   |Video sub-filter      = [[Category:Video sub-filters]]
   |#default              = {{{type}}}
  |Visualization
}}{{#switch:{{{type}}}
  |Visualisation        = [[Category:Visualisations]]
   |#default              = [[Category:Modules]]
  }}
  {{#switch:{{{type2}}}
   |Access                = [[Category:Accesses]]
   |Access                = [[Category:Accesses]]
   |Access demux          = [[Category:Access demux]]
   |Access demux          = [[Category:Access demux]]
Line 25: Line 58:
   |Visualization
   |Visualization
   |Visualisation        = [[Category:Visualisations]]
   |Visualisation        = [[Category:Visualisations]]
  |#default              = [[Category:Modules]]
   }}
   }}
|-
|-

Revision as of 06:30, 17 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
 }}

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