admin/setting/blocksettingslideshow: Difference between revisions
From MoodleDocs
(add new page for Moodle Docs for this add-on) |
(added more info) |
||
| Line 1: | Line 1: | ||
An add-on block that inserts a slideshow in the header of the front page or course page. | An add-on block that inserts a slideshow in the header of the front page or course page. | ||
This is a new block which creates a slideshow in the header of a site or course page. It uses jquery/cycle to handle the image transitions. Jquery is also used to manipulate the DOM to reposition the block's node into the heading div of the page. | |||
Since this is dependent on using moodle's built in jquery functions, it is not available for versions prior to 2.5. | |||
==Moodle themes== | |||
It works with all core Moodle 2.x Themes except "Clean" due to an issue with the theme's ability to load Jquery correctly (MDL-41516). This block will work with the Clean theme on Moodle version 2.5.2 where MDL-41516 has been fixed. | |||
Tested with: | |||
* Afterburner | |||
* Anomaly | |||
* Arialist | |||
* Binarius | |||
* Boxxie | |||
* Brick | |||
* Formal White | |||
* FormFactor | |||
* Fusion | |||
* Leatherbound | |||
* Magazine | |||
* Nimble | |||
* Nonzero | |||
* Overlay | |||
* Serenity | |||
* Sky High | |||
* Splash | |||
Note: it may work with some third party themes, but most likely not with any bootstrap based theme due to MDL-41516. If you have a third party theme and it doesn't work, send me a link to your site and I will update the code. | |||
==Features== | ==Features== | ||
| Line 7: | Line 36: | ||
* size. | * size. | ||
==Settings== | ==Global Settings== | ||
These settings apply o the teachers who will upload slides. Admins have no such limits. | These settings apply o the teachers who will upload slides. Admins have no such limits. | ||
| Line 13: | Line 42: | ||
* '''Max file size''': Select the largest file size that can be uploaded to the slideshow. Keep in mind that smaller sizes will restrict images to low quality but larger sizes will affect page load time. | * '''Max file size''': Select the largest file size that can be uploaded to the slideshow. Keep in mind that smaller sizes will restrict images to low quality but larger sizes will affect page load time. | ||
==Instance Configuration== | |||
* Title - Set title of slideshow (leave blank to hide block's heading) | |||
* Height - Sets height of slideshow and images **NOTE** this block will not rescale image files, it will only change the display size | |||
* Transition - Choose from various slide transitions (some are a bit clunky, but most work well) | |||
* Delay - Sets the time for which a single slide is displayed | |||
* Background color - Clicking in this textbox triggers a colorpicker | |||
* Transparent - Clicking this overrides the background color setting and makes the background transparent | |||
* Image selector - Will only accept gif, jpg, or png files | |||
==Download== | ==Download== | ||
This add-on is available from [https://moodle.org/plugins/view.php?plugin=block_slideshow the Moodle Database]. | This add-on is available from [https://moodle.org/plugins/view.php?plugin=block_slideshow the Moodle Database]. | ||
==See also== | |||
* [https://github.com/moodleboy/moodle-block_slideshow Source control URL] | |||
* [https://github.com/moodleboy/moodle-block_slideshow/issues Bug tracker] | |||
* [https://moodle.org/mod/forum/discuss.php?d=238109 Discussion forum] | |||
[[Category:Blocks]] | [[Category:Blocks]] | ||
[[Category:Contributed code]] | [[Category:Contributed code]] | ||
Revision as of 02:19, 18 September 2013
An add-on block that inserts a slideshow in the header of the front page or course page.
This is a new block which creates a slideshow in the header of a site or course page. It uses jquery/cycle to handle the image transitions. Jquery is also used to manipulate the DOM to reposition the block's node into the heading div of the page.
Since this is dependent on using moodle's built in jquery functions, it is not available for versions prior to 2.5.
Moodle themes
It works with all core Moodle 2.x Themes except "Clean" due to an issue with the theme's ability to load Jquery correctly (MDL-41516). This block will work with the Clean theme on Moodle version 2.5.2 where MDL-41516 has been fixed.
Tested with:
- Afterburner
- Anomaly
- Arialist
- Binarius
- Boxxie
- Brick
- Formal White
- FormFactor
- Fusion
- Leatherbound
- Magazine
- Nimble
- Nonzero
- Overlay
- Serenity
- Sky High
- Splash
Note: it may work with some third party themes, but most likely not with any bootstrap based theme due to MDL-41516. If you have a third party theme and it doesn't work, send me a link to your site and I will update the code.
Features
- customizable background colors,
- transition types,
- speeds, and
- size.
Global Settings
These settings apply o the teachers who will upload slides. Admins have no such limits.
- Maximum slides: Maximum number of slides in the show.
- Max file size: Select the largest file size that can be uploaded to the slideshow. Keep in mind that smaller sizes will restrict images to low quality but larger sizes will affect page load time.
Instance Configuration
- Title - Set title of slideshow (leave blank to hide block's heading)
- Height - Sets height of slideshow and images **NOTE** this block will not rescale image files, it will only change the display size
- Transition - Choose from various slide transitions (some are a bit clunky, but most work well)
- Delay - Sets the time for which a single slide is displayed
- Background color - Clicking in this textbox triggers a colorpicker
- Transparent - Clicking this overrides the background color setting and makes the background transparent
- Image selector - Will only accept gif, jpg, or png files
Download
This add-on is available from the Moodle Database.
