Confluence 4.1 : Hello World Example of User Macro

This page tells you how to create a user macro that displays the text 'Hello World!' and any variable text you place between the macro tags. (For full details about creating a user macro, see the guide to writing user macros.) 

(warning) The information on this page does not apply to Confluence OnDemand.

Defining the 'Hello World' User Macro

To create the 'Hello World' user macro:

  1. Go to the 'Confluence Administration Console' and click User Macros in the left-hand panel.
  2. Click Create a User Macro at the top of the list of macros.
  3. Enter the macro attributes as follows:
    • Macro Name: helloworld
    • Visibility: Visible to all users in the Macro Browser
    • Macro Title: Hello World
    • Description: Displays "Hello World" and the macro body.
    • Categories: Confluence Content
    • Icon URL: You can leave this field empty.
    • Documentation URL: You can leave this field empty.
    • Macro Body Processing: Rendered
    • Template:

      ## @noparams
      Hello World!
      $body
      
  4. Click Add.

Screenshot: Definition of the 'Hello World' user macro

Using the 'Hello World' Macro on a Page

Now you can add the macro to your Confluence page using the Macro Browser:

The result is:

Related Topics

Writing User Macros