Documentation

How does it work

User tags

User attributes

Online visitors

Technical

Add or Edit a User Info block

 

How does it work ?

You can integrate tags like {ui_name} or {ui_visitors} anywhere you like in your text. for example to show the username, or the number of visitors currently online.

A big advantage is that you can just use styles or markups anyway you want.

It uses the normal editor (redactor) with extra pull-down menu's with all available tags. You can just select and insert them anywhere you like...no extra typing needed.

When you create a new block, a standard example is already provided. Just take a look and adapt it to your needs.

User tags:

The following tags are now available:

{ui_agent} - browser agent
{ui_avatar} - the avatar (edit the content in the avatar tab)
{ui_badges} - the badges earned (with name and description when hovering)
{ui_email} - user email address
{ui_ip} - user IP address
{ui_language} - user's language
{ui_lastip} - last IP
{ui_lastlogin} - time and date of last login
{ui_login} - link to login/out
{ui_logins} - number of logins
{ui_name} - user name (or guest)
{ui_points} - the number of community points earned
{ui_profile} - link to user's profile
{ui_regdate} - date of registration
{ui_timezone} - the user's timezone
{ui_uid} - user id (internal concrete5 code)

User Attributes

Not only can you use typical user information like Name, IP, Number of Logins, etc. But also you can use user attributes !
Want a second picture for a user ? Just create a user attribute and a new tag will become available to your 'User Info' blocks !! The tag itself will be listed automatically in the editor's pull down menu.

All attribute tags have their own classes, so you can style them with .CSS.

The tags have a format like: {ui_attr_handle}. So if you have an attribute handle "extrapicture" you can use {ui_attr_extrapicture} in your text.

Show number of online visitors

A special feature: show the number of visitors currently online. The following tags are now available:

{ui_guests} - the number of guest users
{ui_registered} - the number of users that are logged in
{ui_visitors} - total number of users online
{ui_onpage} - the total number of users viewing the current page

If you don't want to use this feature, you can disable it in the settings-tab. To disable it, you set the refreshtime to 0.

Technical

To count the number of visitors currently on your website, 'User Info' will contact the server every so many seconds and refresh the contents of the 'User Info' blocks. You can set the 'refreshtime' and 'timeout' in any of your 'User Info' blocks.

If you want to disable this, then set the refresh time to zero (0).

Add a 'User Info' block to one of the global area's so it will work on every page. (even without any content, it will contact the server)

'User Info' is optimized to update multiple "User Info" blocks on one page. So adding more than one 'User Info' blocks, won't increase the number of refresh call to the server.

Add or Edit a block

When you add or edit a 'User Info' block, you will see 4 tabs:

  • User - choose to display the current online user, or the page author
  • Guests - the content that will be shown to guest users (not logged in). You will get fewer user tags and no attribute tags in the pull-down menus
  • Avatar: guests - the content that will be shown in a popover when hovering over the avatar picture (for guests)
  • Logged-in Users - the content that will be shown to registrated users. Here you can also use tags like {ui_avatar}
  • Avatar: logged-in - the content that will be shown in a popover when hovering over the avatar picture (for logged-in users)
  • Global settings - configuration options (sitewide)

In settings you can adapt some options. You can edit them in any 'User Info' block on your site, it will apply to all the blocks on your site. Change one, change them all.

  • sample content - uncheck this if you don´t want any more examples to be filled in new blocks.
  • refresh time - (0 to disable) this is the time interval between calls to the server to update and check on the number of users currently visiting your site. Lower generates more traffic, higher makes it less accurate
  • timeout - this is the time - since his last update to the server - before a user is considered gone. Choose a time a bit higher than the refresh time.