This extension will feature a new page on the forum that will be linked to in the header of the board (configurable) intended to contain a list of rules or information which applies to the entire forum or website, similar to the phpBB rules page.

Unzip the downloaded release, and change the name of the folder to boardrules.

In the ext directory of your phpBB board, create a new directory named phpbb (if it does not already exist).

Copy the boardrules folder to phpBB/ext/phpbb/ (if done correctly, you'll have the main extension class at (your forum root)/ext/phpbb/boardrules/ext.php).

Navigate in the ACP to Customise -> Manage extensions.

Look for Board Rules under the Disabled Extensions list, and click its Enable link.

Set up and configure Board Rules by navigating in the ACP to Extensions -> Board Rules.

Important: Only official release versions validated by the phpBB Extensions Team should be installed on a live forum. Pre-release (beta, RC) versions downloaded from the GitHub repository are only to be used for testing on offline/development forums and are not officially supported.

All are welcome to contribute to the extension by forking our repository and submitting a Pull Request through Github.

Be very well documented. Almost every line should be commented on--this is because our extensions should be used as examples to those who are not as familiar with PHP or phpBB and want to begin writing extensions and code of their own.

Most of the methods we'll need have already been described in interfaces, so it is very easy to just pick a couple and write PRs for them.

As you can see in this PR, the tests will fail. For now this is unavoidable and is fine as long as the PR contains appropriate test coverage (which *should* pass when the test doesn't fail for other reasons).

Here are some mockups of what the board rules could look like. (note: the red block is red because that is a highlighted rule due to the user clicking on its anchor tag, or possibly having been referred to that specific rule by a moderator who provided a link to its anchor tag)

This second example shows rule categories nested inside of other categories. Although it may be possible to allow nesting of categories within categories within categories, we're not sure if this would actually look good (or be confusing), or if anybody would even have reason to do so, so any comments on multi-level nesting vs. simple one-level categories with only rules nested inside them (as in example #1) are welcome.