User Macros

I want to write a macro that uses other Confluence macros (like {color}) but when I type Confluences syntax inside the macro template it appears as is. Is there a way to gain access to this stuff from inside the Velocity template? Or do I have to write plain HTML? Any pointers are appreciated.

Sure would be nice to have named parameters.

To prevent namespace collision, just stuff the macro params into a Hash with the same velocity object name as the macro itself, for example:

$mymacro.title $mymacro.name

Doh... I put in an example but Confluence is trying to eval it inline – hence the unknown macro above.

{mymacro:title=Bright Idea Dude|name=Timo}

So it appears the $param1-n are passed in as strings. How can I pass in a value to determine how many times I loop? I want a macro that says

where $param1 indicates how many times to loop.

So my template looks like this:
#foreach( $foo in [1 .. $param1] )
$nbsp;
#end

However, this does NOT work. Any ideas how I might make this work? The velocity documentation says I should be able to specify a range like [$foo .. $bar], but the only way I've been able to make this work is where I #set($foo=1) and #set($bar=3). How can I let my $param1 define how many times I loop?

It would be very HELPFUL if on the page above you added links
to what on earth a GeneralUtil or BootstrapManager provide,
e.g.

http://www.atlassian.com/software/confluence/docs/api/latest/com/atlassian/confluence/setup/BootstrapManager.html http://www.atlassian.com/software/confluence/docs/api/latest/com/atlassian/confluence/util/GeneralUtil.html http://www.atlassian.com/software/confluence/docs/api/latest/com/atlassian/confluence/core/ConfluenceActionSupport.html

And I'm guessing this is ContentEntity... http://www.atlassian.com/software/confluence/docs/api/latest/com/atlassian/confluence/core/ContentEntityObject.html

Etc...

Wikis are supposed to be all interlinked after all...

I think it would be a good idea to have a "User Macro Library" just as it has been introduced for the "Scaffolding Macros". They might serve as examples and of course might be of general interest. I think this is better than the alternative to make every User Macro a Confluence Extensions appearing in the Extension Space. Perhaps we could in addition point from the Extension Space to the User Macro-Library instead.

Is there any chance to make the User Macros visible in the Notation Guide? Otherwise they will have to be documented in some of the spaces to make them known to the Confluence-Users.

I suggest something like JavaDoc, e. g.

#/**
#* Does *something* useful.
#* @notation \{something-useful\}_Content_\{something-useful\}
#* @notation \{something-useful:_Some Title_\}_Content_\{something-useful\}
#* @param 0 some useful title
#* @param 1 some useful option
#* @param body some useful content
#*/

Where the description will appear as rendered Wiki-Content in the Comment-column while the notations are listed (separated by newlines) in the Notation-column.

Thanks for the help commenters - here is the hardest little thing I have had to write:

#set($globalHelper=$action.getGlobalHelper())
#set( $news=$space.blogPosts )
#set( $count=0)

#foreach($post in $news)  
  #set($count=$count+1)
#end

#set($number= $generalUtil.convertToInteger($param0))

#set($start=1)
#if( $number > 0)
  #set($start= $count - $number)
#end

#foreach( $index in [$count .. $start] )
  #set($index2= $index - 1 )
  #foreach($post in $news.subList( $index2, $index) )  
    <a href="/confluence/display/pages/viewpage.action?pageId=${post.id}">$post.realTitle</a><br/>
  #end
#end

This provides links the the indicated number of recent log posts. The hard part here was reversing the list. Could not get size, Collections.reverse or even get to function ...

It looks like parameters are now 0-based rather than 1-based. Incrementing i in $parami in all my user macros fixed the problem I had after upgrading from 1.3.5 to 2.1.1.

Hello,

I need to have a way to decide whether a page is exported as PDF or not. I thought I might use $action.isPrintableVersion() but this seems to return false for PDF generation. Does anyone know any other way to do this?

Regards,
Mark

I'm using the technique I learned on this page to fetch a numeric value from a database, like this:

#set( $query = "{sql:jndi=Reports |heading=false| table=false}select $param0 from metrics where year=$param1 and ticker='${content.realTitle}'{sql}")

#set($globalHelper=$action.getGlobalHelper())

#set($renderedContent=$globalHelper.renderConfluenceMacro($query))
${renderedContent}

The value is returned, but it comes back with leading and trailing newlines. This is a problem, because sometimes I want to follow the value with a "%", as follows. I can't put the "%" inside the macro, because not all invocations of the macro want the "%".

{metric:expense_ratio|2005}%

produces:

0.015 %

I've tried trim and replace functions, to no avail (but perhaps I didn't invoke them correctly; I am not a java programmer). Trim seems to ignore the newlines, and when I did $globalHelper.renderConfluenceMacro($query).replace("\n",""), the macro returned "${renderedContent}" (that is, the literal variable name, not the rendered content!)

Can someone show me how to trim these newlines?

For some reason, replaceAll("\n","") seem to work.

Here's my code and the output (I've put "x" on either side of \${renderedContent} in the macro, to make more obvious the source of the unwanted space):

#set( $query = "{sql:jndi=Reports |heading=false| table=false}select $param0 from metrics where year=$param1 and ticker='${content.realTitle}'{sql}")

#set($globalHelper=$action.getGlobalHelper())

#set($renderedContent=$globalHelper.renderConfluenceMacro($query).replaceAll("\r",""))


x${renderedContent}x

| Expense Ratio | {metric:expense_ratio|2005}% |

x0.00x %

x0.00x
% 

I think that the position of the "x" characters in the above make clear that the unwanted newline is not in the result of $renderedContent=$globalHelper.renderConfluenceMacro($query), so no manipulation of $renderedContent is going to help. For some reason, the user macro execution process is adding newlines to what I want to return.

Is there some sort of a context that I can manipulate, to tell it that my output is inline?

Am I useless, or is the API documentation?

I was trying to find a function like 'getparent' or 'getchildren' and could find absoluteley no mention of it in the API docs for the objects listed above. However, on a last-ditch whim, I tried:

#set($result=$content.getParent())
$

and to my amazement and horror, they both worked.

So is there any REAL API documentation around, or am I completely missing something in the documentation linked above?

Anyway to create link using a custom page template using a user macro?

An attempt at hacking it in for instance. Sort of works but doesn't pick up the template name.

<a href="/confluence/pages/createpage-entervariables.action?spaceKey=$space&parentPageId=${param0}&fromPageId=${param0}&title=${param1}&linkCreation=false&templateName=Status%20Report">New Status Report</a>

Usage:

{new_status_report:1234|Status Report 2006-04-05}

How to enumerate all registered user and get their full names?

#set($users=$content.getUserAccessor().getUsers() )
#foreach($user in users)
 $user.name
#end

The code above doesn't work

Any have a tip how to access the tiny link – e.g., "http://confluence.atlassian.com/x/hRE" – for the current page within a user macro? Thanks!

Is there any way to change the text color/size of just the title line in the panel macro?

thnx,

steve

Some questions about usermacros:

1. What's the function to add a label to a page? I want to add an unique automatically generated label to a page to use in template, by writing an usermacro. With add-label macro you can't do this.

I have

 
#set($pageId=$content.getIdAsString()) 
#set($labelmanager=$action.getLabelManager())
#set($result = $labelmanager.addLabel($content,new Label("test$pageId")))

but doesn't work. A counter would be better than the pageId, but is it possible to store a variable on a page? So for each new added page the counter does +1: test1, test2, test3, test4, ..?

Thanks a lot.

2. The function to get the templateID if you know the templatename?

I'm a little confused on how to use the New Code Macro with Javascript.

On many of your Macro pages, there is a Version area within a table that has the ability to expand or hide info for each version. (hide-desc, show-desc)...There's no macro in the confluence library that does this and the page tree plug in is for different pages. I can't seem to get the New code one to work though. Could someone show me an example of how something like this is done or used.

I'm using a simple macro to automatically generate a link to a url. Here is the content of my macro:

[JIRA #$param0|http://jira.mycompany.com/browse/$param0]

This works fine except the url is in a <p> block in the generated code, so if I want to use this in line it causes carriage returns around the link.

Here is a sample of my wiki markup on one page:

This is a link to {jira:XX-123} using a macro and all of this should be on one line.

This is a link to [JIRA #123|http://jira.mycompany.com/browse/XX-123] not from a macro.

Here the html source of the resulting page:

<p>This is a link to </p><p><span class="nobr"><a href="http://jira.mycompany.com/browse/XX-123" rel="nofollow">JIRA #123<sup><img class="rendericon" src="/images/icons/linkext7.gif" alt="" align="absmiddle" border="0" height="7" width="7"></sup></a></span></p> using a macro and all of this should be on one line.<p></p>

<p>This is a link to <span class="nobr"><a href="http://jira.mycompany.com/browse/XX-123" rel="nofollow">JIRA #123<sup><img class="rendericon" src="/images/icons/linkext7.gif" alt="" align="absmiddle" border="0" height="7" width="7"></sup></a></span> not from a macro.</p>

Which looks like this:
This is a link to

JIRA #123

using a macro and all of this should be on one line.

This is a link to JIRA #123 not from a macro.

If I edit site-css.vm, it crashes confluence on the server.  I have disabled velocity caching.  Any thoughts?

Hello. I'd like to implement "term" user macros that behaves much like metadata macro but displays a tooltip when mouse is over the "term". Its definition should be smth. like
{term:WMP}Windows Media Player{term}
. Later, user can define
{term-show:WMP}
and get WMP displayed with some marking, so reader can point a mouse on it and get a tooltip saying "Windows Media Player". I am not sure that such macro is already exist.

If you know about a macro doing it, please let me know. Otherwise, please guide me how i can display a tooltip like window using Velocity.

Thank you.

It's a pretty common request. Here's another way to do it:

#set($username=$action.getRemoteUser().getName())
$username

Hi,

I want to create a macro that prints the current date along with the macro body - so something like |somemacro| body goes here |somemacro|

should output

body goes here  09/11/2007 5:37 PM

This date only should be printed once - not updated with every edit of the page. I can get the page modified time but that will update on every page edit.

Is there a way to get the content of a page (other than the current page) from inside a macro?  (I'd like to at least initially do this in a user macro, but if I need to write a real plugin, I can do that--however, from looking at the docs and the objects available, I don't see any methods that let you specify a page and space and get back the contents.)

Does anyone know how to do a $string.replaceAll (or equivalent) with DOTALL in effect, I mean so that . matches anything, including newlines?

That is:

$body.replaceAll(".*","got the whole thing")

if given a multi-line body, will put "got the whole thing" once for each line.  The behavior I need is to replace the entire contents of the body, even if there are newlines in there.

HI all -
Does anyone have any ideas on how to use the useraccessor to pull back ldap information in a user macro? We are using Active Directory and I want to be able to pull back various properties of the user, such as manager and department.
Many Thanks
Jag

Hi,
We add usernames as labels on pages to indicate what users in our community need to take action on a page. I wanted to add a 'contentbylabel' macro to all spaces that would reflect what the signed-in user needed to address in that space, based on their username. For example:

contentbylabel:@user | key=@self

Unfortunately, Confluence does not support the feature in this macro. Does anyone know how to create a user macro that will do this?

Many thanks,

Darcy 

I am trying to add a macro showing a table of content using the toc-macro, but packed into a box:

<div class='panelMacro'>
<table class='infoMacro' width="100%">
<tr>
<td>
<h2>Seiteninhalt:</h2>
{toc}
</td>
</tr>
</table>
</div>

This shows prints {toc} if I set "macro generates HTML". If I set "macro generates wiki markup" I am looking at html codes surrounding my table of content.

Any idea how I could get what I'd like to have: the table of content inside a box?

Hi,

Can anyone suggest how to retrieve a page by it's name and space key? The following macros code certainly does not work:

#set($temp=$pageManager.getPage("SPACEKEY", "PAGETITLE"))
$temp

Retrieving page by id does not work as well.

Retrieving user works perfectly.

Thanks in advance!

I'm trying to write a user macro that can do stuff with the page's children, and it seems like I need to get the Page object in order to get the children. It seems like this should work:

#set($globalHelper=$action.getHelper())
#set($page=$globalHelper.getPage())
$page.getChildren()

But $page never seems to get set to anything. ($page.getChildren() just prints literally.)

(Two FYIs: I know I could just use a "children" macro to print this--I'm going to collect the children list and process it in the macro. Also, I can see this kind of thing would be better done in a plugin, but I'm trying to prototype this.)

Thanks! Jonathan

Does anyone know how to get an instance of the spaceManager and/or pageManager from within a user macro?

Specifically, I'm trying to retrieve the blogposts (news items) for a space. The Space object is available, but its method "getBlogPosts" is listed as deprecated, along with the note " use spaceManager.getBlogPosts(space, false) instead". 

The Action object available appears to be a concrete instance of ConfluenceActionSupport, as opposed to one of its subclasses such as ViewPageAction, which does appear to have methods to retrieve the space/pageManagers.

Any help would be greatly appreciated!

How do I write a VM that iterates through a list passed as a parameter.

i.e.

{mymacro:["a","b","c"]}

#foreach ($y in $param0)
  <tr><td>$y</td></tr>
#end

  <tr><td>a</td></tr>
  <tr><td>b</td></tr>
  <tr><td>c</td></tr>

When is the core api documentaton online again? I get an error 500.

To embed content from another site into Confluence you can use iFrames. However, since Confluence doesn't allow arbitrary html tags in the wiki markup, this is a prime candidate for user macros:

Name: iframe
Macro has body: no
Template: <iframe src="$src" width="$width" height="$height"></iframe>

Usage:
{iframe:src=http://google.com |height=400px|width=800px}

Is it possible to create a "run-once" user macro that generates wiki markup and inserts it on the page as if the markup was natively written there?

I'd like to be able to create a user macro to make it easy to generate some formatted links, but I'd also like those links to update if/when pages are moved or renamed later.

Here's our user macro:

{bgcolor:#e9f3dc}
{section}
{column:width=33%}
{align:left}  [*Previous*|$param0]
{align}
{column}
{column:width=34%}
{align:center}[*Index*|$param1]
{align}
{column}
{column:width=33%}
{align:right}[*Next*|$param2]  
{align}
{column}
{section}
{bgcolor}

Ideally I'd like to simply use it on a page like this:

{navbar:Page 1 | TOC | Page 3}

And end up with the actual wiki code on the page so the links are dynamically updated:

{bgcolor:#e9f3dc}
{section}
{column:width=33%}
{align:left}  [*Previous*|Page 1]
{align}
{column}
{column:width=34%}
{align:center}[*Index*|TOC]
{align}
{column}
{column:width=33%}
{align:right}[*Next*|Page 3]  
{align}
{column}
{section}
{bgcolor}

How do you access the entire list of parameters as an array? How am I supposed to know how many parameters there are?

 I am building a macro that is basically a collection of other macros, namely to create a header that is both toc and children. I want to pass the parameters of my macro directly to the constituent toc macro. What is the best pattern for doing this? I would like users to use my macro with toc options exactly as they would use the basic toc macro.

Thanks

I wrote this quickie user macro to hide and display large content in a confluence page (like jiraissues macros). It starts out with the content hidden, but clicking the link toggles between display and hide.

 Use:

• Macro Has a Body: true
• Convert Body Wiki markup to HTML
• Macro generates HTML Markup

 Usage:

{hidedisplay:<id>}<body>{hidedisplay}

The id is an arbitrary (but unique for the page) identier. The body is the content you wish to hide/display. This works fine with embedded macros.

The Code:

[<span onClick="var myDiv = document.getElementById('$param0'); if(myDiv.style.display=='none') { myDiv.style.display='block'; this.innerHTML='<i><u>Click to Hide</u></l>';} else {myDiv.style.display='none'; this.innerHTML='<i><u>Click to Display</u></l>';} "><i><u>Click to Display</u></l></span>]
<div id="$param0" style="display:none">
$body
</div>
 

Hi,

How can I have a People Directory button in a new dashboard?

I found the create space button macro and it works, but i cannot find any macro for people directory button.

thanks in advance.

I want to get a list of pages in a macro and according to this I should be using a SpaceManager method. However I can't work out to get the SpaceManager object - as far as I can tell there's no way of getting it from $space, $generalUtil, $action or $page.

For now I'm using the deprecated method, but would prefer not to. I've noticed a couple of other things like this too where I can't access various managers and have had to use deprecated methods instead.

Is there any way to get to the SpaceManager object from user macros?

Is there any way to create a new object in a macro?

The particular case I wanted was to get a java.util.Date object and I managed to work round it be using this:

#set($end = $generalUtil.getBuildDate().clone())
#set($ret = $end.setYear($year))
#set($ret = $end.setMonth($month))
#set($ret = $end.setDate($day))

However it'd be useful to know how to create arbitrary objects for other things in future.

I think the '$page' object is not available.