Replace and Render Plugin

there is no pid for jira, so I've added my comments here:

1) link from annotation guide documentation is incorrect:
gives: http://www.adaptavist.com/display/USERGUIDE/replace-and-render+macro
should be: http://confluence.atlassian.com/display/CONFEXT/Replace+and+Render+Plugin

2) http://jira.adaptavist.com/browse/RNR is invalid

3) replace and render no longer exists on adaptavist site that I could find, by search or by index into their custom macros

4) feature request:

• content from 'replace-body' could be taken from an attachment or an 'included' page - allows a rudimentary template system

5) feature request:

• allow a shorthand notation where you have a simple replacement:
  Unknown macro: {replace-and-render}

  content

  will replace any occurance of key with value in content and render the content as wiki.

example was:

{replace-and-render:key=value}content{replace-and-render}

This has some overlap with the Run macro.

Run macro is now Run Plugin

A great extension to the [replace-and-render plugin] which would differentiate it from the Run Plugin would be a 'foreach' capability: For example:

{foreach}
{foreach-head}
|| Item || Link || Page Titles || Labelled Pages ||
{foreach-head}
{foreach-tail}{foreach-tail}
{foreach-body}
|| %item% | [%item%] | {search:query=title:%item%} | {contentbylabel:%item%} |
{foreach-body}
{foreach-list:%item%}
alpha
beta
gamma
{foreach-list}
{foreach}

that would render a table with 4 rows and the obvious replacements

But this could be a fairly simple patch to replace-and-render that includes a new tag,

(instead of

)

• Each line of the list is rendered.
• the head / body and tail are assembled as wiki and rendered as one step
• Not that I know a use case yet, but if you had multiple lists, it would do all permutations of replacements.
• leading and trailing whitespace and newlines for the head and tail are ignored

There are two very useful macros, Zones Plugin and Replace and Render Plugin, which were once-offs and Alain and Jason don't have time to support / extend them. Perhaps you or the community would combine them, as they are essentially the same thing, except:

• replace and render allows you to specify more useful replace strings, such as %var%, which can be used as macro parameters, unlike {zone:var}
• replace and render can take the template body from the current page (for one-time replacements), while zones, it seems, cannot
• zones very elegantly allow you to get the source from another page, while replace-and-render only uses it's own body.

Both are very simple, and very useful, and provide fundamental functionality missing from Confluence.

Currently, I almost always use both together because of each's deficiencies and strengths (a replace-and-render, wrapped in a zone-template)

replace-and-render would be redundant if:
a) zones supported the {zone-data:%var%}value{zone-data} or {zone-data:$var}value{zone-data} syntax for replacing %var% and $var, respectively, for use in macro parameters
b) supported a {zone-body}body{zone-body} tag which, if present, would override the parameter to zone-template-instance that looked for the body on another page.

zone-templates would be redundant if:
a) replace and render could optionally get it's body from the replace-body tag (as it does currently), or from a remote page using {replace-and-render:space:page} or {replace-and-render:body=space:page}

(They also have some overlap with the Run macro. See discussion above.)

http://developer.atlassian.com/jira/browse/ZONE-15

Thanks guys, for two essential plugins!

By using the replace-and-render plugin in combination with the html plugin, you're able to create new pages based on form values. The following example shows two dropdown lists on the current page allowing the user to select a month and year. By clicking on the Create Status Report button, a JavaScript is called which redirects the browser to Confluence's "add page" dialog with a predefined title.

{replace-and-render}
	{replace-body} 
		{html}
			<br><select id="cboStatusReportMonth">
				<option></option>
				<option>January</option><option>February</option><option>March</option><option>April</option>
				<option>May</option><option>June</option><option>July</option><option>August</option>
				<option>September</option><option>October</option><option>November</option><option>December</option>
			</select>
			<select id="cboStatusReportYear">
				<option>2006</option><option selected>2007</option><option>2008</option><option>2009</option>
			</select>
			<input type="button" value="Create Status Report" onclick="createStatusReport();">

			<script language="JavaScript">
				function createStatusReport() {
					var spaceKey = "%spaceKey%";
					var fromPageId = "%pageId%";
					var projectName = "%pageTitle%";
					var boilerplate = "%boilerPlate%";
					var monthText = document.getElementById('cboStatusReportMonth').value;
					var yearText = document.getElementById('cboStatusReportYear').value;
					
					if (monthText.length>0 && yearText.length>0) {
						var title = "Status Report for '" + projectName + "' - " + monthText + " " + yearText;
						document.location = "/pages/createfromboilerplate.action?spaceKey=" + escape(spaceKey) + "&linkCreation=true&title=" + escape(title) + "&fromPageId=" + fromPageId + "&parentPageString=" + escape(projectName) + "&boilerplate=" + escape(boilerplate);;
					} else {
						alert("Please select a month and year.");
					}
				}
			</script>
		{html}
  {replace-body}
  {replace-item:%pageId%}{page-info:pageId}{replace-item}
  {replace-item:%pageTitle%}{page-info:title}{replace-item}
  {replace-item:%spaceKey%}PRJ{replace-item}
  {replace-item:%boilerPlate%}StatusReport{replace-item}
{replace-and-render}

There's a known issue with this method: although the title of the new page is specified, Confluence still displays the "add page" dialog with the title text box disabled, leaving the user the only option to either click "Save" to finally create the page - or to cancel the process. This is not very user friendly, but seems to be the only option for the moment.

How do I properly replace a value in report-table generated content? I would like to replace the table's <thead> element with a <tr> element in order to work around a bug of the table-plus macro. The following code does not work. Does replace-and-render first replace, then render the content?

{replace-and-render}
	{replace-item:thead}tr{replace-item}
	{replace-body}
		{report-table}
			{content-reporter:scope=@self > children|types=page|labels=todo}
				{date-sort:data:DueDate}
			{content-reporter}
			{report-column:title=Task}{report-info:data:Task}{report-column}
			{report-column:title=Due Date}{report-info:data:DueDate}{report-column}
		{report-table}
	{replace-body}
{replace-and-render}

Just a couple of quick questions,

 I'm trying to pull information from from a table on one page and bring it to a drop, list, or check box list on another page.

I have tried using the get-data macro in combination with the list option macro and this will pull the data, however, when the option

is displayed in the drop or list box, the get-data macro code is displayed but once selected and saved, the actual information from the

table is displayed.  This turned me to the replace-and-render macro.  It seems like it will do the trick, however, I was wondering which directory

to install the .jar files into and I was also wondering if you had a solution to my information retrieval problem.  Any information will

be greatly appreciated

Thanks

Tim Grotheer

I'm trying to auto-generate labels based on a user's selection of check boxes (via Scaffolding plug-in) by using Replace and Render. Trouble is, when more than one check box is selected, only one label is generated. I'd like a label for each of the selected check boxes. Is this possible? Sample code:

{list-data:MyThings\|type=check\|multiple=true\|required=true}
{list-option:Thing_1}Thing_1{list-option}
{list-option:Thing_2}Thing_2{list-option}
{list-option:Thing_3}Thing_3{list-option}
{list-data}

{replace-and-render}
{replace-item:%label%}{get-data:MyThings}{replace-item}
{replace-body}{add-label:%label%}{replace-body}
{replace-and-render} 

Clicking on both Thing_1 and Thing_2 will produce a saved page with only the label "Thing_1"

Hi,

is it somehow possible to set a width in percentage when using RnR-Macro ? Maybe with an escape-char ?

Somethign like this

%

doesn't work

e.g.

{replace-and-render}
{replace-item:%TableWidth%} 25% {replace-item}
{replace-body}

{table:width=%TableWidth%}
{tr}{td}Cell{td}{tr}
{table}

{replace-body}
{replace-and-render}

regards Christian

I wonder, since (I belive) velocity templates allow the direct invocation of java classes, doesn't the {velocity-render} macro constitute a security vulnerability?

Hi

I'm creating a number of search pages using the Advanced Search Macro. Each of the pages has a hidden text field specifying a pattern of ORed labels, and a select list which has the same labels (and'd)

This results in a large page, potentially error prone. What I would like to do is specify the items as a comma separated list at the top of the page, and automatically have each value input to my advance search macros. I can see how the replace and render might help me if I had a fixed length list, but unfortunately it will vary by page.

Can replace and render help me?

Regards
H

PS Actually, what would be even better would be if the advanced search macro ORed the values of checkboxes, and/or a container allowed values to be specified as a comma separated list. Not going to happen

I have the next macro (listofprojectusers):
I call it passing parameter:
listofprojectusers:3004

{replace-and-render}
	{replace-body}{userlister:groups=p%value%PL,p%value%TL,p%value%PQ,p%value%PA}{replace-body}
{replace-item:%value%}$param0{replace-item}
{replace-and-render}

and at the end i need the result to look like:

{userlister:group=p3004PL,p3004TL,p3004PQ,p3004PA}

but it does not works, when I send the parameter it give me:

No results were found for groups : pPA, pPL, pPQ, pTL
it does not replace the value of $param0 when it is alone

{replace-item:%value%}$param0{replace-item}

and it works when i write anything with $param0 for ex.

{replace-item:%value%}($param0){replace-item}

which in result give me broken string

No results were found for groups : p(0003)PA, p(0003)PL, p(0003)PQ, p(0003)TL

any advise

How can I replace a space?
Is there something like this:

{replace-and-render}
  {replace-body}
    my text
    {replace-body}
    {replace-item:' '}-{replace-item}
 {replace-and-render}

--> my-text

Any hints?
Thanks!