Jump to content

Template:Nixos:option/Doc: Difference between revisions

From Official NixOS Wiki
Axka (talk | contribs)
Write new documentation for Template:nixos:option and add TemplateData
 
Axka (talk | contribs)
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.

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
Option1

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.

Example
users.users.*.name
Stringrequired
Display text2

Alternative text to display

Default
The value of the "Option" parameter
Example
users.users.<name>.name
Stringoptional

Example

{{nixos:option|users.users.*.name|users.users.<name>.name}}

users.users.<name>.name