Getting started

Quick Install

Option A — WordPress Admin (recommended)

1. Go to Plugins → Add New
2. Search for TeamWiki
3. Click Install Now, then Activate
4. Follow the activation notice to the Settings page

Option B — Manual upload

1. Download teamwiki.zip from WordPress.org
2. Go to Plugins → Add New → Upload Plugin
3. Upload the ZIP and click Activate Plugin

Flush Permalinks

After installing TeamWiki (or after changing the Archive Slug), WordPress needs to register the new URL structure.

1. Go to Settings → Permalinks
2. Click Save Changes (no changes needed, just save)
3. Your wiki is now accessible at yoursite.com/wiki/

Settings Overview

All settings are under Wiki → Settings. The settings page has five tabs:

• General — Wiki name, archive slug, default sort order, default view, entries per page
• Appearance — Accent color (affects all UI colors)
• Features — Toggle each feature on or off individually
• Access & Roles — Minimum role for submitting entries
• Advanced — Database info, ACF status, permalink flush shortcut

Wiki Name & Slug

The Wiki Name appears in the WordPress admin menu and as the heading on the archive page. Default: Team Wiki.

The Archive Slug controls the URL. Default: wiki, resulting in yoursite.com/wiki/. After changing the slug, go to Settings → Permalinks and click Save.

Default Sort Order

Go to Wiki → Settings → General → Default Sort Order to choose how entries are sorted on first load. Options:

• Newest first (default) — sorted by last modified date, descending
• Oldest first — sorted by last modified date, ascending
• A → Z — alphabetical by title
• Z → A — reverse alphabetical

Users can change the sort on-the-fly using the sort buttons. The default applies to the initial page load only.

Accent Color

Go to Wiki → Settings → Appearance and use the color picker to choose your accent color. TeamWiki automatically derives a darker shade for hover states and a light tint for backgrounds. All buttons, tab underlines, badges and focus rings update automatically — you only need to set one color.

Adding Entries

Go to Wiki → Add New. Fill in:

• Title — Shown in tabs and book navigation
• Content — Use H2/H3 headings to structure content — these become the Table of Contents automatically
• Excerpt — Short summary shown in grid view cards (optional)
• Wiki Category — Assign to a category for tab grouping
• Wiki Details (if ACF not active) — Summary, Responsible, Frequency, Timing

Categories

Go to Wiki → Categories to create and manage categories. Each category becomes a tab on the archive page, ordered alphabetically. Entries without a category appear under "Other".

ACF Integration

TeamWiki automatically detects Advanced Custom Fields (free or Pro). If ACF is active:

• ACF fields are displayed as a metadata grid on each single entry
• ACF taxonomy fields are used for category tab grouping
• The built-in meta box is hidden (ACF replaces it)

Template Override

To customise the archive or single entry layout, copy the template from the plugin to your theme:

# Archive page
/wp-content/plugins/teamwiki/templates/archive-twiki.php
→ /wp-content/themes/your-theme/teamwiki/archive-twiki.php

# Single entry
/wp-content/plugins/teamwiki/templates/single-twiki.php
→ /wp-content/themes/your-theme/teamwiki/single-twiki.php

Create the teamwiki/ subfolder inside your theme if it doesn't exist. WordPress gives your theme's version priority automatically.

Privacy & GDPR

TeamWiki stores the following personal data:

• Read log — stored in {prefix}twiki_read_log: user ID, post ID, timestamp. Used for read/unread status and progress.
• Visit log — stored in post meta _twiki_visits: user ID → last visit timestamp. Used for "Viewed by" on single entries.

No data is transmitted to external servers. Disclose this tracking in your Privacy Policy.

Multisite

TeamWiki is compatible with WordPress Multisite. Each subsite has its own wiki entries, categories, read log and settings. Activate per-site (not network-wide) to ensure each site gets its own database table.