User Tools

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

wiki:article-structure [2026/09/26 21:37] – created stevewiki:article-structure [2026/09/26 21:45] (current) – steve
Line 1: Line 1:
-====== Article Structure & Template ======+====== Article Structure ======
  
-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. ((This page is itself written using the structures it recommends — see the raw source for examples.))+A shared shape keeps the wiki readable without forcing every page into the same mold. This page describes what a good article contains and when to reach for the fancier syntax. Treat it as a standard to know, not a form to fill.((This page is written with the structures it describes. Peek at the raw source for examples.))
  
-<WRAP box important>**Copy the template** (next section), create your page from it, and fill in each section. Delete unused lines, but keep the order.</WRAP>+===== How an article is put together ===== 
 +Most pages share the same bones, in this order:
  
-===== The Template (copy me) ===== +**Lead** — one or two sentences saying what the page is about and who it's for. Brief someone over the shoulder: plain, specific, no throat-clearing.
-Grab the raw markup below into a new page, then replace the bracketed parts. This is the minimum viable skeleton:+
  
-<file dokuwiki article-template.txt> +**Body** — the actual content, shaped by the topic. A config becomes a table of settings. A walkthrough is a description with a spoiler flag where it's needed. A guide is an explanation that earns its length. Don't force a topic into a recipe it doesn't fit.
-====== # 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>+**Related** — a short list of pages that genuinely connect, including the section hub.
  
-^ Field ^ Value ^ +**Tags** — `{{tag>…}}` at the bottom linking the page across namespaces.
-^ 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 ===== +===== The lean template ===== 
-2-3 sentences: what this covers, who it's for, and the end result.+The minimum you need to start a page:
  
-===== Prerequisites ===== +<file dokuwiki template.txt> 
-  - Required plugin/version or prior knowledge +====== Article Title ======
-  - Another requirement+
  
-===== Steps ===== +One or two sentences: what this is about and who it's for. Say it like you're briefing someone over the shoulder.
-  - 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>+===== Body ===== 
 +Write the content here as prose, tables, or code blocks. Let the topic set the shape.
  
 ===== Related ===== ===== Related =====
 * [[minecraft:start|Back to Minecraft hub]] * [[minecraft:start|Back to Minecraft hub]]
  
-{{tag>minecraft example}}+{{tag>minecraft}}
 </file> </file>
  
-===== The required metadata block ===== +===== When to use the extras ===== 
-Every page opens with a **metadata table** (the only place version/status lives) so readers instantly know the scope:+The installed plugins are powerful when used sparingly:
  
-^ Field ^ Purpose | Required? ^ +^ Tool ^ Use it for ^ 
-^ Type | Guide / Config / Walkthrough / Reference | yes | +| Tables (`^` header, `|` row) | settings, comparisons, small metadata blocks | 
-^ Game / Version | Which game + server fork/version the page targets | yes | +| `<code>` / `<file>` blocks | config values and commands, so they're copy-pasteable | 
-^ Section | The namespace the page belongs to | yes | +| `<WRAP box …>` callouts | genuine warnings and spoilers only | 
-^ Status | Draft / Review / Published | yes | +| `{{tag>…}}` | cross-linking topics across namespaces, feeding the tag cloud | 
-^ Updated | ISO date (YYYY-MM-DD) of last edit | yes | +| `((…))` footnotes | asides that would clutter the main text |
-^ Author | Wiki username | No — keep for single-author pages only |+
  
-=What goes in each section= +If a callout exists only to call something out, leave it out. Plain prose is fine.
-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 ===== +===== Optional metadata ===== 
-Use `<WRAP box …>` instead of bold text for emphasis. Pick from the maintained  /box **wrap** classes (the installed plugin — do not use `<note>`):+Add a small table near the top when version or status actually matters to the reader: which server release a config targets, or whether a page is still a draft.
  
-^ Class ^ When ^ +^ Field ^ When it matters ^ 
-^ box tip | helpful extra, or "you can skip this" | +| Type | Guide, Config, Walkthrough, Reference | 
-^ box important | must-read, non-obvious prerequisite | +| Game / version | when the content depends on it | 
-^ box warning | risk of data loss / breaking the server | +| Status | Draft, Review, Published, while a page is settling | 
-^ box danger | spoilers or potentially destructive actions | +| Updated | last meaningful edit, ISO date |
-^ box success | "it works / done" confirmation or a good-result example | +
- +
-Example you can copy: <WRAP box danger>Spoilers ahead — this walkthrough reveals the boss fight.</WRAP> +
- +
-===== Syntax you should use ==== +
-Built-in markup that renders reliably (see [[doku>wiki:syntax|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. +
-  - **Footnotes** — `((…))` for asides that would clutter the main text, like this one ((See the article on version pinning for details.)). +
-  - **Tags** — `{{tag>…}}` at the bottom to cross-link across namespaces and feed the tag cloud. +
-  - **Internal links** — `[[minecraft:somepage|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 ===== ===== Conventions =====
-  - Pagenames are **lowercase**, no spaces (use `:`) — `minecraft:paper-global-yml` +Page names are lowercase with colons separating namespaces (`minecraft:paper-global-yml`), one topic per page, English. Content is CC-BY-SA 4.0: attribute sources, and don't paste game text verbatim.
-  - 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:`).+
  
 ===== Tags ===== ===== Tags =====
 {{tag>template standards guidelines}} {{tag>template standards guidelines}}