Confluence

Note: If you're looking for examples of macro source code, you can download the source for most plugins on Atlassian's SubVersion Repository.

Overview:

The {code} macro is used to display syntax highlited source code...

This macro is an extension to the noformat macro which has the ability to apply syntax highlighting to various types of source code:

Java (default)
JavaScript
ActionScript
XML
HTML
SQL

As you can imagine, the macro is mainly aimed at techies, but it's useful if you need to show snippets of HTML such as how to include a link to your site, etc.

Parameters:

To syntax-highlight code, simply wrap it in {code} macro tags and specify the language to use:

{code:language}Your source code{code}

Parameter	Required	Default	Notes
default		Java	The "language" default parameter defines what type of syntax highligting to use: Java (default) JavaScript ActionScript XML HTML SQL

Examples:

Standard Use

Java Code

Display some Java code as follows:

{code}// example code
public Map newVelocityContext(Map parameters, String body, RenderContext renderContext) { 
  Map velocityContext = MacroUtils.defaultVelocityContext(); 
  velocityContext.put("body", body); 
  velocityContext.put("subRenderer", subRenderer); 
  velocityContext.put("renderContext", renderContext); 
  return velocityContext; 
}{code}

Which results in:

// example code
public Map newVelocityContext(Map parameters, String body, RenderContext renderContext) { 
  Map velocityContext = MacroUtils.defaultVelocityContext(); 
  velocityContext.put("body", body); 
  velocityContext.put("subRenderer", subRenderer); 
  velocityContext.put("renderContext", renderContext); 
  return velocityContext; 
}

HTML and HXTML

Display some HTML or XHTML markup as follows:

{code:html}
<span class="servicemark"><b>Builder Hosting</b><small><sup>SM</sup></small></span>
{code}

Which results in:

<span class="servicemark"><b>Builder Hosting</b><small><sup>SM</sup></small></span>

SQL (Structured Query Language)

Display some SQL as follows:

{code:sql}
SELECT * FROM table WHERE condition > 5 ORDER BY date DESC LIMIT 0,1;
{code}

Which results in:

SELECT * FROM table WHERE condition > 5 ORDER BY date DESC LIMIT 0,1;

If you ever need any bespoke SQL or database development, be sure to give Adaptavist a call

XML (eXtensible Markup Language)

Display some XML as follows:

{code:xml}
<plugin-info> 
  <description>Web Macros</description> 
  <vendor name="Adaptavist.com Ltd" url="http://www.adapatavist.com/" /> 
  <version>1.0</version>
</plugin-info>
{code}

Which results in:

<plugin-info> 
  <description>Web Macros</description> 
  <vendor name="Adaptavist.com Ltd" url="http://www.adapatavist.com/" /> 
  <version>1.0</version>
</plugin-info>

ActionScript (used in Macromedia Flash MX)

Display some ActionScript as follows:

{code:ActionScript}
// checks that the value is a number
validation.isNumeric = function (f) {
  return function (o) {
    if (Number(o.value).toString()=="NaN") {
      o.diagnostic+="FAILURE: value is not a number.";
      o.success=false;
    } else {
      o.diagnostic+="Value is a number. ";
      o.success=true;
      if (f!=null) o=f(o);
    }
    return o;
  };
}; 
{code}

Which results in:

// checks that the value is a number
validation.isNumeric = function (f) {
  return function (o) {
    if (Number(o.value).toString()=="NaN") {
      o.diagnostic+="FAILURE: value is not a number.";
      o.success=false;
    } else {
      o.diagnostic+="Value is a number. ";
      o.success=true;
      if (f!=null) o=f(o);
    }
    return o;
  };
};

JavaScript (used in your web browser)

Display some JavaScript as follows:

{code:JavaScript}
document.gmap = new GMap(document.getElementById("googlemap"));
document.gmap.addControl(new GLargeMapControl());
document.gmap.addControl(new GMapTypeControl());

var l = document.mapLocs["adaptavist2"];
document.gmap.centerAndZoom(new GPoint(Number(l.longitude), Number(l.latitude)), 15);

function createMarker(point, htm) {
 var marker = new GMarker(point);
 GEvent.addListener(marker, "click", function() {
   marker.openInfoWindowHtml(htm);
 });
 return marker;
} 
{code}

Which results in:

document.gmap = new GMap(document.getElementById("googlemap"));
document.gmap.addControl(new GLargeMapControl());
document.gmap.addControl(new GMapTypeControl());

var l = document.mapLocs["adaptavist2"];
document.gmap.centerAndZoom(new GPoint(Number(l.longitude), Number(l.latitude)), 15);

function createMarker(point, htm) {
 var marker = new GMarker(point);
 GEvent.addListener(marker, "click", function() {
   marker.openInfoWindowHtml(htm);
 });
 return marker;
}

Hints and Tips

The macro is ideal for including snippets of code on your pages because the syntax highlighting makes them easier to read (to us techies at least!)

You can improve the look and feel of the code macro and noformat macro using the following CSS:

/* code and noformat blocks */

div.code, div.preformatted {
overflow: auto;
background-color: #F8F7EF;
}

div.codeContent, div.preformattedContent {
background-color: #F8F7EF;
}

div.code, div.preformatted {
border-style: solid;
}

Q	Can I display other languages?
A	Yes, but they probably won't get syntax highligted properly. Just choose the syntax closest to the language you are using and hope for the best!

Confluence

code macro

Overview:

Parameters:

Examples:

Standard Use

Java Code

HTML and HXTML

SQL (Structured Query Language)

XML (eXtensible Markup Language)

ActionScript (used in Macromedia Flash MX)

JavaScript (used in your web browser)

Hints and Tips

See Also:

Ask questions, get help and report bugs & issues on our Community Site

Comments (1)

Matus says:

Adaptavist

Try for Free

Quick Links

Stay in Touch