Difference between revisions of "Template:Module"

From VideoLAN Wiki
Jump to navigation Jump to search
m (Format doc)
(Document where to find shortcuts and which to omit)
Line 62: Line 62:
 
   |sc4          = Shortcut 4
 
   |sc4          = Shortcut 4
 
   }}</nowiki>
 
   }}</nowiki>
If <code>'''<nowiki>|sc=</nowiki>'''</code> is set to ''none'' <samp>(none)</samp> will be shown. The other shortcuts are optional.
+
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>.
 
[[Category:Modules|*]]<!-- To modify sortkey -->
 
[[Category:Modules|*]]<!-- To modify sortkey -->
 
[[Category:Templates]]
 
[[Category:Templates]]
 
</noinclude>
 
</noinclude>

Revision as of 03:40, 17 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 -.