Joomla Documentation

Welcome to the product documentation section. Here you will find installation guides, quick-references and more information for our Joomla! extensions and templates.

Description

The Joomla! XTC K2 Content Wall module enhances your site with incredible power to display K2 Content with your custom CSS and HTML in a module position. Choose items by Category and other criteria and display them with your own templates limited only by your imagination. Its the perfect tool for developers with custom styles in mind. The module can display articles in rows, columns and grids as well as special scrolling effects for sliders and transitions.

Installation

Install the module using the regular Joomla! extension installer.

Configuration

The module can be customized using the standard Joomla! Module Manager.

Parameters are divided in two main sections: The Module Parameters section defines what data will be shown and how it should be presented. The Advanced Parameters allows you to configure the special effects and animations, if any were used. These parameters won't affect the data, but they can affect their display form.

To access these parameters go to the module manager and select the K2 Content Wall Module

Module Parameters

Module parametersUse these parameters to customize the standard presentation of the module

SELECTION PARAMETERS - Use these parameters to select what items to show:

Category IDContent category.
Avatar Compatibility modeEnables avatar support for the most popular extensions.
Comment Compatibility modeEnables comments support for the most popular extensions.
AuthorsFilter according to article authors.
One article per author?Limit articles to one per author?
Sort fieldSorting criteria.
Sort orderChoose the desired sort ordering.

DISPLAY PARAMETERS - Use these parameters to customize the layout of the module box. The layout consists of a grid made up with one or more pages of pictures organized in rows and/or columns.

ColumnsNumber of columns to show.
RowsNumber of rows to show.
PagesNumber of pages to show. Transition effects are enabled between page changes.
Display StyleSpecial effects applied to the layout. Window modes work with one page only, all others require multiple pages of content to perform transitions between them.
Window WidthWidth (in pixels) of the window frame when using a Window special effect.
Window HeightHeight (in pixels) of the window frame when using a Window special effect.
Transition pausePause time between page transitions in milliseconds. A value of -1 disables automatic transitions. Default value is: 4000.
Transition durationPage transition effect duration in milliseconds (default: 1500).
Slide orientationSlide transition orientation.
Transition typeTransition animation type.
Transition Ease modeEase in - Ease out - Ease in out

MODULE DISPLAY CONFIGURATION
- Use this parameters to define who you want to display the module.

Button StyleButton graphic set to use when buttons tags are enabled.
TemplateTo select one of our predesigned template. NOTE: Select -None selected- if want to use Module HTML template and Main Content HTML template fields.
Module HTML template HTML/CSS code to display the overall module box. You can embed any of the following tags:
{leftbutton}Draws a "Left/Back/Previous" button.
{mainarea}This tag draws the main layout area block, including the special effects.
{pages}Displays a numbered page list for quick browsing.
{rightbutton}Draws a "Right/Forward/Next" button.
Main Content HTML template HTML/CSS code to display each item. You can embed any of the following tags to display article information:
{attachmentattrib} Item attachment attribute field value
{attachmentdownload} Displays a link to download the item attachment
{attachmenthits} Hits of the item attachment
{attachmentname} Name of the item attachment
{attachmenturl} URL to item attachment
{attachment} Direct URL to the item attachment
{authorname}Item author's name
{authorprofile}URL to author profile Page
{author}Item author's username
{avatar}Displays the author avatar thumbnail
{categorydescription_text}Shows the category description text without HTML tags
{categorydescription}Shows the raw category description text
{categoryimageurl}URL to the category thumbnail image
{categoryimage}Displays the category thumbnail image
{categorytwitterlink}With this tag you will get the image to tweet the category that contains the item.
{categorytwitterurl}Use this tag to get the url to tweet the category that contains the item.
{categoryurl}URL to the item's category page
{category}Name of the category where the item belongs
{comments} Number of comments done in the item
{count}Total number of rate entries
{date}Item creation date. Also supports an extra formatting parameter according to PHP date() function, eg: {date Ymd}
{featured}Returns a value of "N" or "Y" if the item is featured or not.
{field_xxxx yyy}Display a custom field value, where 'xxxx' is the field name as defined in K2. ENter a numeric 'yyy' value to limit the number of characters shown. For example: {field_custom 100}
{fullimage}URL to the first embedded image in the full text of the item
{fullnoimage}Item full text without images
{fulltext}Full text with all HTML removed
{hits} Number of item hits
{id}The numeric ID of the K2 item
{imagegallery} Displays the item image gallery
{imageGeneric} Displays the Generic item image
{imageGenricurl} URL to the Generic item image
{imageLargeurl} URL to the Large item image
{imageLarge} Displays the Large item image
{imageMediumurl} URL to the Medium item image
{imageMedium}Displays the Medium item image
{imageOriginalurl} URL to the Original item image
{imageOriginal} Displays the Original item image
{imageSmallurl} URL to the Small item image
{imageSmall} Displays the Small item image
{imageXLargeurl} URL to the XLarge item image
{imageXLarge} Displays the XLarge item image
{imageXSmallurl} URL to the XSmall item image
{imageXSmall} Displays the XSmall item image
{index}A number representing the item's position within the module. Useful for Top-Ten lists.
{introimage}URL to the first embedded image in the introduction text
{intronoimage}Introduction text with images removed (all other HTML is preserved)
{introtext}Introduction text with all HTML removed
{intro}Raw introduction text (might contain HTML code).
{itemtwitterlink}With this tag you will get the image to tweet the item.
{itemtwitterurl}Use this tag to get the url to tweet the item.
{language language_token}Display a language token, default value is K2_READ_MORE to show "Read More"
{lastip}Lastip value
{link}URL to the K2 item page
{moddate}Last item modification date. Also supports an extra formatting parameter according to PHP date() function, eg: {moddate Ymd}
{rate}Use this tag to get the interactive rate level, With this tag your visitors can rate the item beign shown
{ratingcount}Count of rate points
{ratingsum}Sum of rate points
{rating}Use this tag to show the rate level image
{rawfulltext}Item raw full text (image tags and other HTML are preserved)
{relatedlink}Related items shown as links to them
{relatedname}This tag will show the related items information
{taglinks}Use this tag to show the tags as a link to other items sharing the same tag
{tagnames}Use this tag to show the tags of the item
{title}Item title
{video} Displays the item video
Avatar widthUse to set the width of the avatar. Note: The avatar tags only work if the compatibility is active.
Avatar heightUse to set the height of the avatar. Note: The avatar tags only work if the compatibility is active.
Max. title lengthMaximum length of {title} tag. Empty = no limit.
Max. title suffixSuffix to show when trimming the title.
Max. intro lengthMaximum length of {introtext} tag. Empty = no limit.
Max. intro suffixSuffix to show when trimming the intro text.
Max. full text lengthMaximum length of {fulltext} or {rawfulltext} tags. Empty = no limit.
Max. full text suffixSuffix to show when trimming full text.
Full text break keywordDisplay article text up to this string mark is found (including). Leave empty to display all text.
Date formatDate format (using PHP date function). Defaulty is: Y-m-d

'MORE' AREA CONFIGURATION - Use these parameters to customize the 'more' area block in the module.

'More' Content HTML templateHTML/CSS code to display each article. You can embed any of the supported tags to display article information.
More titlesOffer links to more article titles.
Clone from main?Enabling this will make the articles in the more section be the same as in the main section.
More ColumnsNumber of articles to show horizontally. If number of articles is higher, multiple rows will be shown.
More legendLegend to show in read more area.
More legend colorLegend color.
Max. length for title textMaximum length of {title} tag. Empty = no limit.
Max. title suffixSuffix to show when trimming the title.
Max. length for intro textMaximum length of {introtext} tag. Empty = no limit.
Max. intro suffixSuffix to show when trimming the intro text.
Max. full text lengthMaximum length of {fulltext} or {rawfulltext} tags. Empty = no limit.
Max. full text suffixSuffix to show when trimming full text.
Full text break keywordDisplay article text up to this string mark is found (including). Leave empty to display all text.
Module Class SuffixA suffix to be applied to the CSS class of the module.
Advanced Parameters

Module advanced parameters These parameters control the behavior of special content effects, please read the next section for more information about content effects and how to apply them.

Show number of votes?Choose if want to show the number of votes in the {rate} and {rating} tag
Max. related items Maximum number of related items, only works if use {related} tag
Category twitter textSelect the text that want to the tag {categorytwitterlink} display
Item twitter textSelect the text that want to the tag {itemtwitterlink} display
Z layerDefine the z-index layer to use for the special effect content.

Tooltip / Pop-Up FX Settings - Use these parameters to customize the Tooltip and Pop-Up effects:

In OpacityThe opacity of the tooltip/pop-up when the mouse enters the trigger zone. A value of 0 will make the display transparent while a value of 1 will make it opaque, values range from 0 to 1 in decimal increments.
Out OpacityThe opacity of the tooltip/pop-up when the mouse leaves the trigger zone. A value of 0 will make the display transparent while a value of 1 will make it opaque, values range from 0 to 1 in decimal increments.
In Animation VerticalThe distance the tooltip/pop-up will move vertically (in pixels) when the mouse enters the trigger zone.
Out Animation VerticalThe distance the tooltip/pop-up will move vertically (in pixels) when the mouse leaves the trigger zone.
In Animation HorizontalThe distance the tooltip/pop-up will move horizontally (in pixels) when the mouse enters the trigger zone.
Out Animation HorizontalThe distance the tooltip/pop-up will move horizontally (in pixels) when the mouse leaves the trigger zone.
Fade-in DurationThe duration of the "In" animation when the mouse pointer enters the trigger zone (in milliseconds).
Fade-Out durationThe duration of the "Out" animation when mouse pointer leaves the trigger zone (in milliseconds).
PauseThe time the tooltip/pop-up will be shown between the "In" animation and the "Out" animation (in milliseconds).
Tooltip animation modeSelect one of the many Moo functions to perform animations.
Tooltip / Popup ease modeThe transition type. All transitions, except for "linear" transition, can be combined with a "Transition Ease".
Centered PopupSet this to "Yes" if you want pop-up effect displays to appear centered in the browser window.

Slide FX Settings
- These parameters control the "Slide" content effect:

Sliding Panels SettingsChoose an animation style from the list.
Note: The following Settings are used ONLY when Slide Panels Settings is set to CUSTOM:
Slide Panel X inThe distance (in pixels) from the left trigger zone border that the slide panel will go to when the mouse enters the trigger zone.
Slide Panel X outThe distance (in pixels) from the left trigger zone border that the slide panel will go to when the mouse leaves the trigger zone.
Slide Panel Y inThe distance (in pixels) from the top trigger zone border that the slide panel will go to when the mouse enters the trigger zone.
Slide Panel Y outThe distance (in pixels) from the top trigger zone border that the slide panel will go to when the mouse leaves the trigger zone.
Slide animation modeSelect one of the many Moo functions to animate the slide effects.
Slide ease modeChoose how to apply the animation effect. This setting is not used when "Slide Animation Mode" is set to Linear.
Frames per SecondThe frames per second used to animate the effect. Note: Using a high value in a heavy site could decrease the video performance. Combine this setting with "Frame Duration" to get a smooth effect.
Fame DurationThe time (in milliseconds) the duration will last.

Hover FX Settings
- These Parameters Control the Hover Effect:

Hover Effect in ColorThe background color that will fade in when mouse enter the element with class="js_hover".
Hover Effect Out ColorThe background color that will fade out when mouse leaves the element with class="js_hover".
Special Effects

Besides the page transition effects, you can also include additional effects that apply to the content of each item. By adding certain CSS tags to your HTML code and organizing the layout of content, these effects allow you to build fully customizable tooltips, pop-ups and slide effects. Since all the content data tags are available on these effects as well, you can elaborate the display of your content as much as you want!

Keep in mind however, that with great power comes great responsibility: the HTML of both zones is still part of the HTML code of your page; if your HTML/CSS code has a bug, it may affect how other parts of your site look and work.

Content effects are activated by the user's mouse pointer but with subtle differences. How you can implement each effect and how they are activated is explained below:

Tooltips

A Tooltip will appear automatically when the mouse pointer hovers over a specific "trigger zone", this example code explains better how to use the necessary tags:

Code Sample

Sample Effect

<div class="jxtctooltip">
This is the tooltip trigger zone
    <div class="tip">
        This is the tooltip content
    </div>
</div>
This is the tooltip trigger zone
This is the tooltip content

Upon display, this code will show the "This is the tooltip trigger zone" legend by itself, but if you move the mouse pointer over it, a tooltip will come up displaying the "This is the tooltip content" legend. Each zone is wrapped within a tag, you must use the CSS tags "jxtctooltip" and "tip" as shown to make the effect work.

Pop-ups

A pop-up will appear when the user clicks on the "trigger zone", the Pop-up zone has its own Close and Drag buttons. This example code shows the necessary CSS tags in use:

Code Sample

Sample Effect

<div class="popuphover">
This is the pop-up trigger zone
    <div class="pop">
        This is the pop-up content
    </div>
</div>
This is the pop-up trigger zone
This is the pop-up content

The trigger zone is made with the contents of the div with class "popuphover", and the pop-up content is hidden in the div with class "pop", it will be shown when the user clicks on the trigger zone.

Slides

Slides are useful to display content in different layers, for example imagine a picture with a footnote that expands to show a full description. Different than Tooltips or Pop-ups, Slides do not use a trigger zone, they react to mouse pointer over their own zones. This is an example code:

Code Sample

Sample Effect

<div class="slidebox">
This is the content zone
    <div class="slidepanel">
        This is the slide content zone
    </div>
</div>
This is the content zone
This is the slide content zone

Again, the container zone inside the div with CSS class "slidebox" will be shown first, and the contents of the slide on div "slidepanel" will be shown when the mouse hovers its zone.

Hover

The Hover is useful when you want to focus on specific zone of the content, for example a "clickable" zone that looks similar to other content, an image or name that want to highlight. Similar to Slides, they react to mouse pointer over their own zones and does not need a trigger zone. This is an example code:

Code Sample

Sample Effect

This is the content zone
<div class="js_hover">
    The content with highlight
</div>
This is the rest of content zone
This is the content zone
The content with highlight
This is the rest of content zone

Once the mouse is over the js_hover zone the color will change automatically. As you can see this is the easier effect but provide you the power to catch the attention of your visitors.

Styling

As previously explained, the content is rendered in a grid fashion with one or more rows and columns and one or more pages, each page represents a single grid. Each cell in a grid contains the template code for one item with the placeholder tags translated to their corresponding data element such as titles, descriptions, images, etc.

In order to ease the visual styling of the grids, there are certain common CSS classes added to the HTML code for your convenience. You can put hard-coded CSS styling in the XTS template fields directly, but you may find using your template's CSS file a better option.

If you can't or don't want to alter your main CSS file, you can put any CSS code needed in the module's own file: css/wall.css. This file is located inside the module folder.

This is a brief explanation on how the HTML and classes are applied:

Each page in the module output is made with an HTML tag; the first table has CSS class firstpage, any inner pages have class centerpage and the last page has class lastpage. If there is only one page then it has class singlepage.

Each row within a table also has similar classes added to it: firstrow for the top row in the table, centerrow for any middle rows and lastrow for the bottom row of content. In the event that only a single row is used, it will have class singlerow assigned to it. These clases are repeated for as many tables (pages) are in the module output.

Likewise, columns also have similar tags: the left-most column has firstcol, the right-most column has lastcol and any middle column has centercol. Single columns have, you guessed it, singlecol. These classes are also applied on all pages shown.

Buttons also have extra CSS classes: prevbutton and nextbutton apply to the tags for each page change button. Page number buttons have tags as well: firstbutton, middlebutton, lastbutton and centerbutton.

You can have a common set of CSS styling code for these tags in your template's CSS file to maintain a consistent appearance on any modules being shown, or you can use them in combination with the module CSS class parameter to define specific styling for a particular module.

With these many options, the styling possibilities are unlimited! You are in total control of how the content will be shown in your site, just let the module handle the content gathering for you.

Examples:

As configuration examples, take a look at these parameter setups from our demo pages:

Copyright 2010 Monev Software LLC www.joomlaxtc.com

Security Notice

JoomlaXTC does not sell it's products on 3rd party sites.  Any website offering JoomlaXTC products for sale are not licensed versions and should be considered a scam.

Never download our products from file sharing websites like rapidshare, torrents or warez forums.

We have received reports of malicious versions of our software containing viruses, extra code, and even once installed, delete your database, steal sensitive information such as passwords, and credit card information. 

There is only one place to get the full and safe licensed versions of our software and you're looking at it!   Enjoy.

Joomla! is Free Software released under the GNU/GPL License. Joomla is a trademark of Open Source Matters and the name is used under a limited license from Open Source Matters in the United States and other countries. joomlaxtc.com / Monev Software LLC is not affiliated with or endorsed by Open Source Matters or the Joomla! Project.