slides plugin that will be removed from core

getnikola · Jun 26, 2017 · dc9ff5a · dc9ff5a
1 parent 8235d14
commit dc9ff5a
Show file tree

Hide file tree

Showing 2 changed files with 91 additions and 0 deletions.
diff --git a/v7/slides/slides.plugin b/v7/slides/slides.plugin
@@ -0,0 +1,14 @@
+[Core]
+name = rest_slides
+module = slides
+
+[Nikola]
+compiler = rest
+PluginCategory = CompilerExtension
+
+[Documentation]
+author = Roberto Alsina
+version = 0.1
+website = https://plugins.getnikola.com/slides
+description = Slides directive
+
diff --git a/v7/slides/slides.py b/v7/slides/slides.py
@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+
+# Copyright © 2012-2017 Roberto Alsina and others.
+
+# 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.
+
+"""Slides directive for reStructuredText."""
+
+
+import uuid
+
+from docutils import nodes
+from docutils.parsers.rst import Directive, directives
+
+from nikola.plugin_categories import RestExtension
+
+
+class Plugin(RestExtension):
+    """Plugin for reST slides directive."""
+
+    name = "rest_slides"
+
+    def set_site(self, site):
+        """Set Nikola site."""
+        self.site = site
+        directives.register_directive('slides', Slides)
+        Slides.site = site
+        return super(Plugin, self).set_site(site)
+
+
+class Slides(Directive):
+    """reST extension for inserting slideshows."""
+
+    has_content = True
+
+    def run(self):
+        """Run the slides directive."""
+        if len(self.content) == 0:  # pragma: no cover
+            return
+
+        if self.site.invariant:  # for testing purposes
+            carousel_id = 'slides_' + 'fixedvaluethatisnotauuid'
+        else:
+            carousel_id = 'slides_' + uuid.uuid4().hex
+
+        output = self.site.template_system.render_template(
+            'slides.tmpl',
+            None,
+            {
+                'slides_content': self.content,
+                'carousel_id': carousel_id,
+            }
+        )
+        return [nodes.raw('', output, format='html')]
+
+
+directives.register_directive('slides', Slides)