Yt Slide Show III Module User-Guide
- April.01.2011
The following documentation applies to the module version 1.0 and later.
REQUIREMENTS
- Joomla! v1.5.x, Joomla! v1.6.x and Joomla! v1.7.x latest stable versions are highly recommended.
INSTALLATION
1. Please to refer the installation in administrator of module on Joomla! v1.5.x after:- In Administrator page, go to Extensions -> Install/Uninstall
In this page, click on Browse.. button, choose our module and then click Upload File & Install
- Go to Extensions -> Module Manager, choose option mod_yt_content_slideshowiii (for Content component) or mod_yt_k2_slideshowiii (for K2 component) or mod_yt_sobi2_slideshowiii (for Sobi2 component) or mod_yt_vmslideshowiii (for VirtueMart component)
- And you can change params for your idea after
- Image of Article: This is the first image in the description of Article if using Data source = Categories or Ids. Or this is the image in the folder if using Data source = Image Folder.
- Description of Article: This is the intro text in the description of Article
SETTING
The parameters are divided into the following areas:- General Settings
- Title Options And Link Options
- Image Options
- Theme, Effect And Layout Options
- Other Options
- Advanced Parameters
Let's refer the detail setting on mod_yt_content_slideshowiii
GENERAL SETTINGS
- Module Class Suffix - Please refer here
- Data Source - You can choose source from categories, from ids or from Image folder
- Image Folder Path - This param is used for data source from image folder. This is path to folder which contains your images. You can put your images in address: /images/image_slideshowIII. For showing module with source from these images, you just need to put path: images/image_slideshowIII into textbox of this param.
- Description for each image - This param is used for data source from image folder. This is description for each image. You can use syntax: imagename=>title|desciption|link. We support two formats for imagename:
- Fullname (ex: imagename.jpg)
- Name without extension (ex: imagename)
- Select option - You can choose category or section for showing data
- Select Categories or Sections - here you can choose some categories or sections which you want to read articles for the module
- From IDs: With Data source from IDs, you can choose some IDs of articles which you want to show the module.
- For Frontpage Article - Allow you to filter articles with 3 options:
- Hide frontpage articles : hide articles which are frontpage article
- Show frontpage articles only : Show frontpage article only
- Include frontpage articles: Show all articles
- Sort order by - Allow you to sort order articles by
- Recently Added First: Show latest articles
- Recently Modified First: Show latest modified articles
- Ordering
- Title: Sort order by alphabet
- Random
- Width Module Type - Percentage/Pixel
- Width Module - Allows you to add a width for the module.
- Width Spotlight - With Module Content Layout = full image, here you can add width spotlight
- Height Navigation - Height for navigation. If you choose Height Navigation Height Navigation = Small Thumnail Height. If not Height Navigation equals Height which you write.
- The Amount of articles - allow you to limit the number of article
- Item Number Per Page - Item number can show on per page
- On/Off Navigation - You can on/off navigation if you want
- Auto Play - Yes/No
TITLE OPTIONS AND LINK OPTIONS
- Open Link:
- Same window: open the link in the same window
- New window: open the link in new window
- Popup: open the link in new window without navigation
- Show Description with - You can show description with three format: No Description/Description Only/Description with Read More
- Show Description When - Always/Hover/Image Animated
- Max length Description - The number of characters of description
- Show Content Title - Allow to Show/Hide article title
- Link Content Title - Enable/Disable link for Content Title
- Show Spotlight - Allow to Show/Hide Spotlight (with Module Content Layout = full image)
- Max length of Navigation Title - The number of character of Navigation Title
- Content Title Color - a value hexadecimal code. Example: #E32636 or #FF7E00. Also, you can use color text: red, blue, white
- Navigation Title Color - a value hexadecimal code. Example: #E32636 or #FF7E00.Also, you can use color text: red, blue, white
- Content Description Color - a value hexadecimal code. Example: #E32636 or #FF7E00.Also, you can use color text: red, blue, white
- Show Button - With button on navigation, there are three cases to play: Always Display/Hover/Hide
- Readmore Text - You can change read more text
- Cutting Description With
- Keeping HTML code: the module will keep html code in description
- Removing HTML code: the module will remove all html code before cutting
- Custom Url Data Source - Custom Url Data Source of articles only support for source from Categories or Ids. Syntax:
- Id1=>url=linkURL1|image=linkimage1
- Id2=>url=linkURL2|image=linkimage2
- ...
IMAGE OPTIONS
- Show Content Image - Allow to show/hide Content Image
- Thumb Width - width of Content Image
- Thumb Height - height of Content Image
- Small Thumnail Width - Width for Thumnail on Navigation
- Small Thumnail Height - Height for Thumnail on Navigation
- Using Image Source - Allow to show/hide Image Source with Content Image
- Resizing image:
- Using Resize
- Using crop
- Link For Image - Allow to show/hide link for Content Image
THEME, EFFECT AND LAYOUT OPTIONS:
- Select theme - Please see demo
- Blue
- Black
- Gray
- Orange
- Navigation Type:
- Type 1:
- Type 2:
- Navigation Show - Title/Image
- Module Content Layout:
- Full Image:
- Image and Description:
- Select Effect - We support 25 Effects on module
- Stop when hover - Enable/Disnable to stop auto play when hover
- Animation Duration - time to show one slide
- Interval - time to change slide
- Opacity spotlight - syntax: ex: 0.7 (1.0)
OTHER OPTIONS:
- Intro text: the content to show at the top of module
- Footer text: the content to show at the end of module
ADVANCED PARAMETERS
- Caching:
- Do not use Cache: Turn off caching
- Use Cache: Turn on caching
- Cache Times: the time to cache
- Include jQuery Library: enable/disable jquery library. If the template is loading a jquery library, you can turn off jquery of the module to do your site loading faster