phpBB • Creating Communities Worldwide

Update to MODX 1.2.x

Update to MODX 1.2.1 from MODX 1.2.0

The MODX 1.2.1 is a maintence release for MODX. The only changes are made in the XSL. You need to update your included XSL to the newest revision you can find at the MODX resource center.
Beside that you will also need to update the url of the XSD in the xml source from 1.2.0 to 1.2.1.
No other changes are required to update.

Update to MODX 1.2.0

MODX 1.2.0 is a new release of MODX, the phpBB MOD Team’s standard to describe changes in phpBB.
This update contains several changes to the syntax that make MODX 1.0.1 incompatable with MODX 1.2.0. This document describes the required changes that need to be made.

Update to the package

As part of the feedback from the community we have updated the packaging of a MODX MOD. When you submit a MODX 1.2.1 MOD you should follow this new packaging.
This new packaging means:

• All new files are placed in the root/ directory.
• There is one main install file in /, and its filename shall include the word “install”. This file should include the prosilver and English language changes.
• Changes for other languages or templates are in separate XML files in the / directory, or in xml/.
• The license.txt in /, including a copy of the GPL v2.
• The prosilver xsl is in / or in xml/.

This new packaging is intended to be easier for MOD authors. Strict packaging is replaced with the link tags which are described below.

Link-group and Link tags

With this MODX version there are two new tags:

• link-group
• link

These 2 new tags are used to group of MODX files together. They are used in the following way:

	<link-group>
		<link type="template" href="subsilver2.xml" lang="en">subsilver2</link>
	</link-group>
	

The link tag can only be a child of the link-group element. The link-group is a child of the header element.
The link tag has the following attributes:

• type: the type of the link. This can be dependency, parent, template, language or contrib. This attribute is required.
• href: the location of the linked file. This can be on the filesystem or at internet. This attribute is required
• lang: the ISO lang code the title is written in. This attribute is required.

The element has a value a text to explain what the link is. This text will be displayed when using the MODX 1.2.0 XSL.
The link tag is used for when a MOD includes multiple MODX files. For example, subsilver2.xml, which was in the templates directory with MODX 1.0.1. In MODX 1.2.0 you can place it where you want, and link it to the main MODX file. Links should be reciprocal: the subsilver2.xml file should contain a link back to the main MODX file.

Changed Version syntax

The last major change in MODX 1.2.0 is the updated version syntax for these elements:

• mod-version
• target-version
• rev-version

The old syntax for each of these was like this:

		<mod-version>
			<major>1</major>
			<minor>0</minor>
			<revision>0</revision>
			<release>b</release>
		</mod-version>
	

With the new syntax the above becomes this:

	    <mod-version>1.0.0b</mod-version>
	

The same applies for all above noted fields. To update your MODX file to MODX 1.2.0 you should change these fields to the new syntax.
The new syntax has no attributes or subelements. Everything is in one element.
This change is done because the old syntax was somewhat confusing.
If you still try to use the old syntax your MOD will denied because your MOD does not follow the MODX 1.2.0 standard.

Questions and more information?

For more information you can look in the MODX Format Description, what explains every element of MODX in detail.
If you have any questions, you can ask in the MOD Writers Discussion Forum.