Adding Resources to your Project

On this page:

Purpose of a Resource

A 'resource' is a non-Java file that a plugin may need in order to operate. Examples of possible resources might be:

  • A Velocity file used to generate HTML for a macro or layout plugin module in Confluence.
  • A CSS file required by a theme layout plugin module.
  • An image referenced from within a layout plugin module.
  • A macro help file.
  • A localisation property file.

Resource definitions can be either a part of the plugin, or part of a particular plugin module.

Example of a Resource Definition

Here is a sample resource definition:

<!-- A resource has a type, a name and a location. The resource definition maps -->
<!-- some arbitrary resource name to where that resource would be located in    -->
<!-- the server's classpath -->
<resource type="velocity" name="template" location="com/example/plugin/template.vm"/>

<!-- For the localisation property file below, it must be named exampleplugin.properties -->
<!-- located under the resources folder -->
<resource type="i18n" name="i18n" location="exampleplugin" />

<!-- Resources may contain arbitrary key/value pairs -->
<resource type="download" name="style.css" location="com/example/plugin/style.css">
   <property key="content-type" value="text/css"/>
</resource>

Contents of the Resource Definition

A resource has a name, a type and a location. The resource definition maps an arbitrary resource name to the location of that resource in the server's classpath.

Element

Attribute

Description

<resource>

This block defines the resource. For example: <resource type="velocity" name="template" location="com/example/plugin/template.vm"/>

<resource>

name

The name of the resource defines how the plugin module can locate a particular resource. Must be specified if 'namePattern' is not. If your location parameter points to a directory rather than a single resource, you should specify the name with a trailing '/'. For example: <resource type="download" name="myimages/" location="com/example/plugin/myimages"/>

Note that for css/javascript resources, they must have the appropriate file extension in the name i.e. .css, .js

<resource>

namePattern

The pattern to use when loading a directory resource.

<resource>

type

The type of a resource tells the module how that resource can be used. The values allowed are different for each application.
A module can look for resources of a certain type or name. For example, a layout plugin requires that its help file is a file of type velocity and name help.
Refer to the examples of resource types below.

<resource>

location

The location of a resource tells the plugin where the resource can be found in the jar file. (Resources are loaded by Java's classpath resource loader.)

  • The full path to the file (without a leading slash) is required.
  • Must end in a '/' when using the 'namePattern' attribute to load multiple resources in a directory.

<property>

key/value

Resources may contain arbitrary key/value pairs. For example: <property key="content-type" value="text/css"/>

<param>

name/value

Resources may contain arbitrary name/value pairs. For example: <param name="content-type" value="image/gif"/>. Refer to the list of values for the param element below

Example of Resource Type: Downloadable Plugin Resources

The simplest kind of resource, supported with all plugin module types, is of type download, which makes a resource available for download from the application at a particular URL.

<resource type="download" name="aimon.gif" location="templates/extra/impresence/aimon.gif">
   <param name="content-type" value="image/gif"/>
</resource>

Example of Resource Type: Stylesheet referring to Images

Stylesheets for your plugin may often refer to images also in your plugin. In which case you would have to make both the stylesheet and image(s) downloadable.

<resource type="download" name="my-images/" location="com/example/plugin/myimages"/>
<resource type="download" name="my-style.css" location="com/example/plugin/my-style.css"/>

Note: If you have multiple stylesheets and javascript resources defined, you should put the resource defintions in a Web Resource Module.

To refer to your plugin images in a stylesheet, use a relative path based on the resource name defined for the image (which is 'my-images' in this case).

my-style.css
 .my-class {
   background-image: url(my-images/mypicture.gif);
}

To reference images already available in an application, you will need to go up three parent directories like so:

.my-class {
   background-image: url(../../../images/icons/confluence-logo.gif);
}

Values for Param Element

These are the common name/value pairs supported by the <param> element.

Name

Value (Example)

Description

content-type

image/gif

Specify a MIME content type.

media

print

Declare the media type for CSS resources. This is supported by Web Resource plugin modules.
For example, requesting this resource will insert a <link> in the HTML header, with a media value of 'print':

<web-resource key="mechanical-parts" name="Mechanical Parts"
    i18n-name-key="com.example.confluence.plugin.special.mechanical.parts.name">
    <resource type="download" name="sprockets.css" location="styles/sprockets.css">
        <param name="media" value="print"/>
    </resource>
</web-resource>

ieonly

true

Specify that the resource should be wrapped in an Internet Explorer conditional comment. This is supported by Web Resource plugin modules.
For example, the web resource declaration below says that the resource should be wrapped in an Internet Explorer conditional comment, which means it will only be used by Internet Explorer. This is useful for IE-specific styling to work around browser bugs.

<web-resource key="mechanical-parts" name="Mechanical Parts"
    i18n-name-key="com.example.confluence.plugin.special.mechanical.parts.name">
    <resource type="download" name="sprockets-ie.css" location="styles/sprockets.css">
        <param name="ieonly" value="true"/>
    </resource>
</web-resource>


The HTML output when this resource is included will be something like this:

<!--[if IE]>
<link type="text/css" rel="stylesheet" media="all"
    href="/s/1418/13/1.0/_/download/resources/plugin.example:mechanical-parts/sprocket-ie.css" />
<![endif]-->


The ieonly parameter also works for JavaScript resources.

conditionalComment

lt IE 9

Specify that the resource should be wrapped in an Internet Explorer conditional comment, and should be used when targeting specific versions of Internet Explorer. This is supported by Web Resource plugin modules.
For example, the web resource declaration below says that the resource should be wrapped in an Internet Explorer conditional comment, which means it will only be used by versions of Internet Explorer less than 9. This is useful for IE version-specific styling to work around browser bugs.

<web-resource key="mechanical-parts" name="Mechanical Parts"
    i18n-name-key="com.example.confluence.plugin.special.mechanical.parts.name">
    <resource type="download" name="sprockets-lt-ie9.css" location="styles/sprockets-lt-ie9.css">
        <param name="conditionalComment" value="lt IE 9"/>
    </resource>
</web-resource>


The HTML output when this resource is included will be something like this:

<!--[if lt IE 9]>
<link type="text/css" rel="stylesheet" media="all"
    href="/s/1418/13/1.0/_/download/resources/plugin.example:mechanical-parts/sprocket-lt-ie9.css" />
<![endif]-->


The conditionalComment parameter also works for JavaScript resources.

title

(Your title)

The value given here will form the title attribute of the CSS <link> tag.

Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport