[CDB] [Official Ext] Board Rules Extension

A place for Extension Authors to post and receive feedback on Extensions still in development. No Extensions within this forum should be used within a live environment!
Get Involved
Forum rules
READ: phpBB.com Board-Wide Rules and Regulations

IMPORTANT: Extensions Development rules

IMPORTANT FOR NEEDED EVENTS!!!
If you need an event for your extension please read this for the steps to follow to request the event(s)
Locked
User avatar
EXreaction
Former Team Member
Posts: 5666
Joined: Sun Aug 21, 2005 9:31 pm
Location: Wisconsin, U.S.
Name: Nathan

[CDB] [Official Ext] Board Rules Extension

Post by EXreaction » Mon Nov 04, 2013 12:58 am

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.

User avatar
Raul [ThE KuKa]
Jr. Extension Validator
Posts: 3740
Joined: Mon Dec 08, 2003 9:24 pm
Location: Spain
Name: Raul Arroyo
Contact:

Re: [DEV] Board Rules Extension

Post by Raul [ThE KuKa] » Thu Nov 07, 2013 9:24 am

Nice job EXreaction. ;)

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

Best Regards.
If you like my styles, translations, etc. and want to show some appreciation, then feel free to Donate with Image
phpBB International Support Team (Spanish - Español) :flag_es: Online Since 2003
🎨phpBB Professional Premium Themes🔥
Author Translations (Spanish - Spain) :two_hearts:

:warning: I don't support those without the copyright Spanish translation. :warning:

User avatar
tmbackoff
Former Team Member
Posts: 6995
Joined: Thu Jun 04, 2009 1:41 am
Location: cheerleading practice
Name: Tabitha Backoff

Re: [DEV] Board Rules Extension

Post by tmbackoff » Thu Nov 07, 2013 12:14 pm

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?

User avatar
EXreaction
Former Team Member
Posts: 5666
Joined: Sun Aug 21, 2005 9:31 pm
Location: Wisconsin, U.S.
Name: Nathan

Re: [DEV] Board Rules Extension

Post by EXreaction » Thu Nov 07, 2013 2:38 pm

That would certainly be easy to do

User avatar
VOLKERMORD
Registered User
Posts: 110
Joined: Thu Jul 23, 2009 1:20 pm
Location: Dacia (Wolf land)
Contact:

Re: [DEV] Board Rules Extension

Post by VOLKERMORD » Thu Nov 07, 2013 3:21 pm

Nice work EXreaction ;)
Har tios tintoninos insus tiko is dakon kand sia til kogaion ilmaton hlioylo pleiste naktoilo

User avatar
EXreaction
Former Team Member
Posts: 5666
Joined: Sun Aug 21, 2005 9:31 pm
Location: Wisconsin, U.S.
Name: Nathan

Re: [DEV] Board Rules Extension

Post by EXreaction » Sun Nov 10, 2013 4:51 pm

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).

User avatar
Pico88
Registered User
Posts: 878
Joined: Sat Mar 07, 2009 10:24 pm
Location: Poland
Name: Lukasz

Re: [DEV] Board Rules Extension

Post by Pico88 » Sun Nov 10, 2013 8:08 pm

The link doesn't work.
Please do not PM me for support.

User avatar
sherl0ck
Registered User
Posts: 29
Joined: Sun Jul 21, 2013 1:05 pm
Location: Ukraine, Ivano-Frankivsk
Name: Alex Fryschyn
Contact:

Re: [DEV] Board Rules Extension

Post by sherl0ck » Mon Nov 11, 2013 3:09 pm

SH

User avatar
VSE
Extensions Development Coordinator
Extensions Development Coordinator
Posts: 4463
Joined: Sat Jan 17, 2009 9:37 am
Location: Los Angeles, CA
Name: Matt Friedman
Contact:

Re: [DEV] Board Rules Extension

Post by VSE » Fri Jan 10, 2014 6:45 pm

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.
Official phpBB Extensions My Extensions & MODs
Please do not PM me for support.
Dictated but not read.

User avatar
VSE
Extensions Development Coordinator
Extensions Development Coordinator
Posts: 4463
Joined: Sat Jan 17, 2009 9:37 am
Location: Los Angeles, CA
Name: Matt Friedman
Contact:

Re: [DEV] Board Rules Extension

Post by VSE » Fri Jan 10, 2014 6:57 pm

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
Official phpBB Extensions My Extensions & MODs
Please do not PM me for support.
Dictated but not read.

User avatar
VSE
Extensions Development Coordinator
Extensions Development Coordinator
Posts: 4463
Joined: Sat Jan 17, 2009 9:37 am
Location: Los Angeles, CA
Name: Matt Friedman
Contact:

Re: [DEV] Board Rules Extension

Post by VSE » Thu Apr 24, 2014 5:42 pm

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 ✔
Official phpBB Extensions My Extensions & MODs
Please do not PM me for support.
Dictated but not read.

User avatar
VSE
Extensions Development Coordinator
Extensions Development Coordinator
Posts: 4463
Joined: Sat Jan 17, 2009 9:37 am
Location: Los Angeles, CA
Name: Matt Friedman
Contact:

Re: [DEV] Board Rules Extension

Post by VSE » Tue May 13, 2014 10:04 pm

All planned features have been implemented :)
Official phpBB Extensions My Extensions & MODs
Please do not PM me for support.
Dictated but not read.

nicofuma
3.2 Release Manager
3.2 Release Manager
Posts: 529
Joined: Sun Apr 13, 2014 1:47 am
Location: Grenoble - France

Re: [DEV] Board Rules Extension

Post by nicofuma » Tue May 13, 2014 11:17 pm

nice
Member of phpBB Development-Team
No Support via PM

User avatar
watisnf.nl
Registered User
Posts: 605
Joined: Sat Mar 13, 2010 12:53 pm
Location: The Netherlands
Name: David
Contact:

Re: [DEV] Board Rules Extension

Post by watisnf.nl » Wed May 14, 2014 12:51 pm

Does this states still count: Current status: Initial development (not usable) would be fun if I can test this out ;)
Dutch Translator | Looking for, Dutch extensions translations

User avatar
VSE
Extensions Development Coordinator
Extensions Development Coordinator
Posts: 4463
Joined: Sat Jan 17, 2009 9:37 am
Location: Los Angeles, CA
Name: Matt Friedman
Contact:

Re: [DEV] Board Rules Extension

Post by VSE » Wed May 14, 2014 10:24 pm

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.
Official phpBB Extensions My Extensions & MODs
Please do not PM me for support.
Dictated but not read.

Locked

Return to “Extensions in Development”

Who is online

Users browsing this forum: chanlon1, J_Sparrow, nou nou, SeewolfPK and 26 guests

cron