-
October.17.2013
This guide is intended for
SJ K2 Scrollbar 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! v1.5, 2.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 Scrollbar to configure
SJ K2 Scrollbar module are configured in 7 groups of parameters following:
- Basic Options
- Vertical Options
- Horizontal Options
- Source Options
- Item Options
- Image Options
- Advanced Options
Let's look at the parameters in detail:
BASIC OPTIONS
- Module Class Suffix - Allow you to choose another CSS class that suits your template
- Layout - Allow to select Horizontal or Vertical layout
- Link Target - Allow to select open link in the Sample/New/ Popup window.
- Display scroll buttons - Allow to show/hide scroll buttons
VERTICAL OPTIONS
- # Column - Allow to set the number of columns for devices which have different screen width
- Pane height - Allow to set height of viewport
HORIZONTAL OPTIONS
- Item width - Allow to set width of item
- # Rows - Allow to set number of rows. We recommend setting 5 rows for nice showing
- If total row >= Item count => each item is displayed on per row
- If total row < Item count => there are over 1 item are displayed on 1 row
SOURCE OPTIONS
- Source - Allow to choose source to show item
- Retrieve items from categories
- Select specific items
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 items which will be displayed in the module. Set value "0" if you want to display all items.
- Item ordering - Select the item ordering way:
- Oldest first (by date created)
- Most recent first (by date created)
- Most recent first (by date published)
- Title Alphabetical
- Title Reverse-Alphabetical
- Ordering
- Ordering reverse
- Most popular
- Highest rated
- Most recommented
- Latest modified
- Random Ordering
- 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"
Select specific items
- Add items - Allow to select specific item to be shown
- Drag and drop to re-order item - Allow to drag and drop to re-order items that you selected in "Add items" param. It also allows to remove item by click the remove icon
ITEM OPTIONS
Item 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
- Ending character - Set ending character of title when using the truncating the title
Description Options
- Display Description - Allow to show category description OR not
- Description Maxlength - Allow to set the length of category description, set 0 for showing full description
- Ending character - Set ending character when using the truncating the description
- Tags Display - Allow to display tags for each item OR not
Readmorre Options
- Display Readmore Link - Allow to show Readmore link OR not
- Read More Text - Set text for Readmore link
IMAGE OPTIONS
Note: Image sources will be got in the item - Click HERE
Get Image From K2 Image
- K2 Image - Allow you to get image from K2 image tab OR not
- K2 Image size - Set size for image k2 tab
Get Image From Inline Introtext
- Inline Introtext - Allow you to get image from Introtext OR not
Get Image From Inline Fulltext
- Inline Fulltext - Allow to get image from Fulltext OR not
Get Image From Extend Folder
- Extend Folder - Allow to extend folder or not
- Extend Folder - Set path to external image folder used by option above
- Order to Get - Set order: 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
Image Options
- 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 to set width/height of image
- Background - Allow to set the color of image background. This is applied for showing images without full background. If the image with full background, you can see nothing to change.
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