mizuho 0.9.6 → 0.9.8

data/asciidoc/filters/code/code-filter-readme.txt

@@ -1,37 +1,37 @@
-AsciiDoc Code Filter
-====================
-
-This simple minded filter highlights source code keywords and
-comments.
-
-NOTE: The filter is to demonstrate how to write a filter -- it's much
-to simplistic to be passed off as a code syntax highlighter. If you
-want a full featured highlighter use the 'source highlighter filter.
-
-
-Files
------
-code-filter.py::
-        The filter Python script.
-code-filter.conf::
-        The AsciiDoc filter configuration file.
-code-filter-test.txt::
-        Short AsciiDoc document to test the filter.
-
-
-Installation
-------------
-The code filter is installed in the distribution `filters` directory
-as part of the standard AsciiDoc install.
-
-Test it on the `code-filter-test.txt` file:
-
-  $ asciidoc -v code-filter-test.txt
-  $ firefox code-filter-test.txt &
-
-
-Help
-----
-Execute the filter with the help option:
-
-  $ ./code-filter.py --help
+AsciiDoc Code Filter
+====================
+
+This simple minded filter highlights source code keywords and
+comments.
+
+NOTE: The filter is to demonstrate how to write a filter -- it's much
+to simplistic to be passed off as a code syntax highlighter. If you
+want a full featured highlighter use the 'source highlighter filter.
+
+
+Files
+-----
+code-filter.py::
+        The filter Python script.
+code-filter.conf::
+        The AsciiDoc filter configuration file.
+code-filter-test.txt::
+        Short AsciiDoc document to test the filter.
+
+
+Installation
+------------
+The code filter is installed in the distribution `filters` directory
+as part of the standard AsciiDoc install.
+
+Test it on the `code-filter-test.txt` file:
+
+  $ asciidoc -v code-filter-test.txt
+  $ firefox code-filter-test.txt &
+
+
+Help
+----
+Execute the filter with the help option:
+
+  $ ./code-filter.py --help

data/asciidoc/filters/code/code-filter-test.txt

@@ -1,15 +1,15 @@
-Code Filter Test
-================
-
-[python]
-code~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-''' A multi-line
-    comment.'''
-def sub_word(mo):
-        ''' Single line comment.'''
-        word = mo.group('word') # Inline comment
-        if word in keywords[language]:
-                return quote + word + quote
-        else:
-                return word
-code~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Code Filter Test
+================
+
+[python]
+code~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+''' A multi-line
+    comment.'''
+def sub_word(mo):
+        ''' Single line comment.'''
+        word = mo.group('word') # Inline comment
+        if word in keywords[language]:
+                return quote + word + quote
+        else:
+                return word
+code~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

data/asciidoc/filters/code/code-filter.conf

@@ -1,8 +1,8 @@
-#
-# AsciiDoc code filter configuration file.
-#
-# Documented in code-filter-readme.txt
-#
-
-[blockdef-listing]
-code-style=template="listingblock",presubs=(),postsubs=("callouts",),posattrs=("style","language"),filter="code-filter.py -b {basebackend} -l {language}"
+#
+# AsciiDoc code filter configuration file.
+#
+# Documented in code-filter-readme.txt
+#
+
+[blockdef-listing]
+code-style=template="listingblock",presubs=(),postsubs=("callouts",),posattrs=("style","language"),filter="code-filter.py -b {basebackend} -l {language}"

data/asciidoc/filters/graphviz/asciidoc-graphviz-sample.txt

@@ -2,51 +2,64 @@
 
 Author: Gouichi Iisaka
 
-Version: 1.0
+Version: 1.1.3
 
 == Introduction ==
 
-Graph visualization is a way of representing structural information
+The Graphviz(link:http://www.graphviz.org[]) is a way of representing structural information
 as diagrams of abstract graphs and networks.
 
+
+Automatic graph drawing has many important applications
+in software engineering, database and web design, networking,
+and in visual interfaces for many other domains.
+
+Graphviz take descriptions of graphs in a simple text language,
+And has many useful features for concrete diagrams,
+such as options for colors, fonts, tabular node layouts,
+line styles, hyperlinks, and custom shapes.
+
 AsciiDoc can external shell commands used to process Paragraph and 
 DelimitedBlock content by Filter.
 
+So now, AsciiDoc can draw graphs via graphviz filter.
 
-== Simple Example ==
+== Examples ==
 
---------------------------------------------------------------------
- ["graphviz", "sample1.png"]
- ---------------------------------------------------------------------
- digraph G { rankdir=LR; Graphviz->AsciiDoc->HTML}
- ---------------------------------------------------------------------
---------------------------------------------------------------------
+=== Simple ===
+.....................................................................
+[graphviz]
+---------------------------------------------------------------------
+digraph G { rankdir=LR; Graphviz->AsciiDoc->HTML}
+---------------------------------------------------------------------
+.....................................................................
 
-["graphviz", "sample1.png"]
+[graphviz]
 ---------------------------------------------------------------------
 digraph G { rankdir=LR; Graphviz->AsciiDoc->HTML}
 ---------------------------------------------------------------------
 
+=== Using options ===
+.....................................................................
+["graphviz", "sample2.png"]
 ---------------------------------------------------------------------
- ["graphviz", "sample2.png"]
- ---------------------------------------------------------------------
- digraph automata_0 {
-    size ="8.5, 11";
-    node [shape = circle];
-    0 [ style = filled, color=lightgrey ];
-    2 [ shape = doublecircle ];
-    0 -> 2 [ label = "a " ];
-    0 -> 1 [ label = "other " ];
-    1 -> 2 [ label = "a " ];
-    1 -> 1 [ label = "other " ];
-    2 -> 2 [ label = "a " ];
-    2 -> 1 [ label = "other " ];
-    "Machine: a" [ shape = plaintext ];
- } 
- ---------------------------------------------------------------------
+digraph automata_0 {
+  size ="8.5, 11";
+  node [shape = circle];
+  0 [ style = filled, color=lightgrey ];
+  2 [ shape = doublecircle ];
+  0 -> 2 [ label = "a " ];
+  0 -> 1 [ label = "other " ];
+  1 -> 2 [ label = "a " ];
+  1 -> 1 [ label = "other " ];
+  2 -> 2 [ label = "a " ];
+  2 -> 1 [ label = "other " ];
+  "Machine: a" [ shape = plaintext ];
+} 
 ---------------------------------------------------------------------
+.....................................................................
 
-["graphviz", "sample3.png"]
+["graphviz", "sample2.png"]
 ---------------------------------------------------------------------
 digraph automata_0 {
     size ="8.5, 11";
@@ -63,35 +76,35 @@ digraph automata_0 {
 } 
 ---------------------------------------------------------------------
 
+=== Using Layout ===
 
---------------------------------------------------------------------
- ["graphviz", "sample4.png", "dot"]
- ---------------------------------------------------------------------
- digraph finite_state_machine {
-    rankdir=LR;
-    size="8,5"
-    node [shape = doublecircle]; LR_0 LR_3 LR_4 LR_8;
-    node [shape = circle];
-    LR_0 -> LR_2 [ label = "SS(B)" ];
-    LR_0 -> LR_1 [ label = "SS(S)" ];
-    LR_1 -> LR_3 [ label = "S($end)" ];
-    LR_2 -> LR_6 [ label = "SS(b)" ];
-    LR_2 -> LR_5 [ label = "SS(a)" ];
-    LR_2 -> LR_4 [ label = "S(A)" ];
-    LR_5 -> LR_7 [ label = "S(b)" ];
-    LR_5 -> LR_5 [ label = "S(a)" ];
-    LR_6 -> LR_6 [ label = "S(b)" ];
-    LR_6 -> LR_5 [ label = "S(a)" ];
-    LR_7 -> LR_8 [ label = "S(b)" ];
-    LR_7 -> LR_5 [ label = "S(a)" ];
-    LR_8 -> LR_6 [ label = "S(b)" ];
-    LR_8 -> LR_5 [ label = "S(a)" ];
- }
- ---------------------------------------------------------------------
---------------------------------------------------------------------
+.....................................................................
+["graphviz", "sample3.png", "dot"]
+---------------------------------------------------------------------
+digraph finite_state_machine {
+  rankdir=LR;
+  size="8,5"
+  node [shape = doublecircle]; LR_0 LR_3 LR_4 LR_8;
+  node [shape = circle];
+  LR_0 -> LR_2 [ label = "SS(B)" ];
+  LR_0 -> LR_1 [ label = "SS(S)" ];
+  LR_1 -> LR_3 [ label = "S($end)" ];
+  LR_2 -> LR_6 [ label = "SS(b)" ];
+  LR_2 -> LR_5 [ label = "SS(a)" ];
+  LR_2 -> LR_4 [ label = "S(A)" ];
+  LR_5 -> LR_7 [ label = "S(b)" ];
+  LR_5 -> LR_5 [ label = "S(a)" ];
+  LR_6 -> LR_6 [ label = "S(b)" ];
+  LR_6 -> LR_5 [ label = "S(a)" ];
+  LR_7 -> LR_8 [ label = "S(b)" ];
+  LR_7 -> LR_5 [ label = "S(a)" ];
+  LR_8 -> LR_6 [ label = "S(b)" ];
+  LR_8 -> LR_5 [ label = "S(a)" ];
+}
+---------------------------------------------------------------------
+.....................................................................
 
-.Example for `dot':
-["graphviz", "sample4.png", "dot"]
+["graphviz", "sample3.png", "dot"]
 ---------------------------------------------------------------------
 digraph finite_state_machine {
     rankdir=LR;
@@ -118,13 +131,40 @@ digraph finite_state_machine {
 
 == Layout ==
 
-layout for graphviz as follows.
-
- * dot::    filter for drawing directed graphs
- * neato::  filter for drawing undirected graphs
- * twopi::  filter for radial layouts of graphs
- * circo::  filter for circular layout of graphs
- * fdp::    filter for drawing undirected graphs
-
-default is `dot'.
-
+Layout for graphviz as follows.  The default is `dot'.
+
+    *dot;;
+    'dot' draws directed graphs.
+    It works well on DAGs and other graphs that can be drawn as hierarchies.
+    It  reads attributed graph files and writes drawings.
+
+    *neato;;
+    'neato' draws  undirected graphs using ‘‘spring'' models (see Kamada and
+    Kawai, Information Processing Letters 31:1, April 1989).
+    Input  files must be formatted in the dot attributed graph language.
+
+    *twopi;;
+    'twopi'  draws  graphs  using a radial layout (see G. Wills, Symposium on
+    Graph Drawing GD'97, September, 1997). 
+    Basically, one node  is  chosen as the center and put at the origin.
+    The remaining nodes are placed on a sequence of concentric circles
+    centered about the origin, each a fixed radial distance from
+    the previous circle.
+
+    *circro;;
+    'circo' draws graphs using a circular layout (see Six and Tollis, GD  '99
+    and  ALENEX  '99, and Kaufmann and Wiese, GD '02.)
+    The tool identifies biconnected components and draws the nodes
+    of the component on  a  circle.
+    The block‐cutpoint tree is then laid out using a recursive radial
+    algorithm.
+    Edge crossings within a circle are minimized by  placing  as
+    many  edges  on  the circle's perimeter as possible.
+    In particular, if the component is outerplanar,
+    the component will have a planar  layout.
+
+    *fdp;;
+     'fdp'  draws undirected graphs using a ‘‘spring'' model.
+     It relies on a force‐directed approach in the spirit of Fruchterman
+     and Reingold 
+     (cf.  Software‐Practice & Experience 21(11), 1991, pp. 1129‐1164).

data/asciidoc/filters/graphviz/graphviz-filter.conf

@@ -4,26 +4,30 @@
 # Version: 1.0
 # Gouici Iisaka <iisaka51 at gmail dot com>
 
+[graphviz-filter-style]
+graphviz-style=template="graphviz{format?-{format}}-block",subs=(),posattrs=("style","target","layout","format"),filter='graphviz2png.py {verbose?-v} -o "{outdir={indir}}/{imagesdir=}{imagesdir?/}{target}" -L {layout=dot} -F {format=png} -'
+
 [blockdef-listing]
-graphviz-style=template="graphviz-block",subs=(),posattrs=("style","target","layout"),filter='graphviz2png.py {verbose?-v} -o "{outdir}/{target}" -L {layout=dot} -'
+template::[graphviz-filter-style]
 
-ifdef::basebackend-html[]
-[graphviz-block]
-<div class="graphvizblock">
-<a id="{id}"></a>
-<div class="title">{title}</div>
-<div class="content">
-<a href="{link}">
-<img style="border-width: 0;" src="{target}" alt="{target}"{width? width="{width}"}{height? height="{height}"} />
-{link#}</a>
-</div></div>
-endif::basebackend-html[]
+[paradef-default]
+template::[graphviz-filter-style]
 
-ifdef::basebackend-docbook[]
 [graphviz-block]
-template::[image-blockmacro]
-endif::basebackend-docbook[]
+template::[filter-image-blockmacro]
 
+# EXPERIMENTAL: xhtml11 backend SVG image block.
+ifdef::basebackend-xhtml11[]
+[graphviz-svg-block]
+<div class="imageblock"{id? id="{id}"}{align? style="text-align:{align};"}{float? style="float:{float};"}>
+<div class="content">
+<a class="image" href="{link}">
+<object data="{imagesdir=}{imagesdir?/}{target}" type="image/svg+xml" />
+{link#}</a>
+</div>
+<div class="title">{caption={figure-caption} {counter:figure-number}. }{title}</div>
+</div>
+endif::basebackend-xhtml11[]
 
 #
 # DEPRECATED: Pre 8.2.7 filter definition.
@@ -32,7 +36,7 @@ endif::basebackend-docbook[]
 delimiter=^graphviz~{4,}$
 template=graphviz-block
 presubs=none
-filter=graphviz2png.py {verbose?-v} -o "{outdir}/{target} -L {layout=dot}" -
+filter=graphviz2png.py {verbose?-v} -o "{outdir={indir}}/{target}" -L {layout=dot} -
 posattrs=target,format
 #
 # DEPRECATED: End

data/asciidoc/filters/graphviz/graphviz2png.py

@@ -1,18 +1,15 @@
 #!/usr/bin/env python
-import os, sys
+
+import os, sys, subprocess
 from optparse import *
 
 __AUTHOR__ = "Gouichi Iisaka <iisaka51@gmail.com>"
-__VERSION__ = '1.1'
+__VERSION__ = '1.1.4'
 
 class EApp(Exception):
     '''Application specific exception.'''
     pass
 
-class Struct:
-    '''variable contenor as C `struct'.'''
-    pass
-
 class Application():
     '''
 NAME
@@ -27,17 +24,26 @@ DESCRIPTION
 
 
 OPTIONS
-    -o OUTFILE
+    -o OUTFILE, --outfile=OUTFILE
         The file name of the output file. If not specified the output file is
         named like INFILE but with a .png file name extension.
 
-    -v
+    -L LAYOUT, --layout=LAYOUT
+        Graphviz layout: dot, neato, twopi, circo, fdp
+        Default is 'dot'.
+
+    -F FORMAT, --format=FORMAT
+        Graphviz output format: png, svg, or any other format Graphviz
+        supports. Run dot -T? to get the full list.
+        Default is 'png'.
+
+    -v, --verbose
         Verbosely print processing information to stderr.
 
-    --help, -h
+    -h, --help
         Print this documentation.
 
-    --version
+    -V, --version
         Print program version number.
 
 SEE ALSO
@@ -45,52 +51,56 @@ SEE ALSO
 
 AUTHOR
     Written by Gouichi Iisaka, <iisaka51@gmail.com>
+    Format support added by Elmo Todurov, <todurov@gmail.com>
 
 THANKS
     Stuart Rackham, <srackham@gmail.com>
     This script was inspired by his music2png.py and AsciiDoc
 
 LICENSE
-    Copyright (C) 2008 Gouichi Iisaka.
+    Copyright (C) 2008-2009 Gouichi Iisaka.
     Free use of this software is granted under the terms of
     the GNU General Public License (GPL).
     '''
 
     def __init__(self, argv=None):
+        # Run dot, get the list of supported formats. It's prefixed by some junk.
+        format_output = subprocess.Popen(["dot", "-T?"], stderr=subprocess.PIPE, stdout=subprocess.PIPE).communicate()[1]
+        # The junk contains : and ends with :. So we split it, then strip the final endline, then split the list for future usage.
+        supported_formats = format_output.split(": ")[2][:-1].split(" ")
+
         if not argv:
             argv = sys.argv
-        self.attrs = Struct()
-        self.usage_msg = '%prog [options] inputfile\n'
-        self.usage_msg += 'Version: %s\n' % __VERSION__
-        self.usage_msg += 'Copyright(c) 2008: %s' % __AUTHOR__
+
+        self.usage = '%prog [options] inputfile'
+        self.version = 'Version: %s\n' % __VERSION__
+        self.version += 'Copyright(c) 2008-2009: %s\n' % __AUTHOR__
 
         self.option_list = [
             Option("-o", "--outfile", action="store",
-		    dest="outfile",
-		    help="Output file"),
+                dest="outfile",
+                help="Output file"),
             Option("-L", "--layout", action="store",
-		    dest="layout", default="dot",
-		    help="Output file"),
+                dest="layout", default="dot", type="choice",
+                choices=['dot','neato','twopi','circo','fdp'],
+                help="Layout type. LAYOUT=<dot|neato|twopi|circo|fdp>"),
+            Option("-F", "--format", action="store",
+                dest="format", default="png", type="choice",
+                choices=supported_formats,
+                help="Format type. FORMAT=<" + "|".join(supported_formats) + ">"),
             Option("--debug", action="store_true",
-		    dest="do_debug",
-		    help=SUPPRESS_HELP),
+                dest="do_debug",
+                help=SUPPRESS_HELP),
             Option("-v", "--verbose", action="store_true",
-		    dest="do_verbose", default=False,
-		    help="verbose output"),
-            Option("-V", "--version", action="store_true",
-		    dest="do_version",
-		    help="Print version"),
-	    ]
-
-        self.parser = OptionParser(option_list=self.option_list)
-        self.parser.set_usage(self.usage_msg)
-        (self.options, self.args) = self.parser.parse_args()
+                dest="do_verbose", default=False,
+                help="verbose output"),
+            ]
 
-	if self.options.do_version:
-            self.parser.print_usage()
-            sys.exit(1)
+        self.parser = OptionParser( usage=self.usage, version=self.version,
+                                    option_list=self.option_list)
+        (self.options, self.args) = self.parser.parse_args()
 
-	if len(self.args) != 1:
+        if len(self.args) != 1:
             self.parser.print_help()
             sys.exit(1)
 
@@ -101,7 +111,7 @@ LICENSE
             msg = 'Execute: %s' % cmd
             sys.stderr.write(msg + os.linesep)
         else:
-            cmd += ' 2>/dev/null'
+            cmd += ' 2>%s' % os.devnull
         if os.system(cmd):
             raise EApp, 'failed command: %s' % cmd
 
@@ -119,14 +129,19 @@ LICENSE
         saved_cwd = os.getcwd()
         os.chdir(outdir)
         try:
-            cmd = '%s -Tpng "%s" > "%s"' % (
-                        self.options.layout, infile, outfile)
+            cmd = '%s -T%s "%s" > "%s"' % (
+                  self.options.layout, self.options.format, infile, outfile)
             self.systemcmd(cmd)
-            os.unlink(infile)
         finally:
             os.chdir(saved_cwd)
 
+        if not self.options.do_debug:
+            os.unlink(infile)
+
     def run(self):
+        if self.options.format == '':
+            self.options.format = 'png'
+
         if self.options.infile == '-':
             if self.options.outfile is None:
                 sys.stderr.write('OUTFILE must be specified')