Wiki Readme

# Blatchy Wiki​

A collaborative wiki for XenForo 2.3. Members write and edit pages together, every change is kept in history, and new articles can be started straight from Wikipedia.

## Features​

- Wiki pages written in BB code with the standard editor
- Full revision history with side-by-side comparison and one-click revert
- Page protection levels backed by automatic trust tiers
- Watch any page for an alert on every edit, with optional email
- Seed new pages from Wikipedia, references included
- Wiki links and references work in forum posts too
- Nested categories, recent changes, and per-member contribution lists
- Built into XenForo search, sitemaps, and notable members

## Writing pages​

- Type `Page name` to link to another wiki page, or `shown text` for custom link text. Links to pages that don't exist yet show in red and lead straight to the create form with the title filled in.
- Headings come from the editor's paragraph formats and automatically build the contents rail beside the article.
- To cite a source, select the citation text and click the reference button in the editor toolbar. A small panel asks for the source URL and inserts the reference where you are. Pages number every reference and collect them in a References section at the bottom; citing the same source twice reuses its number.
- Wiki links and references work in regular forum posts as well. In a post, a reference shows as a small marker with the source in a tooltip.
- The `[wiki]Page name[/wiki]` and `[wiki=slug]shown text[/wiki]` BB codes are available anywhere BB code renders.

## Starting a page from Wikipedia​

Search Wikipedia from the create form and import an article as your page's starting content. Headings, formatting, tables, and links come across as clean BB code, and the article's sources become numbered references. An imported page shows a "From Wikipedia" box in its sidebar with the article summary, a link to the original, and the required CC BY-SA attribution. Editors can refresh the summary at any time, and clearing the source field removes the box.

## History and watching​

Every edit is a revision. Any two revisions can be compared side by side, and any older revision can be reverted in one click — a revert is saved as a new revision, so nothing is ever lost. Watching a page brings an alert on every edit, plus an email if the watcher opts in.

## Protection​

Each page carries a protection level on top of the normal edit permission:

- **Open** — anyone who can edit the wiki
- **Trusted** — editors whose account age and post count meet the trusted thresholds
- **Veteran** — the same, with higher thresholds
- **Author + staff** — the page author and protection managers
- **Locked** — protection managers only

Tiers are automatic — set the age and post count thresholds in options and members qualify on their own; there is no manual promotion. New pages inherit their category's default protection, and every protection change is recorded in page history.

## Categories​

Categories nest to any depth, order however you like, and can override who views or edits their pages. Each category sets the default protection for new pages. Pages saved without a category are listed under an uncategorized row on the wiki home.

## Setup​

1. Upload the contents of the `upload/` folder to your XenForo root.
2. Install Blatchy Wiki from Admin CP → Add-ons.
3. Pick the wiki discussion forum in Setup → Options → Blatchy Wiki so each page's Discuss button has somewhere to open its thread.
4. Grant the wiki permissions — every label contains "wiki", so the permission filter finds all seven.
5. Add categories under the Wiki admin tab, and enable the wiki tab in Setup → Public navigation.

The wiki link and reference BB codes are managed like any others under Content → Button manager. Members without the wiki create or edit permission never see the buttons, wherever you place them.

Two style properties under Appearance → Style properties → Blatchy Wiki control the accent color and the missing-page link color, each with separate light and dark values.

## Requirements​

- XenForo 2.3.7 or later
- PHP 8.0 or later

## Support​

See overallowed.com for license terms and support.