Merge pull request #269 from lgiordani/series_plugin

[pelican-bootstrap3] Added support for series plugin

5 files changed, 66 insertions, 0 deletions

diff --git a/pelican-bootstrap3/README.md b/pelican-bootstrap3/README.md
index 0e9924b..a2a17f5 100644
--- a/pelican-bootstrap3/README.md
+++ b/pelican-bootstrap3/README.md
@@ -121,6 +121,16 @@ If you wish to use the inverse navbar from Bootstrap, set the flag `BOOTSTRAP_NA
 
 This theme has support for the [Related Posts plugin](https://github.com/getpelican/pelican-plugins/tree/master/related_posts). All you have to do, is enable the plugin, and the theme will do the rest.
 
+### Series
+
+This theme supports the [Series plugin](https://github.com/getpelican/pelican-plugins/tree/master/series). If you enable the plugin you will find in the footer the links to the previous and next articles in the series.
+
+You may customize the header of this list setting the `SERIES_TEXT` variable, which can also include the `index` and `name` variables. The first is the index of the current article in the series (starting from 1) and the second is the name of the series. The default string is `Part %(index)s of the %(name)s series`.
+
+You may display on the sidebar the link to the previous and next article in the series setting `DISPLAY_SERIES_ON_SIDEBAR` to `True`.
+
+You may display information on the series just under the article title setting `SHOW_SERIES` to `True`.
+
 ### IPython Notebook support
 
 This theme supports including IPython notebooks through the [Liquid Tags plugin](https://github.com/getpelican/pelican-plugins/tree/master/liquid_tags). If you enable the plugin, the theme will automatically include the right CSS/JS to make the notebooks work.
diff --git a/pelican-bootstrap3/templates/article.html b/pelican-bootstrap3/templates/article.html
index 2313521..fcfab20 100644
--- a/pelican-bootstrap3/templates/article.html
+++ b/pelican-bootstrap3/templates/article.html
@@ -87,6 +87,7 @@
             </div>
             <!-- /.entry-content -->
             {% include 'includes/related-posts.html' %}
+            {% include 'includes/series.html' %}
             {% include 'includes/addthis.html' %}
             {% include 'includes/comments.html' %}
         </article>
diff --git a/pelican-bootstrap3/templates/includes/article_info.html b/pelican-bootstrap3/templates/includes/article_info.html
index f13f4d1..787c360 100644
--- a/pelican-bootstrap3/templates/includes/article_info.html
+++ b/pelican-bootstrap3/templates/includes/article_info.html
@@ -3,6 +3,15 @@
     <span class="published">
         <i class="fa fa-calendar"></i><time datetime="{{ article.date.isoformat() }}"> {{ article.locale_date }}</time>
     </span>
+
+    {% if SHOW_SERIES %}
+        {% if article.series %}
+            <span class="label label-default">Series</span>
+            Part {{ article.series.index}} of {{ article.series.name }}
+        {% endif %}
+    {% endif %}
+
+
     {% if SHOW_ARTICLE_AUTHOR %}
         {% if article.author %}
             <span class="label label-default">By</span>
diff --git a/pelican-bootstrap3/templates/includes/series.html b/pelican-bootstrap3/templates/includes/series.html
new file mode 100644
index 0000000..24729a2
--- /dev/null
+++ b/pelican-bootstrap3/templates/includes/series.html
@@ -0,0 +1,22 @@
+{% if article.series %}
+<section class="well" id="related-posts">
+	{% set text = SERIES_TEXT|default('Part %(index)s of the %(name)s series') %}
+    <h4>{{ text|format(index=article.series.index, name=article.series.name) }}</h4>
+    {% if article.series.all_previous %}
+	    <h5>Previous articles</h5>
+	    <ul>
+	    {% for article in article.series.all_previous %}
+	        <li><a href="{{ SITEURL }}/{{ article.url }}">{{ article.title }}</a></li>
+	    {% endfor %}
+	    </ul>
+    {% endif %}
+    {% if article.series.all_next %}
+	    <h5>Next articles</h5>
+	    <ul>
+	    {% for article in article.series.all_next %}
+	        <li><a href="{{ SITEURL }}/{{ article.url }}">{{ article.title }}</a></li>
+	    {% endfor %}
+	    </ul>
+    {% endif %}
+</section>
+{% endif %}
diff --git a/pelican-bootstrap3/templates/includes/sidebar.html b/pelican-bootstrap3/templates/includes/sidebar.html
index ef6768b..35811f6 100644
--- a/pelican-bootstrap3/templates/includes/sidebar.html
+++ b/pelican-bootstrap3/templates/includes/sidebar.html
@@ -70,6 +70,30 @@
                     </ul>
                 </li>    
             {% endif %}
+
+            {% if DISPLAY_SERIES_ON_SIDEBAR %}
+                {% if article %}
+                    {% if article.series %}
+                        <li class="list-group-item"><h4><i class="fa fa-tags fa-list-ul"></i><span class="icon-label">Series</span></h4>
+                            <ul class="list-group">
+                                <li class="list-group-item">
+                                {% if article.series.previous %}
+                                    <h5></i> Previous article</h5>
+                                    <a href="{{ SITEURL }}/{{ article.series.previous.url }}">{{ article.series.previous.title }}</a>
+                                {% endif %}
+                                </li>
+                                <li class="list-group-item">
+                                {% if article.series.next %}
+                                    <h5>Next article</h5>
+                                    <a href="{{ SITEURL }}/{{ article.series.next.url }}">{{ article.series.next.title }}</a>
+                                {% endif %}
+                                </li>
+                            </ul>
+                        </li>
+                    {% endif%}
+                {% endif %}
+            {% endif %}
+
             {% include 'includes/github.html' %}
             {% include 'includes/twitter_timeline.html' %}
             {% include 'includes/links.html' %}