Macros

Added by Mike Cannon-Brookes, last edited by Timo on Jul 11, 2007  (view change) show comment

Macros allow you to perform programmatic functions within a page, and can be used for generating more complex content structures.

Show Plugins By Category

Building your own?
Take a look at the Atlassian Developer Network for pointer to all the resources you'll need for developing your own plugins. For more detail on how to build your own custom macros, see the guide here.
System macros
Confluence includes a large number of macros out of the box, see the guide to Confluence macros.
Want to see your favourite bug fixed?
Vote for the less popular features requests: Macro Component Issues Sorted by User Votes

Categories

Please help to keep these organized

Plugin Categories
  • Action Macros — perform, launch, start, or execute a specific action from a display page
  • Communication Macros
  • Content Macros — generate content for display
  • External Content — Macros and Plugins to include, wrap, embed, or otherwise expose external content within a confluence page, either from an attachment or an external url
  • Formatting Macros — Format or re-format content, manipulate style, reorganize display, but do not generate content de-novo
  • Games
  • Image and Visualisation — generate image content, either inline, attached or using 3rd party libraries or services
  • Other
  • Prototype Macros — placeholder or proof-of-concept macros which may be incomplete, buggy, dangerous, or otherwise unsupported
  • Scaffolding Plugin — This plug-in contains macros for creating 'permanent templates' and editable forms.
  • User Feedback — Macros and plugins used to solicit user feedback

By Category

Plugins
  • Action Macros — perform, launch, start, or execute a specific action from a display page
    • Create Page Macro — The {create-page} macro asks the user for the name of the page and then creates it based on a template.
    • Dynamic Table Macro — This macro creates and maintains a table that is modified dynamically in the view mode, similarly to the Dynamic Task List. Additionally it allows reordering of the rows.
    • Dynamic Tasklist 2 — A wiki-based checklist for tasks with easy, ajax-driven task completion.
    • Run Plugin — Dynamic content based on substitution of parameters provided by page user.
    • Livesearch Macro — This plugin makes it possible to search for Confluence content, from Confluence content.
  • Communication Macros
  • Content Macros — generate content for display
    • Advanced Search Plugin — This plugin provides a set of macros utilising DWR (AJAX) searching capabilities. These macros center around providing a form-based interface for building search queries, the output is dynamically sortable and can be customised.
    • Approvals Workflow Plugin — The Approvals Workflow plugin integrates seamlessly with Confluence to provide an innovative way of managing content approvals, without compromising the open and collaborative philosophy of a wiki.
    • Remote Publishing Plugin
    • Booking Plugin — This plugin allows you to set up booking sheets.
    • Cache Plugin — Allows cache control of page-level elements.
    • Calendar Plugin — This plug-in puts a dynamically updated calendar into any page.
    • Checklists Plugin — A set of macros to generate checklist tables for a subset of pages (children of a given parent-page and/or filtered by a label). For each page, labels can be added/removed, values can be edited, and text segments can be added.
    • Cira Plugin — Cira is a set of macros that allows Confluence to be used as a basic issue tracking system.
    • Confluence Advanced Macros — This plugin provides many macros which generate content on Confluence content.
    • Confluence Attachments Macro — This plugin contains macros which display attachments (useful when attachment display is off by default).
    • Confluence Basic Macros — This plugin includes basic macros for linking and formatting content.
    • Confluence Compatibility Macros — This plugin contains macros for compatibility with other wiki systems (primarily with content imported from SnipSnap).
    • Confluence Dashboard Macros — This library includes macros that replicate the functions of the dashboard and space summary.
    • Confluence HTML Macros — This library contains macros that allow users to include raw HTML code within a page.
    • Confluence Information Macros — This plugin contains a few macros which can be used to to provide information blocks in Confluence (eg notes and warnings).
    • Confluence Tabular Metadata Plugin — This plugin contains a pair of macros which work with content labels to allow you to embed metadata into pages and blog posts.
    • Confluence User Lister Plugin
    • Content Publishing Plugin — The Content Publishing Plugin allows draft pages to be published in public Spaces. The public Space can be kept synchronized through a workflow using the Approvals Workflow Plugin, or manually.
    • Contributors Plugin — The Contributors Plugin contains macros to display contributors and statistics from a page or a set of pages.
    • Enhanced Tasklist — creates an enhanced TaskList
    • Exec Macro — Confluence macro to display output of executed commands or include local file content in a page.
    • Footnotes Plugin — A pair of Macros that allow you to create footnotes
    • Form Mail NG — A completely re-engineered version of the Form Mail Plugin. Hold no preconceptions; this is one small step for plugins, one giant leap for Confluence mailing.
    • HTML Plugin — Collection of macros for rendering HTML and related markup inside a Confluence page.
    • Include Random Macro — Plugin offers macros to randomly include pages and page excerpts
    • Index Glossary Plugin — contains 2 macros which can generate a index of word and a glossary.
    • Jasper Report Plugin — Allows Confluence users to compile, fill, show, and export a Jasper Report within Confluence pages
    • JavaBlackBelt Plugin — The JavaBlackBelt plugin shows the JavaBlackBelt (www.javablackbelt.com) status of one user, or of a list of users. Ideal for showing the status of your development team.
    • Java Scripting Plugin — Java scripting of Confluence page content with BeanShell, Groovy, or Jython
    • JIRA Graph Plugin — Confluence plugin that displays a graph of total issues per status over time, directly from a JIRA database
    • Job Manager Plugin — A Confluence plugin to view and manage the jobs registered by Confluence and its plugins.
    • Label Tools Plugin — A macro which allows you to ensure that pages containing it are given a predefined label
    • LaTeX Plugin — A plug-in for displaying LaTeX in Confluence.
    • Linking Plugin — This plug-in contains macros for linking to templates, the dashboard and other Confluence features.
    • Metadata Plugin — This plugin allows the user to attach metadata to any page in Confluence and to then generate reports and statistics using it.
    • Metadata Plugin 2 — Version 2 of the Metadata Plugin provides full metadata support for spaces, users, blog posts and attachments, as well as adding support for hierarchical spaces.
    • Multi-Excerpt Plugin — The multi excerpt plugin behaves like the excerpt macro, but allows for multiple excerpts, from multiple spaces.
    • Navigation Plugin — This set of macros displays links to pages within a specific hierarchy; currently {scrollbar} and (formerly) {noparent}.
    • NCBI aka Pubmed Literature Reference Macro — retrieves the article descriptions from Pubmed and renders them as literature citations (chicago-style)
    • New Code Macro — A new code macro that highlights more languages as well as nicer line numbering, printing and scrolling.
    • Overlib Macro — The OverLib confluence macro is a wrapper around the OverLib JavaScript library.
    • Page Access Macros — contains two macros which allow you to display a list of users who have view access to the page or space in which the macros are included. Both macros can optionally take one parameter - the maximum number of users the list should display.
    • Page Flag Plugin — The page flag macro creates a check box on a page. The check box is linked to a label and metadata such that when the checkbox is changed,the label and metadata are also changed.
    • Page Information Plugin — The Page information macros allow you to insert various pieces of information about either the current page or a remote page
    • PageTree Plugin — embeds the ajax page tree found in the browse space content page
    • Pagetree Search Plugin — This plugin provides functionality to search a hierarchal page tree within a space.
    • Plugins Information Plugin
    • Portlet, Script, Hidden and TOC Macros — Macros for table of content generation, hidden content and easy extension point for scripts and portlets.
    • Pygments Code Macro
    • Replace and Render Plugin — Allows replacements to be made within a block of wiki markup
    • Reporting Plugin — This plug-in allows generation of powerful and flexible reports to be displayed on Confluence pages.
    • Scriptix — taps into the standardised scripting API that comes with Java 6 and provides a nice platform for writing what might be considered to be advanced user macros.
    • Slideshow Plugin — construct a PowerPoint-style slideshow inside a Confluence page
    • Space Access Macro — The space access macro provides a list of users that have at least view privileges to the space in which the page containing the macro is located.
    • Table of Contents Plugin — This macro generates a Table of Contents for the current page based on its headings.
    • Table Plugin — A collection of macros dealing with enhanced table capability in Confluence.
    • Tagcloud Macro — Displays a visual representation of the tags (labels) within a space, size representing frequency, and allows the user to click on each to access related pages.
    • Testplan Plugins — These plugins allow the user to write and maintain testplans within Confluence.
    • Zones Plugin — Provides a simple template system for creating dynamic templates based on zones.
    • Confluence Markup Comments Macro — The Confluence Markup Comments Macro (CMCM) allows Confluence users, for the first time ever, to add "comments" in their wiki markup to make it more readable.
    • Insert Picture Plugin — A in-place image management widget for Confluence to help with image attachment manipulation
    • Sticky Notes and Snip-Edit Plugin — The Sticky Notes and Snip-Edit Plugin allows users to add notes on different sections of a page or blog post, and to modify any text excerpt.
    • Swimlanes - activity visualization — A hybrid java/flash plugin originally designed for visualizing student activity on a wiki, by providing a teacher in a class of wiki-using students a way to quickly get an impression of who's busy and doing what.
    • SimpleBlog
    • Universal Edit Button User Macro
  • External Content — Macros and Plugins to include, wrap, embed, or otherwise expose external content within a confluence page, either from an attachment or an external url
  • Formatting Macros — Format or re-format content, manipulate style, reorganize display, but do not generate content de-novo
  • Games
  • Image and Visualisation — generate image content, either inline, attached or using 3rd party libraries or services
    • Balsamiq Mockups For Confluence — Balsamiq Mockups For Confluence allows you to add UI mockups to your wiki pages.
    • Chart Plugin — A plugin that will allow you to generate simple or advanced charts from tabular data.
    • Gliffy Plugin for Confluence - Diagram and draw in Confluence — create collaborative web-based diagrams right on a Confluence page.
    • Graphviz Plugin — Macros to display graphs based on Graph Visualization Software (Graphviz) and the DOT language
    • ImageMap Plugin — This macro provides ImageMap functionality for pictures. ImageMaps allow to define clickable regions within a picture, that link to other pages/URLs.
    • JMAGE Plugin — The plugin allows filtering confluence image attachments through JMAGE filterchains, modifying the image at runtime before returning it to the browser.
    • Space Hypergraph — Displays a Hypergraph of the Space page hierarchy drawn using an applet from Jens Kanschik's Hypergraph Project at Sourceforge.
  • Other
    • Access Manager (Sun Identity Server) custom Seraph authenticator for Confluence
    • Attachment Checkout Plugin — Automatic Undo Check-out functionality is implemented.
    • Autowatch Plugin — This plugin allows administrators to specify that any contributors to a space watch their contribution automatically.
    • Blogging RPC Plugin — The Blogging RPC Plugin implements the Blogger 1.0 API and the MetaWeblog API for Confluence to let you post Confluence news pages from any client that implements these APIs
    • Copy Space Plugin — The copyspace plugin allows a space administrator to copy a space, including the pages within the space, but excluding (so far)page history, blog posts and email.
    • Edit Dashboard Plugin — allow you to edit a html section for Home page of each space.
    • Link Validator Plugin — This plugin checks links to see if they are valid.
    • Mail Page Plugin — Enables a page to be emailed to specified email addresses, users or groups.
    • Mark for Review Plugin — Allows users to mark pages for review by moderators.
    • Podcasting Plugin — This plugin allows the creation of Podcasting feeds based on Confluence pages and news items.
    • PrintBasket Plugin — add a printing basket which allows you to make a selection of pages and to print them at one time
    • Recently Updated Portlet — The Recently Updated Portlet is a JSR-168 compliant portlet that can be used to display Recently Updated Confluence Pages on portal software.
    • Search Portlet — The Search Portlet is a JSR-168 compliant portlet that can be used to search a confluence server.
    • Social Bookmarking Plugin — This plugin provides social bookmarking functionality allowing users to create and share bookmarks in a Confluence instance.
    • Stats Links Plugin — add a link in "browse space" menu which leads to a page where you can find some statistics and a list of links of the space.
    • Subconf — Plugin that allows subversion to act as the attachment store for Confluence, with 2 way synchronization.
    • TagLinks — Allows pages whose titles match a pattern (<id>.<id>.<id>...) to be handled hierarchically, by automatically storing them as children of higher-level pages and rendering any reference to them as links, without having to explicitly declare them as such using '[' and ']'.
    • TinyMCE Plugin — This is the default plugin which provides Rich Text Editing (RTE) features to Confluence.
    • User Information Plugin — This plugin replaces the Confluence user profile actions to allow users to enter more information about themselves.
    • WAP Plugin — This plugin allows access to Confluence using cellular phones supporting WAP 2.0.
    • WebDAV Plugin — Use Confluence like a network drive with drag and drop file operations.
    • Usage Tracking Plugin — A macro for tracking content view, create, edit and delete events in Confluence.
    • Agile Toolkit Plugin - Planning Poker — The agile toolkit will eventually contain a set of plugins that support agile techniques like Planning Poker.
    • Confluence AppLinks Plugin
    • Confluence Shared Access Layer Plugin
    • title
  • Prototype Macros — placeholder or proof-of-concept macros which may be incomplete, buggy, dangerous, or otherwise unsupported
  • Scaffolding Plugin — This plug-in contains macros for creating 'permanent templates' and editable forms.
  • User Feedback — Macros and plugins used to solicit user feedback
    • Form Mail Plugin — A macro for presenting the user with an AJAX form-mail UI which they can email you with messages.
    • Questionniki Plugin — Questionniki enables Confluence users to collaboratively author a questionnaire and to put the resulting questionnaire online.
    • Rate Macro — A set of macros for collecting and displaying page ratings.
    • RSVP Plugin — The RSVP macro provides a slick interface allowing to RSVP to upcoming events.
    • Survey Macro — Like the vote macro but need to collect data and comments on many issues at once? The Survey Macro is perfect for performance reviews and multi-question surveys.

Labels

macro macro Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Comments (3)

 

  1. Feb 05, 2007

    James Mortimer says:

    I've started to move these around as discussed previously: simple content (unde...

    I've started to move these around as discussed previously:

    simple content (under-construction) - usually shorthand for code that can be done in regular wiki
    compound content (edit-include) - shorthand macros that require other macros or plugins
    complex content (metadata / footnotes / multi-excerpt)
    dynamic content (dynamic table, calendar, tasklist)
    user feedback (vote, rate, rsvp)
    confluence content (contributors, glossary, versions, userlister)
    external content (word / flash / excel / conflikr / graphviz / ncbi ) - link to or render external, inline or attachment content. this can be broken into those that require a third-party installation (esentailly, the macro is a wrapper for another product) and those that work out-of-the-box
    prototype (sub-section) - neat macros only meant as proof-of-concept but may still be useful
    low-level macros (sql / run / portlets etc / cache / html / scripting) - fundamentally change capabilities of the wiki and requires careful consideration and usage
    Images/visualisation (gliffy/jmage/chart/etc)

    We should perhaps also consider harmonizing with confluence internal macro categories, currently:

    Text Formatting
    Headings
    Text Breaks
    Links
    Lists
    Images
    Tables
    Advanced Formatting
    Confluence Content
    External Content
    Misc
    Macros

    with the macros section, of course, being more diverse.

    1. Feb 15, 2008

      Brian M. Thomas says:

      .mycenter O Cobbler, why do your children go barefoot? or In a wiki that ...
      O Cobbler, why do your children go barefoot?
      or
      In a wiki that has labeling deeply integrated into its content,
      why are its authors struggling with hierarchical taxonomies for their own pages?

      Seems you could multiply index these things using labels, and save yourself the headaches and soul-searching...

      1. Feb 15, 2008

        David Peterson says:

        A valid point.

        A valid point.