Skip to content

README.md

Latest commit

 

History

History
126 lines (89 loc) · 9.54 KB

README.md

File metadata and controls

126 lines (89 loc) · 9.54 KB
Raw

phpBB Modders Wiki

Tests Lint

A wiki for phpBB with version history, side-by-side compare, and a moderation queue for edits.

Features

  • A wiki at /wiki, with an overview page listing its articles.
  • Start an article from the overview page's New article title box, or by linking to /wiki/<article-name> and following the link.
  • Link to another article by writing [[Article name]], in articles and in forum posts; links to articles that don't exist yet are shown in red and open the editor. Each article lists the articles that link to it under What links here. See Linking between articles.
  • Every edit is saved as a new version; compare any two versions side by side.
  • Edits can wait for approval: moderators get a Pending articles list with Approve and Disapprove. Approving a version older than the live one is blocked, so a stale draft can't overwrite newer content.
  • Moderators can take an article offline or delete it, and articles can be made sticky or set to redirect.
  • A Recent changes page at /wiki/recent-changes lists every version saved to the wiki that is or was live, newest first, with RSS and Atom feeds at /wiki/recent-changes.rss and /wiki/recent-changes.atom (the latest 50). The ACP setting Recent changes feed under Extensions > Wiki > Settings offers RSS, Atom or both, and the header advertises the offered feeds to feed readers. Versions waiting for approval never appear.
  • A contributions page for every member, at /wiki/contributions/<username>, lists every version they saved across all articles, newest first. Author names on articles and in the version history link to it. Versions waiting for approval, and those of switched-off articles, show only to moderators and to the author.
  • Files can be uploaded to an article by members who hold the Can upload files to articles permission. They are checked against the board's allowed file types and size limit, stored outside public view under store/phpbbmodders_wiki/, and read only through the wiki, which checks that the reader may see the article. In the text, [[File:Diagram.png]] shows an uploaded image and [[File:notes.zip|the notes]] links to any other file. The member who uploaded a file, or a moderator who may delete versions, can remove it, and deleting an article deletes its files.
  • Notifications when an edit is waiting for approval.
  • Watch article on every article page, for signed-in members: they are notified when a new version of a watched article goes live (a moderator approved an edit, or a trusted editor's edit went live directly), never about their own edit. It is a notification type in phpBB's notification settings, so members choose the bell, email or both. With the ACP setting Watch edited articles (on by default, under Extensions > Wiki > Settings), saving an edit also starts watching the article. Watches are removed with the article and with the member.
  • Wikipedia-style headings: == Heading == to ====== Heading ====== in an article become section headings with anchors, [[Article#Section]] and [[#Section]] link to them, and a table of contents shows after the intro when an article has four or more headings (__TOC__ places it, __FORCETOC__ forces it, __NOTOC__ hides it). A first line #REDIRECT [[Article]] sets the redirect for members who may set redirects. This works in wiki articles only; in a forum post == text == stays plain text.
  • The Wiki link in the board header shows the Wikipedia icon by default. Under Extensions > Wiki > Settings in the ACP the icon can be changed to any Font Awesome icon name, or left blank for no icon.
  • A Start discussion button on each article creates its discussion topic in a forum chosen under Extensions > Wiki > Settings in the ACP, and links the topic to the article. It shows to members who hold the "Can change the discussion topic for an article" permission and may post in that forum, and stays hidden until a forum is chosen.
  • Separate permissions for viewing, editing, version history, deleting and moderating.

Screenshots

Overview Article
Wiki overview page Article view
Editing Pending review
Edit form Pending articles awaiting approval

Approving or disapproving a pending edit shows a diff against the currently active version:

Version diff with approve/disapprove actions

The version history page also has a "Moderator controls" dropdown for taking an active article offline or deleting it entirely:

Moderator controls dropdown: set article inactive, delete article

Linking between articles

Write an article's name in double square brackets to link to it, in wiki articles and in forum posts:

  • [[Installation]] links to the article Installation.
  • [[Installation|how to install]] links to the same article but shows how to install.

Links to articles that don't exist yet are shown in red, and following one opens the editor to create that article. The Wiki link button in the editor toolbar inserts the brackets. Inside a [code] block the brackets stay plain text.

Below each article, What links here lists the other articles whose current version links to it.

An article with links to other articles; links to articles that don't exist yet are red
Links, with missing articles in red		 An article with its What links here list
What links here		 The Wiki link button in the editor toolbar, outlined
The editor button (outlined)

Articles and posts written before this feature existed get their links the next time they are edited. To convert them all at once, run phpBB's reparser from the board's folder: php bin/phpbbcli.php reparser:reparse phpbbmodders_wiki_article for articles and php bin/phpbbcli.php reparser:reparse post_text for forum posts.

Requirements

  • phpBB 3.3.19 or later (also tested on phpBB 4.0)
  • PHP 8.2 or later

Tested versions and compatibility notes: docs/compatibility.md.

Installation

  1. Copy the extension to /ext/phpbbmodders/wiki
  2. In the Administration Control Panel, go to Customise → Manage extensions
  3. Enable the phpBB Modders Wiki extension
  4. Set who can view and edit the wiki under the usual Permissions screens

Upgrading from tas2580/wiki

This extension used to be installed as tas2580/wiki. It is now phpbbmodders/wiki. To switch an existing board without losing any articles, versions, permissions or notification settings:

  1. Disable the old tas2580 Wiki extension in the ACP. Do not delete its data.
  2. Delete the /ext/tas2580/wiki folder.
  3. Upload this version to /ext/phpbbmodders/wiki and enable it. The old install's migration history, notification type and users' notification settings are moved to the new name automatically; the wiki tables themselves never included the old name, so they are used as they are.
  4. Purge the board cache.

If you disable the old extension from the command line (bin/phpbbcli.php) instead of the ACP, run bin/phpbbcli.php cache:purge before enabling the new one; the command-line disable doesn't clear the cache.

TODO

Ideas not yet built, practical and speculative alike: docs/TODO.md.

Contributing

Contributions are welcome!

Acknowledgments

  • Original extension by tas2580.
  • Updated for phpBB 3.2.x (notification API fixes, textreparser support) by Christian Schnegelberger (Crizz0) in the phpBB.de fork.
  • This fork builds on Crizz0's phpBB.de branch: fixed phpBB 3.3.x/4.0 compatibility (routing, YAML parsing, notification API, Flash BBCode removal), completed missing English translations, added an approve/disapprove moderation queue for pending articles, and general bug fixes.
  • Code review, bug fixes, and documentation assisted by Claude.

License

This extension is licensed under the GNU General Public License v2.0.

See license.txt for more information.