Confluence User Macro Documentation

[Andrew Frayling]

Hi,

Is there any other documentation available on user macros in Confluence in addition to:

• http://confluence.atlassian.com/display/DOC/Writing+User+Macros
• http://confluence.atlassian.com/display/DOC/Guide+to+User+Macro+Templates
• http://docs.atlassian.com/com/atlassian/confluence/atlassian-confluence/latest/index.html

??

The reason I'm asking is because I've recently come across #contentLink2 and #userLink for displaying links to content and user profiles in user macros respectively, but I only discovered these by chance through another answer posted on this forum and by looking at the source code for some of the bundled plugins that ship with Confluence and couldn't find any reference to them in the official documentation.

I fully accept that me missing these directives could be down to my Google-Fu letting me down or me not understanding the API documentation properly, but I did spend several hours trawling through the documentation and trying different combinations of objects in Velocity to try and get what I wanted without success until I discovered these.

Did I miss something when looking at the documentation or are #contentLink2 and #userLink not documented?

Apologies if it's just me missing something in the existing documentation, but if these aren't documented and there are other hidden gems that are not publicly documented (maybe in internal documentation?) I'm sure the community would appreciate it if they could be shared.

Thanks,

Andrew.

[David at David Simpson Apps · Accepted solution]

Andrew,

With #contentLink2, you're just refering to a velocity macro from confluence/template/includes/macros.vm in the installation directory.

To find this or any other snippet from the Confluence source code:

1. Buy a 10 user license (optional if you already have the code)
2. Download the Confluence source code from my.atlassian.com
3. Search the Confluence source for your #contentLink2
4. Open up the file you find it in -- macros.vm

...but in this case, you don't need the source - the installation files will do just fine.

[Andrew Frayling]

Thanks David - glad I'm not going bonkers and imagining those didn't exist in the documentation :-)

Will spend some more time in the source code.

Cheers,

Andrew.

[Evgeny Victorov]

@Matthew J. Horn, could you just publish it somewhere, please?

[MS]

This info is a bit old but I found it quite helpful...

http://www.slideshare.net/GoAtlassian/no-coding-necessary-building-confluence-user-macros-cheat-shee-atlassian-summit-2010

[Matthew J. Horn]

Unfortunately, there are dozens, if not scores, of macros used by the Confluence templates that are never documented. I've started compiling a list, but it's taking a long, long time to then figure out what each one does and in what context it can be used.