Difference between revisions of "Template:Module"

From VideoLAN Wiki
Jump to navigation Jump to search
(Document where to find shortcuts and which to omit)
(Whitespace: remove line break)
Line 45: Line 45:
 
  -->|#default                            = -<!--
 
  -->|#default                            = -<!--
 
-->}}
 
-->}}
|}
+
|}<noinclude>
<noinclude>
 
 
Template for Documentation:Modules/* pages.
 
Template for Documentation:Modules/* pages.
 
{{Clear}}
 
{{Clear}}

Revision as of 02:19, 19 April 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 -.