How to install a MODX Modification
Description: Summarised a list of things about using a MODX modification file
In Categories: Modifications
- Link to this article: Select All
[url=http://www.phpbb.com/support/docs/en/3.3/kb/article/how-to-install-a-modx-modification/]Knowledge Base - How to install a MODX Modification[/url]
This article intended to give you a simple tutorial about using the new XML modification format: MODX.
What do I do after I have downloaded a MOD?
After you have downloaded a MOD from the MODDB, the first step is to uncompress the zip file. When you go into the MOD's directory, you should see at least 3 files in the directory:
- a XML (e.g. index.xml)
- a XSL (most likely modx.prosilver.en.xsl or modx.subsilver.en.xsl
- a GPL license file (always called license.txt)
What do I use to open a XML file?
Almost all current browsers support the XML language. Therefore, in order to read the file, simple double click on the XML file, and it should be automatically loaded on your default web browser.
How do I read the XSL rendered XML?
After you open the XML file in a web browser, you should be able to see similar MOD information as the old text-based MOD tutorial.
The web page is broken download into 2 main sections, general information about the MOD and the actual tutorial that you must follow to install the MOD on your phpBB forum. Below, we will break this down further into smaller section and introduce them one by one.
In the top right-hand corner the language selector allows you to change the language of the file. There are currently 19 languages available for use, with many more hoped in the future. This tutorial is written using the default English interface.
About this MOD
In this section, you will see the MOD's title, detail description, the MOD version you are installing, estimated difficulty and the time you may take to complete the installation.
Here, you will see the phpBB handle of the author(s) of this MOD. His/her email information, personal web page and real name may also be provided.
Files to Edit and Included Files
A list of file(s) that you will need to edit are presented here, the filename(s) will be written in such a way to include the full path to the file(s). Therefore, you will know where to find the specific file(s) for editing.
The notice is pretty straight forward, please read it before installing any MOD.
Authors sometimes will want to include additional information about their MODs. It is always useful to read this before installing the MOD.
You may track a MOD's development history by reading this section of the install file.
License and Other Notes
The majority of the MOD will need to be GPL licensed and a copy of the license is included with the MOD. If you have doubts about what you can/can't do with the MOD, contact the MOD author(s).
Here, the MOD install file reminds you to backup your files before attempting any modification to the phpBB code. You should also back up your database (or related tables) if the MOD requires changes to your database. In case of any errors during installation, you can restore the backup files/database easily.
The notice also reminds you again the phpBB version a MOD is compatible with.
Documentation has been written to cover this part of the tutorial, please refer to MOD Actions.