[[PageOutline(2-5,Contents,pullout)]]
= Gliffy Macro =

== Description ==

Allows you to embed Gliffy (http://www.gliffy.com) diagrams in your trac wiki pages.  The diagram is inlined on the page with an edit link that embeds the Gliffy editor.

When the editor launches, click the "Return to trac" link in the upper right corner to go back to your trac page.  The Gliffy editor will prompt you to save if you have made changes to the diagram.

This plugin requires that you have a gliffy.com account.  For API access you may need a paid account.

I haven't tested this with 0.11, so I may need assistance there to make it compatible.

== Bugs/Feature Requests == 

Existing bugs and feature requests for GliffyMacro are 
[report:9?COMPONENT=GliffyMacro here].

If you have any issues, create a 
[http://trac-hacks.org/newticket?component=GliffyMacro&owner=jcooper new ticket].

== Download ==

Download the zipped source from [download:gliffymacro here].

== Source ==

You can check out GliffyMacro from [http://trac-hacks.org/svn/gliffymacro here] using Subversion, or [source:gliffymacro browse the source] with Trac.

== Example ==

To install:
 * Copy `oauth.py`, `gliffylib.py`, and `GliffyDiagram.py` to your `wiki-macros` directory.  For example, on my server this is: `/usr/share/trac/wiki-macros`
 * Edit your `trac.ini` and add a `[gliffy]` block with 4 settings.  See below:

{{{
# example in trac.ini
[gliffy]
consumer_key = aaaaaaaaa
consumer_secret = zzzzzzzzzzzz
account_id = 1234
username = youruser@example.com
}}}

 * Example macro: `[[GliffyDiagram(Test Doc 2|ROOT/myfolder)]]`
 * Format is:  `[[GliffyDiagram(filename|folder path|type|size)]]`

||filename||required||Name of doc to edit. If doc doesn't exist it will be created ||
||folder||optional.  default is ROOT||Folder path to place document in.  Folder must have been previously created on gliffy.com.  The path that the Gliffy API uses is a little funny.  All user created folders are under `ROOT/`, so if you create a "Work" folder, then the path you should supply would be: `ROOT/Work`||
||type||optional. default is png||Format of image to return.  Valid values are: png, jpg, svg, xml|| 
||size||optional. default is M||Size of image to inline.  Valid values: T, S, M, L||
        

== Recent Changes ==

[[ChangeLog(gliffymacro, 3)]]

== Author/Contributors ==

'''Author:''' [wiki:jcooper] [[BR]]
'''Maintainer:''' [wiki:jcooper] [[BR]]
'''Contributors:'''