Packaging Custom Work :: The Mambot Setup File

{glossarbot=disable}The XML for a Mambot installation could look like this:

<?xml version="1.0" encoding="iso-8859-1"?>
<mosinstall type="mambot" group="content" version="1.0">
  <name>Smilies converter</name>
  <copyright>(C) 2005 Open Source Matters. All rights reserved.</copyright>
  <license> GNU/GPL</license>
  <description>Converts text smilies into graphic images.</description>
    <filename mambot=""></filename>

The <mosinstall> element has an additional attribute called "group". This attribute places the Mambot in a sub-directory named "content".

There needs to be ONE and only one <filename> that has a "mambot" attribute.  This attribute indicates the file that is called when the Mambot is loaded. The value of the attribute should be the name of the file less the ".php" extension.

There are two special (or reserved) groups in Joomla:

  • content: The Mambots in this group perform operations on displayed content.
  • search: The Mambots in this group provide for components to plug in the results to search engine.

A Mambot may optionally have parameters associated with it.  If parameters are supported by the Mambot then exactly one <params> element should be included containing one <param> sub-element for each parameter to be defined.  Once the Mambot is installed parameters will be displayed and values may be entered in the Administrator Mambot Edit form.  If no <params> element is defined (and if this is the case then no <param> elements must be included either) then a simple text box will be provided in the Administrator Mambot Edit form.

 Please report any errors on this page to the Developer Documentation Forum.

Last Updated ( Monday, 24 April 2006 )