Confluence Development Hub

Getting Started With Plugins

This is a quick guide to getting off the ground when starting a new plugin for Confluence.

The Guide

Building and Deploying Confluence has been broken into a series of steps.

Initial development environment setup
Building and Deploying Confluence in IDEA
- Setup Confluence Source Code For Development
- Creating an IDEA project with a Confluence distribution
Building and Deploying Plugins in IDEA
- Setting up a new Confluence plugin
- Working on an existing Confluence plugin
Packaging and releasing a plugin

Extra Information

Confluence Internals

Confluence Plugin Guide

Installing and Configuring Plugins manually
Installing and Configuring Plugins using the Plugin Repository
Installing plugins overview
Single Sign-on
Writing Confluence Plugins
- Accessing Confluence Components From Plugin Modules
- Confluence Plugin Module Types
  - Code Formatting Plugins — Code formatting plugin modules allow you to add new languages to the {code} macro.
  - Component Plugins
  - Decorator Plugins — Decorator plugin modules allow you to add decorators without using a Theme Plugin.
  - Downloadable Plugin Resources
  - Editor Plugins — Editor plugin modules allow you to implement Wysiwyg editors for editing Confluence pages.
  - Event Listener Plugins
  - Extractor Plugins — Extractor plugins allow you to hook into the mechanism by which Confluence populates its search index.
  - Job Plugins
  - Language Pack Plugins
  - Lifecycle Plugins — Lifecycle plugins allow you to perform tasks on application startup and shutdown
  - Macro Plugins
  - RPC Plugins
  - Servlet Plugins
  - Spring Component Plugins
  - StateAware
  - Theme Plugins
  - Trigger Plugins
  - User Macro Plugins
  - Velocity Context Plugins
  - Web UI Plugins — Web UI plugin modules allow you to insert links, tabs and sections of links into the Confluence web interface
  - Workflow Plugins
  - XWork-WebWork Plugins
- Plugin Self-Configuration

Customise Confluence Page Exports

Modify the style or content of the following page exports:

Remote API

Remote API Specification

Resources

The Confluence Confluence Developer FAQ

How do I associate my own properties with a ContentEntityObject?

How do I autowire a component?

How do I change the default polling time for email in Confluence?

How do I configure Confluence to use GMail as the mail server

How do I convert wiki text to HTML?

How do I find information about lost attachments?

How do I find the logged in user?

How do I get a reference to a component?

How do I get hold of the HttpServletRequest?

How do I get the base URL and ContextPath of a Confluence installation?

How do I get the information about Confluence such as version number, build number, build date?

How do I get the location of the confluence.home directory?

How do I load a resource from a plugin?

How do I make my attachments open in a new window or a tab?

How do I prevent my rendered wiki text from being surrounded by paragraph tags?

How do I tell if a user has permission to...?

How does RENDERMODE work?

HTTP Response Code Definitions

I am trying to compile a plugin, but get an error about the target release

I have checked out the source, and use IntelliJ IDEA. Where do I go from here?

What class should my macro extend?

What class should my XWork action plugin extend?

What is the best way to load a class or resource from a plugin?

What's the easiest way to render a velocity template from Java code?

Within a Confluence macro, how do I retrieve the current ContentEntityObject?