Skip to content
Permalink
Browse files

template reStructureText directive

  • Loading branch information
humitos committed Jan 3, 2016
1 parent 33c3c20 commit a19a8480f05b5121c1627040476ba438e23c7228
@@ -0,0 +1,36 @@
The idea of MetaTemplate plugin is, as a final user, be able to create
simple HTML templates to be included in your posts/stories without
having to program anything in Python.

You only have to add a simple `.tmpl` file in the
`meta_template/templates/mako` folder with the content you want and
using variables to be replaced with the information you will pass in
the reStructuredText directive. Let's see an example of it.

This is the reStructuredText you will need to put in your post to get
a Bootstrap3 simple button:

```
.. template:: bootstrap3/button
:href: http://google.com/
Go to google.com
```

You will also need to put the file `button.tmpl` in the folder
`meta_template/templates/mako` with this content:

```
## -*- coding: utf-8 -*-
<div style="${style or 'text-align: center; margin-top: 25px; margin-bottom: 25px;'}">
<a class="btn btn-lg btn-primary" target="${target or '_blank'}" href="${href}">
${'\n'.join(content)}
</a>
</div>
```

Finally, you will get the button as you expect. Easy. Doesn't it?

Feel free to send your pull request to collaborate with more templates
or supported options :)
@@ -0,0 +1,12 @@
[Core]
Name = meta_template
Module = meta_template

[Nikola]
MinVersion = 7.7.4

[Documentation]
Author = Manuel Kaufmann
Version = 0.1
Website = http://plugins.getnikola.com/#meta_template
Description = "template" rest directive to include custom templates
@@ -0,0 +1,81 @@
# -*- coding: utf-8 -*-

# Copyright © 2016 Manuel Kaufmann

# Permission is hereby granted, free of charge, to any
# person obtaining a copy of this software and associated
# documentation files (the "Software"), to deal in the
# Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the
# Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice
# shall be included in all copies or substantial portions of
# the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
# OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

from __future__ import unicode_literals

import os

from docutils import nodes
from docutils.parsers.rst import Directive, directives

from nikola.plugin_categories import RestExtension

from nikola.plugin_categories import LateTask
from nikola.utils import copy_tree


class Plugin(RestExtension):

name = "meta_template"

def set_site(self, site):
self.site = site
MetaTemplate.site = site
return super(Plugin, self).set_site(site)


class MetaTemplate(Directive):
""" Restructured text extension for inserting custom templates."""

option_spec = {
'title': directives.unchanged,
'href': directives.unchanged,
'url': directives.unchanged,
'target': directives.unchanged,
'src': directives.unchanged,
'style': directives.unchanged,
}
has_content = True
required_arguments = 1
optional_arguments = 0

def __init__(self, *args, **kwargs):
super(MetaTemplate, self).__init__(*args, **kwargs)

def run(self):
template_name = self.arguments[0] + '.tmpl'
self.options.update({
'content': self.content,
})
output = self.site.template_system.render_template(
template_name,
None,
self.options,
)
return [nodes.raw('', output, format='html')]


directives.register_directive('template', MetaTemplate)
@@ -0,0 +1,7 @@
## -*- coding: utf-8 -*-

<div style="${style or 'text-align: center; margin-top: 25px; margin-bottom: 25px;'}">
<a class="btn btn-lg btn-primary" target="${target or '_blank'}" href="${href}">
${'\n'.join(content)}
</a>
</div>
@@ -0,0 +1,3 @@
## -*- coding: utf-8 -*-

<iframe style="${style or 'width: 100%; height: 450px;'}" src="${src}"></iframe>

0 comments on commit a19a848

Please sign in to comment.
You can’t perform that action at this time.