Confluence plugin module types

Confluence supports the following types of plugin modules:

Module Type

Since version...

Documentation

Description

about-page-panel5.2About Page Panel ModuleAdds information to the 'About Confluence' dialog in the Confluence user interface.
attachment-text-extractor7.0Attachment Text Extractor ModuleExtract and index the contents of a particular attachment type (for example, OpenOffice documents or Flash files).
blueprint5.1Blueprint ModuleDefines a way to create new pages based on user input and pre-defined content.

codeformatter

2.2

Code Formatting Module

Adds new languages to the {code} macro

colour-scheme

1.3

Theme Module

A colour-scheme for a theme

component

2.10

Component Module

Adds components to Confluence's component system. This is the newer and recommended version of the component module type.

component

1.4

Component Module - Old Style

Adds components to Confluence's component system. This is the earlier version of the component module type.

component-import

2.10

Component Import Module

Accesses Java components shared by other plugins.

cql field5.9CQL Field ModuleAdds fields to the Confluence Query Language
cql function5.9CQL Function ModuleAdds functions to the Confluence Query Language

decorator

2.5

Decorator Module

Adds decorators without using a Theme Plugin

device-type-renderer4.3.3Device Type Renderer ModuleAdds a renderer for a particular device type.

extractor

1.4 to 6.15

Extractor Module

Adds information to the Confluence search index

extractor2

7.0

Extractor2 Module

Adds information to the Confluence search index

gadget

3.1

Gadget Plugin Module

Atlassian gadgets provide a new way to include external content into a Confluence wiki page.

index-recoverer5.8 to 6.15Index Recoverer ModuleRecover out of date or invalid plugin index on start up of a node in a cluster.

job-config

5.10

Job Config Module

Adds scheduled tasks to Confluence using atlassian-scheduler.

keyboard-shortcut

3.4

Keyboard Shortcut Module

defines a keyboard shortcut within Confluence.

language

2.2

Language Module

Adds language translations to Confluence

layout

1.3

Theme Module

A layout (decorator) definition for a theme

lifecycle

2.3

Lifecycle Module

Schedule tasks to be run on application startup and shutdown

listener

1.4

Event Listener Module

A component that can respond to events occurring in the Confluence server

lucene-boosting-strategy

3.0 to 6.15

Lucene Boosting Strategy Module

Tweaks document scores in search results in Confluence.

macro

1.3

Macro Module

A macro used in wiki to HTML conversions (e.g {color}). Outputs HTML that can be embedded in a page or layout. Can retreive user, page and space info, or external content (eg RSS)

module-type

2.10

Module Type Module

Dynamically adds new plugin module types to the plugin framework, generally building on other plugin modules.

path-converter

2.8

Path Converter Module

Allows you to install custom URL schemes as a part of your plugin, i.e. you can have 'pretty' URLs.

rest

3.1

REST Module

Exposes services and data entities as REST APIs.

rpc-soap

1.4

RPC Module

Deploys a SOAP service within Confluence

rpc-xmlrpc

1.4

RPC Module

Deploys an XML-RPC service within Confluence

search-decorator7.0Search Decorator moduleChanges the behaviour of the default v2 search. Use it to change the order of contents returned by search, or change the filter to exclude a certain type of content.

servlet

1.4

Servlet Module

A standard Java servlet deployed within a Confluence plugin

servlet-context-listener

2.10

Servlet Context Listener Module

Deploys Java Servlet context listeners as a part of your plugin.

servlet-context-param

2.10

Servlet Context Parameter Module

Sets parameters in the Java Servlet context shared by your plugin's servlets, filters, and listeners.

servlet-filter

2.10

Servlet Filter Module

Deploys Java Servlet filters as a part of your plugin, specifying the location and ordering of your filter.

space-blueprint5.3Space Blueprint ModuleDefines a way to create new spaces based on user input and pre-defined content.

spring

2.2

Spring Component Module - Old Style

Add a Spring component. Unlike component plugins these allow the use of full Spring configuration XML

theme

1.3

Theme Module

A custom look-and-feel for a Confluence site or space

usermacro

2.3

User Macro Module

Allows a simple macro to be created in the plugin XML file, with no Java coding necessary

velocity-context-item

1.4

Velocity Context Module

Adds helper objects to Confluence's Velocity context

web-item

2.2

Web UI Modules

Adds links or tabs to the Confluence UI

web-resource

2.8

Including Javascript and CSS resources

Allows you to include Javascript and CSS resources

web-resource-transformer

3.4

Web Resource Transformer Module

Web Resource Transformer plugin modules allow you to manipulate static web resources before they are batched and delivered to the browser

web-section

2.2

Web UI Modules

Adds sections of links to the Confluence UI

xwork

1.4

XWork-WebWork Module

XWork/Webwork actions and views bundled with a plugin, enabling user interaction