Page 1 of 7

[CDB] [Official Ext] Board Rules Extension

Posted: Mon Nov 04, 2013 12:58 am
by EXreaction
The Extensions Development Team is working on this Board Rules Extension.

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.

Current Release:
Release Candidate 2 (Requires phpBB-3.1.0-RC4)

Features:
  1. ACP Panel Interface for rule management
  2. DB Storage
  3. Header link option
  4. Rules page (similar to FAQ)
  5. Option to require users acceptance of board rules prior to registration
  6. BBCode support
  7. BBCode editor in ACP and Preview
  8. Customisable anchors
  9. Multiple language support
  10. Rule categories (optional)
  11. Movable rules (up/down); buttons or drag & drop
  12. Display # anchors next to rule on output
  13. Notify users of board rules change
Release Archive: https://github.com/phpbb-extensions/boardrules/releases

Github Repository: https://github.com/phpbb-extensions/boardrules

Installation:
  1. Unzip the downloaded release, and change the name of the folder to boardrules.
  2. In the ext directory of your phpBB board, create a new directory named phpbb (if it does not already exist).
  3. 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).
  4. Navigate in the ACP to Customise -> Manage extensions.
  5. Look for Board Rules under the Disabled Extensions list, and click its Enable link.
  6. 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.

Re: [DEV] Board Rules Extension

Posted: Thu Nov 07, 2013 9:24 am
by Raul [ThE KuKa]
Nice job EXreaction. ;)

I think it's important for any forum, take a Board Rules page.
Working in Spanish translation.

Best Regards.

Re: [DEV] Board Rules Extension

Posted: Thu Nov 07, 2013 12:14 pm
by tbackoff
EXreaction wrote:similar to the phpBB rules page.

[snip]
  • Customisable anchors
  • Rule categories (optional)
  • Display # next to rule on output
Does this mean that clicking on a rule will highlight it too?

Re: [DEV] Board Rules Extension

Posted: Thu Nov 07, 2013 2:38 pm
by EXreaction
That would certainly be easy to do

Re: [DEV] Board Rules Extension

Posted: Thu Nov 07, 2013 3:21 pm
by VOLKERMORD
Nice work EXreaction ;)

Re: [DEV] Board Rules Extension

Posted: Sun Nov 10, 2013 4:51 pm
by EXreaction
Anyone wanting to work on this can feel free to submit Pull Requests.

The form of PR we're generally looking for (at the moment) will look like this:
https://github.com/phpbb-extensions/boardrules/pull/8

It will:
  1. Focus on one specific aspect, e.g. set/get rules_title on the entity.
  2. Contain complete test coverage for the methods implemented.
  3. 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).

Re: [DEV] Board Rules Extension

Posted: Sun Nov 10, 2013 8:08 pm
by Pico88
The link doesn't work.

Re: [DEV] Board Rules Extension

Posted: Mon Nov 11, 2013 3:09 pm
by sherl0ck

Re: [DEV] Board Rules Extension

Posted: Fri Jan 10, 2014 6:45 pm
by MattF
sherl0ck wrote:Ukrainian translation: http://www.phpbbukraine.net//downloads/ ... master.zip
Thanks for the translation. However, it is still too early for translations, as there is going to be a lot of new language to add once the front-end and admin interfaces have been designed.

We will be holding off on translations until we have a more complete language structure in place.

Re: [DEV] Board Rules Extension

Posted: Fri Jan 10, 2014 6:57 pm
by MattF
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)

Example #1
Image


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.

Example #2Image

Re: [DEV] Board Rules Extension

Posted: Thu Apr 24, 2014 5:42 pm
by MattF
Current status:
  1. ACP Panel ✔
  2. DB Storage ✔
  3. Header link option ✔
  4. Rules page (similar to FAQ) ✔
  5. Require acceptance of board rules prior to registration ✔
  6. BBCode support ✔
  7. BBCode editor in ACP ✔
  8. Preview ✔
  9. Customisable anchors ✔
  10. Multiple language support ✔
  11. Rule categories (optional) ✔
  12. Movable rules (up/down) ✔
  13. Display # next to rule on output ✔
  14. Notify users of board rules change ✔

Re: [DEV] Board Rules Extension

Posted: Tue May 13, 2014 10:04 pm
by MattF
All planned features have been implemented :)

Re: [DEV] Board Rules Extension

Posted: Tue May 13, 2014 11:17 pm
by nicofuma
nice

Re: [DEV] Board Rules Extension

Posted: Wed May 14, 2014 12:51 pm
by watisnf.nl
Does this states still count: Current status: Initial development (not usable) would be fun if I can test this out ;)

Re: [DEV] Board Rules Extension

Posted: Wed May 14, 2014 10:24 pm
by MattF
watisnf.nl wrote:Does this states still count: Current status: Initial development (not usable) would be fun if I can test this out ;)
No. Development is done. Now it is ready for testing and bug fixing and feature tweaking.