Custom Java Macros - obsolete

Java-based macros give you the most power to create your own Confluence macros that can produce complex HTML, retrieve data from Confluence, manipulate pages and interact with other systems and resources.

Adding a Java macro

To add a Java macro library, drop the macro library JAR (called by convention macros-name.jar - ie macros-tasklist.jar) into the WEB-INF/lib directory within your Confluence web application and restart Confluence.

Structure of a Java macro library

A Confluence macro library is a JAR file containing classes and resources (ie Velocity templates) used by the macros in the library, as well as a macro library descriptor file macro-library.xml. This descriptor defines and documents the macro library, like the example below:

<macro-libraries>
   <macro-library name="Task List Macros" 
      key="confluence.extra.tasklist"
      description="An example macro library which generates task lists.">

      <macro name="tasklist" 
         class="com.atlassian.confluence.extra.tasklist.TaskListMacro"
         description="Creates a very simple task list, with user checkable tasks."/>

      <!-- more macros -->

   </macro-library>
   
   <!-- more macro libraries -->

</macro-libraries>

A descriptor can contain multiple library definitions, each with multiple macros.

Building Java macros

The Confluence installation contains a custommacros directory with a "Confluence Macro Builder" Ant script and some sample macro projects.

Task List Example Library

As an example, tasklist is one of the example macros, which builds a simple task list within a Confluence page and allows users to complete and uncomplete the various tasks simply. It also serves as a good example of how easy it is to build add functionality to Confluence.

Example

Here's a screenshot of the tasklist macro in action, showing a simple shopping list that's half completed:

This was generated by notation like the following, with tasks completed or uncompleted by clicking on the relevant or :

{tasklist:Shopping List}
Buy apples
Buy bananas
Purchase shopping bag
Collect laundry
Deposit money
{tasklist}

You can download a prebuilt tasklist library or build it yourself as below.

Building the tasklist library

To build tasklist, go to the custommacros directory within the expanded distribution, and run:

ant -Dlibrary=tasklist build

Your macro library is now located at custommacros/tasklist/dist/macros-tasklist.jar

Installing the tasklist library

To install the library straight into the web application, run:

ant -Dlibrary=tasklist install

and then restart your Confluence instance. Similarly you can uninstall the library like so:

ant -Dlibrary=tasklist uninstall

Note: Confluence must first be shutdown before you can uninstall macros.