Difference between revisions of "Template:Option"

From VideoLAN Wiki
Jump to navigation Jump to search
(New feature: optional parameters "alias" and "alias2")
m (Whitespace (no effect))
Line 4: Line 4:
 
               -->}}<!--
 
               -->}}<!--
 
               -->''' or '''{{{alias}}}'''<!--
 
               -->''' or '''{{{alias}}}'''<!--
             -->}} {{#if:{{{value|}}}|<{{#switch:{{{value}}}<!--
+
             -->}} {{#if:{{{value|}}}<!--
                                  -->|boolean  = [[boolean]]<!--
+
                -->|<{{#switch:{{{value}}}
                                  -->|float    = [[float]]<!--
+
                        |boolean  = [[boolean]]
                                  -->|integer  = [[integer]]<!--
+
                        |float    = [[float]]
                                  -->|string  = [[string]]<!--
+
                        |integer  = [[integer]]
                                  -->|#default = {{{value}}}<!--
+
                        |string  = [[string]]
                                -->}}{{#if:{{{select|}}}|> <span style="overflow-wrap:break-word;">{{{select}}}</span>|{{#if:{{{min|}}}|{{#if:{{{max|}}}|&#32;&#x5B;{{{min}}} .. {{{max}}}&#x5D;|}}|}}>}}|{{{select|}}}}} ''': {{{description<includeonly>|?</includeonly>}}}{{#if:{{{default|}}}|. ''default value: {{{default}}}''|}}<noinclude>
+
                        |#default = {{{value}}}
 +
                      }}{{#if:{{{select|}}}<!--
 +
                      -->|> <span style="overflow-wrap:break-word;">{{{select}}}</span><!--
 +
                      -->|{{#if:{{{min|}}}<!--
 +
                          -->|{{#if:{{{max|}}}<!--
 +
                            -->|&#32;&#x5B;{{{min}}} .. {{{max}}}&#x5D;<!--
 +
                            -->|<!--
 +
                          -->}}<!--
 +
                          -->|<!--
 +
                        -->}}><!--
 +
                    -->}}<!--
 +
                -->|{{{select|}}}<!--
 +
              -->}} ''': {{{description<includeonly>|?</includeonly>}}}{{#if:{{{default|}}}<!--
 +
                                                                      -->|. ''default value: {{{default}}}''<!--
 +
                                                                      -->|<!--
 +
                                                                    -->}}<noinclude>
  
 
Usage:
 
Usage:

Revision as of 08:29, 20 May 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!)