Style Guide - Revision history

Merc at 01:49, 6 October 2025

2025-10-06T01:49:37Z

← Older revision		Revision as of 01:49, 6 October 2025
Line 61:		Line 61:
	== Template Usage ==		== Template Usage ==

	* Use existing '''templates''' (e.g., <code><nowiki>{{~~Command~~}}</nowiki></code>, <code><nowiki>{{~~Warning~~}}</nowiki></code>, <code><nowiki>{{~~Note~~}}</nowiki></code>) wherever applicable.		* Use existing '''templates''' (e.g., <code><nowiki>{{Cleanup}}</nowiki></code>, <code><nowiki>{{Infobox}}</nowiki></code>, <code><nowiki>{{Stub}}</nowiki></code>) wherever applicable.
	* If a new type of formatting appears often, consider creating a reusable template or module to maintain consistency.		* If a new type of formatting appears often, consider creating a reusable template or module to maintain consistency.

Line 69:		Line 69:
	* Keep language '''inclusive''' and '''non-judgmental'''.		* Keep language '''inclusive''' and '''non-judgmental'''.
	* Avoid personal opinions or editorial comments (“This plugin is annoying”).		* Avoid personal opinions or editorial comments (“This plugin is annoying”).
	* If something is ~~uncertain~~ or subject to change, mark it clearly ~~with~~ <code><nowiki>{{~~Needs Verification~~}}</nowiki></code> ~~or <code><nowiki>{{Outdated}}</nowiki></code> if such templates exist~~.		* If something is outdated or subject to change, mark it clearly using the <code><nowiki>{{Update}}</nowiki></code> [[Template:Update\|template]].

	== Future Additions (Suggested Topics) ==		== Future Additions (Suggested Topics) ==

Merc: /* Command syntax format */

2025-10-06T01:05:39Z

Command syntax format

← Older revision		Revision as of 01:05, 6 October 2025
Line 22:		Line 22:
	/res create [name]		/res create [name]

	=== Command syntax format ===		=== Command syntax format for variable arguments ===
	Use <code>/command [required_argument] (optional_argument)</code> to denote structure.		Use <code>/command [required_argument] (optional_argument)</code> to denote structure with variables.

	* Square brackets [] indicate variable ~~required~~ arguments.		* Square brackets [] indicate required variable arguments.
	* Parentheses () indicate variable ~~optional~~ arguments.		* Parentheses () indicate optional variable arguments.
			* Exceptions to this format include provided non-variable arguments which are being explained, such as options that might follow <code>/res set</code> as opposed to simply <code>/res</code>. In this example "set" is not considered a variable and does not require punctuation indicating such. However, if one were explaining the variables associated with the root <code>/res</code> command, then the ensuing arguments would be considered variables.
	Example: <code>/res set [resname] (flagname) (true\|false\|removed)</code>		Example: <code>/res set [resname] (flagname) (true\|false\|removed)</code>

Merc at 20:36, 5 October 2025

2025-10-05T20:36:58Z

← Older revision		Revision as of 20:36, 5 October 2025
Line 13:		Line 13:
	=== In-line commands ===		=== In-line commands ===
	Use the Computer Code format (Ctrl+Shift+6) for any command mentioned within a sentence.		Use the Computer Code format (Ctrl+Shift+6) for any command mentioned within a sentence.

	Example: Type <code>/spawn</code> to return to the main world.		Example: Type <code>/spawn</code> to return to the main world.

	=== Single-line or block commands ===		=== Single-line or block commands ===
	Use the Preformatted Paragraph style (Ctrl+7) for any command displayed on its own line or as a group.		Use the Preformatted Paragraph style (Ctrl+7) for any command displayed on its own line or as a group.
	Example:
	~~<code>/home set~~		Example:
	~~/warp Alpha~~		/res create [name]
	/res create [name]~~</code>~~

	=== Command syntax format ===		=== Command syntax format ===
	Use <code>/command [required_argument] (optional_argument)</code> to denote structure.		Use <code>/command [required_argument] (optional_argument)</code> to denote structure.

	* Square brackets [] indicate required arguments.		* Square brackets [] indicate variable required arguments.
	* Parentheses () indicate optional arguments.		* Parentheses () indicate variable optional arguments.
	Example: <code>/res ~~create~~ [~~name~~] (~~owner~~)</code>		Example: <code>/res set [resname] (flagname) (true\|false\|removed)</code>

	== Linking and Cross-References ==		== Linking and Cross-References ==
Line 35:		Line 35:

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

			== Item and Plugin Names ==

			* '''Minecraft item names''' should match their in-game capitalization (e.g., ''Diamond Pickaxe'', ''Golden Apple'').
			* '''Plugin names''' should be capitalized as their developers do (e.g., ''VeinMiner'', ''DynMap'').
			* '''Custom items or tools''' unique to BadWolfMC should be ''italicized'' and capitalized consistently (e.g., ''Sonic Shimmer'', ''Key of Rassilon'').

			== Page Layout ==

			* Each article should begin with a '''brief overview paragraph''' describing what the page covers.
			* For guides, follow this logical flow:
			*# Overview / Purpose
			*# Prerequisites or Requirements
			*# Step-by-Step Instructions
			*# Tips or Notes
			*# Related Pages

			== Template Usage ==

			* Use existing '''templates''' (e.g., <code><nowiki>{{Command}}</nowiki></code>, <code><nowiki>{{Warning}}</nowiki></code>, <code><nowiki>{{Note}}</nowiki></code>) wherever applicable.
			* If a new type of formatting appears often, consider creating a reusable template or module to maintain consistency.

			== Tone and Conduct ==
			Remember: the wiki represents the '''BadWolfMC community'''.

			* Keep language '''inclusive''' and '''non-judgmental'''.
			* Avoid personal opinions or editorial comments (“This plugin is annoying”).
			* If something is uncertain or subject to change, mark it clearly with <code><nowiki>{{Needs Verification}}</nowiki></code> or <code><nowiki>{{Outdated}}</nowiki></code> if such templates exist.

			== Future Additions (Suggested Topics) ==
			You can expand the guide over time to include:

			* Image usage and file naming conventions
			* Category tagging and navigation boxes
			* How to write lore entries vs. technical guides
			* Formatting changelogs or version histories
			* Markdown vs. Wikitext do’s and don’ts

Merc: Merc moved page BadWolfMC:Style Guide to Style Guide without leaving a redirect

2025-10-05T20:22:56Z

Merc moved page BadWolfMC:Style Guide to Style Guide without leaving a redirect

← Older revision	Revision as of 20:22, 5 October 2025
(No difference)

Merc: Initial Page Creation

2025-10-05T20:22:05Z

Initial Page Creation

New page

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:An Adult Minecraft Server|BadWolfMC Wiki]]," not "[[BadWolfMC:An Adult Minecraft Server|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 <code>/spawn</code> 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:
<code>/home set
/warp Alpha
/res create [name]</code>

=== Command syntax format ===
Use <code>/command [required_argument] (optional_argument)</code> to denote structure.

* Square brackets [] indicate required arguments.
* Parentheses () indicate optional arguments.
Example: <code>/res create [name] (owner)</code>

== 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|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).