Customisation Database Frequently Asked Questions
What is Titania (aka The Customisation Database)
- What is Titania?
- Titania (aka The Customisation Database) is a database where users are be able to download extensions and styles for a phpBB forum. You also are ensured that the extensions or style that you have downloaded has passed the phpBB validation requirements.
- Validation? What’s that?
- Each and every extension, or style, that is downloaded by you within Titania has undergone validation. Validation means that an extension, or style, has undergone scrutiny as to the security of the code involved as well as testing to ensure the extension or style installs and works properly within a particular version of a phpBB forum. Validation provides to you a level of comfort in knowing that you are not downloading/installing a extension or style that may subject your forum to being hacked.
How to use Titania
- Finding a contribution
- There are several ways to find a contribution. On the main Customisation Database page you can see the categories that are currently available as well as recent extensions/styles that have been approved within the database.
- Finding an extension
- You can either go directly to the type of extension wanted based on what category the contribution is based on (Tools, Communication, Security, Entertainment, etc) or by using the search feature toward the top of the page. If using the search feature you can use wildcards and search on either the contribution name (or part of the name) as well as the contribution’s author. Once you find the customisation you are interested in you will be brought to the “Contribution Details” page where you can find a download of the current version of the customisation as well as past versions of the customisation within the “Revisions” section.
- Finding a style
- Similar to finding an extension, Titania also allows you to locate styles, smilie packs, rank images and other items. The search feature will also allow you to use wild cards and to search on just an authors name as well. Once you find the item you are interested in you will be brought to the “Contribution Details” page where you can find a download of the current version of the item as well as past versions of the that item within the “Revisions” section.
- With the introduction of Titania, the rules involved to use it are very simple. As in the past, the saying “You should seek support within the extension/style topic where you got the customisation” pertains. While the support Team of phpBB.com does their best to assist you in running and using your forum they can not, and are not expected to, provide support for any customisation/contribution. It is our hope that the author of a contribution provides end user support. Please remember that all authors are volunteers who have spent their time in providing an enhancement to the phpBB software. The saying “You get more flies with honey than you do with vinegar” applies, so please keep this in mind when requesting support for a customisation (eg, be nice in the way you ask).
- How to get support
- Each customisation is provided a method to provide support to you. Within each is the ability for the author to post FAQ(s) concerning the customisation as well as a discussion/support area for a type of one-on-one support. This support can range anywhere from assisting you to getting the customisation installed and may even provide to you additional add-ons to enhance the customisation. To access this area you simply click on the customisation and a tab will be displayed stating “Discussion/Support”. Once you access this area you may post a question or comment to the author. Please remember that authors are under no obligation to provide support just as they are under no obligation to provide to you the customisation. If you run across a post or comment that you feel is not in the best interests of the community, please feel free to use the “Report this post” button and a moderator will take the appropriate action necessary.
Creating and Managing Contributions
- Creating a Contribution
- As with any contribution, authors are requested to follow certain guidelines when submitting their own contribution. The Coding Guidelines, though seemingly daunting at first, are actually your friend. They should be followed as closely as possible to assist you in getting your contribution to the community published. In the case of an extension, the phpBB extension pre-validator (aka “EPV”) will be run against the submitted revision and will check for things such as correct licensing, current phpBB version and correct packaging and version requirements.
- Submitting a Contribution
- So you’ve made a contribution. Let’s get that puppy published!!
To submit a contribution, go to the Customisation Database and within that page you will find an image link that states “New Contribution”. Once clicked on you will be able to enter in the contribution name, select the contribution type, add some wording to describe the contribution (smilies and bbcode is allowed), select the category(ies) that the contribution fits into, add co-authors (if any) and screenshots as well. Please keep in mind that as you are submitting the contribution, it is your name the contribution will be aligned with.
- Managing Contributions
- Once your contribution is uploaded successfully into Titania, you are able to manage it. After selecting your contribution by clicking on "My Contributions" at the top of the page, you may add additional information to it via the "Manage Contribution" tab. You are able to amend the description of the contribution, upload screen shots, change ownership of the contribution (please note this is irreversible so ensure you really want to give another user ownership of your contribution), change the categories the contribution fits under as well as input a demo url so users can see firsthand what the contribution looks like and how it works.
- Submitting a new Revision
- You can upload new revisions on the main page, the “Contribution Details” section, of your customisation. Once you click on the “New Revision” link, you are presented a page where in you upload the revision, assign it a version and input notes to the validation team (bbcode and smilies are allowed). You can also choose to have the validation team “repack” the extension. Repacking involves making minor fixes to the customisation. This may involve corrections to the composer.json file or even minor code changes. Repacking is not having the validation team re-write major snippets of the code you supplied, that would be your “job”.
The rules, as they apply concerning creation of a customisation, still apply when submitting revisions to your customisation. That is, the phpBB extension pre-validator (aka “EPV”) will be run against the revision of the customisation and will check for things such as correct licensing, current phpBB version and correct packaging and version requirements.
- Each customisation provides to the author the ability to submit FAQ type of topics. These topics that you create should be written in a way that a user can understand and apply the topic to the customisation, whether the topic be concerning how to get the customisation installed, accessing features of the customisation, etc. It should be noted that this area is just for you. Users can not edit or reply to FAQ entries.
- Support Forum
- Please keep in mind that users will ask questions or make comments concerning your contribution. We ask that you support your contribution as much as you can. We realize that you spent your free time in creating your contribution and that real life can, sometimes, get in the way of fun. We just ask that you as the author(s) provide as much support as is possible. If you run across a post or comment that you feel is not in the best interests of the community, please feel free to use the “Report this post” button and a moderator will take the appropriate action necessary.
- My Customisation didn’t pass the pre validator check
- Remember, every customisation MUST have the correct licensing (currenty GNU GPL version 2), the correct version of phpBB software and the correct packaging. If your customisation does not have these rudimentary items then it cannot be accepted into the database. Some errors are simply warnings and may not need fixing, if you are unsure of the problem feel free to continue with the submission and a validator will handle it.
- My Customisation passed pre validation, now what?
- Once a customisation is accepted into the database, if it is an extension is then up to the relevant team who will validate your contribution. You may find that you get a message stating your customisation was denied. Please don’t fret. We know things get overlooked or just simply missed. Not to worry. The message you receive will contain items that were found. These items may suggest changes to the code or images and may even suggest changes on “user friendliness”. Generally speaking, “user friendliness” suggestions are just that...suggestions. The most important part of any customisation is security, not in what it looks like to the end user.
If no items were found during validation of your contribution you will get a PM stating that your contribution has been accepted into the database. It is now time to relax a bit and revel in the knowledge that you have made a contribution to the open source community.
No matter the outcome of the validation, we appreciate the time and effort you have exerted in sharing your contribution.
- Who will be validating my contribution?
- If it is an extension it will be validated by the Extension Customisations Team and Junior Validators or occassionally a Development Team Member. For a style it will be validated by the Style Customisations Team and Junior Style Validators. For a convertor it will be validated by a Support or Development Team Member. For a bridge it will be validated by an Extension or Development Team Member. Language Packs are all checked by the International Manager. Official Tools are tested and created by the phpBB.com Teams.