Manual of Style

⚠

Under construction!

This guideline is a part of the NixOS Wiki's Manual of Style

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.

This Manual of Style (hereinafter referred to as "MoS" or "MOS") 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.

Any new content incorporated into this page must directly address a persistently recurring style issue.

Rules of Thumb

• Use Common Sense: Always apply logic and reason when contributing to the wiki.
• Cite Reliable Sources: Ensure that all information added is verifiable and sourced from reliable references.
• Maintain Neutrality: Strive to present information in a neutral and unbiased manner.
• Be Clear and Concise: Use clear, concise, and grammatically correct language to ensure readability and understanding.
• Follow Site Guidelines: Adhere to the site's guidelines and policies at all times.
• Avoid Edit Wars: Engage in constructive discussions to resolve content disputes rather than engaging in edit wars.
• Protect Privacy: Do not share personal information about yourself or others without consent.
• Contribute Constructively: Aim to improve the quality of the content and the overall user experience.
• Use Proper Formatting: Follow the wiki's formatting guidelines to ensure consistency and readability.
• Stay On Topic: Ensure that contributions are relevant to the subject matter of the page.
• Report Issues: Report any issues or inappropriate behavior to the administrators promptly.
• Be Patient and Helpful: Assist new users and be patient with those who are still learning the ropes.
• Respect Others: Treat all users with respect and courtesy. Personal attacks and harassment are strictly prohibited.
• No Advertising, Vandalism, or Spamming: Contributions should be constructive and relevant. Any form of advertising, vandalism, or spamming will not be tolerated.

Content Policy

Plagiarizing

Plagiarizing involves using someone else’s work without proper attribution and presenting it as your own. This practice is strictly prohibited on this wiki.

• Definition: Plagiarism includes copying text, images, or other media without crediting the original source.
• Consequences: Plagiarized content will be removed immediately. Contributors who repeatedly plagiarize may be banned.
• Prevention: Always cite your sources. Use quotation marks for direct quotes and provide proper references.

Vandalism

Vandalism refers to any act of deliberately adding false or misleading information, deleting content, or otherwise compromising the integrity of the wiki.

• Types of Vandalism: This includes adding false information, deleting pages, inserting inappropriate content, and spamming links.
• Response: Vandalized pages will be promptly reverted to their previous state. Persistent vandals will be blocked from editing.
• Reporting: Users are encouraged to report vandalism immediately.

Spam and Advertisement

Spamming and advertising are prohibited to keep the wiki free from clutter and irrelevant content.

• Definition: Spam includes repetitive content, irrelevant links, and advertisements for external products or services.
• Detection: Automated filters and manual reviews help identify and remove spam.
• Action: Spammers will have their content removed and may be banned from editing. Legitimate contributions should not include promotional content.

Unofficial Wikis

Hostility towards other wikis is not tolerated. Editors who make hostile comments about other wikis will be warned and may be blocked.

• Linking to Other Wikis: Linking to other wikis is not prohibited if such links contribute to the quality of the content.
• Contribution Recommendation: It is recommended that editors only contribute to one wiki at a time to ensure they do not inadvertently violate the copyright policies of the wikis they edit.

Article titles, headings, and sections

Article titles and section headings should reflect the content they contain. Titles and section headings should be concise and precise. Titles should be consistent with the titles of related content.

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.

• Consistency: Ensure that article titles are consistent with the titles of related content to maintain a cohesive structure across the wiki.
• Avoid Redundancy: Do not include unnecessary words or phrases that do not add value to the title.

Section Organization

Sections within an article should be organized logically to guide the reader through the content in a coherent manner. Each section should cover a distinct aspect of the topic, and related sections should be grouped together.

• Hierarchy: 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.
• Flow: Arrange sections in a logical order, starting with an introduction and moving through the main points before concluding.

Section Headers

Section headers should be concise and accurately reflect the content of the section. They should provide a clear indication of what the reader can expect to find in that section.

• Clarity: Use clear and descriptive language for section headers. Avoid vague or ambiguous terms.
• Consistency: Maintain consistency in the formatting and style of section headers throughout the article.

Translation

Translation of content is essential to make the wiki accessible to a broader audience. Accurate and culturally sensitive translations help ensure that information is available to users who speak different languages.

• Accuracy: Translations should be accurate and faithful to the original content. Avoid adding or omitting information that could alter the meaning.
• Cultural Sensitivity: Be mindful of cultural differences and ensure that translations are appropriate for the target audience. Avoid idioms or phrases that may not translate well.
• Consistency: Use consistent terminology and style across translations to maintain the integrity of the content. Refer to already translated pages if available.
• Attribution: If you are translating content from another source, provide proper attribution to the original author and source.
• Collaboration: Work with native speakers or professional translators when possible to ensure the highest quality translations. Engage with the community to review and improve translations.
• Tools and Resources: You may use translation tools and resources, but always review and edit machine translations for accuracy.