Manual of Style - Revision history

Perchun: nixpkgs -> Nixpkgs; it is referenced with capital N in 5 other places

2026-04-13T18:36:05Z

nixpkgs -> Nixpkgs; it is referenced with capital N in 5 other places

← Older revision		Revision as of 18:36, 13 April 2026
Line 151:		Line 151:

	* <strong>Software names, tools, and commands:</strong> Use regular text, typically with initial capitalization		* <strong>Software names, tools, and commands:</strong> Use regular text, typically with initial capitalization
	** Example: Nix, NixOS, ~~nixpkgs~~, nix-shell		** Example: Nix, NixOS, Nixpkgs, nix-shell

	* <strong>Website names:</strong> Use regular text without quotes or italics		* <strong>Website names:</strong> Use regular text without quotes or italics

Layer-09 at 06:42, 9 June 2025

2025-06-09T06:42:22Z

← Older revision		Revision as of 06:42, 9 June 2025
Line 95:		Line 95:
	4. Tips and tricks		4. Tips and tricks
	5. Troubleshooting		5. Troubleshooting
	6. References		6. See also
			7. References

	==== Standard section structure (applications) ====		==== Standard section structure (applications) ====
Line 105:		Line 106:

	== Installation ==		== Installation ==
	==== ~~Using nix-shell~~ ====		==== Shell ====
	==== ~~Using global configuration ====~~		==== System setup ====
	~~==== Using home configuration~~ ====

	== Configuration ==		== Configuration ==
Line 114:		Line 114:

	== Tips and tricks ==		== Tips and tricks ==
	~~==== Location of options ====~~

	== Troubleshooting ==		== Troubleshooting ==
	==~~== Issue 1 ==~~==
			== See also ==

	== References ==		== References ==

DoggoBit: Change notice for template

2025-06-04T22:33:20Z

Change notice for template

← Older revision		Revision as of 22:33, 4 June 2025
Line 1:		Line 1:
	~~<div style~~=~~"border: 1px solid var(--border-color-success); background: var(--background-~~color~~-success-subtle); padding: 30px; border-radius: 5px; margin: 10px 0px; display: flex; align-items: center;">~~		{{Notice
	~~<div style~~=~~"color:~~ var(--border-color-success)~~; font-size: 40px; margin-right: 15px;~~ background: var(--background-color-success-subtle)~~; display: flex; line-height: 0; align-items: center;">✦</div>~~		\|icon=✦
	~~<div style="color: var(--border-color-success); font-size: 15px; font-style: normal; font-weight: 400; line-height: normal; text-align: left;">~~Editors are generally expected to adhere to this standard, applying common sense and allowing for occasional exceptions. Significant edits to this page should reflect a consensus. If uncertain, please discuss on the talk page first.~~</div>~~		\|color=var(--border-color-success)
	~~</div>~~		\|background=var(--background-color-success-subtle)
			\|Editors are generally expected to adhere to this standard, applying common sense and allowing for occasional exceptions. Significant edits to this page should reflect a consensus. If uncertain, please discuss on the talk page first.
			}}

	<strong>This Manual of Style</strong> (hereinafter referred to as <strong>"MoS"</strong> or <strong>"MOS"</strong>) is designed to ensure that all content on the NixOS Wiki is presented in a clear and consistent manner. It provides guidelines on language usage, article structure, formatting, and other stylistic elements to maintain a high standard of quality across the wiki. This guide is intended for all contributors, whether they are new to editing or have extensive experience, to assist them in creating content that is both informative and accessible.		<strong>This Manual of Style</strong> (hereinafter referred to as <strong>"MoS"</strong> or <strong>"MOS"</strong>) is designed to ensure that all content on the NixOS Wiki is presented in a clear and consistent manner. It provides guidelines on language usage, article structure, formatting, and other stylistic elements to maintain a high standard of quality across the wiki. This guide is intended for all contributors, whether they are new to editing or have extensive experience, to assist them in creating content that is both informative and accessible.

SigmaSquadron: Dark mode support for header

2025-04-13T01:51:27Z

Dark mode support for header

← Older revision		Revision as of 01:51, 13 April 2025
Line 1:		Line 1:
	<div style="border: 1px solid ~~#2E8B57~~; background: ~~#DFF2DF~~; padding: 30px; border-radius: 5px; margin: 10px 0px; display: flex; align-items: center;">		<div style="border: 1px solid var(--border-color-success); background: var(--background-color-success-subtle); padding: 30px; border-radius: 5px; margin: 10px 0px; display: flex; align-items: center;">
	<div style="color: ~~#2E8B57~~; font-size: 40px; margin-right: 15px; background: ~~#DFF2DF~~; display: flex; line-height: 0; align-items: center;">✦</div>		<div style="color: var(--border-color-success); font-size: 40px; margin-right: 15px; background: var(--background-color-success-subtle); display: flex; line-height: 0; align-items: center;">✦</div>
	<div style="color: ~~#2E8B57~~; font-size: 15px; font-style: normal; font-weight: 400; line-height: normal; text-align: left;">Editors are generally expected to adhere to this standard, applying common sense and allowing for occasional exceptions. Significant edits to this page should reflect a consensus. If uncertain, please discuss on the talk page first.</div>		<div style="color: var(--border-color-success); font-size: 15px; font-style: normal; font-weight: 400; line-height: normal; text-align: left;">Editors are generally expected to adhere to this standard, applying common sense and allowing for occasional exceptions. Significant edits to this page should reflect a consensus. If uncertain, please discuss on the talk page first.</div>
	</div>		</div>

Pogobanane: Mention https://wiki.nixos.org/wiki/Help:Template in the templates section

2024-10-26T08:28:04Z

Mention https://wiki.nixos.org/wiki/Help:Template in the templates section

← Older revision		Revision as of 08:28, 26 October 2024
Line 539:		Line 539:
	== Templates ==		== Templates ==

	Templates are pre-formatted pieces of content that can be reused across multiple pages. They help maintain consistency and reduce repetitive work.		Templates are pre-formatted pieces of content that can be reused across multiple pages. They help maintain consistency and reduce repetitive work. For a detailed list of templates, see [[Help:Template]].

	=== Common templates ===		=== Common templates ===

Klinger: 5 / 5 (table editing with GUI mode)

2024-09-02T18:56:03Z

5 / 5 (table editing with GUI mode)

← Older revision		Revision as of 18:56, 2 September 2024
Line 464:		Line 464:
	\| Row 2, Cell 1 \|\| Row 2, Cell 2 \|\| Row 2, Cell 3		\| Row 2, Cell 1 \|\| Row 2, Cell 2 \|\| Row 2, Cell 3
	\|}		\|}
			</syntaxhighlight>Writers who use the GUI editor must then add (using the „Edit source“ mode):<syntaxhighlight lang="mediawiki">
			style="text-align: center; width: 500px;"
	</syntaxhighlight>		</syntaxhighlight>

Klinger: 4 / X

2024-09-02T18:40:39Z

4 / X

← Older revision		Revision as of 18:40, 2 September 2024
Line 245:		Line 245:
	** Use numerals for 10 and above.		** Use numerals for 10 and above.
	** Use commas for numbers with four or more digits (e.g., 1,000, 10,000).		** Use commas for numbers with four or more digits (e.g., 1,000, 10,000).
			** Use dots as decimal separator (e.g. 1,000.23 )
	** For very large numbers, consider using words (e.g., 1 million instead of 1,000,000).		** For very large numbers, consider using words (e.g., 1 million instead of 1,000,000).

Line 257:		Line 258:
	** Include the time zone when relevant (e.g., 14:30 UTC).		** Include the time zone when relevant (e.g., 14:30 UTC).

	* <strong>~~Versions~~:</strong>		* <strong>Software versions:</strong>
	** ~~Do not add software~~ versions~~, since they~~ are ~~prone~~ to change.		** Software versions are subject to change. Only add software versions when required by the content.

	==== Abbreviations ====		==== Abbreviations ====
Line 343:		Line 344:
	When using these terms:		When using these terms:
	* Be consistent in capitalization (e.g., always "NixOS", never "Nixos" or "NIXOS").		* Be consistent in capitalization (e.g., always "NixOS", never "Nixos" or "NIXOS").
	* Provide brief explanations for technical terms when they're first introduced in an article.
	* Use the full term on first mention, followed by any abbreviation in parentheses if it will be used later.		* Use the full term on first mention, followed by any abbreviation in parentheses if it will be used later.

Line 356:		Line 356:
	* Use double square brackets to create a wikilink: <syntaxhighlight lang="mediawiki">[[Page Name]]</syntaxhighlight>		* Use double square brackets to create a wikilink: <syntaxhighlight lang="mediawiki">[[Page Name]]</syntaxhighlight>
	* If the link text should differ from the page name, use a pipe character: <syntaxhighlight lang="mediawiki">[[Page Name\|displayed text]]</syntaxhighlight>		* If the link text should differ from the page name, use a pipe character: <syntaxhighlight lang="mediawiki">[[Page Name\|displayed text]]</syntaxhighlight>
	* For section links, use a hash symbol: <syntaxhighlight lang="mediawiki">[[Page Name#Section Name]]</syntaxhighlight>		* For section links, use a hash symbol. Please note: Section headings are sometimes changed during editing - it may be overlooked to change all the necessary references to them as well. Section links should therefore be used sparingly: <syntaxhighlight lang="mediawiki">[[Page Name#Section Name]]</syntaxhighlight>

	==== External linking ====		==== External linking ====
Line 393:		Line 393:
	Proper image file naming helps with organization and searchability:		Proper image file naming helps with organization and searchability:

	* '''Descriptive names:''' Use clear, descriptive file names (e.g., "~~NixOS~~-installation-partitioning.png").		* '''Descriptive names:''' Use clear, descriptive file names (e.g., "nixos-installation-partitioning.png").
	* '''Lowercase:''' Use lowercase letters to avoid case-sensitivity issues.		* '''Lowercase:''' Use lowercase letters to avoid case-sensitivity issues.
	* '''Hyphens:''' Use hyphens (-) to separate words, not underscores or spaces.		* '''Hyphens:''' Use hyphens (-) to separate words, not underscores or spaces.

Klinger: 3 / X (sentence case for the MoS)

2024-09-02T18:32:28Z

3 / X (sentence case for the MoS)

Show changes

Klinger: 2 / X (title case to sentence case)

2024-09-02T18:27:27Z

2 / X (title case to sentence case)

← Older revision		Revision as of 18:27, 2 September 2024
Line 68:		Line 68:
	=== Article titles ===		=== Article titles ===

	Article titles should be clear and descriptive, providing a succinct summary of the article's content. Avoid using jargon or overly technical terms unless they are widely understood within the context of the wiki. Titles should be formatted in ~~title~~ case, capitalizing the first letter of ~~each major~~ word.		Article titles should be clear and descriptive, providing a succinct summary of the article's content. Avoid using jargon or overly technical terms unless they are widely understood within the context of the wiki. Titles should be formatted in sentence case with capitalizing only the first letter of the first word.

	* <strong>Consistency:</strong> Ensure that article titles are consistent with the titles of related content to maintain a cohesive structure across the wiki.		* <strong>Consistency:</strong> Ensure that article titles are consistent with the titles of related content to maintain a cohesive structure across the wiki.
Line 88:		Line 88:

	* Arrange sections in a logical order, typically following this pattern:		* Arrange sections in a logical order, typically following this pattern:
	1. Introduction (no heading)		1. Introduction (the introduction has no heading)
	2. Installation		2. Installation
	3. Configuration		3. Configuration
	4. Tips and ~~Tricks~~		4. Tips and tricks
	5. Troubleshooting		5. Troubleshooting
	6. References		6. References
Line 104:		Line 104:
	== Installation ==		== Installation ==
	==== Using nix-shell ====		==== Using nix-shell ====
	==== Using ~~Global Configuration~~ ====		==== Using global configuration ====
	==== Using ~~Home Configuration~~ ====		==== Using home configuration ====

	== Configuration ==		== Configuration ==
Line 111:		Line 111:
	==== Advanced ====		==== Advanced ====

	== Tips and ~~Tricks~~ ==		== Tips and tricks ==
	==== Location of ~~Options~~ ====		==== Location of options ====

	== Troubleshooting ==		== Troubleshooting ==
Line 146:		Line 146:

	* <strong>Articles, blog posts, and short stories:</strong> Use double quotation marks		* <strong>Articles, blog posts, and short stories:</strong> Use double quotation marks
	** Example: "Understanding Nix Flakes", "The NixOS ~~Installation Guide~~"		** Example: "Understanding Nix Flakes", "The NixOS installation guide"

	* <strong>Software names, tools, and commands:</strong> Use regular text, typically with initial capitalization		* <strong>Software names, tools, and commands:</strong> Use regular text, typically with initial capitalization
Line 161:		Line 161:

	* <strong>Short quotes (less than 40 words):</strong> Use double quotation marks ("") and incorporate into the text.		* <strong>Short quotes (less than 40 words):</strong> Use double quotation marks ("") and incorporate into the text.
	** Example: According to the documentation, "NixOS is a Linux distribution built on top of the Nix ~~package manager~~."		** Example: According to the documentation, "NixOS is a Linux distribution built on top of the Nix Package Manager."

	* <strong>Long quotes (40 words or more):</strong> Use block quotes by indenting the entire quote or using the <strong>blockquote</strong> tag.		* <strong>Long quotes (40 words or more):</strong> Use block quotes by indenting the entire quote or using the <strong>blockquote</strong> tag.
Line 178:		Line 178:
	Proper capitalization improves readability and maintains a professional appearance:		Proper capitalization improves readability and maintains a professional appearance:

	* <strong>Article titles:</strong> Use ~~title~~ case, capitalizing ~~all major words~~.		* <strong>Article titles:</strong> Use sentence case, capitalizing only the first word.
	** Example: Installing NixOS on a ~~Virtual Machine~~		** Example: Installing NixOS on a virtual machine

	* <strong>Section headers:</strong>		* <strong>Section headers:</strong>
	** Main sections (==): Use ~~title~~ case		** Main sections (==): Use sentence case
	** Subsections (===, ====): Use sentence case		** Subsections (===, ====): Use sentence case
	* <strong>Proper nouns:</strong> Always capitalize names of specific people, places, organizations, and NixOS-specific components.		* <strong>Proper nouns:</strong> Always capitalize names of specific people, places, organizations, and NixOS-specific components.
Line 188:		Line 188:

	* <strong>Common nouns:</strong> Do not capitalize unless they are part of an official name or at the beginning of a sentence.		* <strong>Common nouns:</strong> Do not capitalize unless they are part of an official name or at the beginning of a sentence.
	** Example: "~~The~~ package manager ~~is efficient~~." but "Nix Package Manager"		** Example: "Every distribution has a package manager." but "Nix Package Manager"

	* <strong>Acronyms and initialisms:</strong> Generally use all caps, but follow official styling if different.		* <strong>Acronyms and initialisms:</strong> Generally use all caps, but follow official styling if different.

Klinger: Agreed changes from https://github.com/NixOS/nixos-wiki-infra/issues/98 - part 1 of X

2024-09-02T18:13:56Z

Agreed changes from https://github.com/NixOS/nixos-wiki-infra/issues/98 - part 1 of X

← Older revision		Revision as of 18:13, 2 September 2024
Line 6:		Line 6:
	<strong>This Manual of Style</strong> (hereinafter referred to as <strong>"MoS"</strong> or <strong>"MOS"</strong>) is designed to ensure that all content on the NixOS Wiki is presented in a clear and consistent manner. It provides guidelines on language usage, article structure, formatting, and other stylistic elements to maintain a high standard of quality across the wiki. This guide is intended for all contributors, whether they are new to editing or have extensive experience, to assist them in creating content that is both informative and accessible.		<strong>This Manual of Style</strong> (hereinafter referred to as <strong>"MoS"</strong> or <strong>"MOS"</strong>) is designed to ensure that all content on the NixOS Wiki is presented in a clear and consistent manner. It provides guidelines on language usage, article structure, formatting, and other stylistic elements to maintain a high standard of quality across the wiki. This guide is intended for all contributors, whether they are new to editing or have extensive experience, to assist them in creating content that is both informative and accessible.

	Editors ~~are expected to~~ compose articles using language that is clear, concise, and readily comprehensible. Articles must be organized with consistent, reader-friendly layouts and formatting, as delineated in this guide.		Technical writing is a skill that gets better with practice. This Manual of Style will help editors do that. It's OK to try to stick to it for the most part at first. A wiki thrives on all users helping each other to create better content.

			Editors should compose articles using language that is clear, concise, and readily comprehensible. Articles must be organized with consistent, reader-friendly layouts and formatting, as delineated in this guide.

	Any new content incorporated into this page must directly address a persistently recurring style issue.		Any new content incorporated into this page must directly address a persistently recurring style issue.
Line 12:		Line 14:
	== Rules of Thumb ==		== Rules of Thumb ==
	* <strong>Use Common Sense:</strong> Always apply logic and reason when contributing to the wiki.		* <strong>Use Common Sense:</strong> Always apply logic and reason when contributing to the wiki.
	* <strong>Cite Reliable Sources:</strong> ~~Ensure~~ that all information added is verifiable and ~~sourced~~ from reliable ~~references~~.		* <strong>Cite Reliable Sources:</strong> Aim to ensure that all information added is verifiable and comes from reliable sources.
	* <strong>Maintain Neutrality:</strong> Strive to present information in a neutral and unbiased manner.		* <strong>Maintain Neutrality:</strong> Strive to present information in a neutral and unbiased manner.
	* <strong>Be Clear and Concise:</strong> Use clear, concise, and grammatically correct language to ensure readability and understanding.		* <strong>Be Clear and Concise:</strong> Use clear, concise, and grammatically correct language to ensure readability and understanding.
Line 25:		Line 27:
	* <strong>Respect Others:</strong> Treat all users with respect and courtesy. Personal attacks and harassment are strictly prohibited.		* <strong>Respect Others:</strong> Treat all users with respect and courtesy. Personal attacks and harassment are strictly prohibited.
	* <strong>No Advertising, Vandalism, or Spamming:</strong> Contributions should be constructive and relevant. Any form of advertising, vandalism, or spamming will not be tolerated.		* <strong>No Advertising, Vandalism, or Spamming:</strong> Contributions should be constructive and relevant. Any form of advertising, vandalism, or spamming will not be tolerated.
			* '''Stay on Topic:''' This wiki is only about NixOS, Nixpkgs, Nix and the Nix-ecosystem.

	== Content Policy ==		== Content Policy ==
Line 34:		Line 37:
	* <strong>Definition:</strong> Plagiarism includes copying text, images, or other media without crediting the original source.		* <strong>Definition:</strong> Plagiarism includes copying text, images, or other media without crediting the original source.
	* <strong>Consequences:</strong> Plagiarized content will be removed immediately. Contributors who repeatedly plagiarize may be banned.		* <strong>Consequences:</strong> Plagiarized content will be removed immediately. Contributors who repeatedly plagiarize may be banned.
	* <strong>Prevention:</strong> Always cite your sources. Use quotation marks for direct quotes and provide proper references.		* <strong>Prevention:</strong> Always cite your sources. Use quotation marks for direct quotes and provide proper references. Don't just copy&paste a single sentence, but change it at least a little.

	=== Vandalism ===		=== Vandalism ===
Line 92:		Line 95:
	6. References		6. References

	==== Standard Section Structure ====		==== Standard Section Structure (Applications) ====

	For consistency across the wiki, use the following structure where applicable:		For consistency across the wiki, use the following structure where applicable: