From: Vladimír Vondruš <mosra@centrum.cz>
Date: Sun, 14 Oct 2018 14:32:10 +0000 (+0200)
Subject: m.dot: make title optional.
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=545986c93c9af084ff73f56c4f6a770783e393ad;p=blog.git

m.dot: make title optional.

Requiring a title won't make any sense for graph figures.
---

diff --git a/doc/plugins/plots-and-graphs.rst b/doc/plugins/plots-and-graphs.rst
index b2ac3394..3d00e267 100644
--- a/doc/plugins/plots-and-graphs.rst
+++ b/doc/plugins/plots-and-graphs.rst
@@ -199,7 +199,7 @@ The plugin produces SVG graphcs that make use of the
 --------------------
 
 The :rst:`.. digraph::` directive uses the ``dot`` tool to produce directed
-graphs. The required directive argument is graph title, contents is whatever
+graphs. The optional directive argument is graph title, contents is whatever
 you would put inside the :dot:`digraph` block. Use the :rst:`:class:` to
 specify a `CSS color class <{filename}/css/components.rst#colors>`_ for the
 whole graph, it's also possible to color particular nodes and edges using the
diff --git a/pelican-plugins/m/dot.py b/pelican-plugins/m/dot.py
index 04e2a41e..b5f8855b 100644
--- a/pelican-plugins/m/dot.py
+++ b/pelican-plugins/m/dot.py
@@ -35,7 +35,7 @@ import dot2svg
 
 class Dot(rst.Directive):
     has_content = True
-    required_arguments = 1
+    optional_arguments = 1
     final_argument_whitespace = True
     option_spec = {'class': directives.class_option,
                    'name': directives.unchanged}
@@ -53,19 +53,35 @@ class Dot(rst.Directive):
 
 class Digraph(Dot):
     def run(self):
-        return Dot.run(self, 'digraph "{}" {{\n{}}}'.format(self.arguments[0], '\n'.join(self.content)))
+        # We need to pass "" for an empty title to get rid of <title>,
+        # otherwise the output contains <title>%3</title> (wtf!)
+        return Dot.run(self, 'digraph "{}" {{\n{}}}'.format(
+            self.arguments[0] if self.arguments else '',
+            '\n'.join(self.content)))
 
 class StrictDigraph(Dot):
     def run(self):
-        return Dot.run(self, 'strict digraph "{}" {{\n{}}}'.format(self.arguments[0], '\n'.join(self.content)))
+        # We need to pass "" for an empty title to get rid of <title>,
+        # otherwise the output contains <title>%3</title> (wtf!)
+        return Dot.run(self, 'strict digraph "{}" {{\n{}}}'.format(
+            self.arguments[0] if self.arguments else '',
+            '\n'.join(self.content)))
 
 class Graph(Dot):
     def run(self):
-        return Dot.run(self, 'graph "{}" {{\n{}}}'.format(self.arguments[0], '\n'.join(self.content)))
+        # We need to pass "" for an empty title to get rid of <title>,
+        # otherwise the output contains <title>%3</title> (wtf!)
+        return Dot.run(self, 'graph "{}" {{\n{}}}'.format(
+            self.arguments[0] if self.arguments else '',
+            '\n'.join(self.content)))
 
 class StrictGraph(Dot):
     def run(self):
-        return Dot.run(self, 'strict graph "{}" {{\n{}}}'.format(self.arguments[0], '\n'.join(self.content)))
+        # We need to pass "" for an empty title to get rid of <title>,
+        # otherwise the output contains <title>%3</title> (wtf!)
+        return Dot.run(self, 'strict graph "{}" {{\n{}}}'.format(
+            self.arguments[0] if self.arguments else '',
+            '\n'.join(self.content)))
 
 def configure(pelicanobj):
     dot2svg.configure(
diff --git a/pelican-plugins/m/test/dot/page-236.html b/pelican-plugins/m/test/dot/page-236.html
index e740ce42..1963b629 100644
--- a/pelican-plugins/m/test/dot/page-236.html
+++ b/pelican-plugins/m/test/dot/page-236.html
@@ -97,11 +97,10 @@ and the arrowheads, nothing else. Non-default font size should be preserved.</p>
 </g>
 </svg>
 </div>
-<p>Unoriented graph:</p>
+<p>Unoriented graph without a title:</p>
 <div class="m-graph m-success">
 <svg style="width: 3.875rem; height: 7.500rem;" viewBox="0.00 0.00 62.00 120.00">
 <g transform="scale(1 1) rotate(0) translate(4 116)">
-<title>A to B</title>
 <g class="m-node m-flat">
 <title>a</title>
 <ellipse cx="27" cy="-93" rx="27" ry="18.2703"/>
diff --git a/pelican-plugins/m/test/dot/page-238.html b/pelican-plugins/m/test/dot/page-238.html
index 5fa3e779..c0c85a9d 100644
--- a/pelican-plugins/m/test/dot/page-238.html
+++ b/pelican-plugins/m/test/dot/page-238.html
@@ -97,11 +97,10 @@ and the arrowheads, nothing else. Non-default font size should be preserved.</p>
 </g>
 </svg>
 </div>
-<p>Unoriented graph:</p>
+<p>Unoriented graph without a title:</p>
 <div class="m-graph m-success">
 <svg style="width: 3.875rem; height: 7.375rem;" viewBox="0.00 0.00 62.00 117.54">
 <g transform="scale(1 1) rotate(0) translate(4 113.539)">
-<title>A to B</title>
 <g class="m-node m-flat">
 <title>a</title>
 <ellipse cx="27" cy="-91.1543" rx="27" ry="18.2703"/>
diff --git a/pelican-plugins/m/test/dot/page.html b/pelican-plugins/m/test/dot/page.html
index 664d8351..4c5ecc00 100644
--- a/pelican-plugins/m/test/dot/page.html
+++ b/pelican-plugins/m/test/dot/page.html
@@ -97,11 +97,10 @@ and the arrowheads, nothing else. Non-default font size should be preserved.</p>
 </g>
 </svg>
 </div>
-<p>Unoriented graph:</p>
+<p>Unoriented graph without a title:</p>
 <div class="m-graph m-success">
 <svg style="width: 3.875rem; height: 7.375rem;" viewBox="0.00 0.00 62.00 117.54">
 <g transform="scale(1 1) rotate(0) translate(4 113.5391)">
-<title>A to B</title>
 <g class="m-node m-flat">
 <title>a</title>
 <ellipse cx="27" cy="-91.1543" rx="27" ry="18.2703"/>
diff --git a/pelican-plugins/m/test/dot/page.rst b/pelican-plugins/m/test/dot/page.rst
index 42e39649..87e2c7fd 100644
--- a/pelican-plugins/m/test/dot/page.rst
+++ b/pelican-plugins/m/test/dot/page.rst
@@ -27,9 +27,9 @@ Colors:
     a -> b [class="m-warning" label="yes"]
     b -> b [class="m-primary" label="no"]
 
-Unoriented graph:
+Unoriented graph without a title:
 
-.. graph:: A to B
+.. graph::
     :class: m-success
 
     a -- b