Template:Nixos:option/Doc: Difference between revisions
Appearance
Write new documentation for Template:nixos:option and add TemplateData |
Add more details about special characters |
||
| Line 4: | Line 4: | ||
"1": { | "1": { | ||
"label": "Option", | "label": "Option", | ||
"description": "The attribute path of the option. Note that this template doesn't support including e.g. `<name>` in this parameter, but does in the \"Display text\" parameter.", | "description": "The attribute path of the option. Note that MediaWiki additionally parses characters like < oddly in links, so this template doesn't support including e.g. `<name>` in this parameter, but does in the \"Display text\" parameter.", | ||
"type": "string", | "type": "string", | ||
"required": true, | "required": true, | ||
Latest revision as of 12:46, 10 February 2026
Link to a NixOS option's page on https://search.nixos.org/options.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Option | 1 | The attribute path of the option. Note that MediaWiki additionally parses characters like < oddly in links, so this template doesn't support including e.g. `<name>` in this parameter, but does in the "Display text" parameter.
| String | required |
| Display text | 2 | Alternative text to display
| String | optional |
Example
{{nixos:option|users.users.*.name|users.users.<name>.name}}