phpBB

Development Wiki

Text template

From phpBB Development Wiki

Revision as of 17:13, 17 September 2008 by Igorw (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The text template is a MOD format that was mostly used for phpBB 2.0.x. For the 3.0 line the MODX format is used. It is a diff format, that is designed to be more human-friendly, while still being automisable.

Basic layout

This is the basic structure of the text template. There can be multiple MOD authors. The history section is optional. EoM marks the end of the MOD. There is a head and a body section. ##############################################################

    1. MOD Title: mod_title_goes_here
    2. MOD Author: your_phpBB_username < your_email > (your_real_name) your_url
    3. MOD Description: some_description_goes_here
    4. MOD Version: x.x.x
    5. Installation Level: (Easy/Intermediate/Advanced)
    6. Installation Time: x Minutes
    7. Files To Edit: file_1,
    8. file_2,
    9. file_3,
    10. etc
    11. Included Files: (N/A, or list of included files)
    12. License: http://opensource.org/licenses/gpl-license.php GNU General Public License v2
    13. For security purposes, please check: http://www.phpbb.com/mods/
    14. for the latest version of this MOD. Although MODs are checked
    15. before being allowed in the MODs Database there is no guarantee
    16. that there are no security problems within the MOD. No support
    17. will be given for MODs not found within the MODs Database which
    18. can be found at http://www.phpbb.com/mods/
    19. Author Notes:
    20. MOD History:
    21. YYYY-MM-DD - Version x.x.x
    22. - version notes go here
    23. Before Adding This MOD To Your Forum, You Should Back Up All Files Related To This MOD
  1. -----[ ACTION ]------------------------------------------
  1. -----[ ACTION ]------------------------------------------
  1. -----[ ACTION ]------------------------------------------


  1. -----[ SAVE/CLOSE ALL FILES ]------------------------------------------
  2. EoM

Actions

The text template has actions that allow you to modify the code.

SQL

The SQL action allows you to execute SQL queries required for the MOD.

COPY

The COPY action allows you to copy files included with the MOD. The syntax is (note the "copy" keyword): copy root/filename.php to filename.php You may also use wildcards (*), however only in the following format: copy root/*.* to *.*

DIY INSTRUCTIONS

DIY INSTRUCTIONS allow you to specify manual tasks that have to be done by the person installing the MOD.

OPEN

With OPEN you can mark the start of a file that needs to be edited. The file remains open until the next OPEN or a non-editting action.

FIND

This action makes you find a section of code, that can be spread over multiple lines. It is relative to the file pointer, so you have to search for the next occurence, if there are multiples. It's also possible to have multiple FINDs in a row to place the file pointer correctly in case of duplicate occurences of the code to be searched.

REPLACE WITH

AFTER, ADD

BEFORE, ADD

INCREMENT

IN-LINE FIND

IN-LINE AFTER, ADD

IN-LINE BEFORE, ADD

IN-LINE REPLACE WITH

Packaging