Joomla Module Builder - Documentation & User Guide
Joomla Module Builder is a Joomla Component to ease development of Joomla Module(s). Below you will find general information and frequently asked questions. These will make it easier for you to use the extension. If you can't find the answer to your question here, please create a support ticket.
Created on : 24 December 2018, Monday
Last updated on : 08 January 2019, Tuesday
Current Version : 1.0.5
If you haven't downloaded this extension yet, click the link for more information and features. Joomla Module Builder.
Please click on the title for details..
Compatibility : Joomla 3.x.x
You will download UnzipFirst_MoBuilder.zip package. This is not installation package.
You must Unzip UnzipFirst_MoBuilder.zip package.
This package has 2 plugins and a component.
When you unzip the package you will 3 files :
- com_mobuilder - Component to build Joomla Modules
You can install extensions via Joomla Installer at Joomla Administrator area.
Installer can be found at administrator/index.php?option=com_installer
After successful installation you will get a success message.
All extension parameters are well-explained. All you need to do is rolling your mouse over the parameter title. An info window will show the parameter title and the short description about parameter.
Sometimes, when it is necessary, we add notes before the parameter to make it more clear for users.
Default Configuration is prepared
- to define a folder for the modules you are developing and
- to prevent you entering the same information for each module development.
If you do not complete the default configuration, you will get message each time when you start to create a module.
You must click to the button above the message to enter the configuration area to complete the data.
Modules folder is the place where you save the projects. This should be just a name without any path because folder will be created in the component -> mobuilder
You can use the default name or you can simply change it to another name you desired.
At MoBuilder -> Modules list view ( administrator/index.php?option=com_mobuilder&view=mbmodules ) click to NEW button and you can start to create your first module.
There are 4 tabs for creating the module :
and as 5th tab you will see Build, build is the latest part you need to use. You will use this part after saving your first module
When you develop a joomla module, you can do that as a front-end or an admin module.
For that reason, at Basics tab, first thing you need to do is selecting the client.
If you want to develop an administrator module, then select Admin option.
If you are developing a front-end module, then select Site as client.
When you name your module code name will be generated automatically.
If you want to develop a module for Joomla Extensions Directory please do not forget to check if there is already a module with the same name.
When you are developing a Joomla Extension, you may want your users update the extension automatically. In order to use this feature an update server must be defined in your extension's manifest.
This part will create this definition in modules manifest ( .xml ) file.
You can create multi-language modules. For each language click to + button and add the language code.
Language strings for Field title and descriptions will be created automatically in the language files.
You can create as much as fieldsets for the module. Fieldsets will help the module users to manage the module easier.
Most important is : you must create a unique id for each Fieldset
You can create as much as fields in your module. You need to write
- Fieldset ID : Field will be in this fieldset area
- Field Title : This is the display name for the field
- Unique Name : This is the code name for the field and this must be a unique name.
- Field Type : You can select one of the field type from the options.
- Default Value: This value will be used if module user does not enter a value for the field.
After completing, save the module.
After saving the module, a button at Build Module Tab will be visible, click on it and your module will be ready
In case you make a change, you can remove the previous files and re-build the module.
Re-build module will be visible after building the module.
If you do not want to loose the previous build, then simply change the version of the module at Basics and save the module.
After saving, you can build your module with new version
After building the module, a new tab will be visible : Version Manager
You can view all versions of your module.
You can click to Create zip and prepare Install-able package of your module.
When you create a Joomla Module with MoBuilder file structure will be as below :
All the files below will be created automatically!
mod_helloworld ( Main folder )
|-- mod_helloworld.php ( main.php file of the module )
|-- helper.php ( main helper file of the module )
|-- assets ( folder has 5 sub-folders )
|------- css ( folder has style files for the module )
|------ style.css ( main style file )
|------- customfields ( folder has custom field files for the module )
|------- images ( image files for the module )
|------- subforms ( subform field .xml files for the module )
|-- language ( language files for the module )
|------- en-GB (folder has lang. files if you created your module with en-GB language, this folder will be created automatically )
|------ en-GB.mod_helloworld.ini ( language file for field label and description strings )
|------ en-GB.mod_helloworld.sys.ini ( language file for module name and description strings)
|-- tmpl ( folder has layout files for the module )
|------ default.php ( main layout file )
One of the most difficult part of module development is creating the language strings for each field label and description.
You do not need to spend hours to do that!
MoBuilder will create it for you.
If you want to edit a language string you can open the language file and edit in the file.
If you create your module multi-language, it will create language files for each language you created at Language tab.