API Documentation

hello world xml

<?xml version="1.0" encoding="UTF-8"?>
* Community Builder User Plugin: plug_helloworld
* @version $Id$
* @package plug_helloworld
* @subpackage helloworld.xml
* @author Nant and CB Team
* @copyright (C)
* @license Limited GNU/GPL
* @final 1.0
<cbinstall version="1.0.3" type="plugin" group="user">
    <name>CB Hello World 1</name>
    <author>Nick A.</author>
    <copyright>(C) 2010</copyright>
    <license> GNU/GPL</license>
        This is a hello world 1 CB plugin used as a rough guideline for novice CB plugin developers.
        The only thing it does is to read a plugin parameter, read a tab parameter and display something in a new tab.
        <filename plugin="helloworld">helloworld.php</filename>
        <param    name="hwPlugEnabled" type="radio" label="Hello World Plugin Enabled" default="1" description="Specify Yes to enable hello world plugin.">
            <option value="0">No</option>
            <option value="1">Yes</option>
        <param    name="@spacer" type="spacer" label="Credits:" default="This plugin was created by Nick A. with the support of JoomlaJoe and Beat B." description="" />
        <param    name="@spacer" type="spacer" label="License:" default="This plugin is distributed under a limited GNU/GPL license and cannot be modified to work with anything else outside of the Community Builder suite supported by the site" description="" />
        <param    name="@spacer" type="spacer" label="Parameters:" default="Please look at the relevant tab for additional parameters" description="" />

        <tab name="Hello World" description="This tab is just a basic hello world type project to demonstrate a simple CB API application" class="gethelloworldTab" fields="0" position="cb_tabmain" displaytype="tab">
                <param name="hwTabMessage" type="text" label="CB Hello World Tab Text" default="Hello Joomlapolitans!" description="Actual hello world message to display in the tab (default: Hello Joomlapolitans!)." />