phpBB

Development Wiki

Difference between revisions of "Tutorial.Adding modules"

From phpBB Development Wiki

(brief overview -- helping someone out on STG, why not add it to the wiki. :))
 
m (Reverted edits by All4phone (talk) to last revision by Battye)
 
(5 intermediate revisions by 5 users not shown)
Line 9: Line 9:
 
When you reach the options screen for your new tab/module, be sure to select type: ''Category'' and ''No Parent'' -- Module enabled: ''Yes''.<br>
 
When you reach the options screen for your new tab/module, be sure to select type: ''Category'' and ''No Parent'' -- Module enabled: ''Yes''.<br>
 
The new Tab will not display until there are actual active modules within the new tab.<br>
 
The new Tab will not display until there are actual active modules within the new tab.<br>
After adding a new category, the [[Cache directory]] must be cleared for the change to become visible.<br>
 
  
 
===Adding a new Module to the ACP, MCP or UCP===
 
===Adding a new Module to the ACP, MCP or UCP===
Line 19: Line 18:
 
Click on ''Main''.<br>
 
Click on ''Main''.<br>
 
Now select a module from the drop down menu on the lower right-hand side of the screen.<br>
 
Now select a module from the drop down menu on the lower right-hand side of the screen.<br>
This drop down menu includes all [[info files]] located within the <code>/includes/mcp/info/<code> directory.<br>
+
This drop down menu includes all [[info files]] located within the <code>/includes/mcp/info/</code> directory.<br>
:Note: To create a new module for use within the three control panels, please see detailed information on [[creating info files]].<br>
+
:Note: To create a new module for use within the three control panels, please see detailed information on [[creating modules]].<br>
 
Now click ''Add Module''. -- It will ask you to confirm adding the new module to the selected category. Click ''Yes''.<br>
 
Now click ''Add Module''. -- It will ask you to confirm adding the new module to the selected category. Click ''Yes''.<br>
 
You will be returned back to the modules list within ''Main''.<br>
 
You will be returned back to the modules list within ''Main''.<br>

Latest revision as of 21:10, 7 July 2011

Guide to adding modules to the ACP (Administration Control Panel), MCP (Moderator Control Panel), and UCP (User Control Panel).

Adding a Tab to the ACP, MCP or UCP

This tutorial will guide you through the process of adding a TAB (top level category) to the ACP.
The same process will follow for the MCP and UCP.

Go to ACP > System > Module Management : Administration Control Panel
This will bring you to the list of top level categories for the ACP. (i.e. the Tabs)
To add a new tab, simply type in the Tab name you want to use for the tab in the lower left-hand input field, and click Create New Module.

Note that you can use localization for new modules as well, to do this, type in the ALL CAPS name of a language string that is included with the /language/<lang>/acp/common.php language file.

When you reach the options screen for your new tab/module, be sure to select type: Category and No Parent -- Module enabled: Yes.
The new Tab will not display until there are actual active modules within the new tab.

Adding a new Module to the ACP, MCP or UCP

This tutorial will guide you through the process of creating a new module for use within the MCP.
The same procedure follows for creating a new module within the ACP or UCP.

Go to ACP > System > Module Management : Moderator Control Panel
This will bring you to the list of top level categories for the MCP.
Select a Category you wish to create the new module under. -- For this tutorial, we’ll be using the Main Module. --
Click on Main.
Now select a module from the drop down menu on the lower right-hand side of the screen.
This drop down menu includes all info files located within the /includes/mcp/info/ directory.

Note: To create a new module for use within the three control panels, please see detailed information on creating modules.

Now click Add Module. -- It will ask you to confirm adding the new module to the selected category. Click Yes.
You will be returned back to the modules list within Main.
Click on Enable to activate the new module.
Click on the green wheel to edit options for your new module

This article is a stub. You can help in improving Olympus Documentation by expanding it.