XML Schema Reference

XML files are used to control, map or define several things in Tribiq CMS.

This section contains a complete structure reference for the XML files you need to create for your Modules and Skins.

Skin Schema <skin>

Skins need an XML description of themselves in the form of a file called skin.xml in their directory.

If you are making a Skin, you must create this file and add information about the Skin you have just created; for example a list of Plugins that you have styled in your Skin.

Module Schema <module>

Every Module you create must have an XML file with some basic information about that Module in it.

Some of this information is descriptive: for example you must give your Plugin an name and a description.

Some of this information is used to enable certain features: for example there is a tag that you must include before your Module can act as a Plugin and can create Instances.

Storekeeper Schema <storekeeper>

Storekeeper is built on XML files, written in the Tribiq User Interface Language (TUIX), which describe and give structure to its sections and Panels.

Storekeeper Apps, which are Tribiq Modules, are written in the same language and using the same XML Schema as Storekeeper - which is an App itself.

In order to add functionality to Storekeeper, your Module must contain one or more XML files in its tuix/storekeeper subdirectory. (If your App is complex, you may wish to split a single large XML file into multiple files.)

The XML files serve as a map or plan of what functionality your Plugin adds to Storekeeper, and where.

For example, an XML tag may define the buttons which are added to Storekeeper, or the top level links that appear at the left hand-side.

When developing Storekeeper Apps, the flow of the Schema is one-way. Your XML files are read by the CMS on the server and turned into a PHP array, which then passes them to the client as JSON. The client does not pass the JSON object back, but instead replies using GET or POST AJAX requests.

Admin Box Schema <admin_boxes>

Admin Boxes are very much like Storekeeper, in that they are also built on XML files, written in TUIX, which describe which boxes there are, and what tabs and fields they contain.

In order to create an Admin Box, your Module must contain one or more XML files in its tuix/admin_boxes subdirectory.

Where Admin Boxes differ from Storekeeper is that when developing Admin Boxes, the flow of the Schema is two-way. Your XML files are read by the CMS on the server and turned into a PHP array, which then passes them to the client as JSON. The client then passes the JSON object back with some tags updated.

Admin Toolbar Schema <admin_toolbar>

At the top of each Content Item in Admin-mode is the Admin Toolbar. This provides several tools and controls, which Plugin Developers can add to using TUIX.

From Tribiq 6.0 onwards, the Admin Toolbar is powered using a TUIX-based system that is very similar to Storekeeper. This gives your Plugins the ability to add buttons to the Admin Toolbar the same way they can add buttons into Storekeeper Panels.