Collage Framework and Code Markup Tools

Add ink annotations and text comments on top of the code in your Eclipse editor. Design your own editor extensions.

Collage is a framework that lets you create and edit layers of graphical shapes on top of the code in an Eclipse editor. Collage is based on the powerful Eclipse Graphical Editing Framework, and its features include the following:

• Your original source code is not modified in any way. Collage data is stored separately in the workspace's plugin state location.
• Shapes can be moved, resized and deleted; shape operations can be undone and redone.
• As in graphics software like Adobe Photoshop or GIMP, layers can be moved above and below other layers and hidden from view. They can also be exported to and imported from XML files.
• Shape properties can be viewed and edited in the Eclipse Properties view.
• Shapes are positioned based on code line numbers, so their rendering can be adjusted when code blocks are expanded and collapsed. Collage also attempts to reposition shapes when lines are added to or removed from the code underneath.
• Developers can contribute new shapes and tools through extension points.

Code Markup Tools

Have you ever wanted to write or draw on your code - perhaps to comment on problematic areas during a code review, or to plan out a large refactoring, or to figure out how an algorithm is supposed to work? Do you use Eclipse to teach classes or give presentations that involve coding, and wish you had some way to mark up the code on the fly? The Collage Code Markup Tools let you annotate code in your Eclipse editor with ink drawings, text notes and basic geometric shapes (see the included screenshot.)

Documentation

• A more detailed look at the user interface for Collage and the Code Markup Tools, with some usage tips
• Brief overview of Collage's extension points

Feedback

Bug reports, suggestions, and general feedback are very welcome. Bugs can be reported using the project's Google Code issue tracker. Email feedback is also welcome at a.bradley at alumni dot cs dot ubc dot ca.

Collage has been tested on Eclipse 3.7 (Indigo) and 4.2 (Juno) on Ubuntu Linux 12.04 and Windows 7; on Eclipse 4.2 on Mac OS X; on Eclipse 4.3 (Kepler) on Ubuntu Linux 12.04; and on Eclipse 4.4 (Luna) on Ubuntu Linux 14.04.