-
October.22.2013
This guide is intended for
SJ K2 Categories Full module
When you buy the module the first time, you will have the latest version. After the first release, we will update this module regularly, then please check newer versions when informed
here.
REQUIREMENTS
Joomla! v2.5.x and Joomla! 3.x latest stable versions are highly recommended.
INSTALLATION
1. Prepare your module package (zip file; please UNZIP first if it is indicated in the file name)
2. All steps are in administrator backend of Joomla!
:
- In your Administrator page, go to Extensions -> Extension Manager
In this page, click Choose File, select module package.
- Then click Upload & Install
- Please wait for module being installed, usually within several seconds
SETTINGS
1. This module with sample layout is below:
2. Configuration
NOTE: We used the images of module's installation on Joomla 3.x to illustrate
After installing, go to
Extension -> Module Manager and find
SJ K2 Categories Full to configure
SJ K2 Categories Full module are configured in 6 groups of parameters following:
- Basic Options
- Source Options
- Category Options
- Item Options
- Effect Options
- Advanced Options
Let's look at the parameters in detail:
BASIC OPTIONS
- Module Class Suffix - Allow you to style module with specific CSS suffix
- Layout - Allow you to choose one of 2 layouts available
- Open Link - Allow to select open link in the Sample/New/ Popup window.
- Border Module - Allow to show/hide boder for block
- Max Column of Categories - The number of categories' columns which are allowed to show on the module. Max column is 6 and Min column is 1
- Number Row of Items - The number of articles' rows which are allowed to show on category. Minimum row is 1.
SOURCE OPTIONS Retrieve items from categories
- Category filter - Allow to choose all or only selected categories
- Select one or more categories - If above choice is "select", you must to select categories that are used in this module
- Fetch items from children categories - Allow to get data from child categories or not
- Item count - Allow to set number of articles which will be displayed in the module.
- Item ordering - Select the item ordering way
- Featured Items - Allow to show/hide/show only featured items
- Time Range - Allow to set time range. This is applied when "Item Ordering" = "Most Popular" or "Most Commented", you can choose time range all time/ 1 week/ 2 weeks...
CATEGORIES OPTIONS
- Display Title - Allow to show title OR not
- Title Maxlength - Allow to set the length of category title, set 0 for showing full title
- Style Title - Allow you choose style for showing title of category: Dark OR Blue
- Style Image - Allow you choose style for showing image of category: Full OR Half
Image Options
- K2 Image Tab - Allow you to get image from K2 Image Tab OR not
- Image Description - Support to show description of image or not
- Extend Folder - Allow you to get images from external source
- Extend Folder - Set path to external image folder used by option above
- Image Priority - Allow to set image priority to get image from each category
- Resize Mode - Allow you to choose the mode of image resizing:
- None
- Center
- Fill
- Fit
- Stretch
- Output format - Allow to set format for all output file:
- Default - if you want to keep original format
- GIF
- JPEG
- PNG
- Keep Transparency - Allow to keep images transparent, for PNG and GIF format
- Width/Height - Set width/height of category image
- Background - Allow to set the color of category image background. This is applied for showing images without full background. If the image with full background, you can see nothing to change
- User Default Image - Allow to set user default image OR not
- Placeholder Path (or Url) - Allow to set path to placeholder image
ITEM OPTIONS
Item Options
- Style Description - Allow you choose style for showing description of item: Dark OR Light
- Display title - Allow to display title of item or not
- Title Maxlength - Allow to set the max length of title's item can be shown (choose 0 to show full title)
- Ending character - Set ending character when using the truncating the description
Description Options
- Display Description - Allow to show item description OR not
- Description Maxlength - Allow to set the length of item description, set 0 for showing full description
- Ending character - Set ending character when using the truncating the description
- Tags Display - Allow to show/hide tags of item
Readmore Options
- Display Readmore Link - Allow to show readmore link OR not
- Read More Text - Set text for Readmore link
Image Options
- K2 Image - Allow you to get image from K2 image tab OR not
- Inline Introtext - Allow you to get image from Introtext OR not
- Inline Fulltext - Allow to get image from Fulltext OR not
- Extend Folder - Allow to get image from extend folder or not
- Extend Folder - Set path to external image folder used by option above
- Image Priority - Allow to set image priority to get image from each item: k2_image, inline_introtext, inline_fulltext, external OR external, inline_fulltext, inline_introtext, k2_image
- Use Default Image - Allow you to use a placeholder image when entries' image is empty
- Placeholder Path (or Url) - Allow to set path to placeholder image
- Resize Mode - Allow you to choose the mode of image resizing
- None
- Center
- Fill
- Fit
- Strech
- Output Format - Allow to set format for all output file:
- Default - if you want to keep original format
- GIF
- JPEG
- PNG
- Keep Transparency - Allow to keep images transparent, for PNG and GIF format
- Width/Height - Allow you to set the width/height of the item image
- Background - Allow to set the color of item image background. This is applied for showing images without full background. If the image with full background, you can see nothing to change.
EFFECT OPTIONS
- Start Slide - Allow to set the slide which should be initially displayed.
- Pause when hover - Allow you to pause when hover or not. This is applied when "Auto Play"="Yes"
- Auto Play - Allow you to set autoplay for sliding or not
- Interval - Allow you to set speed of timer
- Effect Options - Allow to select effects: Slider of Fade
- Swipe - Allow users to use swipe gesture for switching pages on touchscreens
- Mouse Wheel - Allow users to use mouse wheel for switching pages on each tab
ADVANCED OPTIONS
- Alternative Layout - Allow to use a different layout from the supplied module or overrides in the templates
- Include jQuery - Allow you to include jQuery from this module or another one
- Pre-text - The content to show at the top of module
- Post-text - The content to show at the end of module
- Caching
- Use Global: Turn on caching
- No Caching: Turn off caching
- Cache Times - The time to cache
- Module Tag - Allow to select the HTML Tag for module
- Bootstrap Size - Allow to set the number of columns that module will use.
- Header Tag - Allow to select the HTML Tag for module header/title
- Header Class - Support the CSS Class for module header/title
- Module Style - Select module style
