Actions

Help16

Difference between revisions of "Extensions Module Manager Who Online"

From Joomla! Documentation

(Advanced Options)
 
(3 intermediate revisions by one user not shown)
Line 1: Line 1:
==Who's Online==
+
==How to Access==
This Module displays information about Users currently browsing the web site. An example is shown below:
+
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 manage an existing Wrapper module, open the module from the Module list. 
 +
 
 +
==Description==
 +
The "Who's Online" module displays information about users that are visiting your site at a particular moment.
 +
 
 +
==Screenshot==
 +
 
 
[[Image:Whosonline_module_example.png|frame|center]]
 
[[Image:Whosonline_module_example.png|frame|center]]
The Module Type name for this Module is "mod_whosonline". It is not related to any other component.
 
  
==Module Parameters==
+
For screenshots of the back-end, refer to the "Options" section.
 +
==Outline==
  
 
===Basic Options===
 
===Basic Options===
  
 
[[Image:J16_module_whosonline_basic.JPG|frame|center]]
 
[[Image:J16_module_whosonline_basic.JPG|frame|center]]
*'''Caching.''' Always set to "Never".
 
 
*'''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.
 
**''Member Names.'' Display a list of the names 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.
{{colheader|Module Class Suffix}}
+
*'''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:J16_mod_advanced_3.JPG|frame|center]]
 
[[Image:J16_mod_advanced_3.JPG|frame|center]]
 +
 +
*'''Alternative Layout''' Allows you to select an alternative lay-out or template override for the module, if available.
 +
{{colheader|Module Class Suffix}}
 +
 +
*'''Caching''' Always set to ''No caching'', or the module will display incorrect data
 +
 +
==Quick Tips==
 +
 +
*Most people prefer not to use the "Who's Online" module when they've got little 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.

Latest revision as of 13:58, 4 May 2011

Contents

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 manage an existing Wrapper module, open the module from the Module list.

Description

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

Screenshot

Whosonline module example.png

For screenshots of the back-end, refer to the "Options" section.

Outline

Basic Options

J16 module whosonline basic.JPG
  • Display.
    • # 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.
    • 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

J16 mod advanced 3.JPG
  • Alternative Layout Allows you to select an alternative lay-out or template override for the module, if available.
  • 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! 1.5/1.6 for more information.
  • Caching Always set to No caching, or the module will display incorrect data

Quick Tips

  • Most people prefer not to use the "Who's Online" module when they've got little 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.