Difference between revisions of "Template:Option"
Jump to navigation
Jump to search
(Add usage information) |
(New feature: new optional parameter "select" for free-form argument selection. Use as |select={foo,bar,baz}. Documentation updated) |
||
Line 1: | Line 1: | ||
− | * '''{{{name}}} {{#if:{{{value|}}}|<{{{value}}}{{#if:{{{min|}}}|{{#if:{{{max|}}}| [{{{min}}} .. {{{max}}}]|}}|}}>|}} ''': {{{description<includeonly>|?</includeonly>}}}{{#if:{{{default|}}}|. ''default value: {{{default}}}''|}}<noinclude> | + | * '''{{{name}}} {{#if:{{{value|}}}|<{{{value}}}{{#if:{{{select|}}}|> {{{select}}}|{{#if:{{{min|}}}|{{#if:{{{max|}}}| [{{{min}}} .. {{{max}}}]|}}|}}>|}}|}} ''': {{{description<includeonly>|?</includeonly>}}}{{#if:{{{default|}}}|. ''default value: {{{default}}}''|}}<noinclude> |
Usage: | Usage: | ||
Line 6: | Line 6: | ||
** min (optional) | ** min (optional) | ||
** max (optional) | ** max (optional) | ||
+ | ** select (optional): takes precedence over <code>min</code> and <code>max</code>. Only works if <code>value</code> is given. <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) | * description (required) | ||
* default (optional) | * default (optional) |
Revision as of 04:50, 27 February 2019
- {{{name}}} : {{{description}}}
Usage:
- name (required)
- value (optional)
- min (optional)
- max (optional)
- select (optional): takes precedence over
min
andmax
. Only works ifvalue
is given.{}
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!)