Changeset 1160824
- Timestamp:
- 05/14/2015 11:15:54 PM (11 years ago)
- File:
-
- 1 edited
-
sherk-carousel-banners/trunk/readme.txt (modified) (3 diffs)
Legend:
- Unmodified
- Added
- Removed
-
sherk-carousel-banners/trunk/readme.txt
r1156006 r1160824 26 26 == Installation == 27 27 28 This section describes how to install the plugin and get it working. 28 <h3>This section describes how to install the plugin and get it working.</h3> 29 29 30 30 1. BACKUP everything before you install the plugin. … … 33 33 4. Update the Permalinks on settings. 34 34 5. SherkBanners post type should now available at dashboard and start creating sherkbanners post type. 35 36 37 <h3>Basic Instruction on Creating a SherkBanner Post types</h3> 38 39 1. Create Sherk Banners Post Type 40 2. Add Sherk Banners tag at the upper right on the edit Sherk Banners view. 41 3. Add Sherk Banners category. 42 4. Add Slide Images for the Sherk Banners, its captions and links if needed. 43 5. Submit the SherkBanner post type form. 44 45 46 <h3>Display Slideshow using Dashboard Widget</h3> 47 1. Go to Dashboard-> Appearance -> Widgets (/wp-admin/widgets.php) 48 2. Look for Sherk Banners Slider Widget and drag it to the widget region you would like it to be shown. 49 3. Configure your Sherk Banners Slider Widget, select the Banner from the select option and save. 50 51 <h3>Display Slideshow using Shortcode</h3> 52 1. Go to Dashboard-> SherkBanners `(/wp-admin/edit.php?post_type=sherk_banners)` 53 2. Select the Banners you would like it to be shown. 54 3. Shortcode template is shown at the edit/add SherkBanner post type which looks like this: 55 **[sherkbanners title="My Banner" bannerid="234" captions="true" auto="true" controls="true" pager="true" minslides="1" maxslides="1" slidewidth="0"]** 56 4. Copy the shortcode, paste it to the content text editor and update the values of your shortcode parameters depends on what you need. 57 58 <h3>Parameters Available</h3> 59 60 **captions** 61 *Include image captions. Captions are derived from the image's title attribute* 62 default: **true** 63 options: **boolean** (true / false) 64 65 **auto** 66 *Slides will automatically transition* 67 default: **true** 68 options: **boolean** (true / false) 69 70 **controls** 71 *If true, "Next" / "Prev" controls will be added* 72 default: **true** 73 options: **boolean** (true / false) 74 75 **pager** 76 *If true, a pager will be added* 77 default: **true** 78 options: **boolean** (true / false) 79 80 **minSlides** 81 *The minimum number of slides to be shown. Slides will be sized down if carousel becomes smaller than the original size.* 82 default: **1** 83 options: **integer** 84 85 **maxSlides** 86 *The maximum number of slides to be shown. Slides will be sized up if carousel becomes larger than the original size.* 87 default: **1** 88 options: **integer** 89 90 **slideWidth** 91 *The width of each slide. This setting is required for all horizontal carousels!* 92 default: **0** 93 options: **integer** 94 95 35 96 36 97 == Frequently Asked Questions == … … 58 119 59 120 60 == Basic Instruction on Creating a SherkBanner Post types == 61 62 1. Create Sherk Banners Post Type 63 2. Add Sherk Banners tag at the upper right on the edit Sherk Banners view. 64 3. Add Sherk Banners category. 65 4. Add Slide Images for the Sherk Banners, its captions and links if needed. 66 5. Submit the SherkBanner post type form. 67 68 69 Display Slideshow using Dashboard Widget 70 1. Go to Dashboard-> Appearance -> Widgets (/wp-admin/widgets.php) 71 2. Look for Sherk Banners Slider Widget and drag it to the widget region you would like it to be shown. 72 3. Configure your Sherk Banners Slider Widget, select the Banner from the select option and save. 73 74 Display Slideshow using Shortcode 75 1. Go to Dashboard-> SherkBanners (/wp-admin/edit.php?post_type=sherk_banners) 76 2. Select the Banners you would like it to be shown. 77 3. Shortcode template is shown at the edit/add SherkBanner post type which looks like this: 78 [sherkbanners title="My Banner" bannerid="234" captions="true" auto="true" controls="true" pager="true" minslides="1" maxslides="1" slidewidth="0"] 79 4. Copy the shortcode, paste it to the content text editor and update the values of your shortcode parameters depends on what you need. 80 81 Parameters Available 82 83 captions 84 Include image captions. Captions are derived from the image's title attribute 85 default: true 86 options: boolean (true / false) 87 88 auto 89 Slides will automatically transition 90 default: true 91 options: boolean (true / false) 92 93 controls 94 If true, "Next" / "Prev" controls will be added 95 default: true 96 options: boolean (true / false) 97 98 pager 99 If true, a pager will be added 100 default: true 101 options: boolean (true / false) 102 103 minSlides 104 The minimum number of slides to be shown. Slides will be sized down if carousel becomes smaller than the original size. 105 default: 1 106 options: integer 107 108 maxSlides 109 The maximum number of slides to be shown. Slides will be sized up if carousel becomes larger than the original size. 110 default: 1 111 options: integer 112 113 slideWidth 114 The width of each slide. This setting is required for all horizontal carousels! 115 default: 0 116 options: integer 121 == Detailed Instructions == 122 After installation, check at Dashboard -> Tools -> Sherk Banners (/wp-admin/edit.php?post_type=sherk_banners&page=sherkbanners_info) 123 for more detailed instructions.
Note: See TracChangeset
for help on using the changeset viewer.