Jump to content

Style Guide: Difference between revisions

From BadWolfMC Wiki
Initial Page Creation
 
m Merc moved page BadWolfMC:Style Guide to Style Guide without leaving a redirect
(No difference)

Revision as of 20:22, 5 October 2025

This document outlines the formatting and writing conventions used throughout the wiki to maintain consistency, clarity, and accessibility. All contributors should follow these guidelines when editing or creating pages.

General Writing Guidelines

  • Tone: Keep a friendly, informative tone. Articles should be accessible to both new and experienced players. Avoid unnecessary jargon and assume readers may not be familiar with every system.
  • Perspective: Use third person (“Players can…” rather than “You can…”), unless describing direct commands or dialogue where second person is more natural.
  • Clarity: Write short, direct sentences. Avoid redundancy and filler.
  • Spelling: Use American English (e.g., “color” instead of “colour”).
  • Punctuation: Use Oxford commas for lists, and keep punctuation outside of wiki links (e.g., "BadWolfMC Wiki," not "BadWolfMC Wiki,".

Command Formatting

Commands should always follow a consistent structure and visual style to improve readability.

In-line commands

Use the Computer Code format (Ctrl+Shift+6) for any command mentioned within a sentence. Example: Type /spawn to return to the main world.

Single-line or block commands

Use the Preformatted Paragraph style (Ctrl+7) for any command displayed on its own line or as a group. Example: /home set /warp Alpha /res create [name]

Command syntax format

Use /command [required_argument] (optional_argument) to denote structure.

  • Square brackets [] indicate required arguments.
  • Parentheses () indicate optional arguments.

Example: /res create [name] (owner)

Linking and Cross-References

  • Always link the first mention of a topic to its relevant wiki page.
  • Use descriptive link text, not “click here.” Example: See the Residence Guide for details.
  • Avoid overlinking the same term multiple times on one page.

Visual Formatting

  • Use Headings (Ctrl+1 through Ctrl+5) to create clear hierarchy.
  • Heading 2 for major sections
  • Heading 3 for subsections
  • Avoid excessive bold or italics. Use them sparingly for emphasis.
  • Lists (• or numbered) are encouraged for clarity, especially in how-to or procedural pages.
  • Tables should be used only where data benefits from structured comparison (e.g., price charts, flag lists).