Changeset 4412

Timestamp:

Oct 7, 2008, 8:23:40 AM (16 years ago)

Author:

Christian Boos

Message:

GraphvizPlugin: well, that README.txt was only approximatively reStructuredText, fixing it.

File:

• graphvizplugin/0.11/README.txt (modified) (7 diffs)

graphvizplugin/0.11/README.txt

@@ -14 +14 @@
 ++++++++++++++
 
-A simple example would be:
-
-{{{
-#!graphviz
-digraph G {Hello->World->Graphviz->Rules}
-}}}
+A simple example would be::
+
+  #!graphviz
+  digraph G {Hello->World->Graphviz->Rules}
 
 There are also several additional examples available in the examples
@@ -34 +32 @@
 to generate the images.
 
-The different programs can be invoked using one of these:
-
-#!graphviz
-#!graphviz.dot
-#!graphviz.neato
-#!graphviz.twopi
-#!graphviz.circo
-#!graphviz.fdp
-
+The different programs can be invoked using one of these::
+
+ #!graphviz
+ #!graphviz.dot
+ #!graphviz.neato
+ #!graphviz.twopi
+ #!graphviz.circo
+ #!graphviz.fdp
+ 
 
 The supported image formats are: png (default), gif, jpg, svg and svgz.
 The format can be specified using a "/format" modifier, in the hashbang,
-as shown below:
-
-#!graphviz/svg
-#!graphviz.dot/png
-#!graphviz.circo/gif
-
-
+as shown below::
+
+ #!graphviz/svg
+ #!graphviz.dot/png
+ #!graphviz.circo/gif
+ 
+ 
 Platform Specific Requirements
 ==============================
@@ -88 +86 @@
 http://trac-hacks.swapoff.org/svn/graphvizplugin.
 
-Change to the graphvizplugin/0.11 directory and run:
+Change to the graphvizplugin/0.11 directory and run::
 
     python setup.py bdist_egg
@@ -110 +108 @@
 
 A new section called graphviz should be added to the conf/trac.ini
-file with these fields:
+file with these fields::
 
     cache_dir       - The directory that will be used to cache the 
@@ -148 +146 @@
 
     default_*       - These settings define the default graph, node and
-                      edge attributes. They must be written as :
+                      edge attributes. They must be written as:
                             default_TYPE_ATTRIBUTE = VALUE
                       where TYPE      is one of graph, node, edge
@@ -191 +189 @@
 +++++++++++++++++++++
 
-Here is a sample graphviz section:
-
-[graphviz]
-cache_dir = /tmp/trac/htdocs/graphviz
-png_antialias = true
-default_graph_fontname = "Andale Mono"
-default_graph_fontsize = 10
-
-
-Here is a sample graphviz section that activates the cache manager:
-
-[graphviz]
-cache_dir = /tmp/trac/htdocs/graphviz
-png_antialias = true
-default_graph_fontname = "Andale Mono"
-default_graph_fontsize = 10
-cache_manager = yes
-cache_max_size = 10000000
-cache_min_size = 5000000
-cache_max_count = 2000
-cache_min_count = 1500
+Here is a sample graphviz section::
+
+ [graphviz]
+ cache_dir = /tmp/trac/htdocs/graphviz
+ png_antialias = true
+ default_graph_fontname = "Andale Mono"
+ default_graph_fontsize = 10
+
+
+Here is a sample graphviz section that activates the cache manager::
+
+ [graphviz]
+ cache_dir = /tmp/trac/htdocs/graphviz
+ png_antialias = true
+ default_graph_fontname = "Andale Mono"
+ default_graph_fontsize = 10
+ cache_manager = yes
+ cache_max_size = 10000000
+ cache_min_size = 5000000
+ cache_max_count = 2000
+ cache_min_count = 1500
 
 The cache manager is turned on since there is an entry in the graphviz
@@ -223 +221 @@
 
 
-Here's the same example but for Windows systems:
-
-[graphviz]
-cache_dir = C:\projects\plugins\env\trac\htdocs\graphviz
-cache_manager = yes
-cache_max_size = 10000000
-cache_min_size = 5000000
-cache_max_count = 2000
-cache_min_count = 1500
+Here's the same example but for Windows systems::
+
+ [graphviz] cache_dir = C:\projects\plugins\env\trac\htdocs\graphviz
+ cache_manager = yes
+ cache_max_size = 10000000
+ cache_min_size = 5000000
+ cache_max_count = 2000
+ cache_min_count = 1500
 
 Notice that the png_antialias, rsvg_path, default_graph_fontname and