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))
(Add category codes "Audio decoder" and "Audio encoder")
Line 27: Line 27:
 
   |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]]
Line 46: Line 48:
 
   |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]]

Revision as of 07:09, 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 -.