Difference between revisions of "Extensions Module Manager Custom HTML/en"
From Joomla! Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
|Line 31:||Line 31:|
=== Options ===
=== Options ===
Latest revision as of 04:51, 28 March 2022
The Custom Module allows you to create a self-contained HTML unit and then put it in any valid location on a page.
How to Access
Add a new module 'Custom'
- Select Extensions → Modules from the dropdown menu of the Administrator Panel.
- Click the New button in the toolbar
- Select the Module Type Custom.
Edit an existing module 'Custom'
- Click on the module's Title in Module.
- Title. The title of the module. This is also the title displayed in the Frontend for the module.
Default Editor is TinyMCE.
- Show Title. (Show/Hide) Show or hide module title on display. Note: Effect will depend on the module style (chrome) in the template.
- Position. You may select a module position from the list of pre-defined positions or enter your own module position by typing the name in the field and pressing enter.
- Status. (Published/Unpublished/Trashed) The published status of the module.
- Start Publishing. Date and time to start publishing. Use this field if you want to enter content ahead of time and then have it published automatically at a future time.
- Finish Publishing. Date and time to finish publishing. Use this field if you want to have content automatically changed to Unpublished state at a future time (for example, when it is no longer applicable).
- Access. Who has access to this module.
- Public: Everyone has access.
- Guest: Everyone has access.
- Registered: Only registered users have access.
- Special: Only users with author status or higher have access.
- Super Users: Only super users have access.
- Ordering. This shows a dropdown of every module in the position that the current module is in. This is the order that the modules will display in when displayed on in the Frontend as well as in Modules.
- Language. Select the language for this module. If you are not using the multi-language feature of Joomla, keep the default of All.
- Note. Module note. This is normally for the site administrator's use (for example, to document information about this module) and does not show in the Frontend of the site.
- Module Assignment.
- On all pages: Module is shown on all pages.
- No pages: Module is not shown on any page.
- Only on the pages selected: 'Menu Selection' will show with all the menu items on. You can assign modules by selecting the menu links that you want the module associated with on what pages modules appear.
- On all pages except those selected: 'Menu Selection' list will show with all the menu items on. This allows you to assign modules by selecting the menu links that you want the module associated with on what pages modules don't appear.
- Prepare Content. (Yes/No) Optionally prepare the content with the Joomla Content Plugins.
- Select a Background Image. Select or upload an image that will automatically be inserted as an inline style for the wrapping div element.
- Layout. If you have defined one or more alternative layouts for a module either in the template or Joomla Core, you can select the layout to use for this module.
- Module Class Suffix. A suffix applied to the CSS class of the module. This allows you to create customized CSS styles that will apply just to this module. You would then modify the template.css or custom.css file of your template to apply styling to this new class.
- Enter this parameter with a leading space to create a new CSS class for this module.
- Enter the parameter without a leading space to change the CSS class name for this module.
- Caching. (Use Global/No Caching) Whether or not to cache the content of this module. "Use Global" will use the settings from Global Configuration.
- Cache Time. The number of minutes for which to cache the module locally. It can safely be left at the default.
- Module Tag. The HTML tag for the module to be placed in. By default this is a div tag but other HTML5 elements (address, article, …) can also be used.
- Bootstrap Size. (0/…/12) This allows you to choose the width of the module via the span element built into bootstrap.
- Header Tag. (h1/h2/h3/h4/h5/h6/p/div) The HTML tag to use for the modules header or title. Note: You must use a module style (chrome) of html5 or add your custom module styles in [yourtemplate]/html/modules.php.
- Header Class. Add optional CSS classes to the modules header or title element.
- Module Style. Override the templates style for its position.
Manage the permission settings for user groups.
To change the permissions for this module, do the following.
- 1. Select the Group by clicking its title located on the left.
- 2. Find the desired Action. Possible Actions are:
- Delete. Users can delete content of this module.
- Edit. Users can edit content of this module.
- Edit State. Users can change the published state and related information for content of this module.
- Frontend Editing. Allows users in the group to edit in Frontend.
- 3. Select the desired Permission for the action you wish to change. Possible settings are:
- Inherited: Inherited for users in this Group from the module options permissions of this site.
- Allowed: Allowed for users in this Group. Note that, if this action is Denied at one of the higher levels, the Allowed permission here will not take effect. A Denied setting cannot be overridden.
- Denied: Denied for users in this Group.
- 4. Click Save in Toolbar at top. When the screen refreshes, the Calculated Setting column will show the effective permission for this Group and Action.
At the top left you will see the toolbar.
The functions are:
- Save. Saves the module and stays in the current screen.
- Save & Close. Saves the module and closes the current screen.
- Save & New. Saves the module and keeps the editing screen open and ready to create another module.
- Save as Copy. Saves your changes to a copy of the current module. Does not affect the current module.Note: This toolbar icon is only shown if you edit an existing module.
- Close. Closes the current screen and returns to the previous screen without saving any modifications you may have made.
- Help. Opens this help screen.
The editor does not allow you to enter certain HTML tags. To work around this, you can temporarily change your User's editor to "No Editor", create the Custom HTML Module, and then change the editor back to TinyMCE. Another option is to use an editor from an Extension that allows HTML code to be entered. Another possibility is (if the editor has this option) to switch to the HTML mode, enter the code, save and switch back to normal view.
- More about Modules: what is a module position, Description of the default Site and Administrator Modules.