Module Management



Modules are used the form the structure and content of the UCP, MCP and ACP. Individual modules can be optionally disabled and it is possible to reorganize them into a different structure. Modules for the User Control Panel and the Moderator Control panel have a Category » Module two-level structure, while the Administration modules have three levels: Category (tabs at the top) » Category (headers on the left-hand side) » Module (individual sections).

Very often, MODs that have controllable features add modules to the ACP to allow comfortable editing of various settings.

To create a module category, use the text field next to the Create new module button. Enter the category title, click the button and on the next page ensure that the Module type is Category, the module is enabled and that the Module parent is set correctly. After you create a category, you can browse to it through the list of modules and add a specific module that is saved in a file. Modules are saved in the appropriate directory (acp/, mcp/ or /ucp) contained in the includes/ directory.

Warning

By disabling the Module Management module, it is possible to cut yourself off from the ACP and other control panels. Be careful when you are editing modules.

Adding a module

  • Module language name: This should be set to the language constant that holds the module name in the different languages, which are used on the board. You can also specify a normal title here, if you do not have the module title translated.

  • Module type: You can add a category or a module. As stated above, categories hold another level of categories or modules, they are used to organize the control panels.

  • Parent: This setting defines under which category the module or category will be displayed.

  • Module enabled: If a module is disabled, it will not be accessible at all, you will have to enable it to use it.

  • Module displayed: If the module is enabled, but not displayed, you will be able to access it with a direct URL but it will not show in the menus. This setting is shown only if the Module type is set to Module.

  • Choose module: Individual module files contain the various control panels. Similar modules are grouped into one file and are called by specifying a mode. Here you select the file in which the specific module you want is located. This setting is shown only if the Module type is set to Module.

  • Choose module mode: Here you set the what mode should be used in the module file selected above. The final contents of the module are based on this setting. This setting is shown only if the Module type is set to Module.