Jump to content

Template:Cite manual

From NixOS Wiki
🏗︎
This template is a work in progress. The information on this page may not be reliable, and the formatting may not follow the Manual of Style yet. Please remove this notice as soon as the work is in a presentable shape.

Template Documentation [edit source| uses| help]

Use this template to provide a citation to the Nix, Nixpkgs or NixOS manuals.

[1]

Usage

Simply include this template inline with the text that needs the citation. The first two arguments are the manual you want to cite from, and the argument is the path within the manual. For more information about these, check out the {{manual}} documentation. The named arguments differ depending on the manual you are citing from.

  • For the Nix Reference Manual, provide the section number and title.
  • For the Nixpkgs Reference Manual, provide the section title.
Text that needs citation. {{cite manual|nix|introduction|number=1|title=Introduction}}

Template data

Insert a citation to one of the Nix manuals.

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
Manual1

Which manual you want to cite from

Suggested values
nix nixos nixpkgs
Stringrequired
Citation path2

The path to the manual page you want to cite from. Only include the URL part after the manual version.

Stringrequired
Section numbernumber

The section number you want to cite. Only applies to the Nix Reference Manual.

Stringsuggested
Section titletitle

The title of the section you want to cite.

Stringrequired
Subsection pathsubsection

The subsection you want to cite. Only applies to the Nix Reference Manual, and is the part of the URL after the # sign.

Stringoptional
Subsection titlesubtitle

The title of the subsection you want to cite.

Stringoptional
  1. Nix Reference Manual, §1. 📖︎ Introduction