Difference between revisions of "Extensions Module Manager Weblinks"

From Joomla! Documentation

m (Quick Tips: updating Help screens relevant versions)
m (Quick Tips: clean up)
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=Web Links Module=
The Weblinks module will display weblinks from within the Weblinks component.
==How to Access==
==How to access==
You can access the Weblinks module by either opening an existing Weblinks module in the Module Manager or by creating a new Weblinks Module.
You can access the Module Manager by going to '''Extensions > Module Manager'''
===Common Details===
The Weblinks module will display weblinks from within the Weblinks component.
{{Chunk30:Module Details}}
===Common Tabs===
==Basic Options==
*'''Category''':  Select the Weblinks category from which you want to display the links
*'''Count''':  Choose the number of links you want the module to show.
*'''Ordering''':  Choose the ordering method
**'''Title''':  Order links alphabetically.
**'''Order''':  Sort links based on their ID.
**'''Hits''':  Sort links, based on how often they were opened by your visitors.
*'''Direction''':  Select how you want to apply the method chosen in ''Ordering''
**'''Ascending''':  Start with the lowest value (first letter, id, lowest number of hits) and upwards.
**'''Descending''':  Start with the highest value (last letter, id, highest number of hits) and downwards.
*'''Target window''': Choose how to open the links.
**'''Open in new window''': Opens the link in a new window or tab.  This is often the preferred method. 
**'''Open in popup''': Opens a pop-up screen.
**'''Open in parent''':  Opens the site in the same window.  Deprecated, as it leads your visitor away from your site.
*'''Follow / No Follow''':  Instruct search engines how they should threat the link
**'''Follow''':  The search engine will follow the link
**'''No follow''':  The search engine won't follow the link.  This is usefull in some SEO scenarios.
**'''Description''':  Wether or not the description of the link (as added in the Weblinks component) should be shown.
*'''Hits''':  Wether or not the number of clicks for a link should be shown.
*'''Count clicks''': Wether or not the number of clicks for a link should be recorded.
**'''Use global:''' Use the global settings defined elsewhere.
**'''Yes''': Enable counting of links (regardless of global settings)
**'''No''': Disable counting of clicks (regardless of global settings)
==Advanced Options==
*'''Alternative layout''' Apply an alternative layout or template override
*'''Module Class Suffix''' Apply a CSS suffix to the module
{{colheader|Cache Time}}
==Menu Assignment==
==Quick Tips==
==Quick Tips==
No tips have been added.
No tips have been added.
<noinclude>{{cathelp|3.0,3.1|Module Manager Help Screens|Extensions Help Screens}}</noinclude>
<noinclude>{{cathelp|3.0,3.1,3.2,3.3|Module Manager Help Screens|Extensions Help Screens}}</noinclude>

Latest revision as of 11:28, 30 April 2014


The Weblinks module will display weblinks from within the Weblinks component.

How to Access

To 'add' a new Weblinks module or 'edit' an existing Weblinks module, navigate to the Module Manager:

  • Select Extensions  Module Manager

Click the 'New' button and click on Weblinks in the modal popup window.

To 'Edit' an existing Weblinks module, in the Module Manager click on the Weblinks Module's Title or click the Weblinks module's check box and then click the Edit button in the Toolbar.




  • Title: Module must have a title


This modules displays weblinks from a category defined in the Weblinks component.

  • Category: (Sample Data-Weblinks/Park Links/Joomla! Specific Links/Other Resources/Uncategorised). Choose the Weblinks category to display
  • Count: Number of Web Links to display
  • Direction: (Ascending/Descending). Set the ordering direction
  • Target Window: (Open in new window/Open in popup/Open in parent window). Target browser window when the link is clicked
  • Follow/No Follow: (Follow/No follow). Robots index - allow to follow or not
  • Description: (Show/Hide). Display Web Link description
  • Hits: (Show/Hide). Show Hits
  • Count Clicks: (Use Global/No/Yes). If set to yes, the number of times the link has been clicked will be recorded

Common Details


  • Title. The title of the module. This is also the title displayed in the front end for the module depending on the Show Title Form Field
  • Show Title. (Show/Hide) Choose whether to show or hide the modules title in the front end. The title will be the one in the Form Field above.
  • Module Position. Choose the module position you wish this module to be displayed in. A custom module position can be entered for use with the load position plugin or the position button can be pressed to select a module position from the template.


  • Status. (Published/Unpublished/Trashed) The published status of the item.</translate>
  • Access. The viewing level access for this item.
  • Module Ordering. This shows a drop down 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 front end as well as in the Module Manager.


  • 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.</translate>


  • 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).</translate>
  • Language. Item language.
  • Note. Item note. This is normally for the site administrator's use (for example, to document information about this item) and does not show in the front end of the site.

Common Tabs

Menu Assignment


On this tab there is a list of menu items. You can choose between On All Pages, No Pages, Only on the pages selected and On all pages except those selected from the List.

If the latter two options are selected a list will show with all the menu items on as shown in the screenshot above. This allows you to assign modules to some but not all pages, and by selecting the menu links that you want the module associated with you can customize on what pages modules appear/don't appear. See How do you assign a module to specific pages? for more information.

Module Permissions


  • Delete: (Inherited/Allowed/Denied). Allow or deny Delete for users in the Public group. Delete Allows users in the group to delete any content in this extension.
  • Edit: (Inherited/Allowed/Denied). Allow or deny Edit for users in the Public group. Edit Allows users in the group to edit any content in this extension.
  • Edit State: (Inherited/Allowed/Denied). Allow or deny Edit State for users in the Public group. Edit State Allows users in the group to change the state of any content in this extension.



  • Alternative 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. See Layout Overrides in Joomla 2.5 for more information about alternative layouts.
  • 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" 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.
    • See the tutorial Using Class Suffixes in Joomla! for more information.
  • Caching. Use Global/No Caching. Whether or not to cache the content of this Module. A setting of "Use Global" will use the Cache Settings from the Global Configuration screen.
  • Cache Time. The length of time, in minutes, before the Module is re-cached.
  • Module Tag. The HTML tag for the module to be placed in. By default this is a div tag but other HTML5 elements can also be used.
  • Bootstrap Size. (Values 0 to 12) This allows you to choose the width of the module via the span element built into bootstrap. For more information see the bootstrap documentation.
  • Header Tag. The HTML tag to use for the modules header or title. This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must use a module style (chrome) of html5 or add your custom module styles in <mytemplate>/html/modules.php.
  • Header Class. Here you can add optional CSS classes to add to the modules header or title element.
  • Module Style. You can use this option to override the templates style for its position.


<translate> At the top left you will see the toolbar:</translate>

[[Image:Help30-Save-SaveClose-SaveNew-SaveCopy-Close-Help-toolbar-<translate> en</translate>.png]]

<translate> The functions are:</translate> <translate>

  • Save: Saves the module and stays in the current screen.</translate>


  • Save & Close: Saves the module and closes the current screen.</translate>


  • Save & New: Saves the module and keeps the editing screen open and ready to create another module.</translate>


  • Save as Copy: Saves your changes to a copy of the current module. Does not affect the current module. This toolbar icon is not shown if you are creating a new module.</translate>


  • Cancel/Close: Closes the current screen and returns to the previous screen without saving any modifications you may have made.</translate>


  • Help: Opens this help screen.</translate>

Quick Tips

No tips have been added.