wiki : aside (plugin)

Positions text to the right of the page. It is used by the plugins pages to place a list of all available plugins, and a similar menu for the syntax pages.

Plugin Details

Plugin Name : aside

Parameters

Administrator Notes

There are two different implementations for this plugin. The first uses class NotedDivPlugin, the second uses NamedNodePlugin.

NamedNodePlugin is more flexible, and is the recommended solution. However it requires addition tags within your template.jsp.

Here's how each one works :

NotedDivPlugin

Creates a floated html div (the default css class is wiki_aside). It also sets an attribute which the template can check for. This attribute can be use to turn off adverts for pages that need extra space for the aside. However, the template can ignore the attribute, and the plugin will still work (unlike the NamedNodePlugin).

The content will appear floated relative to where the aside plugin is within the wiki page.

The css class wiki_aside must be defined within your template's style sheet. If not, the syntax pages and the plugins pages will look very bad.

More than one aside per page is allowed.

NamedNodePlugin

This is more complex than NoteDivPlugin, and requires the template.jsp to do some of the work.

The main content of the wiki page does not contain the body of the aside plugin. Instead, a new mini-page is created, with a given name, and it is up to the template.jsp to look for this mini-page, and include it wherever it wants within the html page.

Therefore, the contents of the aside is not relative to where is was defined, and you can only have a single aside per wiki page.

Here is typical code within the template.jsp :

<tiles:importAttribute name="namedContents" ignore="true"/>
<c:if test="${! empty namedContents.aside}">
  <div class="wiki_aside">
    ${namedContents.aside}
  </div>
</c:if>

This can appear wherever you want to see the aside. So if you like laying out your page using <table> tags, you could place the main contents within one <td> cell, and the aside within a different <td>.

The <div class="wiki_aside"> above is optional - you can wrap the contents however you like.