template reStructureText directive

getnikola · Jan 3, 2016 · a19a848 · a19a848
1 parent 33c3c20
commit a19a848
Show file tree

Hide file tree

Showing 5 changed files with 139 additions and 0 deletions.
diff --git a/v7/meta_template/README.md b/v7/meta_template/README.md
@@ -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 :)
diff --git a/v7/meta_template/meta_template.plugin b/v7/meta_template/meta_template.plugin
@@ -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
diff --git a/v7/meta_template/meta_template.py b/v7/meta_template/meta_template.py
@@ -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)
diff --git a/v7/meta_template/templates/mako/bootstrap3/button.tmpl b/v7/meta_template/templates/mako/bootstrap3/button.tmpl
@@ -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>
diff --git a/v7/meta_template/templates/mako/iframe.tmpl b/v7/meta_template/templates/mako/iframe.tmpl
@@ -0,0 +1,3 @@
+## -*- coding: utf-8 -*-
+
+<iframe style="${style or 'width: 100%; height: 450px;'}" src="${src}"></iframe>