Difference between revisions of "Template:Option"

From VideoLAN Wiki
Jump to navigation Jump to search
m (Prune (no effect))
(Remove conditional full stop after description)
Line 21: Line 21:
 
                 -->|{{{select|}}}<!--
 
                 -->|{{{select|}}}<!--
 
               -->}} ''': {{{description<includeonly>|?</includeonly>}}}{{#if:{{{default|}}}<!--
 
               -->}} ''': {{{description<includeonly>|?</includeonly>}}}{{#if:{{{default|}}}<!--
                                                                       -->|. ''default value: {{{default}}}''<!--
+
                                                                       -->| ''default value: {{{default}}}''<!--
 
                                                                     -->}}<noinclude>
 
                                                                     -->}}<noinclude>
  

Revision as of 07:30, 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!)