Actions

Help25

Difference between revisions of "Extensions Module Manager Who Online"

From Joomla! Documentation

(Created page with "==How to Access== To add the Wrapper module, go to your site back-end. Using the top menu, go to Extensions -> module manager and select "new". Then, select "Who's Online. To ma...")
 
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
{{RightTOC}}
 
==How to Access==
 
==How to Access==
To add the Wrapper module, go to your site back-end. Using the top menu, go to Extensions -> module manager and select "new". Then, select "Who's Online.
+
To ''''add'''' a new Who's Online Module or ''''edit'''' an existing Who's Online Module, navigate to the [[Help25:Extensions_Module_Manager|Module Manager]]:
 +
* Select {{rarr|Extensions,Module Manager}}
  
To manage an existing Wrapper module, open the module from the Module list.
+
Click the ''''New'''' button and click on Who's Online in the modal popup window.
 +
 
 +
To ''''Edit'''' an existing Who's Online Module, in the Module Manager click on an '''Who's Online Modules Title''' or click the '''Who's Online Modules check box''' and then click the '''Edit''' button in the Toolbar.
  
 
==Description==
 
==Description==
Line 8: Line 12:
  
 
==Screenshot==
 
==Screenshot==
 +
[[Image:Help25-module-manager-who-online-screenshot.png]]
  
[[Image:Whosonline_module_example.png|frame|center]]
+
==Details and Options==
 
+
===Details===
For screenshots of the back-end, refer to the "Options" section.
+
{{Chunk25:Module Details}}
==Outline==
+
  
 
===Basic Options===
 
===Basic Options===
 
+
[[Image:Help25-module-manager-who-online-basic-options-screenshot.png]]
[[Image:J25_module_whosonline_basic.JPG|frame|center]]
+
 
*'''Display.'''
 
*'''Display.'''
 
**''# of Guests / Members.'' Display the total number of Guests (Users who are not logged in) and Members (Users who are logged in).
 
**''# of Guests / Members.'' Display the total number of Guests (Users who are not logged in) and Members (Users who are logged in).
**''Member Names.'' Display a list of the names of Members logged in. No count of Guests will display.
+
**''User Names.'' Display a list of the usernames of Members logged in. No count of Guests will display.
 
**''Both.'' A count of users and a list of Member Names will both display.
 
**''Both.'' A count of users and a list of Member Names will both display.
*'''Link''' Choose wether or not the module should link to user date.  Only applies to registered guest, when Display is set to "Member Names" or "Both"
 
*'''Data'''
 
**''Profile'' Link to the user's profile page
 
**''Contact'' Link to the user's associated contact page
 
  
 
===Advanced Options===
 
===Advanced Options===
 +
[[Image:Help25-module-manager-who-online-advanced-options.png]]
 +
{{Chunk25:colheader|Alternative Layout}}
 +
{{Chunk25:colheader|Module Class Suffix}}
 +
{{Chunk25:colheader|Caching}}
 +
{{Chunk25:colheader|Filter Groups}}
  
[[Image:J25_mod_advanced_3.JPG|frame|center]]
+
===Menu Assignment===
 +
{{Chunk25:Menu Assignment}}
  
*'''Alternative Layout''' Allows you to select an alternative lay-out or template override for the module, if available.
+
==Toolbar==
{{colheader|Module Class Suffix}}
+
{{Chunk25:Help_screen_module_manager_edit_toolbar}}
  
*'''Caching''' Always set to ''No caching'', or the module will display incorrect data
+
==Front End Screenshot==
 +
{{Chunk25:Help screen screenshot disclaimer}}
 +
Who's Online module shown:
  
==Quick Tips==
+
[[Image:Help25-module-manager-who-online-frontend-screenshot.png]]
  
*Most people prefer not to use the "Who's Online" module when they've got little visitors.   
+
The Module Type name for this Module is "mod_whosonline". It is related to the Users component.
 +
 
 +
==Quick Tips==
 +
* Most people prefer not to use the "Who's Online" module when they have few visitors.   
  
*If you set the cache time for this module too long, the number of visitors will incorrect as the module takes users in account that visited your site x minutes ago.
+
<noinclude>{{cathelp|2.5|Module Manager Help Screens|Extensions Help Screens}}</noinclude>

Latest revision as of 14:23, 10 April 2013

Contents

How to Access

To 'add' a new Who's Online Module or 'edit' an existing Who's Online Module, navigate to the Module Manager:

  • Select Extensions  Module Manager

Click the 'New' button and click on Who's Online in the modal popup window.

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

Description

The "Who's Online" module displays information about users that are visiting your site at a particular moment.

Screenshot

Help25-module-manager-who-online-screenshot.png

Details and Options

Details

Help25-module-manager-details-screenshot.png

  • 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/Archived/Trashed) The published status of the item.
  • 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.
  • 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).
  • 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.

Basic Options

Help25-module-manager-who-online-basic-options-screenshot.png

  • Display.
    • # of Guests / Members. Display the total number of Guests (Users who are not logged in) and Members (Users who are logged in).
    • User Names. Display a list of the usernames of Members logged in. No count of Guests will display.
    • Both. A count of users and a list of Member Names will both display.

Advanced Options

Help25-module-manager-who-online-advanced-options.png

  • Alternative Layout. If you have defined one or more alternative layouts for the Single Article menu item, you can select the layout to use for this article. See Layout Overrides in Joomla 2.5 for more information about alternative layouts.
  • Module Class Suffix. Setting this parameter causes Joomla! to either add a new CSS class or modify the existing CSS class for the div element for this specific module. See here for more information
  • Caching. (Use Global/No Caching) Choose whether you wish to cache the contents of the module.
  • Filter Groups Choose to filter by groups of a user's profile.

Menu Assignment

Help25-module-manager-menu-assignment-screenshot.png

On the left there is a list of menu items. You can chose between None, All and Select Menu Item(s) from the List. To assign to some but not all pages choose the third option and select the menu links that you want the module associated with. See How do you assign a module to specific pages? for more information

Toolbar

At the top right you will see the toolbar:

Help25-Toolbar-Save-SaveClose-SaveNew-SaveCopy-Close-Help.png

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. This toolbar icon is not shown if you are creating a new module.
  • Cancel/Close. Closes the current screen and returns to the previous screen without saving any modifications you may have made.
  • Help. Opens this help screen.

Front End Screenshot

Example Front End Site images are generic images using Joomla! core installation supplied free Front End Templates. The actual view can depend on the installed custom template used and the template's style for those views on a Joomla! website. Who's Online module shown:

Help25-module-manager-who-online-frontend-screenshot.png

The Module Type name for this Module is "mod_whosonline". It is related to the Users component.

Quick Tips

  • Most people prefer not to use the "Who's Online" module when they have few visitors.