Name	Snippet Plugin
Vendor	Atlassian Software Systems (Website)
Authors	Don Brown, Patrick Lightbody
Homepage	http://confluence.atlassian.com/display/CONFEXT/Snippet+Plugin
Issue Management	n/a
Continuous Integration	n/a
Categories	Content Macros
Most Recent Version	2.0.2
Availability	Confluence v2.2.1 to v2.10
State	Stable
Support
License	Freeware / Open Source (BSD)
Price	Free
Release Docs	http://confluence.atlassian.com/display/CONFEXT/Snippet+Plugin
Java API Docs	n/a
Download Source	http://svn.atlassian.com/svn/public/contrib/confluence/snippet-plugin/tags/2.0.2
Download JAR	snippet-2.0.2.jar

What is it?

A Confluence plugin to retrieve and display a snippet of text from a remote URL (e.g., Subversion).
The content will be trimmed down to the content found between some special tags. This is very handy for documentation that includes code. The code can be in Subversion (whatever build system is used will make sure it builds properly) and the URL can be a Subversion URL. (In case of ViewCVS the URL should point to the download URL of a file). The content is cached for configurable period, defaulting to one hour, in order to improve performance. The snippet is also unindented to remove excess space.

This can ensure that code examples in your documentation are kept up-to-date since they are sourced from the original code, thus preserving ideas put forth in LiterateProgramming.

The original version was spawned at codehaus (written by those two legendary maestros of code - Jon Tirsen and Aslak Hellesoy) and the code for it still lives there. A later version, 1.0, can be found at Snippet Macro Library V1.

Features

• Configurable snippet url prefixes and settings via a plugin configuration page
• Caching of snippets to improve performance
• Snippet errors are saved per space and displayed in the Space Administration section
• Ability to clear cache and saved snippet errors

Snippet Macro

Usage

{snippet:id=<snippetId>|url=<sourceURL>|lang=<language>|linenumbers=<true|false>|javadoc=<true|false>}

Parameters

Parameter	Required	Values	Default	Notes
id		Any string	all	The id of the snippet in the URL content
url		Any string, must start with a configured prefix		The location of the content containing the snippet
lang		Any language supported by the code macro		If present, will wrap the content in {code:lang}
linenumbers		true, false	false	If true, will add line numbers
javadoc		true, false	false	If true, performs extra processing like removing starting * and space characters, escaping XML, and cleaning out {@link} tags

Example

URL/snippet content

this
// START SNIPPET: something
macro
// START SNIPPET: somethingElse
is
// END SNIPPET: somethingElse
very
// END SNIPPET: something
cool

Macro usage

{snippet:lang=java|id=something|linenumbers=true|url=http://some/url/to/viewcvs}

This will give the following content:

{code:java}
1. macro
2. is
3. very
{code}

Administration

Administrative tasks are available for the members of the confluence-administrators group and space administrators:

Confluence Administrators

• Change plugin settings including cache expiration and snippet wrappers
• Add or remove allowed snippet url prefixes
• Flush the snippet cache
• Clear all snippet errors

Space Administrators

• View snippet errors
• Clear snippet errors for their space

Version History

Issue Tracking

Screenshots

Space snippet errors report	Snippet configuration