Definition

Navigation:  Components > Basic Structure >

Definition

Previous pageReturn to chapter overviewNext page

Definition is a XML file that we create for each component. Component Directory Name is considered as Component Name. A definition file contain below data:
 
Version (<version>):
Current version of a component.
 
Title (<name>):
Name of the component display in the list.

 

URI (<uri>):
Website address of component
 
Description (<description>):
Description of the Component
 
Author (<author>):
Component developer name.
 
Author URI (<author_uri>):
Website address of Component developer.
 
Namespace (<namespace>):
This is for further use of system. Keep it "Auto".

 
Helper (<help>):
A quick help for user. 
 
Checkfiles (<checkfiles>)
Enter the list of mandatory file to check existence. 

 

Check below example:
 
<?xml version="1.0" encoding="utf-8"?>
<database>
    <version>0.1.0</version>
    <name>A Test Component</name>
    <uri>http://www.example.com</uri>
    <description><![CDATA[This is a test component]]></description>
    <author>Jhon Regan </author>
    <author_uri>http://jhon.example.com</author_uri>
    <namespace>auto</namespace>
    <help>
        <![CDATA[
            Check the menu of the component in Left Side of Application tab.<br />
            This is a test component.
        ]]>
    </help>
    <checkfiles>
        <filepath>register.php</filepath>
    </checkfiles>
</database>