= Module.ini = 

----

== Module.ini is now obsolete in favor of [wiki:module.xml] == 

----

The module.ini file is used to describe a module, including it's display name, version, type, category, and the menu items it provides.

Example:

{{{
[module id name] 
name=My Module 
version=1.0 
type=setup 

[menuitems] 
module_menu_id=My Module Menu 1
}}}

The module id name should be unique, and should exactly match the name of the directory the module is stored in. The following name=value pairs should be defined:

 * name=The display name for the module
 * version=The version number of this module
 * type=setup or tool.  setup tells freePBX that this module should appear in the "Setup" page. type=tool would result in the module going in the "Tools" page.
 * category=??? 

menuitems are the links displayed for the main components this module defines.  The following name=value pairs are expected:

 * menuid=menu display name

The menuid used should be unique, and will link to the page.menuid.php for this module.  Note that a module can define more than one menu item.

If needed, the system will optionally give you total control over the link created by a menu item (ie: to link somewhere besides page.menuid.php).  To make use of it, simply define the complete anchor tag for the menu item display name.  ie:

{{{
[menuitems]
wiki=<a href="http://www.freepbx.org" target="_blank">FreePBX.org</a>
}}}

You can use both absolute and relative links.  The text displayed (ie: "FreePBX.org") will be automatically translated if necessary/available.