Difference between revisions of "Template:Module"

From VideoLAN Wiki
Jump to navigation Jump to search
 
(Allow shortcuts up to 11 (add "sc5", "sc6", "sc7", "sc8", "sc9", "sc10", "sc11"))
 
(49 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
{| class="infobox bordered wikitable" style="width: 325px; font-size: 95%; margin-left: 1em; margin-bottom: 0.5em;"
+
{| class="bordered wikitable template-module"
−
|- style="text-align: center;"
+
|- style="font-size: large;"
−
! colspan="2" | {{{name}}}
+
! scope="col" colspan="2" | Module: {{{name}}}
−
|- valign="top"
 
−
! Type
 
−
| {{{type}}}
 
 
|-
 
|-
−
! First VLC version
+
! scope="row" | Type
 +
| {{#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 decoder        = [[Category:Audio decoders]]
 +
  |Audio encoder        = [[Category:Audio encoders]]
 +
  |Audio output          = [[Category:Audio output]]
 +
  |Muxer                = [[Category:Muxers]]
 +
  |Packetizer            = [[Category:Packetisers]]
 +
  |Packetiser            = [[Category:Packetisers]]
 +
  |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 sub-filter      = [[Category:Video sub-filters]]
 +
  |Visualization
 +
  |Visualisation        = [[Category:Visualisations]]
 +
  |#default              = [[Category:Modules]]
 +
  }}
 +
|-
 +
! scope="row" | First VLC version
 
| {{{first_version|-}}}
 
| {{{first_version|-}}}
 
|-
 
|-
−
! Last VLC version
+
! scope="row" | Last VLC version
 
| {{{last_version|-}}}
 
| {{{last_version|-}}}
 +
  {{#if:{{{last_version|}}}
 +
  |{{DEFAULTSORT:†|noerror}}
 +
  |{{DEFAULTSORT:{{#titleparts:{{PAGENAME}}|0|2}}|noreplace}}
 +
  }}
 
|-
 
|-
−
! Description
+
! scope="row" | Operating system(s)
 +
| {{{os|all}}}
 +
|-
 +
! scope="row" | Description
 
| {{{description}}}
 
| {{{description}}}
−
|}
+
|-
 +
! scope="row" | Shortcut(s)
 +
| {{#switch:{{{sc|}}}{{{sc2|}}}{{{sc3|}}}{{{sc4|}}}{{{sc5|}}}{{{sc6|}}}{{{sc7|}}}{{{sc8|}}}{{{sc9|}}}{{{sc10|}}}{{{sc11|}}}
 +
    |none                                = (none)
 +
    |{{{sc}}}                            = <code>{{{sc}}}</code>
 +
    |{{{sc}}}{{{sc2}}}                  = <code>{{{sc}}}</code>, <code>{{{sc2}}}</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}}}{{{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                            = -
 +
  }}
 +
|}<noinclude>
 +
Template for Documentation:Modules/* pages.
 +
{{Clear}}
  
−
[[Category:Modules|{{PAGENAME}}]]
+
==Usage==
 +
<pre>
 +
{{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
 +
}}
 +
</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 />
 +
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:Templates]]
 +
</noinclude>

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

Retrieved from "https://wiki.videolan.org/index.php?title=Template:Module&oldid=61621"