Difference between revisions of "Template:Option"
Jump to navigation
Jump to search
(New feature: new optional parameter "select" for free-form argument selection. Use as |select={foo,bar,baz}. Documentation updated) |
m (Insert space, hex entity) |
||
| (10 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | * '''{{{name}}} {{#if:{{{value|}}}|<{{{value}}}{{#if:{{{select|}}}|> {{{select}}}|{{#if:{{{min|}}}|{{#if:{{{max|}}}|&# | + | * '''{{{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|}}}<!-- | ||
| + | -->| [{{{min}}} .. {{{max}}}]<!-- | ||
| + | -->}}<!-- | ||
| + | -->}}><!-- | ||
| + | -->}}<!-- | ||
| + | -->|{{{select|}}}<!-- | ||
| + | -->}} ''': {{{description<includeonly>|?</includeonly>}}}{{#if:{{{default|}}}<!-- | ||
| + | -->| ''default value: {{{default}}}''<!-- | ||
| + | -->}}<noinclude> | ||
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) | ||
** max (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) | * description (required) | ||
* default (optional) | * default (optional) | ||
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
minandmax.{}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!)
