Template:NixOS Manual: Difference between revisions

From NixOS Wiki
imported>Nix
create convenience template for linking to official NixOS manual
 
m Change flavour of the example text
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
<noinclude>
<noinclude>
{{Template}}
{{Template}}
This is the template which is used to easily link out to the official stable NixOS Manual.
 
== About ==
Create a link to the official NixOS Manual.


== Basic use ==
== Basic use ==
Line 10: Line 12:


== Advanced use ==
== Advanced use ==
=== Link to the unstable version ===
Example:
  <nowiki>{{NixOS Manual|ver=unstable}}</nowiki>
Creates: {{NixOS Manual|ver=unstable}}


=== Rename the link ===
=== Rename the link ===
Example:
Example:
   <nowiki>{{NixOS Manual|name=NixOS's Greatest Most OFFICIAL Manual}}</nowiki>
   <nowiki>{{NixOS Manual|name=The official NixOS manual}}</nowiki>


Creates: {{NixOS Manual|name=NixOS's Greatest Most OFFICIAL Manual}}
Creates: {{NixOS Manual|name=The official NixOS manual}}


=== Add an anchor link ===
=== Add an anchor link ===
Line 24: Line 32:


</noinclude>
</noinclude>
<includeonly>[https://nixos.org/manual/nixos/stable/{{{anchor|}}} {{{name|NixOS Manual}}}]</includeonly>
<includeonly>[https://nixos.org/manual/nixos/{{{ver|stable}}}/{{{anchor|}}} {{{name|NixOS Manual}}}]</includeonly>

Latest revision as of 01:17, 7 April 2024

This page is a template. It should be used as part of other articles. For more information, see Help:Template.

Please do not experiment with this template; you could ruin all pages using this template. If you want to edit this template, copy the text to Template:Sandbox, edit and test it there, and copy it back when it works.

Feel free to discuss this template in the talk page.

If you wanted to create a new page instead, use the search box to search for the title of the new page you want to create and follow the link Create the page "XYZ" on this wiki! in the results page. An alternative is to create a dangling link to the new page from an existing page. A final option is to directly visit the expected URL of the page.

About

Create a link to the official NixOS Manual.

Basic use

Example:

 {{NixOS Manual}}

Creates: NixOS Manual

Advanced use

Link to the unstable version

Example:

 {{NixOS Manual|ver=unstable}}

Creates: NixOS Manual

Rename the link

Example:

 {{NixOS Manual|name=The official NixOS manual}}

Creates: The official NixOS manual

Add an anchor link

Example:

 {{NixOS Manual|name=NixOS Manual: Chapter - Package Management|anchor=#sec-package-management}}

Creates: NixOS Manual: Chapter - Package Management