Difference between revisions of "Template:Option"

From VideoLAN Wiki
Jump to navigation Jump to search
m (Fix last)
(New feature: optional parameters "alias" and "alias2")
Line 1: Line 1:
* '''{{{name}}} {{#if:{{{value|}}}|<{{#switch:{{{value}}}<!--
+
* '''{{{name}}}{{#if:{{{alias|}}}<!--
 +
              -->|{{#if:{{{alias2|}}}<!--
 +
                -->|''', '''{{{alias}}}''' or '''{{{alias2}}}'''<!--
 +
              -->}}<!--
 +
              -->''' or '''{{{alias}}}'''<!--
 +
            -->}} {{#if:{{{value|}}}|<{{#switch:{{{value}}}<!--
 
                                   -->|boolean  = [[boolean]]<!--
 
                                   -->|boolean  = [[boolean]]<!--
 
                                   -->|float    = [[float]]<!--
 
                                   -->|float    = [[float]]<!--
Line 9: Line 14:
 
Usage:
 
Usage:
 
* name (required)
 
* name (required)
 +
** alias (optional): an alias for the name
 +
** alias2 (optional): a second alias for the name
 
* value (optional)
 
* value (optional)
 
** min (optional)
 
** min (optional)

Revision as of 04:55, 13 April 2019

  • {{{name}}} : {{{description}}}

Usage:

  • name (required)
    • alias (optional): an alias for the name
    • alias2 (optional): a second alias for the name
  • value (optional)
    • min (optional)
    • max (optional)
  • select (optional): takes precedence over min and max. {} will not be provided if not given (to avoid doubling). Use as e.g. {png,jpg,tiff} for documentation of options for --snapshot-format
  • description (required)
  • default (optional)

min and max are only shown if both of them are specified, because no range should be given unbounded (if you think that is stupid, change it!)