@@ Line 81: / Line 81: @@
 * <strong>Hierarchy:</strong> Use a clear hierarchy of headings (e.g., ==, ===, ====) to indicate the structure of the content. Main sections should use level 2 headings (==), while subsections should use level 3 (===) and level 4 (====) headings as needed.
 * <strong>Flow:</strong> Arrange sections in a logical order, starting with an introduction and moving through the main points before concluding.
+<strong>e.g.</strong> Where applicable, you must use the following structure:
+<syntaxhighlight lang="text">
+(Description)
+== Installation ==
+├── ==== Using nix-shell ====
+├── ==== Using Global Configuration ====
+└── ==== Using Home Configuration ====
+== Configuration ==
+├── ==== Basic ====
+└── ==== Advanced ====
+== Tips and Tricks ==
+└── ==== Location of Options ====
+== Troubleshooting ==
+└── ==== Issue 1 ====
+== References ==
+</syntaxhighlight>
 === Section Headers ===
@@ Line 89: / Line 111: @@
 * <strong>Consistency:</strong> Maintain consistency in the formatting and style of section headers throughout the article.
-==== Linking to sections ====
+=== Length Restrictions ===
+Be mindful of length restrictions when crafting titles and section headings. Excessively long names can make navigation difficult and negatively impact readability.
+* Limit Characters: Section headings should ideally remain under 40 characters.
+* Conciseness: Strive for brevity without sacrificing clarity. Consider rephrasing complex ideas or breaking them down into multiple sections.
 == Text formatting ==
+Proper text formatting is essential for maintaining consistency, readability, and professionalism across the NixOS Wiki. This section outlines the guidelines for various text formatting elements to ensure a uniform presentation of information.
 ==== Title of works ====
+When referencing titles of various works, follow these guidelines:
+* <strong>Articles, blog posts, and short stories:</strong> Use double quotation marks
+** Example: "Understanding Nix Flakes", "The NixOS Installation Guide"
+* <strong>Software names, tools, and commands:</strong> Use regular text, typically with initial capitalization
+** Example: Nix, NixOS, nixpkgs, nix-shell
+* <strong>Website names:</strong> Use regular text without quotes or italics
+** Example: Visit the NixOS website for more information.
+When in doubt, prioritize clarity and consistency within the article.
 ==== Quotations ====
+Proper quotation formatting helps distinguish cited material from original content:
+* <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."
+* <strong>Long quotes (40 words or more):</strong> Use block quotes by indenting the entire quote or using the <strong>blockquote</strong> tag.
+* <strong>Quotes within quotes:</strong> Use single quotation marks (') for the inner quote.
+** Example: "The developer explained, 'Nix provides a purely functional approach to package management,' which revolutionized the field."
+* <strong>Citations:</strong> Always provide a source for quotations, either inline or as a footnote.
+** Example: "NixOS offers reproducible builds"[1].
+* <strong>Alterations and omissions:</strong> Use square brackets [] to indicate changes or additions to quotes, and ellipsis (...) for omissions.
+** Example: "NixOS [provides] a unique approach to ... configuration management."
 ==== Capital letters ====
+Proper capitalization improves readability and maintains a professional appearance:
+* <strong>Article titles:</strong> Use title case, capitalizing all major words.
+** Example: Installing NixOS on a Virtual Machine
+* <strong>Section headers:</strong>
+** Main sections (==): Use title case
+** Subsections (===, ====): Use sentence case
+** Example:
+*** Installation Process
+*** Preparing the installation media
+* <strong>Proper nouns:</strong> Always capitalize names of specific people, places, organizations, and NixOS-specific components.
+** Example: Nix, NixOS, Nixpkgs, Eelco Dolstra
+* <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"
+* <strong>Acronyms and initialisms:</strong> Generally use all caps, but follow official styling if different.
+** Example: RAM, CPU, NixOS (not NIXOS)
 ==== Boldface ====
+Use bold text sparingly to emphasize important information:
+* <strong>First mention:</strong> Bold the first occurrence of the article's main topic in the introduction.
+** Example: <nowiki><strong>NixOS</strong></nowiki> is a Linux distribution built on top of the Nix package manager.
+* <strong>Key terms:</strong> Use bold for important terms being defined.
+** Example: A <nowiki>'''derivation'''</nowiki> in Nix is a description of how to build a package.
+* <strong>User interface elements:</strong> Bold names of buttons, menu items, or other UI elements.
+** Example: Click the <strong>Save</strong> button to apply your changes.
+* <strong>Avoid overuse:</strong> Do not use bold for entire sentences or paragraphs, as this reduces its effectiveness.
 ==== Italic ====
+Italic text serves several purposes in technical writing:
+* <strong>Emphasis:</strong> Use italics to stress particular words when appropriate.
+** Example: It is <strong>''crucial''</strong> to back up your configuration before making major changes.
+* <strong>Non-English words:</strong> Italicize words or phrases from languages other than the primary language of the article.
+** Example: In programming, we often use the term <strong>''de facto''</strong> to describe widely accepted standards.
+* <strong>Do not italicize:</strong> Proper names, technical terms after their first use, or entire paragraphs.
 ==== Spacing ====
+Consistent spacing enhances readability and maintains a clean appearance:
+* <strong>Single space after periods:</strong> Use only one space after a period at the end of a sentence.
+* <strong>No spaces around slashes:</strong> In constructions like "and/or" or "TCP/IP", do not add spaces around the slash.
+* <strong>Space after commas:</strong> Always include a space after a comma, but not before.
+* <strong>Lists:</strong> Add a space after the list marker (*, #) in bulleted or numbered lists.
+* <strong>Parentheses:</strong> No spaces inside parentheses, but do use spaces outside when in a sentence.
+** Example: NixOS (a Linux distribution) offers many advantages.
+* <strong>Code blocks:</strong> Use consistent indentation within code blocks for readability.
 ==== Numbers and dates ====
+Consistent formatting of numbers and dates is crucial for clarity:
+* <strong>Numbers:</strong>
+** Spell out numbers zero through nine in prose.
+** Use numerals for 10 and above.
+** Use commas for numbers with four or more digits (e.g., 1,000, 10,000).
+** For very large numbers, consider using words (e.g., 1 million instead of 1,000,000).
+* <strong>Percentages:</strong> Use the % symbol with numerals (e.g., 50%), but spell out "percent" when the number is also spelled out (e.g., five percent).
+* <strong>Dates:</strong>
+** Use the format: Month Day, Year (e.g., January 1, 2024).
+** For numeric dates, use ISO 8601 format: YYYY-MM-DD (e.g., 2024-01-01).
+* <strong>Time:</strong>
+** Use 24-hour clock format to avoid ambiguity (e.g., 14:30 instead of 2:30 PM).
+** Include the time zone when relevant (e.g., 14:30 UTC).
+* <strong>Versions:</strong>
+** Do not add software versions, since they are prone to change.
 ==== Abbreviations ====
+Proper use of abbreviations ensures clarity while maintaining brevity:
+* <strong>First use:</strong> When first using an abbreviation, write out the full term followed by the abbreviation in parentheses.
+** Example: The Nix Expression Language (NEL) is used to define packages.
+* <strong>Common abbreviations:</strong> Well-known abbreviations (e.g., RAM, CPU) don't need to be spelled out on first use.
+* <strong>Plurals of abbreviations:</strong> Add 's' without an apostrophe (e.g., SSDs, not SSD's).
+* <strong>Periods in abbreviations:</strong>
+** Generally, omit periods in abbreviations (e.g., PhD, AM/PM).
+** Use periods for lowercase abbreviations (e.g., i.e., etc.).
+* <strong>Units of measurement:</strong> Use standard abbreviations without periods (e.g., 5 GB, 10 MHz).
 ==== Grammar and punctuation ====
+Correct grammar and punctuation are essential for clear communication:
+* <strong>Comma usage:</strong>
+** Use the Oxford comma in lists of three or more items.
+* <strong>Semicolons:</strong> Use to separate closely related independent clauses or in complex lists.
+* <strong>Colons:</strong> Use to introduce lists or explanations.
+* <strong>Hyphens and dashes:</strong>
+** Use hyphens (-) for compound modifiers (e.g., well-known package).
+** Use en dashes (–) for ranges (e.g., 5–10 minutes).
+** Use em dashes (—) for parenthetical thoughts—like this one—in sentences.
+* <strong>Parentheses:</strong> Use sparingly to include additional information without disrupting the flow of the sentence.
+* <strong>Quotation marks:</strong> Place periods and commas inside quotation marks. Place other punctuation outside unless it's part of the quoted material.
+* <strong>Active voice:</strong> Prefer active voice over passive voice for clearer, more direct writing.
 ==== Wording and tone ====
+Maintain a consistent and appropriate tone throughout the wiki:
+* <strong>Formal but approachable:</strong> Strike a balance between professional and friendly.
+* <strong>Clarity:</strong> Use clear, concise language. Avoid jargon unless necessary, and explain technical terms.
+* <strong>Objectivity:</strong> Present information neutrally, avoiding bias or personal opinions.
+* <strong>Consistency:</strong> Maintain consistent terminology throughout articles and across the wiki.
+* <strong>International audience:</strong> Consider that readers may not be native English speakers. Avoid colloquialisms or culture-specific references.
+* <strong>Direct address:</strong> Use "you" to address the reader directly when providing instructions or explanations.
 ==== Common examples of tone ====
+Here are some examples of appropriate and inappropriate tone:
+* <strong>Appropriate:</strong> "To install NixOS, follow these steps carefully."
+* <strong>Inappropriate:</strong> "Installing NixOS is super easy! Here's how to do it."
+* <strong>Appropriate:</strong> "If you encounter an error, consult the troubleshooting section."
+* <strong>Inappropriate:</strong> "If you get an error, check the solution below!"
+Remember, the goal is to provide clear, helpful information in a professional manner.
 == Vocabulary ==
@@ Line 114: / Line 321: @@
 == Images ==
+Images can greatly enhance the content of wiki articles. When using images, follow these guidelines:
+* '''File types:''' Use PNG for screenshots and diagrams, JPEG for photographs, and SVG for logos and icons when available.
+* '''Size:''' Keep file sizes reasonable. Aim for under 1MB for most images.
+* '''Alt text:''' Always provide descriptive alt text for accessibility.
+* '''Captions:''' Use clear, concise captions to describe the image content.
+* '''Alignment:''' Generally, align images to the right of text unless a different alignment better serves the content.
+To add an image:
+<syntaxhighlight lang="mediawiki">
+[[File:Example.png|thumb|right|250px|Alt text: Description of image content]]
+</syntaxhighlight>
 ==== Image file names ====
+Proper image file naming helps with organization and searchability:
+* '''Descriptive names:''' Use clear, descriptive file names (e.g., "NixOS-installation-partitioning.png").
+* '''Lowercase:''' Use lowercase letters to avoid case-sensitivity issues.
+* '''Hyphens:''' Use hyphens (-) to separate words, not underscores or spaces.
+* '''Avoid special characters:''' Stick to alphanumeric characters and hyphens.
+* '''Version numbers:''' If updating an image, consider adding a version number (e.g., "nixos-logo-v2.svg").
+Examples of good file names:
+* nixos-boot-screen.png
+* package-management-diagram.svg
+* user-home-directory-structure.jpg
 == Copyrighted material ==
+Respecting copyright is crucial. Follow these guidelines when dealing with copyrighted content:
+* '''Permission:''' Always obtain permission before using copyrighted material.
+* '''Fair use:''' If claiming fair use, clearly state this and provide a rationale.
+* '''Attribution:''' Properly attribute all copyrighted material to its source.
+* '''Licenses:''' Use content with compatible licenses (e.g., Creative Commons).
+* '''Public domain:''' Clearly mark content that is in the public domain.
+To attribute copyrighted material:
+<syntaxhighlight lang="mediawiki">
+{{Attribution
+ | author = Original Author
+ | source = https://example.com/original-source
+ | license = CC BY-SA 4.0
+}}
+</syntaxhighlight>
+<div style="border: 1px solid #2E8B57; background: #DFF2DF; 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: #2E8B57; font-size: 15px; font-style: normal; font-weight: 400; line-height: normal; text-align: left;">This template does not yet exist! Remove this note if added.</div>
+</div>
+'''Note:''' When in doubt about the copyright status of material, do not use it. It's better to err on the side of caution.
 == Videos ==
+Videos can be a valuable addition to wiki articles, especially for tutorials or demonstrations. Follow these guidelines:
+...
 == Wiki markup styling ==

Manual of Style: Difference between revisions