This is an old revision of the document!
Article Structure & Template
This page defines the standard structure for every article on this wiki. It keeps pages consistent, scannable, and easy to cross-link. Follow it for new content; the template below gives you the skeleton to copy and fill in. 1)
Copy the template (next section), create your page from it, and fill in each section. Delete unused lines, but keep the order.
The Template (copy me)
Grab the raw markup below into a new page, then replace the bracketed parts. This is the minimum viable skeleton:
- article-template.txt
====== # Article Title # ====== <WRAP box tip>**One-line summary** of what this article covers. Replace or delete this box once the page is filled in.</WRAP> ^ Field ^ Value ^ ^ Type | Guide / Config / Walkthrough / Reference | ^ Game / Version | e.g. Minecraft 1.21 - Paper 1.21.4 | ^ Section | minecraft:guides | ^ Status | Draft / Review / Published | ^ Updated | YYYY-MM-DD | ^ Author | your wiki username | ===== Overview ===== 2-3 sentences: what this covers, who it's for, and the end result. ===== Prerequisites ===== - Required plugin/version or prior knowledge - Another requirement ===== Steps ===== - Step 1 — do the thing - Step 2 — configure it (see [[minecraft:configs:start|configs]]) <WRAP box warning>Call out anything dangerous, destructive, or a spoiler here.</WRAP> ===== Related ===== * [[minecraft:start|Back to Minecraft hub]] {{tag>minecraft example}}
The required metadata block
Every page opens with a metadata table (the only place version/status lives) so readers instantly know the scope:
| Field | Purpose | Required? |
|---|---|---|
| Type | Guide / Config / Walkthrough / Reference | yes |
| Game / Version | Which game + server fork/version the page targets | yes |
| Section | The namespace the page belongs to | yes |
| Status | Draft / Review / Published | yes |
| Updated | ISO date (YYYY-MM-DD) of last edit | yes |
| Author | Wiki username | No — keep for single-author pages only |
=What goes in each section= Use the section order verbatim from the template: Overview → Prerequisites → Steps → Related. Rationale:
- Overview — 2-3 sentences; lets a skim decide if the page applies.
- Prerequisites — anything needed *before* starting (versions, plugins, knowledge).
- Steps — the body; ordered list items, one action each.
- Related — backlink to the section hub + directly relevant pages.
When to use callouts
Use `
` instead of bold text for emphasis. Pick from the maintained /box wrap classes (the installed plugin — do not use `<note>`):
| Class | When |
|---|---|
| box tip | helpful extra, or “you can skip this” |
| box important | must-read, non-obvious prerequisite |
| box warning | risk of data loss / breaking the server |
| box danger | spoilers or potentially destructive actions |
| box success | “it works / done” confirmation or a good-result example |
Example you can copy:
Spoilers ahead — this walkthrough reveals the boss fight.
Syntax you should use
Built-in markup that renders reliably (see official syntax):
- Headings — `======` for the page title, `=====`+ for section titles, never skip levels.
- Tables — `^` header rows + `|` body rows for structured data (like the metadata block).
- Code/config — `<code>` or `<file>` blocks (config values, commands) instead of plain text.
- Lists — 2-space indent + `*` / `-` for steps and checklists.
- Tags — `` at the bottom to cross-link across namespaces and feed the tag cloud.
- Internal links — `label` (never bare URLs to your own pages).
Checklist before publishing
- Title heading matches the page name and uses `======`
- Metadata table filled (Type, Version, Section, Status, Updated)
- Has both an Overview and Related section (minimum)
- Callouts use `<WRAP box …>` classes, not bold/color
- At least one tag appended; links point to existing pages
- Config values/code inside `<code>`/`<file>` blocks
- Status flipped from Draft to Review → Published by an editor
Conventions
- Pagenames are lowercase, no spaces (use `:`) — `minecraft:paper-global-yml`
- English (en). One page = one topic (split long topics into a section).
- License: content is CC-BY-SA 4.0 — attribute sources and don't paste verbatim game text.
- Sections live in the namespace matching their Type (guides → `minecraft:guides:`).