Skip to main content

Plug a html slideshow into your mezzanine website on all pages.

Project description

# mezzanineHtmlSlides

Add simple slide functionality to your Mezzanine based website allowing for
beautiful banners at the tops of pages.


## Setup

1. Run `pip install mezzanineHtmlSlides`
2. In `settings.py` add `mezzanine_slides` to your `INSTALLED_APPS` above mezzanine apps.
3. Run createdb or syncdb, if running syncdb run migrate if you are using South.
4. If you haven't modified your `base.html` or `pages/page.html` templates then you can just `manage.py collectemplates mezzanine_slides` and use the ones I provide. If you've already modified these templates see the Templates section for continued instruction.


## Templates

Add this to your `pages/page.html` anywhere as long as it's not inside another
block:

{% block slides %}{% if page.slide_set.all %}
<div class="row">
<div class="span12">
<ul class="rslides">{% for image in page.slide_set.all %}
<li><img src="{{ MEDIA_URL }}{% thumbnail image.file 940 300 %}" alt="{{ image.description }}"/></li>
{% endfor %}</ul>
</div>
</div>
{% endif %}{% endblock %}

Add this to `base.html` where you would like the slides to appear, which is
usually between your main content and the navigation:

{% block slides %}{% endblock %}

Notice that I include the `row` and `span12` classes on the `pages/page.html`
template so that if you don't have any slides then nothing is added to the page.

Now you'll need to include the CSS and JS in your compress areas of your
`base.html` template:

{% compress css %}
...
<link rel="stylesheet" href="{{ STATIC_URL }}css/responsiveslides.css">
{% endcompress %}


{% compress js %}
...
<script src="{{ STATIC_URL }}js/responsiveslides.min.js"></script>
{% endcompress %}

Lastly you'll need to invoke the slides JavaScript by putting
`$('.rslides').responsiveSlides();` on in your JavaScript somewhere. In the
`base.html` template I put this in the header around line 34 where I found some
other JavaScript functions to just make it easy and try to conform to the
original Mezzanine as much as possible, here is an excerpt of the area:

<script>
$(function() {
...
$('.rslides').responsiveSlides();
});
</script>


## Credits

Thanks to [Viljami Salminen][0] for his great [ResponsiveSlides.js][1] plugin.


## License (Simplified BSD)

Copyright (c) Isaac Bythewood
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


[0]: http://viljamis.com/
[1]: http://responsive-slides.viljamis.com/

Project details


Release history Release notifications

History Node

0.1.5dev

History Node

0.1.3dev

History Node

0.1.2dev

This version
History Node

0.1.1

History Node

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
mezzanineHtmlSlides-0.1.1.tar.gz (7.7 kB) Copy SHA256 hash SHA256 Source None Jan 15, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page