mezzanine-slides

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

Setup

Run pip install mezzanine-slides
In settings.py add mezzanine_slides to your INSTALLED_APPS above mezzanine apps.
Run createdb or syncdb, if running syncdb run migrate if you are using South.
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 for his great ResponsiveSlides.js plugin.

License (Simplified BSD)

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

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
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.

tyaakow / mezzanine-slides Goto Github PK