Manual of Style: Difference between revisions
3 / X (sentence case for the MoS) |
mNo edit summary |
||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Notice | |||
|icon=✦ | |||
|color=var(--border-color-success) | |||
|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. | ||
| Line 93: | 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 103: | Line 106: | ||
== Installation == | == Installation == | ||
==== | ==== Shell ==== | ||
==== | ==== System setup ==== | ||
== Configuration == | == Configuration == | ||
| Line 112: | Line 114: | ||
== Tips and tricks == | == Tips and tricks == | ||
== Troubleshooting == | == Troubleshooting == | ||
== | |||
== See also == | |||
== References == | == References == | ||
| Line 245: | Line 247: | ||
** 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 260: | ||
** Include the time zone when relevant (e.g., 14:30 UTC). | ** Include the time zone when relevant (e.g., 14:30 UTC). | ||
* <strong> | * <strong>Software versions:</strong> | ||
** | ** Software versions are subject to change. Only add software versions when required by the content. | ||
==== Abbreviations ==== | ==== Abbreviations ==== | ||
| Line 343: | Line 346: | ||
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"). | ||
* 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 358: | ||
* 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 395: | ||
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., " | * '''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. | ||
| Line 464: | Line 466: | ||
| 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> | ||
| Line 537: | Line 541: | ||
== 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 === | ||