These are all posted with strict instructions as to which file(s) to edit. When new php file(s) and any SQL are required, they should be be attached as well as posted inline as code blocks.
There will first have to be a few enhancements to our forums to accommodate this MOD service, namely file attachments and a user ratings system. Until that time, all posts must be without attachments. Perhaps some more issues may come up with respect to providing this MOD service in a phpBB forums, we'll see.
The rules
- Your posted changes must work
- All MODS are currently designed for PADkit 2.09
- MODS must follow specific guidelines and contain explicit instructions on every detail (you will regret it if your post causes other webmasters errors)
MOD Guidelines
For now, we are following a logical "install instructions" format that has survived the test of time. All details about the MOD should be given in the header. An example empty form to start off with can be copied from here:
- Code: Select all
##############################################################
## MOD Title: [title of MOD]
## MOD Author: [your name / email / website here]
## MOD Description: [description of MOD]
##
## MOD Version: [specify version]
##
## Installation Level: [select from Very Easy, Easy, Medium, Expert]
## Installation Time: [time... select from <5 min, 5 min, 10 min, 15 min, >15 min, or >30 min]
## Files To Edit: [# of files to edit]
## Included Files: [N/A, or list of included files with relative paths]
## License: http://opensource.org/licenses/gpl-license.php GNU General Public License v2
##
## Author Notes:
## [any requirements??]
##
##############################################################
## MOD History:
##
## 2007-01-22 - Version 1.0.0
## - Initial Release
##
##############################################################
## Before Adding This MOD To Your Forum, You Should Back Up All Files Related To This MOD
##############################################################
#
#-----[ OPEN ]------------------------------------------
#
[file to open]
...all of the rest of the logical install instructions go here...
#
#-----[ SAVE/CLOSE ALL FILES ]------------------------------------------
#
# EoM
Some help with "logical install instructions"
Whenever possible, please insure that what you tell a user to search for - actually leads to only one result. For example, don't tell a user to search for "$email" especially when the file that they are to be searching in had multiple instances of that variable; instead, instruct the user to search for a large enough distinct block of text that only appears once in the given file.
When all of the changes are complete for the first file, instruct the user to open the next file with an [ OPEN ] command.
Another thing that can lead to problems may be changes that have to occur inline. In this case, you should just use two find instructions (first a basic [ FIND ] and then [ IN-LINE FIND ]) followed by the [ IN-LINE AFTER, INSERT ].
For an example, you can refer to our first MOD posting Category displayed as link.
