Manual of Style: Difference between revisions
Improved documentation instructions. Check note. |
mNo edit summary |
||
| (11 intermediate revisions by 5 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. | ||
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 | 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. | ||
== Rules of | == Rules of thumb == | ||
* <strong>Use | * <strong>Use common sense:</strong> Always apply logic and reason when contributing to the wiki. | ||
* <strong>Cite | * <strong>Cite reliable sources:</strong> Aim to ensure that all information added is verifiable and comes from reliable sources. | ||
* <strong>Maintain | * <strong>Maintain neutrality:</strong> Strive to present information in a neutral and unbiased manner. | ||
* <strong>Be | * <strong>Be clear and concise:</strong> Use clear, concise, and grammatically correct language to ensure readability and understanding. | ||
* <strong>Follow | * <strong>Follow site guidelines:</strong> Adhere to the site's guidelines and policies at all times. | ||
* <strong>Avoid | * <strong>Avoid edit wars:</strong> Engage in constructive discussions to resolve content disputes rather than engaging in edit wars. | ||
* <strong>Protect | * <strong>Protect privacy:</strong> Do not share personal information about yourself or others without consent. | ||
* <strong>Contribute | * <strong>Contribute constructively:</strong> Aim to improve the quality of the content and the overall user experience. | ||
* <strong>Use | * <strong>Use proper formatting:</strong> Follow the wiki's formatting guidelines to ensure consistency and readability. | ||
* <strong>Stay | * <strong>Stay on topic:</strong> Ensure that contributions are relevant to the subject matter of the page. | ||
* <strong>Report | * <strong>Report issues:</strong> Report any issues or inappropriate behavior to the administrators promptly. | ||
* <strong>Be | * <strong>Be patient and helpful:</strong> Assist new users and be patient with those who are still learning the ropes. | ||
* <strong>Respect | * <strong>Respect others:</strong> Treat all users with respect and courtesy. Personal attacks and harassment are strictly prohibited. | ||
* <strong>No | * <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 | == Content policy == | ||
=== Plagiarizing === | === Plagiarizing === | ||
| Line 39: | Line 39: | ||
* <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 45: | Line 45: | ||
Vandalism refers to any act of deliberately adding false or misleading information, deleting content, or otherwise compromising the integrity of the wiki. | Vandalism refers to any act of deliberately adding false or misleading information, deleting content, or otherwise compromising the integrity of the wiki. | ||
* <strong>Types of | * <strong>Types of vandalism:</strong> This includes adding false information, deleting pages, inserting inappropriate content, and spamming links. | ||
* <strong>Response:</strong> Vandalized pages will be promptly reverted to their previous state. Persistent vandals will be blocked from editing. | * <strong>Response:</strong> Vandalized pages will be promptly reverted to their previous state. Persistent vandals will be blocked from editing. | ||
* <strong>Reporting:</strong> Users are encouraged to report vandalism immediately. | * <strong>Reporting:</strong> Users are encouraged to report vandalism immediately. | ||
=== Spam and | === Spam and advertisement === | ||
Spamming and advertising are prohibited to keep the wiki free from clutter and irrelevant content. | Spamming and advertising are prohibited to keep the wiki free from clutter and irrelevant content. | ||
| Line 57: | Line 57: | ||
* <strong>Action:</strong> Spammers will have their content removed and may be banned from editing. Legitimate contributions should not include promotional content. | * <strong>Action:</strong> Spammers will have their content removed and may be banned from editing. Legitimate contributions should not include promotional content. | ||
=== Unofficial | === Unofficial wikis === | ||
Hostility towards other wikis is not tolerated. Editors who make hostile comments about other wikis will be warned and may be blocked. | Hostility towards other wikis is not tolerated. Editors who make hostile comments about other wikis will be warned and may be blocked. | ||
* <strong>Linking to | * <strong>Linking to other wikis:</strong> Linking to other wikis is not prohibited if such links contribute to the quality of the content. | ||
* <strong>Contribution | * <strong>Contribution recommendation:</strong> 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, headings, and sections == | ||
| Line 70: | Line 70: | ||
=== 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 | 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. | ||
* <strong>Avoid | * <strong>Avoid redundancy:</strong> Do not include unnecessary words or phrases that do not add value to the title. | ||
=== Section organization === | |||
Proper section organization is crucial for creating well-structured, easily navigable articles. A logical and consistent structure helps readers find information quickly and understand the content more effectively. | |||
==== Hierarchy and structure ==== | |||
* | * Use a clear hierarchy of headings to organize content: | ||
* | * Level 2 (==) for main sections | ||
* Level 3 (===) for subsections | |||
* Level 4 (====) for sub-subsections | |||
* Avoid going deeper than level 4 unless absolutely necessary | |||
* Begin each article with an introduction (without a heading) that summarizes the topic. | |||
* Arrange sections in a logical order, typically following this pattern: | |||
1. Introduction (the introduction has no heading) | |||
2. Installation | |||
3. Configuration | |||
4. Tips and tricks | |||
5. Troubleshooting | |||
6. See also | |||
7. References | |||
==== Standard section structure (applications) ==== | |||
For consistency across the wiki, use the following structure where applicable: | |||
<syntaxhighlight lang="text"> | <syntaxhighlight lang="text"> | ||
( | (Introduction) | ||
== Installation == | == Installation == | ||
==== Shell ==== | |||
==== System setup ==== | |||
== Configuration == | == Configuration == | ||
==== Basic ==== | |||
==== Advanced ==== | |||
== Tips and | == Tips and tricks == | ||
== Troubleshooting == | == Troubleshooting == | ||
== See also == | |||
== References == | == References == | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== Section | ==== Flexibility ==== | ||
While consistency is important, remember that different topics may require different structures. Use your judgment to adapt the standard structure when necessary, always prioritizing clarity for the reader. | |||
=== 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. | 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. | ||
| Line 111: | Line 133: | ||
* <strong>Consistency:</strong> Maintain consistency in the formatting and style of section headers throughout the article. | * <strong>Consistency:</strong> Maintain consistency in the formatting and style of section headers throughout the article. | ||
=== Length | === Length restrictions === | ||
Be mindful of length restrictions when crafting titles and section headings. Excessively long names can make navigation difficult and negatively impact readability. | Be mindful of length restrictions when crafting titles and section headings. Excessively long names can make navigation difficult and negatively impact readability. | ||
* Limit | * <strong>Limit characters:</strong> 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. | * <strong>Conciseness:</strong> Strive for brevity without sacrificing clarity. Consider rephrasing complex ideas or breaking them down into multiple sections. | ||
== Text formatting == | == Text formatting == | ||
| Line 126: | Line 148: | ||
* <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 | ** 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 141: | Line 163: | ||
* <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 | ** 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 158: | Line 180: | ||
Proper capitalization improves readability and maintains a professional appearance: | Proper capitalization improves readability and maintains a professional appearance: | ||
* <strong>Article titles:</strong> Use | * <strong>Article titles:</strong> Use sentence case, capitalizing only the first word. | ||
** Example: Installing NixOS on a | ** Example: Installing NixOS on a virtual machine | ||
* <strong>Section headers:</strong> | * <strong>Section headers:</strong> | ||
** Main sections (==): Use | ** 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. | ||
** Example: Nix, NixOS, Nixpkgs, Eelco Dolstra | ** 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. | * <strong>Common nouns:</strong> Do not capitalize unless they are part of an official name or at the beginning of a sentence. | ||
** Example: " | ** 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. | ||
| Line 206: | Line 224: | ||
==== Spacing ==== | ==== Spacing ==== | ||
Consistent spacing | Consistent spacing improves 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>Single space after periods:</strong> Use only one space after a period at the end of a sentence. | ||
| Line 229: | 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 241: | 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 312: | Line 331: | ||
== Vocabulary == | == Vocabulary == | ||
Consistent use of terminology is crucial for maintaining clarity across the NixOS Wiki. This section outlines key terms and their preferred usage: | |||
* <strong>Nix:</strong> The package manager and build system at the core of NixOS. | |||
* <strong>NixOS:</strong> The Linux distribution built on top of the Nix package manager. | |||
* <strong>Nixpkgs:</strong> The collection of packages available for Nix and NixOS. | |||
* <strong>Derivation:</strong> A description of how to build a package in Nix. | |||
* <strong>Expression:</strong> A piece of Nix code that describes how to build something. | |||
* <strong>Channel:</strong> A versioned set of Nix expressions and binaries. | |||
* <strong>Flake:</strong> A newer way to package Nix code with explicit dependencies and outputs. | |||
* <strong>Attribute:</strong> A named value in a Nix expression, often used to refer to packages or configuration options. | |||
* <strong>Configuration.nix:</strong> The main configuration file for a NixOS system. | |||
When using these terms: | |||
* 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. | |||
== Linking == | == Linking == | ||
Proper linking improves navigation and provides additional context for readers. This section covers different types of links used in the NixOS Wiki. | |||
==== Wikilinks ==== | ==== Wikilinks ==== | ||
Wikilinks are internal links to other pages within the NixOS Wiki. | |||
* 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> | |||
* 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 ==== | ||
External links point to resources outside the NixOS Wiki. | |||
* Use single square brackets for external links: <syntaxhighlight lang="mediawiki">[https://example.com Link text]</syntaxhighlight> | |||
* If no link text is provided, the URL itself will be displayed: <syntaxhighlight lang="mediawiki">[https://example.com]</syntaxhighlight> | |||
* For bare URLs, no brackets are needed: <syntaxhighlight lang="mediawiki">https://example.com</syntaxhighlight> | |||
==== Category links ==== | ==== Category links ==== | ||
Category links help organize pages into groups. | |||
* Add category links at the bottom of the page: <syntaxhighlight lang="mediawiki">[[Category:Category Name]]</syntaxhighlight> | |||
* Multiple categories can be added to a single page. | |||
* To link to a category page without adding the current page to that category, use a colon before "Category": <syntaxhighlight lang="mediawiki">[[:Category:Category Name]]</syntaxhighlight> | |||
== Images == | == Images == | ||
Images can greatly | Images can greatly improve 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. | * '''File types:''' Use PNG for screenshots and diagrams, JPEG for photographs, and SVG for logos and icons when available. | ||
| Line 339: | 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 350: | Line 406: | ||
* user-home-directory-structure.jpg | * user-home-directory-structure.jpg | ||
== | == Videos == | ||
Videos can be a valuable addition to wiki articles, especially for tutorials or demonstrations. Follow these guidelines: | |||
* <strong>Relevance:</strong> Only include videos that directly support the article's content. | |||
* <strong>Linking:</strong> Use reputable video hosting platforms (e.g., YouTube, Vimeo) to link videos. | |||
* <strong>Permissions:</strong> Ensure you have the right to use and link the video content. | |||
* <strong>Captions:</strong> Include a descriptive caption below the video. | |||
* <strong>Alternative:</strong> Always provide a text-based alternative or summary of the video content within the article. | |||
== Lists == | |||
Lists help organize information in a clear, readable format. The NixOS Wiki uses two types of lists: | |||
=== Unordered lists === | |||
Use asterisks (*) for bullet points. Indent with additional asterisks for nested lists. | |||
<syntaxhighlight lang="mediawiki"> | |||
* First item | |||
* Second item | |||
** Subitem 1 | |||
** Subitem 2 | |||
* Third item | |||
</syntaxhighlight> | |||
=== Ordered lists === | |||
Use hash symbols (#) for numbered lists. Indent with additional hash symbols for nested lists. | |||
<syntaxhighlight lang="mediawiki"> | <syntaxhighlight lang="mediawiki"> | ||
# First step | |||
# Second step | |||
## Substep 1 | |||
## Substep 2 | |||
# Third step | |||
</syntaxhighlight> | </syntaxhighlight> | ||
=== List guidelines === | |||
* Use sentence case for list items. | |||
* Be consistent with punctuation (either use periods at the end of all items or none). | |||
* Keep list items parallel in structure. | |||
* Avoid mixing ordered and unordered lists unless necessary for clarity. | |||
== Tables == | |||
Tables are useful for presenting structured data. Here's how to create and format tables in the NixOS Wiki: | |||
== | === Basic table structure === | ||
Use the following syntax to create a basic table: | |||
<syntaxhighlight lang="mediawiki"> | |||
{| class="wikitable" style="text-align: center; width: 500px;" | |||
|- | |||
! Header 1 !! Header 2 !! Header 3 | |||
|- | |||
| Row 1, Cell 1 || Row 1, Cell 2 || Row 1, 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> | |||
=== Table formatting === | |||
= | * Use <code>class="wikitable"</code> for consistent styling. | ||
* Start each row with <code>|-</code> | |||
* Use <code>!</code> for header cells and <code>|</code> for regular cells. | |||
* Align cell content using <code>style="text-align: left/center/right;"</code> | |||
== | === Table guidelines === | ||
* Keep tables simple and easy to read. | |||
* Use headers to clearly describe the content of each column. | |||
* Avoid excessive use of tables when prose or lists would suffice. | |||
* For complex tables, consider using additional CSS classes or inline styles for better formatting. | |||
== Translation == | == Translation == | ||
* <strong>Accuracy:</strong> | Translating wiki content is crucial for making information accessible to a global audience. Proper translation not only conveys information accurately but also respects cultural nuances. | ||
* <strong>Cultural | |||
* <strong> | === General principles === | ||
* <strong> | |||
* <strong> | * <strong>Accuracy:</strong> Strive for translations that faithfully represent the original content without altering meaning or omitting information. | ||
* <strong> | * <strong>Clarity:</strong> Prioritize clear, understandable language over literal translations. | ||
* <strong>Consistency:</strong> Maintain consistent terminology and style across all translated pages. | |||
* <strong>Cultural sensitivity:</strong> Be mindful of cultural differences and adapt content appropriately. | |||
=== Translation process === | |||
==== Preparation ==== | |||
* <strong>Familiarize:</strong> Read the entire original article to understand context and technical terms. | |||
* <strong>Research:</strong> Identify established translations for NixOS-specific terms in your target language. | |||
* <strong>Tools:</strong> Machine translation is allowed for a general foundation, but it must be reviewed. | |||
==== Translation ==== | |||
* <strong>Translate content:</strong> Begin with the main body of the article. | |||
* <strong>Maintain structure:</strong> Preserve the original article's structure and formatting. | |||
* <strong>Technical terms:</strong> Use glossaries for consistent translation of technical terms. | |||
* <strong>Proper nouns:</strong> Generally, do not translate names of tools, projects, or people. | |||
==== Review and refinement ==== | |||
* <strong>Self-review:</strong> Proofread your translation for accuracy and fluency. | |||
* <strong>Peer review:</strong> If possible, have a native speaker review the translation. | |||
* <strong>Technical review:</strong> Ensure technical accuracy, especially for code snippets and commands. | |||
=== Language-specific guidelines === | |||
* Maintain a separate page for language-specific translation guidelines. | |||
* Address unique challenges or conventions for each language. | |||
* Provide guidance on translating or adapting idiomatic expressions. | |||
=== Handling untranslatable content === | |||
* <strong>Code snippets:</strong> Generally, do not translate code. Provide translated comments if necessary. | |||
* <strong>Commands:</strong> Keep command syntax unchanged, but translate descriptions and explanations. | |||
=== Metadata and navigation === | |||
* <strong>Page titles:</strong> Use translated titles, but include the original title in parentheses. | |||
* <strong>Categories:</strong> Create and use translated category names. | |||
* <strong>Interlanguage links:</strong> Add appropriate interlanguage links to connect corresponding articles across languages. | |||
=== Quality assurance === | |||
* Regularly review and update translations to ensure they remain accurate and up-to-date. | |||
* Encourage feedback from readers and act on suggestions for improvement. | |||
* Conduct periodic audits of translated content to maintain overall quality and consistency. | |||
== Templates == | == Templates == | ||
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 === | |||
* <strong>Warning:</strong> A warning box used to report potential danger. | |||
* <strong>Note:</strong> A note box used to emphasize important information. | |||
* <strong>Tip:</strong> A tip box used to share helpful hints. | |||
* <strong>Expansion:</strong> An expansion flag used to indicate incomplete articles. | |||
=== Using templates === | |||
To use a template, enclose its name in double curly braces: | |||
<syntaxhighlight lang="mediawiki"> | |||
{{TemplateName}} | |||
</syntaxhighlight> | |||
For templates with parameters: | |||
<syntaxhighlight lang="mediawiki"> | |||
{{TemplateName|parameter1=value1|parameter2=value2}} | |||
</syntaxhighlight> | |||
==== Template markup ==== | ==== Template markup ==== | ||
When creating new templates: | |||
* Use clear, descriptive names for templates. | |||
* Document the purpose and usage of the template on its talk page. | |||
* Use <strong><noinclude></strong> tags for content that should only appear on the template page itself. | |||
== References == | == References == | ||
Proper referencing is crucial for maintaining the credibility and verifiability of wiki content. Follow these guidelines for references: | |||
=== Citation styles === | |||
* Use inline citations with numbered references: | |||
<syntaxhighlight lang="mediawiki"> | |||
This is a statement that needs a reference.<ref>Author Name, "Article Title", Publication, Date. URL</ref> | |||
</syntaxhighlight> | |||
* For multiple uses of the same reference, use named references: | |||
<syntaxhighlight lang="mediawiki"> | |||
First use of the reference.<ref name="example">Author Name, "Article Title", Publication, Date. URL</ref> | |||
... | |||
Later use of the same reference.<ref name="example" /> | |||
</syntaxhighlight> | |||
=== General guidelines === | |||
* Prefer primary sources and official documentation when available. | |||
* Avoid referencing personal blogs or unreliable sources. | |||
* For software-specific information, link to the official documentation or repository. | |||
* When referencing specific versions of software, include the version number in the citation. | |||
[[Category:Contributions]] | [[Category:Contributions]] | ||