`. On the other hand
ToC generated by reST is enclosed in `
`.
`extract_toc` relies on this behavior to work.
+reStructuredText Example
+------------------------
+
+To add a table of contents to your reStructuredText document you need to add a 'contents directive' at the place where you want the table of contents to appear. See the [documentation](http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents) for more details.
+
+```rst
+My super title
+##############
+
+:date: 2010-10-03
+:tags: thats, awesome
+
+.. contents::
+..
+ 1 Head 1
+ 1.1 Head 2
+ 2 Head 3
+ 3 head 4
+
+Heading 1
+---------
+
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.
+```
+
+Markdown Example
+----------------
+
+To add a table of contents to your Markdown document you need to place the 'TOC marker' at the place where you would like the table of contents to appear. See the Python Markdown [documentation](http://pythonhosted.org/Markdown/extensions/toc.html) for more details.
+
+Important! To enable table of contents generation for the markdown reader you need to set `MD_EXTENSIONS = (['toc'])` in your pelican configuration file.
+
+```Markdown
+title: My super title
+date: 4-4-2013
+tags: thats, awesome
+
+[TOC]
+
+# Heading 1 #
+
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.
+```
+
Template Example
================
diff --git a/extract_toc/extract_toc.py b/extract_toc/extract_toc.py
index b926eff..a3a7e00 100644
--- a/extract_toc/extract_toc.py
+++ b/extract_toc/extract_toc.py
@@ -8,11 +8,13 @@ and place it in its own article.toc variable.
from os import path
from bs4 import BeautifulSoup
-from pelican import signals, readers
+from pelican import signals, readers, contents
def extract_toc(content):
- soup = BeautifulSoup(content._content)
+ if isinstance(content, contents.Static):
+ return
+ soup = BeautifulSoup(content._content,'html.parser')
filename = content.source_path
extension = path.splitext(filename)[1][1:]
toc = ''
diff --git a/ical/Readme.rst b/ical/Readme.rst
new file mode 100644
index 0000000..e8897d1
--- /dev/null
+++ b/ical/Readme.rst
@@ -0,0 +1,39 @@
+ical
+----
+
+This plugin looks for and parses an ``.ics`` file if it is defined in a given
+page's ``calendar`` metadata. One calendar can be defined per page.
+
+Dependencies
+------------
+
+This plugin depends on the ``icalendar`` package, which can be installed via
+pip::
+
+ pip install icalendar
+
+Usage
+-----
+
+For a reST-formatted page, include the following line in the metadata::
+
+ :calendar: /path/to/your/ics/file
+
+For Markdown, include the following line in the page metadata::
+
+ Calendar: /path/to/your/ics/file
+
+Following is some example code that can be added to your theme's ``page.html``
+template in order to display the calendar::
+
+ {% if page.calendar %}
+
+ {% for vevent in events[page.slug] %}
+ - {{ vevent.summary }}
+ - {{ vevent.description|replace('\n\n', '
') }}
+ - {{ vevent.dtstart }}
+ - {{ vevent.dtend }}
+
+ {% endfor %}
+
+ {% endif %}
diff --git a/ical/__init__.py b/ical/__init__.py
new file mode 100644
index 0000000..8a1352a
--- /dev/null
+++ b/ical/__init__.py
@@ -0,0 +1 @@
+from .ical import *
diff --git a/ical/ical.py b/ical/ical.py
new file mode 100644
index 0000000..ccfefaa
--- /dev/null
+++ b/ical/ical.py
@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+"""
+ical plugin for Pelican
+=======================
+
+This plugin looks for and parses an .ics file if it is defined in a given
+page's :calendar: metadata. One calendar can be defined per page.
+
+"""
+
+from icalendar import Calendar, Event
+from pelican import signals , utils
+import pytz
+import datetime
+import os.path
+
+def init_cal(generator):
+ # initialisation of the calendar dictionary
+ # you can add one calendar per page
+ calDict = {}
+ generator.context['events'] = calDict
+
+def add_ical(generator, metadata):
+ # check if a calendar is here
+ if 'calendar' in metadata.keys():
+ summ = []
+ path = metadata['calendar']
+ if not os.path.isabs(path):
+ path = os.path.abspath(metadata['calendar'])
+ cal = Calendar.from_ical(open(path,'rb').read())
+ for element in cal.walk():
+ eventdict = {}
+ if element.name == "VEVENT":
+ if element.get('summary') != None:
+ eventdict['summary'] = element.get('summary')
+ if element.get('description') != None:
+ eventdict['description'] = element.get('description')
+ if element.get('url') != None:
+ eventdict['url'] = element.get('url')
+ if element.get('dtstart') != None:
+ eventdict['dtstart'] = element.get('dtstart').dt
+ if element.get('dtend') != None:
+ eventdict['dtend'] = element.get('dtend').dt
+ summ.append(eventdict)
+ # the id of the calendar is the slugified name of the page
+ calId = utils.slugify(metadata['title'])
+ generator.context['events'][calId] = summ
+
+
+def register():
+ signals.pages_generator_init.connect(init_cal)
+ signals.pages_generate_context.connect(add_ical)
diff --git a/latex/Readme.md b/latex/Readme.md
index 9a18cf5..51424ce 100644
--- a/latex/Readme.md
+++ b/latex/Readme.md
@@ -30,6 +30,9 @@ between the `` parameters (for the NotMyIdea template, this file is base.h
{% if article and article.latex %}
{{ article.latex }}
{% endif %}
+ {% if page and page.latex %}
+ {{ page.latex }}
+ {% endif %}
Usage
-----
diff --git a/latex/latex.py b/latex/latex.py
index 2ebd1c7..ce16044 100644
--- a/latex/latex.py
+++ b/latex/latex.py
@@ -45,3 +45,4 @@ def register():
Plugin registration
"""
signals.article_generate_context.connect(addLatex)
+ signals.pages_generate_context.connect(addLatex)
diff --git a/optimize_images/Readme.md b/optimize_images/Readme.md
new file mode 100644
index 0000000..d6fcc0f
--- /dev/null
+++ b/optimize_images/Readme.md
@@ -0,0 +1,26 @@
+Optimize Images Plugin For Pelican
+==================================
+
+This plugin applies lossless compression on JPEG and PNG images, with no
+effect on image quality. It uses [jpegtran][1] and [OptiPNG][2]. It assumes
+that both of these tools are installed on system path.
+
+[1]: http://jpegclub.org/jpegtran/ "jpegtran"
+[2]: http://optipng.sourceforge.net/ "OptiPNG"
+
+
+Installation
+------------
+
+To enable, ensure that `optimize_images.py` is put somewhere that is accessible.
+Then use as follows by adding the following to your settings.py:
+
+ PLUGIN_PATH = 'path/to/pelican-plugins'
+ PLUGINS = ["optimize_images"]
+
+`PLUGIN_PATH` can be a path relative to your settings file or an absolute path.
+
+Usage
+-----
+The plugin will activate and optimize images upon `finalized` signal of
+pelican.
\ No newline at end of file
diff --git a/optimize_images/__init__.py b/optimize_images/__init__.py
new file mode 100644
index 0000000..cbb056a
--- /dev/null
+++ b/optimize_images/__init__.py
@@ -0,0 +1 @@
+from .optimize_images import *
diff --git a/optimize_images/optimize_images.py b/optimize_images/optimize_images.py
new file mode 100644
index 0000000..b49f523
--- /dev/null
+++ b/optimize_images/optimize_images.py
@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+
+"""
+Optimized images (jpg and png)
+Assumes that jpegtran and optipng are isntalled on path.
+http://jpegclub.org/jpegtran/
+http://optipng.sourceforge.net/
+Copyright (c) 2012 Irfan Ahmad (http://i.com.pk)
+"""
+
+import logging
+import os
+from subprocess import call
+
+from pelican import signals
+
+logger = logging.getLogger(__name__)
+
+# A list of file types with their respective commands
+COMMANDS = [
+ ('.jpg', 'jpegtran -copy none -optimize "{filename}" "{filename}"'),
+ ('.png', 'optipng "{filename}"'),
+]
+
+def optimize_images(pelican):
+ """
+ Optimized jpg and png images
+
+ :param pelican: The Pelican instance
+ """
+ for dirpath, _, filenames in os.walk(pelican.settings['OUTPUT_PATH']):
+ for name in filenames:
+ optimize(dirpath, name)
+
+def optimize(dirpath, filename):
+ """
+ Check if the name is a type of file that should be optimized.
+ And optimizes it if required.
+
+ :param dirpath: Path of the file to be optimzed
+ :param name: A file name to be optimized
+ """
+ for extension, command in COMMANDS:
+ if filename.endswith(extension):
+ filepath = os.path.join(dirpath, filename)
+ command = command.format(filename=filepath)
+ call(command, shell=True)
+
+
+def register():
+ signals.finalized.connect(optimize_images)
diff --git a/summary/summary.py b/summary/summary.py
index 500e6ec..a3af2da 100644
--- a/summary/summary.py
+++ b/summary/summary.py
@@ -11,11 +11,11 @@ import types
from pelican import signals
def initialized(pelican):
- from pelican.settings import _DEFAULT_CONFIG
- _DEFAULT_CONFIG.setdefault('SUMMARY_BEGIN_MARKER',
- '')
- _DEFAULT_CONFIG.setdefault('SUMMARY_END_MARKER',
- '')
+ from pelican.settings import DEFAULT_CONFIG
+ DEFAULT_CONFIG.setdefault('SUMMARY_BEGIN_MARKER',
+ '')
+ DEFAULT_CONFIG.setdefault('SUMMARY_END_MARKER',
+ '')
if pelican:
pelican.settings.setdefault('SUMMARY_BEGIN_MARKER',
'')
+