| 1 | Trac Graphviz Plugin v0.7.1 Release Notes |
|---|
| 2 | ========================================= |
|---|
| 3 | March 18, 2008 |
|---|
| 4 | |
|---|
| 5 | Graphviz plugin v0.7.1 for Trac is now available. The v0.7.x series |
|---|
| 6 | provides support for Trac 0.11. The Graphviz wiki processor is a |
|---|
| 7 | plugin for Trac that allows the the dynamic generation of diagrams by |
|---|
| 8 | the various graphviz programs. The text of a wiki page can contain the |
|---|
| 9 | source text for graphviz and the web browser will show the resulting |
|---|
| 10 | image. |
|---|
| 11 | |
|---|
| 12 | |
|---|
| 13 | Changes for release v0.7.1 |
|---|
| 14 | -------------------------- |
|---|
| 15 | |
|---|
| 16 | * Changed the interfaces used to communicate w/ Trac to support Trac |
|---|
| 17 | 0.11. |
|---|
| 18 | |
|---|
| 19 | * Replaced the use of os.popen3 with subprocess.Popen to better |
|---|
| 20 | support running on Windows. This implies that the Graphviz plugin |
|---|
| 21 | requires Python 2.4 and above. |
|---|
| 22 | |
|---|
| 23 | * Renamed GraphvizMacro to Graphviz. |
|---|
| 24 | |
|---|
| 25 | * Added support for OS X when searching for the Graphviz executable |
|---|
| 26 | programs. Fixes #1999. |
|---|
| 27 | |
|---|
| 28 | * Expanded the default locations used when searching for the Graphviz |
|---|
| 29 | executable programs. |
|---|
| 30 | |
|---|
| 31 | |
|---|
| 32 | Changes for release v0.7.0 |
|---|
| 33 | -------------------------- |
|---|
| 34 | |
|---|
| 35 | * Internal release. |
|---|
| 36 | |
|---|
| 37 | |
|---|
| 38 | Changes for release v0.6.8 |
|---|
| 39 | -------------------------- |
|---|
| 40 | |
|---|
| 41 | * Added better support for non-ascii characters in graphviz wiki |
|---|
| 42 | documents. |
|---|
| 43 | |
|---|
| 44 | |
|---|
| 45 | Changes for release v0.6.7 |
|---|
| 46 | -------------------------- |
|---|
| 47 | |
|---|
| 48 | * The GraphvizMacro v0.6.5 release introduced a bug with the now |
|---|
| 49 | optional cmd_path. If run on a platform whose sys.platform name is |
|---|
| 50 | not in the GraphvizMacro.cmd_paths dictionary, the self.cmd_path |
|---|
| 51 | variable isn't initialized. This caused a wee problem and stack |
|---|
| 52 | trace in Trac. |
|---|
| 53 | |
|---|
| 54 | |
|---|
| 55 | Changes for release v0.6.6 |
|---|
| 56 | -------------------------- |
|---|
| 57 | |
|---|
| 58 | * The GraphvizMacro v0.6.5 release introduced a bug with the |
|---|
| 59 | IHTMLPreviewRenderer interface. The render method assumed that the |
|---|
| 60 | content parameter was an object with a read method. Under trac 0.10 |
|---|
| 61 | with a Subversion repository, this object is a svn.core.Stream. |
|---|
| 62 | Under trac 0.9 the object is a string with the contents from the |
|---|
| 63 | repository. As a result, the v0.6.5 wouldn't render the images and |
|---|
| 64 | the raw text was displayed. |
|---|
| 65 | |
|---|
| 66 | |
|---|
| 67 | Changes for release v0.6.5 |
|---|
| 68 | -------------------------- |
|---|
| 69 | |
|---|
| 70 | * The default graphviz processor is now the only processor that must |
|---|
| 71 | be found on the system. GraphvizMacro will not work without it. If |
|---|
| 72 | any of the other processors are missing, a warning message will be |
|---|
| 73 | sent to the trac log, the processor will be removed from the list of |
|---|
| 74 | known GraphvizMacro processors and GraphvizMacro will continue. |
|---|
| 75 | Resolves issue http://trac-hacks.org/ticket/159. |
|---|
| 76 | |
|---|
| 77 | * The cmd_path configuration parameter in trac.ini is now |
|---|
| 78 | optional. Reasonable default values have been set for Linux, Win32 |
|---|
| 79 | and FreeBSD6. |
|---|
| 80 | |
|---|
| 81 | * Altered the way the GraphvizMacro description is returned in |
|---|
| 82 | get_macro_description. Instead of returning a description for each |
|---|
| 83 | variant (graphviz, graphviz/png, graphviz/svg, etc.) only return a |
|---|
| 84 | description for graphviz. This will cleanup the WikiMacros page a |
|---|
| 85 | bit to hopefully make it easier to navigate. It isn't a perfect |
|---|
| 86 | solution since all the graphviz macro names are still displayed but |
|---|
| 87 | it no longer repeats the same description for each |
|---|
| 88 | permutation. Resolves issue http://trac-hacks.org/ticket/284. |
|---|
| 89 | |
|---|
| 90 | * Implemented the IRequestHandler interface to return graphviz |
|---|
| 91 | generated images. This means that graphviz images can be referenced |
|---|
| 92 | via http://URL_TO_TRAC_SERVER/graphviz/HASH_KEY. As a result of this |
|---|
| 93 | change, the prefix_url configuration parameter is no longer needed |
|---|
| 94 | in the trac.ini file. Resolves issue |
|---|
| 95 | http://trac-hacks.org/ticket/86. |
|---|
| 96 | |
|---|
| 97 | * Links within images that are rendered as SVG are now automatically |
|---|
| 98 | prefixed with javascript:window.parent.location.href= to force the |
|---|
| 99 | link to be displayed in the parent window instead of the SVG object |
|---|
| 100 | window. Resolves issue http://trac-hacks.org/ticket/560. |
|---|
| 101 | |
|---|
| 102 | * Included the processor options when calculating the sha key used for |
|---|
| 103 | the image file name. This should help in testing various graphviz |
|---|
| 104 | settings in trac.ini. Resolves issue |
|---|
| 105 | http://trac-hacks.org/ticket/575. |
|---|
| 106 | |
|---|
| 107 | * Fixed expand_wiki_links to allow for javascript URL |
|---|
| 108 | references. Resolves issue http://trac-hacks.org/ticket/559. |
|---|
| 109 | |
|---|
| 110 | * GraphvizMacro is now also an IHTMLPreviewRenderer. This was done by |
|---|
| 111 | adding application/graphviz as the mimetype for files with the |
|---|
| 112 | extension of .graphviz, .dot, .neato, .twopi, .circo and .fdp. When |
|---|
| 113 | browsing the source code in the respoitory, any files with those |
|---|
| 114 | extensions will be treated as graphviz programs and will be rendered |
|---|
| 115 | via the GraphvizMacro. Resolves issue |
|---|
| 116 | http://trac-hacks.org/attachment/ticket/576. |
|---|
| 117 | |
|---|
| 118 | * Escaped the error message before displaying it. Resolves issue |
|---|
| 119 | http://trac-hacks.org/ticket/574. |
|---|
| 120 | |
|---|
| 121 | |
|---|
| 122 | Changes for release v0.6.4 |
|---|
| 123 | -------------------------- |
|---|
| 124 | |
|---|
| 125 | * Fixed problem where boolean values in the trac.ini file for Graphviz |
|---|
| 126 | would always evaluate to True. Resolves issue |
|---|
| 127 | http://trac-hacks.org/ticket/373. |
|---|
| 128 | |
|---|
| 129 | |
|---|
| 130 | Changes for release v0.6.3 |
|---|
| 131 | -------------------------- |
|---|
| 132 | |
|---|
| 133 | * Corrected Trac 0.10 specific config API calls to allow the plugin to |
|---|
| 134 | work with 0.9 as well as 0.10 releases of Trac. |
|---|
| 135 | |
|---|
| 136 | |
|---|
| 137 | Changes for release v0.6.2 |
|---|
| 138 | -------------------------- |
|---|
| 139 | |
|---|
| 140 | * Simplify the code to read the configuration files. Instead of having |
|---|
| 141 | lots of if structures, default values are passed as a parameter to |
|---|
| 142 | the self.config.get call. |
|---|
| 143 | |
|---|
| 144 | * Renamed Readme.txt to README.txt. |
|---|
| 145 | |
|---|
| 146 | * Added a additional comment to README.txt about rsvg not being |
|---|
| 147 | available on Windows. |
|---|
| 148 | |
|---|
| 149 | * Changed plugin structure to use entry_points in setup.py instead of |
|---|
| 150 | graphviz.egg-info/trac_plugin.txt. |
|---|
| 151 | |
|---|
| 152 | * Removed graphviz.egg-info from svn repository. It is generated via |
|---|
| 153 | "python setup.py bdist_egg" and shouldn't be in the repository. |
|---|
| 154 | |
|---|
| 155 | * Added Windows trac.ini [graphviz] example. |
|---|
| 156 | |
|---|
| 157 | * Fixed access to global vs local config variables. Resolves issue |
|---|
| 158 | http://trac-hacks.org/ticket/242. |
|---|
| 159 | |
|---|
| 160 | |
|---|
| 161 | Changes for release v0.6.1 |
|---|
| 162 | -------------------------- |
|---|
| 163 | |
|---|
| 164 | * Applied patch from eblot to correct the regular expression for |
|---|
| 165 | embedded URLs. Resolves issue http://trac-hacks.org/ticket/161. |
|---|
| 166 | |
|---|
| 167 | * Renamed module variable __version__ to __revision__ to better |
|---|
| 168 | reflect the intent. |
|---|
| 169 | |
|---|
| 170 | * Moved the release version number from setup.py to |
|---|
| 171 | graphviz/graphviz.py. The version number is now logged when the |
|---|
| 172 | graphviz module is initialized. |
|---|
| 173 | |
|---|
| 174 | * Commented out the many self.log.debug messages. As pointed out in, |
|---|
| 175 | http://trac-hacks.org/ticket/238, the core seems to be mostly stable |
|---|
| 176 | and having lots and lots of debugging messages may no longer be |
|---|
| 177 | needed. |
|---|
| 178 | |
|---|
| 179 | * Added defaults for the cache management control values: |
|---|
| 180 | |
|---|
| 181 | * cache_max_size = 10,000,000 |
|---|
| 182 | * cache_min_size = 5,000,000 |
|---|
| 183 | * cache_max_count = 2,000 |
|---|
| 184 | * cache_min_count = 1,500 |
|---|
| 185 | |
|---|
| 186 | The resolves issue http://trac-hacks.org/ticket/160. |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | Changes for release v0.6 |
|---|
| 190 | ------------------------ |
|---|
| 191 | |
|---|
| 192 | * In render_macro, corrected the self.log.debug statements that were |
|---|
| 193 | printing out the req.args and req.base_url. They are not always |
|---|
| 194 | available. Removed the reference to req.base_url since it was not |
|---|
| 195 | being used and may not always be an attribute to req. Resolves |
|---|
| 196 | issue http://trac-hacks.org/ticket/193. |
|---|
| 197 | |
|---|
| 198 | * Added import for the inspect module. Resolves issue |
|---|
| 199 | http://trac-hacks.org/ticket/236. |
|---|
| 200 | |
|---|
| 201 | |
|---|
| 202 | Changes for release v0.5.1 |
|---|
| 203 | -------------------------- |
|---|
| 204 | |
|---|
| 205 | * Corrected typo in graphviz.py where the wrong internal variable was |
|---|
| 206 | being used to display an error message. |
|---|
| 207 | |
|---|
| 208 | |
|---|
| 209 | Changes for release v0.5 |
|---|
| 210 | ------------------------ |
|---|
| 211 | |
|---|
| 212 | * Added a note in the Readme.txt wrt using load_examples.py to import |
|---|
| 213 | the Graphviz examples into a wiki. Fixed load_examples.py so that |
|---|
| 214 | it correctly looks for Graphviz examples in directories other than |
|---|
| 215 | the working directory. |
|---|
| 216 | |
|---|
| 217 | * Fixed a bug whereby image maps were a bit off when using the png |
|---|
| 218 | antialiasing option. |
|---|
| 219 | |
|---|
| 220 | * URL= strings in diagrams can now have Trac wiki links like |
|---|
| 221 | ticket:1, report:7, changeset:47, wiki:CamelCasePage, |
|---|
| 222 | milestone:milestone1 and source:Readme.txt. |
|---|
| 223 | |
|---|
| 224 | * Added additional examples for links in SVG images and using Trac |
|---|
| 225 | wiki links. |
|---|
| 226 | |
|---|
| 227 | * Fixed the bug #102 (http://trac-hacks.swapoff.org/ticket/102) |
|---|
| 228 | whereby popen2.Popen3 is not available on Windows. |
|---|
| 229 | |
|---|
| 230 | |
|---|
| 231 | Changes for release v0.4 |
|---|
| 232 | ------------------------ |
|---|
| 233 | |
|---|
| 234 | * Map support for bitmap images, allowing to use URL="" attributes in |
|---|
| 235 | graphs. Maps are only generated if the URL= string is found in the |
|---|
| 236 | Graphviz diagram. |
|---|
| 237 | |
|---|
| 238 | * Antialiasing on PNG images, using rsvg, from |
|---|
| 239 | <http://librsvg.sf.net>. |
|---|
| 240 | |
|---|
| 241 | * Better display of SVG images and IE support. |
|---|
| 242 | |
|---|
| 243 | * Display errors graphviz may produce. |
|---|
| 244 | |
|---|
| 245 | * Support for global graph options. |
|---|
| 246 | |
|---|
| 247 | * Updated documentation. |
|---|
| 248 | |
|---|
| 249 | * Example graphs have been created to outline the basic capabilities |
|---|
| 250 | of the plugin. |
|---|
| 251 | |
|---|
| 252 | * The tmp_dir is no longer needed. Instead of creating temp files to |
|---|
| 253 | be processed by graphviz, the plugin now communicates with the |
|---|
| 254 | graphviz programs through pipes. |
|---|
| 255 | |
|---|
| 256 | * Expanded info and debugging messages to allow for better debugging |
|---|
| 257 | of the running environment. |
|---|
| 258 | |
|---|
| 259 | * Error messages that occur when running the grapviz programs will |
|---|
| 260 | now be displayed in the browser. This should help in resolving |
|---|
| 261 | syntax problems with graphviz code. |
|---|
| 262 | |
|---|
| 263 | * Graphviz program paths are now enclosed in quotes. This should |
|---|
| 264 | resolve the problem when there are spaces in the path as is typical |
|---|
| 265 | on Windows. |
|---|
| 266 | |
|---|
| 267 | |
|---|
| 268 | Changes for release v0.3 |
|---|
| 269 | ------------------------ |
|---|
| 270 | |
|---|
| 271 | * A simple cache manager has been added to keep the cache disk space |
|---|
| 272 | and directory entry count under control. A series of parameters in |
|---|
| 273 | the [graphviz] section of the trac.ini configuration file are used |
|---|
| 274 | to control the cache manager. |
|---|
| 275 | |
|---|
| 276 | * The tmp files used in processing the graphviz language are now |
|---|
| 277 | deleted after the new image is created. |
|---|
| 278 | |
|---|
| 279 | * A series of debugging statements are now in the code. See the Trac |
|---|
| 280 | logging documentation section for details on how logging works. |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | More Information |
|---|
| 284 | ---------------- |
|---|
| 285 | |
|---|
| 286 | The graphviz plugin macro home page can be found at: |
|---|
| 287 | https://trac-hacks.swapoff.org/wiki/GraphvizPlugin |
|---|
| 288 | |
|---|
| 289 | The plugin has been tested on a Linux x86 system running python 2.4 |
|---|
| 290 | and the latest version of trac from subversion. Testing on other |
|---|
| 291 | platforms would be appreciated. |
|---|
| 292 | |
|---|
| 293 | Bugs and enhancement requests can be submitted at: |
|---|
| 294 | http://trac-hacks.swapoff.org/newticket?component=GraphvizPlugin&owner=pkropf |
|---|
| 295 | |
|---|
| 296 | |
|---|
| 297 | $Id: ReleaseNotes.txt 3393 2008-03-18 19:37:09Z pkropf $ |
|---|
