| MOD Template |
| Description: This is the required 'Template' for all MOD's submitted to phpBB MOD Database. |
| Author: wGEric |
| Date: Tue Jan 14, 2003 5:07 pm |
| Type: Info |
| Keywords: mod, template |
| Category: MODifications |
 |
The MOD Template
Below is the template that all Modifications submitted to the MODs Database need to use. Please read this article for all of the requirements. The MOD Template provides information about the MOD as well as the instructions on how to install the MOD on a board.
The following is the basic outline of the MOD Template. Each part will be gone over in more detail later.
| Code: | ##############################################################
## MOD Title: mod_title_goes_here
## MOD Author: your_phpBB_username < your_email > (your_real_name) your_url
## MOD Description: some_description_goes_here
## MOD Version: x.x.x
##
## Installation Level: (Easy/Intermediate/Advanced)
## Installation Time: x Minutes
## Files To Edit: file_1,
## file_2,
## file_3,
## etc
## Included Files: (N/A, or list of included files)
## License: http://opensource.org/licenses/gpl-license.php GNU General Public License v2
##############################################################
## For security purposes, please check: http://www.phpbb.com/mods/
## for the latest version of this MOD. Although MODs are checked
## before being allowed in the MODs Database there is no guarantee
## that there are no security problems within the MOD. No support
## will be given for MODs not found within the MODs Database which
## can be found at http://www.phpbb.com/mods/
##############################################################
## Author Notes:
##
##############################################################
## MOD History:
##
## YYYY-MM-DD - Version x.x.x
## - version notes go here
##
##############################################################
## Before Adding This MOD To Your Forum, You Should Back Up All Files Related To This MOD
##############################################################
#
#-----[ ACTION ]------------------------------------------
#
#
#-----[ ACTION ]------------------------------------------
#
#
#-----[ ACTION ]------------------------------------------
#
#
#-----[ SAVE/CLOSE ALL FILES ]------------------------------------------
#
# EoM |
The Header
The header consists of the MOD's title, author, description, and other information about the MOD. Here is a brief description of each part in the first section of the header.
- MOD Title*
The MOD title is where you put the name of the MOD. It can only be one line.
- MOD Author*
This is information about the MOD Author. This line consists of four parts. See this article for examples on how to do the MOD Author line or information about having multiple authors. Each MOD Author line can only be one line and the spacing in each line between the different parts must be exact.
- your_phpbb_username*
This is the username of your account on phpBB.com.
- your_email
This is the email address users can use to get support from the author. This isn't required and you can put N/A if you don't want to put an email address.
- your_real_name
This is your real name. You can put your full name or only parts of your realname. This field isn't required so you can put N/A if you don't want to put your realname.
- your_url
This is the URL to the website that the author uses to give support to his or her MODs. This field isn't requires so like the others, you can put N/A.
- MOD Description*
This is the description of the MOD. It can be short or long. It is preferred that you keep this short and use the Author Notes section to provide detailed information. This can span multiple lines.
- MOD Version*
This is the version of the MOD. Read this article for more information on how to version MODs. This can only be one line.
- Installation Level*
This is the installation difficultly level of the MOD. The factors used to determine this is how many edits are made to the existing phpBB files, the complexity of those edits, and many other factors. It is up to the MOD Author to determine what level the MOD is. This can only be one line.
- Installation Time*
This is an estimation, in minutes, of how long it will take to install the MOD by hand. This can only be one line.
- Files to Edit*
This is a list of what core phpBB files will be edited by the MOD. If none are edited, then put N/A. This can span multiple lines.
- Included Files*
This is a list of the files that are included with the MOD. Put N/A if no files are included with the MOD. This can span multiple lines.
- License*
This is the license that the MOD is released under. 99% of the time, MODs will have to be released under GPL. Read this article if you would like to find out more information about this. This can only be one line.
* is a required field in the first part of the MOD Template. If a field isn't required, N/A needs to be used if you don't want to put anything there unless otherwise noted.
That concludes the first section in the header of the MOD Template. The next sections provide security, installation instructions, and backup information about the MOD.
Security Disclaimer
| Code: | ## For security purposes, please check: http://www.phpbb.com/mods/
## for the latest version of this MOD. Although MODs are checked
## before being allowed in the MODs Database there is no guarantee
## that there are no security problems within the MOD. No support
## will be given for MODs not found within the MODs Database which
## can be found at http://www.phpbb.com/mods/ |
The security disclaimer states that users need to check phpBB.com for updates to the MOD before installing it. This is because updates could contain security fixes as well as any other bug fixes.
It also states that if you get MODs from other sites, phpBB.com will not provide support for those MODs. Only MODs found within the MOD Database at phpBB.com will we give support for.
We do check MODs for security and other problems before we allow any MOD within our MOD Database. This is to provide security for those that use these MODifications. Although we do check for security problems, we can't guarantee that there aren't any within the MODs found in our MOD Database. After all, we are human and make mistakes. If a security exploit is found within one of the MODs within the MOD Database, we will take whatever action we feel is necessary.
The security disclaimer must be included.
Author Notes
Here is where the author of the MOD can go into detail with the description of his or her MOD as well as provide any additional information the person installing the MOD might need. Information such as what version of PHP is required, any special libraries/extensions might be needed, and any special instructions that are needed to finish the installation of the MOD.
Anything that isn't covered anywhere else in the MOD Template can go here as well. It isn't required that you put anything here and can be left blank but you must leave this section in the Template.
MOD History
This section is where you put what changes you have made between versions. The MOD History section isn't required but it is nice to have so that users can track what changes have been made to the MOD. If you do use it, please use the following format for each version in the MOD History section.
| Code: | ## YYYY-MM-DD - Version x.x.x
## - version notes go here
## - More version notes can go on new lines |
Install Disclaimer
| Code: | | ## Before Adding This MOD To Your Forum, You Should Back Up All Files Related To This MOD |
The install disclaimer tells the person who is installing the MOD that he or she needs to backup all files related to this MOD before installing. In no way is the author of the MOD or phpBB responsible to the user if any data is lost or the user's message board is broken.
Install Actions
This next part is all of the actions that need to be done in order to install the MOD. For more information on each action, read this article. Here is a list of possible actions that you can use
| Code: | SQL
COPY
DIY INSTRUCTIONS
OPEN
FIND
REPLACE WITH
AFTER, ADD
BEFORE, ADD
INCREMENT
IN-LINE FIND
IN-LINE AFTER, ADD
IN-LINE BEFORE, ADD
IN-LINE REPLACE WITH |
The End of the MOD
| Code: | #
#-----[ SAVE/CLOSE ALL FILES ]------------------------------------------
#
# EoM |
This is put at the end of the MOD Template to tell the person installing the MOD that he or she needs to save and close all files altered by the MOD and then upload all of the files to the his or her website. EoM means End of MOD |
|
|
|
