Template:Option: Difference between revisions

From VideoLAN Wiki
Jump to navigation Jump to search
m Add brackets to mimic command-line look
m Insert space, hex entity
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
* '''{{{name}}} {{#if:{{{value|}}}|<{{{value}}}{{#if:{{{min|}}}|{{#if:{{{max|}}}|&#32;&#x5B;{{{min}}} .. {{{max}}}&#x5D;|}}|}}>|}} ''': {{{description<includeonly>|?</includeonly>}}}{{#if:{{{default|}}}|. ''default value: {{{default}}}''|}}<noinclude>
* '''{{{name}}}{{#if:{{{alias|}}}<!--
              -->|{{#if:{{{alias2|}}}<!--
                -->|''', '''{{{alias}}}''' or '''{{{alias2}}}'''<!--
              -->}}<!--
              -->''' or '''{{{alias}}}'''<!--
            -->}} {{#if:{{{value|}}}<!--
                -->|<{{#switch:{{{value}}}
                        |boolean  = [[boolean]]
                        |float    = [[float]]
                        |integer  = [[integer]]
                        |string  = [[string]]
                        |#default = {{{value}}}
                      }}{{#if:{{{select|}}}<!--
                      -->|> <span style="overflow-wrap:break-word;">{{{select}}}</span><!--
                      -->|{{#if:{{{min|}}}<!--
                          -->|{{#if:{{{max|}}}<!--
                            -->|&#x20;&#x5B;{{{min}}} .. {{{max}}}&#x5D;<!--
                          -->}}<!--
                        -->}}><!--
                    -->}}<!--
                -->|{{{select|}}}<!--
              -->}} ''': {{{description<includeonly>|?</includeonly>}}}{{#if:{{{default|}}}<!--
                                                                      -->|&#x20;''default value: {{{default}}}''<!--
                                                                    -->}}<noinclude>
 
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 <code>min</code> and <code>max</code>. <code>{}</code> will not be provided if not given (to avoid doubling). Use as e.g. <code>{png,jpg,tiff}</code> for documentation of options for <code>--snapshot-format</code>
* 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!)


[[Category:Templates]]
[[Category:Templates]]
</noinclude>
</noinclude>

Latest revision as of 07:32, 22 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!)