CodeBeamer Wiki Markup Help

Basic Formatting

Writing Text

----         = Make a horizontal ruler. Extra '-' is ignored.
\\           = Force a line break, \\\=force line break and clear.

[link]       = Creates a hyperlink to an internal WikiPage called 'link'.
[my page]    = Creates a hyperlink to an internal WikiPage called 'my page'.
[alias|link] = Creates a hyperlink to an internal WikiPage called 'link', but displays the text 'alias' to the user instead of 'link'.
[1]          = Makes a reference to a footnote numbered 1.
[#1]         = Marks the footnote number as 1.
[[link]      = Creates text '[link]'.

!1 heading    = Large heading with text 'heading'
!2 heading    = Medium heading with text 'heading'
!3 heading    = Small heading with text 'heading'
!4 heading    = Smaller heading with text 'heading'
!5 heading    = Smallest heading with text 'heading'

''text''     = Prints 'text' in italic.
__text__     = Prints 'text' in bold.
{{text}}     = Prints 'text' in monospaced font.
^^text^^     = Prints 'text' in superscript.
,,text,,     = Prints 'text' in subscript.

* text       = Makes a bulleted list item with 'text'
# text       = Makes a numbered list item with 'text'
;term:ex     = Makes a definition for 'term' with the explanation 'ex'
// markup comment line (nothing is rendered)

You do not need to know anything about the Wiki text formatting rules to use Wiki. You just need to write normal text, and then use an empty line to mark it as a paragraph. It's just like writing a simple email.

Links can also be direct URLs starting with http://, ftp://, mailto:, https://, or news:, in these cases the link points to an external entity.
For example, to point at the official Sun Java homepage, use [http://java.sun.com], which is changed to http://java.sun.com/ or [Java home page|http://java.sun.com], which is changed to Java home page.

Text Effects

You may use bold text or italic text, by using two underscores (_) and two single quotes ('), respectively. If you're on a Windows computer, make sure that you are using the correct quote sign, as there is another quote sign that looks similar.

You may use superscript text or subscript text, by using two circumflexes (^) and two single commas (,), respectively.

Pre-formatted Text

If you want to add pre-formatted text (like code) just use three consecutive braces ({) to open a block, and three consecutive braces (}) to close a block.

Quote Texts

If you want to quote some text (e.g. a previous comment written by someone else), just add a greater sign (>) in front of that text. 

>> This is a very old comment.
> This is a question that I quote.
And this is my answer.

This is a very old comment.
This is a question that I quote.
And this is my answer.

Pictures

Adding External Pictures

You can inline external pictures by using the following markup: 

[http://www.intland.com/images/intland_01.gif]
You can inline images also from CodeBeamer's documents: 
[http://localhost:8080/cb/displayDocument/mypic.jpeg?doc_id=1122]
You can also assign a URL to the inline picture: 
[http://www.intland.com|http://www.intland.com/images/intland_01.gif]
If you specify a link text that is not a valid URL, it becomes the ALT text for those who either cannot or do not want to view images.

Adding Links with Pictures

The example below shows the Yahoo online / offline graphics and creates a link to the Yahoo send message: 

[{Image src='http://opi.yahoo.com/online?u=YahooUser1234&m=g&t=2' border='0' height='30'
link='http://edit.yahoo.com/config/send_webmesg?.target=YahooUser1234&.src=pg'}]

See more examples of resizing and styling at the plugin's own webpage.

Adding Pictures from Page- or Issue Attachments

You can easily display pictures attached to the current wiki page: 

[!mypic.jpg!]
This will display the most recent picture with this name from the page attachments.
This syntax can be used also in issue descriptions to display picture attachments of the issue (ex: screenshots).
You can also refer explicitly to a specific picture revision (Wiki page attachments only): 
[!mypic.jpg#1!]
You can also display inline pictures that are attached to other pages: 
[!My favourite page/mypic.jpg!]
To inline pictures attached to an issue, into a Wiki page other than the issue description, you must specify the issue via an interwiki link: 
[![ISSUE:4711]/attachment.gif!]
Alternatively a picture can be viewed inline by using its attachment identifier: 
[!28!]
You can create links for all these markups: 
[http://www.intland.com|!mypic.jpg!]
[http://www.intland.com|!My favourite page/mypic.jpg!]
[http://www.intland.com|!28!]
Or you can even use Interwiki links with the attached pictures: 
[BUG:1000|!mypic.jpg!]
[PROJ:1|!My favourite page/mypic.jpg!]
[DOC:1000|!28!]

Adding Pictures from Documents

As with wiki attachments, pictures that are stored in the document managements system can be viewed inline: 
[!/My pictures/Buttons/button.gif!]
You can use also its document identifier: 
[!/1723!]
You can also refer to a specific version of a picture: 
[!/My pictures/Buttons/button.gif#2!]
[!/1723#2!]
You can create links also for these: 
[http://www.intland.com|!/My pictures/Buttons/button.gif!]
[http://www.intland.com|!/1723!]

Lists

Bulleted Lists

Use an asterisk ( * ) in the first column to make bulleted lists. Use more asterisks for deeper indentation. For example: 
* One
* Two
* Three
** Three.One

Creates:

Numbered Lists

Similar to that of bulleted lists, but you use a hash ( # ) instead of the asterisk. Like shown below: 
# One
# Two
# Three
## Three.One

Creates

  1. One
  2. Two
  3. Three
    1. Three.One

If you want to write the list item on multiple lines, just add one or more spaces on the next line and the line will be automatically added to the previous item.

We can continue the second sentence on a line of its own. We might as well do a third line while we are at it... Notice, however, as all these sentences get put inside a single item!

See Advanced formatting for complex list examples.

Definition Lists

A simple way to make definition-lists is to use the ;:-construct: 

;__Term__:''Explanation of the term''

that renders as:

Term
Explanation of the term

Comments

Another good use for the ';:' is that you can use it to give a short comment on other people's text, by having an empty 'term' in the definition, like shown below: 

;:''Comment here.''
Which would be seen as
Comment here.

Tables

Basic Tables

You can do simple tables by using pipe signs ('|'). Use double pipe signs to start the heading of a table, and single pipe signs to then write the rows of the table. End with a line that is not a table.

For example: 

|| Heading 1 || Heading 2
| ''Gobble'' | Bar
| [Main]     | [SandBox]

gives you the following table. Note how you can use links also inside tables.

Heading 1 Heading 2
Gobble Bar
Main SandBox

See Advanced formatting for complex table examples.

Advanced Formatting

Text Styles

Text Color

In addition to the simple styles represented by the regular wiki markup, we also allow you to put in your own styles. For example: 
%%red
This is red text.%%
This is red text.

Styles for the following colors are pre-defined:

blue
cyan
gray
green
magenta
orange
pink
red
yellow

Text Size and Alignment

%%small this %%             = Smaller then normal font
%%sub aij = aji %%          = Subscript
%%sup 23 = 8 %%             = Superscript
%%strike hardly readable %% = Strikethrough text
%%center centered %%        = Center text
%%ltr left-to-right text %% = Left-to-right text
%%rtl right-to-left text %% = Right-to-left text

Arbitrary Styles

You can also define almost any CSS style command: 
%%( font-size: 150%; color: red; )
Hello, world!%%
Hello, world!

Text Boxes

Information, Warning and Error Boxes

The following special block markers are supported: 

%%information Draft version %%
%%warning Low disk space %%
%%error Out of memory %%

Draft version Low disk space Out of memory

Collapsable Box

When closed only the title of the collapsable box is visible, when opened the complete box becomes visible. Do not forget to use one of the wiki heading styles in the first row of body text, otherwise the handle will not appear. 

%%collapsebox
!! Title of the Box
Here is the body of the box
%%

Title of the Box

Here is the body of the box

Comment Box

See this example comment box to the right and below this section. 

%%commentbox
__Hi there!__\\
It's actually quite possible to do things like put comment boxes like this directly
on your wiki page. This sample comment box uses the "commentbox" style, as
defined in the included "jspwiki.css" style sheet. To make a box like this,
just use {{{%%commentbox
<text> %%.}}}
%%

Hi there!
It's actually quite possible to do things like put comment boxes like this directly on your wiki page. This sample comment box uses the "commentbox" style, as defined in the included "jspwiki.css" style sheet. To make a box like this, just use %%commentbox <text> %%.

Tabbed Sections

When the page loads, only the first tabbed section will be visible. All other sections are hidden, until you click the corresponding tab.

You have to surround all tabbed sections with a tabbedSection style. Next, start each tabbed section with a style prefixed with tab-. 

%%tabbedSection
%%tab-ThisIsMyFirstTab
Some text inside the first tab.
%%
%%tab-ThisIsMyLastTab
Some other text inside the second tab.
%%
%%

Some text inside the first tab.
Some other text inside the second tab.

Advanced Lists

Collapsable Lists

You can turn ordinary lists into collapsable trees by enclosing them inside a collapse style. 

%%collapse
* RDBMS
** Commercial
*** DB2
*** Oracle
** Free
*** MySQL
%%

  • RDBMS
    • Commercial
      • DB2
      • Oracle
    • Free
      • MySQL

Advanced Tables

Zebra Tables

You can render alternate row coloring for large tables. by enclosing them inside zebra- tags. You can specify the odd and even colors using HTML hex color values or HTML color names like aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, purple, red, silver, teal, white, yellow and transparent. 

%%zebra-#FFFFCE-#F0C000
|| column-head1 || column-head2
| cell-data | cell data
| cell-data | cell data
| cell-data | cell data
%%

column-head1 column-head2
cell-data cell data
cell-data cell data
cell-data cell data

Table Plugin

This plugin extends the basic table markup with the following features: 

[{Table

|Nr |A |< |C |<
|#  |a |b |c |(background:yellow;)d
|#  |^ |b |^ |(background:yellow;)d

}]

Nr A C
1 a b c d
2 b d

You can easily organize any content into grid layout with this: 

[{Table

|[{ProjectList}] |(vertical-align:top;) [{MySubscriptions}]
|^ |(vertical-align:top;) [{MyApprovals}]

}]

See more details on the plugin's home page.

Sortable Tables

You can make tables sortable by enclosing them inside a sortable block. Just click the column header and your table is sorted without a round-trip to the server. 

%%sortable
|| Title || Author || Published   || Edition
| book1  |  zappy  |  25-Feb-2005 |  5
| book2  |  happy  |  25-Jan-2005 |  19
| book3  |  pappy  |  23-Mar-2005 |  06
| book4  |  dappy  |  21-Apr-2005 |  199
| book5  |  rappy  |  25-Jul-2005 |  017
%%

Title Author Published Edition
book1 zappy 25-Feb-2005 5
book2 happy 25-Jan-2005 19
book3 pappy 23-Mar-2005 06
book4 dappy 21-Apr-2005 199
book5 rappy 25-Jul-2005 017

Bar Graphs

You can translate a set of values into horizontal colored bars. You can specify both the color and the maximum length of the bars.
These bars can be combined with lists or even with tables: 

%%graphBars-#F0C000-70
* %%gBar 20 %% apples
* %%gBar 40 %% peers
* %%gBar 60 %% bananas
%%

  • 20 apples
  • 40 peers
  • 60 bananas

CodeBeamer Extensions

[PROJ:37]
 Creates a link to the project with the id "37". 
[WIKIPAGE:1037]
 Creates a link to the wiki page with the id "1037". 
[WIKIPAGE:1037/HEAD]
 Same as previous. 
[WIKIPAGE:1037/17]
 Creates a link to the wiki page with the id "1037", version "17". 
[WIKIPAGE:1037#My favourite paragraph]
 Creates a link to the wiki page with the id "1037", section titled "My favourite paragraph". 
[WIKIPAGE:1037/HEAD#My favourite paragraph]
 Same as previous. 
[WIKIPAGE:1037/17#My favourite paragraph]
 Creates a link to the wiki page with the id "1037", version "17", section titled "My favourite paragraph". 
[DIR:1320]
 Creates a link to the directory with the id "1320". 
[DOC:2798]
 Creates a link to the document with the id "2798". 
[DOC:2798/HEAD]
 Creates a download link to the document with the id "2798", latest version. 
[DOC:2798/23]
 Creates a download link to the document with the id "2798", version "23". 
[NOTES:2860]
 Creates a link to the wiki notes with the id "2860". 
[TRACKER:91]
 Creates a link to the tracker with the id "91". 
[ISSUE:567]
 Creates a link to the issue with the id "567". 
[REPORT:965]
 Creates a link to the report with the id "965". 
[FORUM:98]
 Creates a link to the forum with the id "98". 
[FTC:1007]
 Creates a link to the forum topic with the id "1007". 
[BUILD:435]
 Creates a link to the build with the id "435". 
[BUILDLOG:671]
 Creates a link to the build log with the id "671". 
[SRC:3564]
 Creates a link to the source file with the id "3564". 
[USER:1]
 Creates a link to the user account with the id "1". 
[USER:bond]
 Creates a link to the user account with the user name "bond".

Interwiki Link Sterotypes

Since CodeBeamer 6.0, Interwiki links to issues [ISSUE:XXX] and CMDB items [ITEM:XXX] can be customized via link stereotypes.

An interwiki link stereotype defines:


To associate an interwiki link with a stereotype, use: 
[<<stereotype>>|ISSUE:XXX]
Where stereotype is the name of the interwiki link stereotype, e.g. 
[<<infosheet>>|ISSUE:XXX]

Global stereotypes

Global interwiki link stereotypes are defined in ~/CB-X.Y/tomcat/webapps/cb/WEB-INF/classes/general.xml as elements in the <interwiki> subsection of the <wiki> section.

E.g. the default stereotype infosheet is defined as follows: 

<infosheet>
   <link></link>
   <popup></popup>
   <body>columns=3, value.style=min-width: 18em, categories, namedPriority, severities, status, versions, subjects, platforms, description</body>
</infosheet>
This stereotype renders some target object attibutes and the target description (no hyperlink) and is intented so be used as paragraph body in conjunction with a default interwiki link in the paragraph header: 
![ISSUE:123]
[<<infosheet>>|ISSUE:123]

![ISSUE:123]
[<<infosheet>>|ISSUE:124]

Another default stereotype is description: 
<description>
   <link></link>
   <popup></popup>
   <body>description</body>
</description>
As the name implies, this stereotype only renders the description of the referenced object, e.g. 
[<<description>>|ISSUE:124]

A stereotype definition consists of three parts, each of which can be empty.

DefinitionMeaningFormat
linkDefines the hyperlink (label)A string with ${attribute} placeholders,
where attribute is the name of object attribute whose value to substitute.
E.g. ${name} renders a link with the name of the referenced object as it's text.
popupDefines the hyperlink tooltipAnalog link
bodyDefines additional attributes to renderA comma-separated list of the attributes to show, plus optional display settings


In the body definition, you can also specify display settings as setting = value pairs.

SettingValueDefaultExample
columnsNumber of attributes per row in the attributes table5columns=3
table.classCSS class for the attributes <table>--
table.styleCSS style to apply to the attributes <table>--
label.classCSS class for the attribute label cells (<td>) in the attributes table--label.class=optional
label.styleCSS style to apply to the attribute label cells in the attributes tablemargin-left: 1em; white-space: nowrap; font-weight: bold;
background-color: #EEEEEE; text-align: right;
value.classCSS class for the attribute value cells (<td>) in the attributes table--value.class=tableItem
value.styleCSS style to apply to the attribute value cells in the attributes tablesmin-width: 15em;value.style=min-width: 18em
attribute.label.classCSS class for the label of the named attribute--status.class=mandatory
attribute.label.styleCSS style to apply to the label of the named attribute'--
attribute.value.classCSS class for the value of the named attribute--
attribute.value.styleCSS style to apply to the value of the named attribute--
attribute.colspanNumber of columns the named attribute should occupy1subject.colspan=3
attribute.newlineWhether to place the named attribute on a new linefalsesubject.newline=true

Caution: Do not modify general.xml while codeBeamer is running.

Page specific sterotypes

You can also define local interwiki link stereotypes for a page, by declaring the stereotype at the top of the page. 

[{SET <<stereotype>> = body}]

For example: 
[{SET <<special>> = status, namedPriority}]

[<<special>>|ISSUE:123]


Printing to PDF

Defining Prints

Freely configurable printing is supported by using a dedicated plugin ExportWiki. This is able to print a single or multiple pages (in configurable order) to PDF easily. The file to be printed is defined once in a wiki. Then the plugin generates a download link, which recreates the up to date content in PDF format any time later, when the link is selected from the wiki view.

Export Wiki Plugin

The ExportWiki plugin generates a download link for PDFs exported from wiki pages. 
[{ExportWiki id='1004,1005' format='pdf'}]


ExportWiki Plugin Parameters:

ExportWiki Plugin Examples of Use 
[{ExportWiki id='1004,1005' path='/myexports/mywiki.pdf' dpi='300'}]

will save the resulting file mypages.pdf in the myexports folder. 
[{ExportWiki id='1004' path='result.rtf' format='rtf' footerText='Some footer text'}]

will create result.rtf in root folder of the Document Manager.

Internal Content

Wiki Content

Table of Contents Plugin 
[{TableOfContents}]

generates a table of contents for the current page by using the !!!, !! and ! headings as content entries. You can override the default title and apply numbering (starting with 100) to the entries like this: 
[{TableOfContents title='Topic map' numbered='true' start='100'}]

If you need a higher level TOC that covers several pages, you can specify what pages to include in what order by listing their names or IDs in the body text: 

[{TableOfContents title='EJB 3.0 Tutorial' numbered='true'

Stateless EJBs
Stateful EJBs
Transaction and Security
1261
Dependency Injection
1244
}]

Project Content

Project Info Plugin 
[{ProjectInfo}]
displays basic information about the current project.
[{ProjectInfo projectId='2'}]
displays the same for the project with the identifier 2.
[{ProjectInfo projectId='2' description='true'}]
displays also the project description besides the basic information.

Members Plugin 
[{Members}]
displays the members and administrators of the current project.
[{Members projectId='2'}]
displays the same for another project.

Tracker List Plugin 
[{TrackerList}]
displays the trackers of the current project, with statistics.
[{TrackerList projectId='2'}]
displays the same for another project.

Source Code Summary Plugin

Displays statistical information about the source code of a project.

Parameters:

Appearance parameters:

Samples: 

[{SourceCodeSummary}]
displays the source code statistics for the current project.
[{SourceCodeSummary projectId='2'}]
displays the same for another project.

Commit Statistics Plugin 
[{CommitStatistics}]
displays a short summary of the SCM repository commits in all repositories of the current project. 
[{CommitStatistics detailed='true'}]
displays all repositories in the current project, and for each repository will show the number of recent commits. 
[{CommitStatistics repositoryId='2,133' layout='column'}]
displays the commit statistics for repositories with id #2 and #133 with column layout.

Commit Trends Plugin

Commit Trends plugin displays the number of commits in the current or specified projects for a perod of a time.

Parameters:

Data-collection parameters:

Appearance parameters:

Samples: 

[{CommitTrends}]
Shows the commits of the past 30 days. 
[{CommitTrends repositoryId='4,5' period='This year' grouping='Weekly' title='This years commits weekly' display='both'}]
Shows this years commit in a chart and also a data-table.

Committed Issues Plugin

CommittedIssues plugin displays those issues which has an SCM change related to.

Parameters:

Data-collection parameters:

Appearance parameters:

Samples: 

[{CommittedIssues}]
Shows the issues got commits in all repositories of the current project 
[{CommitTrends repositoryId='4,5' title='Committed issues in repository A and B' display='both'}]
Shows the committed issues from repository #4 and #5 with a custom title.

LOC Trends Plugin

LOC (Lines of Code) plugin displays the lines of code changes over the time. Important: the plugin uses the daily calculated data built by the "Project Statistics" daily build. This build must be enabled and running, otherwise this plugin will only produce empty charts/data.

Parameters:

Data-collection parameters:

Appearance parameters:

Samples: 

[{LocTrends}]
Shows the commits of the past 30 days. 
[{LocTrends projectId='4' period='This year' grouping='Weekly' title='This years source changes weekly' display='both'}]
Shows this years LOC changes in a chart and also a data-table.

Most Active Projects Plugin

This plugin shows the top most max active projects either from the set specified via projectId or tag, otherwise from the current working set of the current user. The ranking score is calculated from activities in the specified reporting period (default 'Last 30 days'). 
[{MostActiveProjects period='Last 30 days' max='5'}]
shows the top 5 projects from the user working set, that had the most activity in the last 30 days.

Project Activity Trends Plugin

This plugin shows the number of activities over time for selected projects in the specified granularity and reporting period. You must either specify projects via the projectId parameter, whose value is a comma-separated list of project ids, or the tag parameter, whose value is comma separated list of tag names (only the tagged projects are considered). You can specify a custom reporting period (default is "Past 30 days") via the period parameter, and the granularity (daily, weekly, monthly) via the grouping parameter (default daily). Per default, the activity trend is shown as a chart, but you can also show the data as a table via display='{chart|table|both}' 
[{ProjectActivityTrends projectId='2,4' period='Last 30 days' grouping='Daily'}]
displays the activity trend of the projects with ID 2 and 4 for the last 30 days, daily.

Activity Stream Plugin

This plugin provides an aggregated view of all recent activities in a project, including wiki page and document creates, issue submissions, comments, forum posts, and such. 
[{ActivityStream}]
displays all recent activities in the enclosing project. When used in a personal wiki page, it displays all recent activities in all projects in which the user is a direct member. You can easily narrow down the displayed activities using the filter parameter: filter can be any combination of 'issue', 'commit', 'wikipage', 'document', 'build' and 'forum', separated by comma. 
[{ActivityStream projectId='2,4' title='Recently in the Development Project' cssStyle='-moz-box-shadow: 0 0 1em gray;' filter='issue,build' period='Last 3 months' max='10'}]
will display the 10 most recent issue submissions and updates, and the most recent builds in two other projects. 
[{ActivityStream tag='customer, client' title='Recently in the Customer Projects' max='30'}]
displays the activities from all projects tagged with "customer" or "client".

Recent News Plugin 
[{RecentNews}]
displays the recent news posted to the forums of the current project.
[{RecentNews projectId='2' since='30' max='3'}]
will display the 3 most recent news in the last 30 days in another project.

Recent Documents Plugin 
[{RecentDocuments}]
displays the recently updated documents in the current project.
[{RecentDocuments projectId='2' since='30' max='3'}]
will display the 3 most recent document updates in the last 30 days in another project.

Recent Tracker Items Plugin 
[{RecentTrackerItems}]
displays the recently updated issues in the current project.
[{RecentTrackerItems projectId='2' since='30' max='3'}]
displays the 3 most recent issue updates in the last 30 days in another project.

The result set can be filtered by specifying an optional "include='...'" parameter:

Recent Builds Plugin 
[{RecentBuilds}]
displays the recent builds in the current project. 
[{RecentBuilds projectId='2' since='30' max='3'}]
displays the 3 most recent builds in the last 30 days for another project.

Recent Wiki Pages Plugin 
[{RecentWikiPages}]
displays list of recently changed or commented wiki pages. 
[{RecentWikiPages projectId='2' since='30' max='5'}]
displays the 5 most recent wiki page updates in the last 30 days in another project.

Artifact Activity Trends Plugin 
[{ArtifactActvityTrends artifactId='1000'}]
displays the number of "reads" of a wiki page or document. 
[{ArtifactActvityTrends artifactId='1000,1002' display='table'}]
displays the "reads" of two wiki pages or documents, in a table. 
[{ArtifactActvityTrends title='Updates on MySql' tag='mysql, rdbms' activity='update' period='Past 30 days' display='both' cssStyle='background-color:#DEEFF6'}]
displays the "updates" of any wiki page or document tagged with "mysql" or "rdbms", for the past 30 days, both in a chart and in a table with a distinct background color.

Artifact Count Trends Plugin 
[{ArtifactCountTrends}]
displays the number of wiki pages changing over time in the current project. 
[{ArtifactCountTrends projectId='11,27' type='document' display='table'}]
displays the total number of documents in two projects, in a table. 
[{ArtifactCountTrends title='Knowledge Base Size' tag='knowledge-base, kb' period='Past 30 days' display='both' cssStyle='background-color:#DEEFF6'}]
displays the total number of wiki pages in any project tagged with "knowledge-base" or "kb", for the past 30 days, both in a chart and in a table with a distinct backgound color.

Issue Count By Field Plugin 
[{IssueCountByField}]
displays the issue distribution in the current project by the Status field. 
[{IssueCountByField projectId='11,27' display='table'}]
displays the issue distribution in two projects, in a table. 
[{IssueCountByField trackerId='81,85' title='Bugs by Priority' field='priority' display='both'}]
displays the issue distribution in two trackers by Priority, both in a chart and in a table.

The parameter field can be one of assignedto, category, detected, os, platform, priority, resolution, severity, status, submitter and target. 
[{IssueCountByField tag='java,mysql,acme-corp' title='Acme Corp. Issues' display='both' cssStyle='background-color:#DEEFF6'}]
displays the issue distribution in any project or tracker tagged with the listed tags, both in a chart and in a table with a distinct backgound color.

Issue Count Trends

Issue Count Trends plugin displays the number of issues created vs the number of issues resolved for a period of a time.

This information can be displayed in either chart or table format. The chart image will show two lines of the issue progress: the green line indicates the total number of issues cumulative from the start of the period and the red shows the number of new issues. The coloring of this chart indicates the health of the project, simply saying: the green area will indicate that there are more bugs/issues being fixed than it is created, and if the red area is dominating that suggests that more resources and time should be spent on fixing the bugs.

Parameters:

Data-collection parameters:

Appearance parameters:

Samples: 

[{IssueCountTrends}]
displays the trend of the issues being created/resolved in the current project in the default period='Past 7 days' 
[{IssueCountTrends projectId='11,27' display='table'}]
displays the issue-trends in the nominated projects, and the chart is not shown but data is displayed in a table. 
[{IssueCountTrends trackerId='33,21' period='Last 13 weeks' grouping='weekly' display='both' cssStyle='background-color:#DEEFF6'}]
displays the issue trends in the trackers selected, both in a chart and in a table with a distinct background color, over the last 13 weeks, aggregated per calendar week. 
[{IssueCountTrends tag='enterprise' period='This Month'}]
displays the issue trends of the current month, computed from all trackers of the projects tagged with "enterprise". 
[{IssueCountTrends tag='funtional-req, nonfunctional-req, req' period='This year'}]
displays the issue trends of the current year, computed from all trackers in any project, that is accessible for the user and is tagged with at least one of the 3 listed tags.

Report Plugin 
[{Report id='9875'}]
executes report with the identifier 9875 and displays the issues retrieved by the report.

Tracker Item State History Plugin 
[{TrackerItemStateHistory id='1000' showHeader='true'}]
shows the state change history of a issue (bug, task, etc.), identified by its task-id.

Inside a comment of an issue page you can add this plugin without the "id" parameter, and the plugin will automatically show the state transitions of the current issue.
Parameters:

Personal Content

User Profile Plugin 
[{UserProfile}]
displays the user profile information of the current user. 
[{UserProfile id='12'}]
or 
[{UserProfile name='john.doe'}]
displays the same of another user account.

Project List Plugin

Plugin to display the complete list of projects accessible by the current user. 
[{ProjectList}]
The projects listed can filtered by using the following optional parameters:

Filtering rules:

In addition, the output format can be specified: format='name|brief|full'

Usage examples: 

[{ProjectList id='12,1'}]
displays the projects with identifiers 12 and 1. 
[{ProjectList name='Test.*' format='brief'}]
will display all projects with names starting with "Test" in brief format.

Tag Cloud Plugin 
[{TagCloud}]
displays the visual depiction of tags used to categorize content in this CodeBeamer instance. Legend: larger font means more popular, darker color means newer tags.

My Current Issues Plugin

This plugin displays the list of the issues assigned to the current user, and not in closed or resoved statuses. Issues are ordered by priority and last update time descending.

Parameters:

Note: only one or none of the paramters projectId, trackerId, versionId or tag can be used.

Samples: 

[{MyCurrentIssues}]
displays the open issues for me in the current project. 
[{MyCurrentIssues projectId='11,27'}]
displays the open issues in the those projects. 
[{MyCurrentIssues versionId='1396'}]
displays the open issues in that version. 
[{MyCurrentIssues tag='mysql,#runtime'}]
displays the open issues tagged with either public tag mysql or private tag runtime. Additionally, all open issues in projects or trackers tagged with one of those two tags will be included. 
[{MyCurrentIssues title='My Starred Issues' tag='#Starred'}]
displays your open starred issues.

My Issue Summary Plugin 
[{MyIssueSummary}]
displays a dashboard-like summary of your issues according to the specified filters.

Parameters:

Examples: 

[{MyIssueSummary show='Successful' onlyDirectUserItems='false'}]
displays a summary of all your successful issues (both open and closed). 
[{MyIssueSummary show='Open' onlyDirectUserItems='true'}]
displays a summary of all open (not closed or resolved) issues, that were submitted by you or are directly assigned to/supervised by you.

My Subscriptions Plugin 
[{MySubscriptions}]
displays the entities subscribed by the current user.

My Approvals Plugin

This plugin produces three listings:
  1. Lists the join requests to your projects which are awaiting your approval.
  2. Lists those wikis or documents which are awaiting your approval. By navigating to a wiki or document, you can either approve or reject its pending changes.
  3. Lists wikis or documents which you have modified and which are currently awaiting approval. The status of the document approval work-flow on each wiki or document is shown.

Parameters:

Example: 

[{MyApprovals allProjects='true'}]

Data Set Plugin

This plugin produces statistical information that can be either directly written to the page or visualized by chart plugins.

Parameters:

wikiVariable='<variable name>' (optional) is the name of the wiki variable to save the result to. If omitted then the output will be written directly to the wiki page.
data='<producer name>' identifies the dataset. This is the name of one of the producers detailed below with the following capitalization: 'commitTrend', 'documentAccessTrend', etc.
format='table or barChart or lineChart or timeSeriesChart or ganttChart or pieChart or multiplePieChart' specifies the output format. It defauls to 'table' and must be set to a different format if it will be passed to a chart plugin later.

Data Set Examples 
[{DataSet data='projectTrend' projectId='2' startDate='2008-8-28'}]
will display some basic figures of that project changing over time, as a regular wiki table.

[{DataSet data='documentAccessTrend' documentId='1009,1010' type='read' since='7'}]
will display document "read" accesses for documents 1009 and 1010, in the last 7 days. 
[{DataSet data='trackerItemHourTrend' format='table'}]
will display tracker item hours statistics in the current project as a regular wiki table. 
[{DataSet data='sourceCodeChangeTrend' since='15'}]
will display source code line counts changing over the last 15 days. 
[{DataSet data='trackerItemChangeTrend' startDate='2008-8-1' endDate='2008-8-31'}]
will display the number of newly created, updated and closed tracker items in that month. 
[{DataSet data='trackerItemsByLabel' label='versions'}]
will display the number of tracker items grouped by their version property.

Generating Charts from Data Sets

Using the special formatters it is possible to pipe the output of DataSet to Chart in order to draw diagrams instead of generating tabular data.
There must be a blank line between the Chart definition and the Dataset definition, otherwise a "no body text" error will result. 
[{TimeSeriesChart title='Downloads'

[{DataSet data='documentAccessTrend' documentId='1001,1002' type='read' since='10' format='timeSeriesChart'}]
}]
will show how many time documents 1001 and 1002 were downloaded - compared against each other. 
[{TimeSeriesChart title='Tracker Items'

[{DataSet projectId='1' data='trackerItemChangeTrend' format='timeSeriesChart' since='7'}]
}]
will display the tracker item counts for the last 7 days as a time series chart diagram. 
[{DataSet wikiVariable='myvar' format='timeSeriesChart' projectId='1' data='trackerItemChangeTrend' since='7'}]

[{TimeSeriesChart title='Tracker Items'

{$myvar}
}]
will do the same using a temporary wiki variable myvar. 
[{PieChart title='Open Tracker Items by Severity' legend='false'

[{DataSet data='trackerItemsByLabel' label='severities' format='pieChart'}]
}]
will show the distribution of open tracker items by severity. 
[{TimeSeriesChart title='Subversion Activity' legend='false'

[{DataSet data='commitTrend' since='15' format='timeSeriesChart'}]
}]
will display show the number of commits changing over time. 
[{TimeSeriesChart title='Bugs Per Source' legend='false'

[{DataSet data='trackerItemsPerSourceTrend' trackerId='2,3' format='timeSeriesChart'}]
}]
will display the evolution of the number of tracker items in the given trackers and source code size. 
[{GanttChartPlugin title='Project Plan' legend='false'

[{DataSet data='ganttActivities' projectId='1' format='ganttChart'}]
}]
will display the project schedule of that project.

Common Parameters

The following parameters are supported by several producers detailed below:
projectId='<project-id>' (optional) must be specified when using outside any project context. Defaults to the enclosing project.
since='<number-of-days>' (optional) is the number of the recent days that define the period. If specified, then both startDate and endDate will be ignored.
startDate='<date>' (optional) is the period start date in 'YYYY-MM-DD' format. Defaults to the project creation date.
endDate='<date>' (optional) is the period end date in 'YYYY-MM-DD' format. Defaults to the current date.

Commit Trend Producer

Examples: 
[{DataSet data='commitTrend' since='7'}]

[{TimeSeriesChart title='Commits' legend='false' width='400' height='150' seriespaint='green'

[{DataSet data='commitTrend' since='7' format='timeSeriesChart'}]
}]
Parameters:
projectId (optional) see "Common Parameters" section above.
groupByUser (optional) boolean, whether to group counts by user name. Defaults to false.
since (optional) see "Common Parameters" section above.
startDate (optional) see "Common Parameters" section above.
endDate (optional) see "Common Parameters" section above.

Document Access Trend Producer

Examples: 
[{DataSet data='documentAccessTrend' documentId='1000' type='write' since='5'}]

[{TimeSeriesChart title='Downloads'

[{DataSet data='documentAccessTrend' documentId='1001,1002' type='read' since='10' format='timeSeriesChart'}]
}]
Parameters:
documentId comma separated list of document or wiki page identifiers.
type (optional) one of "read", "write" or "readWrite". Defaults to "readWrite".
since (optional) see "Common Parameters" section above.
startDate (optional) see "Common Parameters" section above.
endDate (optional) see "Common Parameters" section above.

Gantt Activities Producer

Note: this producer is primarily meant to be used with the GanttChartPlugin and is collecting the tracker items from TASK type trackers only.
Examples: 
[{GanttChartPlugin title='Project Plan' legend='false'

[{DataSet data='ganttActivities' format='ganttChart'}]
}]
Parameters:
projectId (optional) see "Common Parameters" section above.

Gantt Labels Producer

Note: this producer is collecting the tracker items from TASK type trackers only.
Examples: 
[{DataSet data='ganttLabels' label='versions'}]

[{PieChart title='Tasks in Categories'

[{DataSet data='ganttLabels' label='categories' format='pieChart'}]
}]
Parameters:
projectId (optional) see "Common Parameters" section above.
label (optional) one of "categories", "severities", "resolutions", "platforms", "oses", "milestones" or "versions". Defaults to "categories".

Gantt Stats Producer

Note: this producer is collecting the tracker items from TASK type trackers only.
Examples: 
[{DataSet data='ganttStats'}]

[{PieChart title='Task Statistics'

[{DataSet data='ganttStats' format='pieChart'}]
}]
Parameters:
projectId (optional) see "Common Parameters" section above.

Gantt Statuses Producer

Note: this producer is collecting the tracker items from TASK type trackers only.
Examples: 
[{DataSet data='ganttStatuses'}]

[{PieChart title='Task Status Distribution'

[{DataSet data='ganttStatuses' format='pieChart'}]
}]
Parameters:
projectId (optional) see "Common Parameters" section above.

Modifications per Tracker Item Trend Producer

Note: this producer is collecting the tracker items from REQ type trackers only.
Examples: 
[{DataSet data='modificationsPerTrackerItemTrend'}]

[{TimeSeriesChart title='Requirement Evolution'

[{DataSet data='modificationsPerTrackerItemTrend' since='7' format='timeSeriesChart'}]
}]
Parameters:
projectId (optional) see "Common Parameters" section above.

Project Trend Producer

Examples: 
[{DataSet data='projectTrend'}]

[{TimeSeriesChart title='Project Metrics' width='600' height='250'

[{DataSet data='projectTrend' since='7' format='timeSeriesChart'}]
}]
Parameters:
projectId (optional) see "Common Parameters" section above.
since (optional) see "Common Parameters" section above.
startDate (optional) see "Common Parameters" section above.
endDate (optional) see "Common Parameters" section above.

Source Code Change Trend Producer

Examples: 
[{DataSet data='sourceCodeChangeTrend'}]

[{TimeSeriesChart title='Source Metrics'

[{DataSet data='sourceCodeChangeTrend' since='7' format='timeSeriesChart'}]
}]
Parameters:
projectId (optional) see "Common Parameters" section above.
since (optional) see "Common Parameters" section above.
startDate (optional) see "Common Parameters" section above.
endDate (optional) see "Common Parameters" section above.

Tracker Item Change Trend Producer

Examples: 
[{DataSet data='trackerItemChangeTrend'}]

[{TimeSeriesChart title='Issues'

[{DataSet data='trackerItemChangeTrend' since='7' format='timeSeriesChart'}]
}]
Parameters:
projectId (optional) see "Common Parameters" section above.
trackerId (optional) is the comma separated list of tracker identifier to include in the statistics. Defaults to all trackers of the enclosing project.
since (optional) see "Common Parameters" section above.
startDate (optional) see "Common Parameters" section above.
endDate (optional) see "Common Parameters" section above.

Tracker Item Hour Trend Producer

Examples: 
[{DataSet data='trackerItemHourTrend'}]

[{TimeSeriesChart title='Work Hours'

[{DataSet data='trackerItemHourTrend' since='5' format='timeSeriesChart'}]
}]
Parameters:
projectId (optional) see "Common Parameters" section above.
trackerId (optional) is the comma separated list of tracker identifier to include in the statistics. Defaults to all trackers of the enclosing project.
since (optional) see "Common Parameters" section above.
startDate (optional) see "Common Parameters" section above.
endDate (optional) see "Common Parameters" section above.

Tracker Items by Label Producer

Examples: 
[{DataSet data='trackerItemsByLabel' label='severities'}]

[{PieChart title='Bugs Per Operating System'

[{DataSet data='trackerItemsByLabel' label='oses' format='pieChart'}]
}]
Parameters:
projectId (optional) see "Common Parameters" section above.
trackerId (optional) is the comma separated list of tracker identifier to include in the statistics. Defaults to all trackers of the enclosing project.
label (optional) one of "status", "priority", "categories", "severities", "resolutions", "platforms", "oses", "milestones" or "versions". Defaults to "categories".

Tracker Items by Severity Producer

Examples: 
[{DataSet data='trackerItemsBySeverity' format='pieChart'}]

[{BarChart title='Known Issues By Severity'

[{DataSet data='trackerItemsBySeverity' format='barChart'}]
}]
Parameters:
projectId (optional) see "Common Parameters" section above.
trackerId (optional) is the comma separated list of tracker identifier to include in the statistics. Defaults to all trackers of the enclosing project.

Tracker Items by Status and Severity Producer

Examples: 
[{DataSet data='trackerItemsByStatusAndSeverity'}]

[{BarChart title='Known Issues By Status & Severity'

[{DataSet data='trackerItemsByStatusAndSeverity' format='barChart'}]
}]
Parameters:
projectId (optional) see "Common Parameters" section above.
trackerId (optional) is the comma separated list of tracker identifier to include in the statistics. Defaults to all trackers of the enclosing project.

Tracker Items per Source Trend Producer

Examples: 
[{DataSet data='trackerItemsPerSourceTrend'}]

[{TimeSeriesChart title='Bugs per Code Ratio'

[{DataSet data='trackerItemsPerSourceTrend' since='20' format='timeSeriesChart'}]
}]
Parameters:
projectId (optional) see "Common Parameters" section above.
trackerId (optional) is the comma separated list of tracker identifier to include in the statistics. Defaults to all trackers of the enclosing project.

Advanced

Best Content Plugin

This plugin produces a list of the highest rated entities. Optionally you can filter for a specific entity-type (for example only WIKIPAGE-es), also for entities in a specific project. Note that this plugin by default will only show entities from the current project if inserted on a project's wiki-page, and for all projects when inserted to an user's wiki page (which does not belong to any projects).

Parameters:

Examples of use: 


[{BestContentPlugin entityType='WIKIPAGE' title='Best Wiki pages'}]

[{BestContentPlugin entityType='FTC' title='Best Forum posts'}]

Best Forum Posts and Best Wiki Pages Plugins

These plugins provide the same functionality as the BestContent plugin, except for convenience they will provide only the appropriate entity types, without using the 'entityType' parameter.

Best Issues Plugin

The BestIssues plugin shows the voting summary for a set of issues, which is calculated as the total of "Yes" votes minus the total of "No" votes.

This plugin supports all parameters of the BestContent plugin, except the "entityType" (which is forced to be "ISSUE" for this plugin).

The BestIssues plugin additionally supports the following parameters:

Note: If both allowedStatuses and deniedStatuses is omitted, then they default to {allowedStatuses=null, deniedStatuses="Closed"}, so basically everything, but the "Closed" issues are shown.

Examples of use: 

[{BestIssues projectId='10' entityType='ISSUE' title='Best Issues in project #10'}]

[{BestIssues max='100' projectId='10' entityType='ISSUE' title='Top 100 best Issues in project #10' }]

[{BestIssues title='Top 10 best Issues overall, which are not "Closed"' }]

[{BestIssues title='Top 10 best Issues overall, which are not "Closed" or "Resolved"' deniedStatuses='Closed,Resolved' }]

[{BestIssues title='Top 10 best Issues, which are in the status of "Resolved"' allowedStatuses='Resolved'}]

Graphs

Basic

Horizontal Graph

[{ HorizontalGraph title='Uses'

(Action class[:color:red]
	(ProjectManager[Service layer][:color:#009900][:background:#DDFFDD]
		(ProjectDao[Persistence Layer][:color:#3C78B5][:background:#D8E4F1])
		(Security[ACL][:color:#3C78B5][:background:#D8E4F1])
	)
	(ArtifactManager[Service layer][:color:#009900][:background:#DDFFDD]
		(ArtifactDao[Persistence Layer][:color:#3C78B5][:background:#D8E4F1]
			(File System[:color:#777777][:background:#DDDDDD])
			(RDBMS[:color:#777777][:background:#DDDDDD])
		)
		(Security[ACL][:color:#3C78B5][:background:#D8E4F1])
	)
)
}]

Vertical Graph

[{ VerticalGraph title='Class Hierarchy'

(BaseDao[Each Dao must extend this][:color:red]
	(EntityDao[Persists entities][:color:#009900][:background:#DDFFDD]
		(ArtifactDao[:color:#3C78B5][:background:#D8E4F1]
			(Documents[:color:#777777][:background:#DDDDDD])
			(Wiki pages[:color:#777777][:background:#DDDDDD])
		)
		(ProjectDao[:color:#3C78B5][:background:#D8E4F1])
		(UserDao[:color:#3C78B5][:background:#D8E4F1])
	)
	(TemporalDao[Persists timestamped entities][:color:#009900][:background:#DDFFDD]
		(ArtifactSample[:color:#3C78B5][:background:#D8E4F1])
		(IssueSample[:color:#3C78B5][:background:#D8E4F1])
	)
)
}]

Directed Acyclic Graph

[{ DirectedAcyclicGraph title='Project Steps'

(
(Separate Tasks[:status:done][:color:#777777][:background:#DDDDDD])
(Develop Business Core[:depend:Separate Tasks][:color:red])
(Develop Web Frontend[:depend:Separate Tasks][:status:done][:color:#777777][:background:#DDDDDD])
(Deploy Components[:depend:Develop Business Core][:depend:Develop Web Frontend][:color:#009900][:background:#DDFFDD])
(Milestone[:depend:Develop Business Core][:date:2.14.2006])
)
}]

Explorer Graph

[{ ExplorerGraph title='Dependencies'

(My Project[:color:red]
	(Microkernel[POJO wiring][:color:#009900][:background:#DDFFDD]
		(Spring IoC[Lightweight container][:color:#3C78B5][:background:#D8E4F1])
	)
	(Persistence[RDBMS access][:color:#009900][:background:#DDFFDD]
		(Hibernate[ORM mapping][:color:#3C78B5][:background:#D8E4F1]
			(EHCache[Entity caching][:color:#777777][:background:#DDDDDD])
		)
		(Spring AOP[Templates and transactions][:color:#3C78B5][:background:#D8E4F1])
	)
)
}]

Mindmap

Mindmap

[{MindMapGraph title='New version'

(New version[:color:red]
	(New features[:color:#009900][:background:#DDFFDD]
		(RDBMS agnostic persistence[Vendor independence][:color:#3C78B5][:background:#D8E4F1]
			(Oracle support[:color:#777777])
			(PostgreSQL support[:color:#777777])
		)
		(JCR support[Java Content Repository][:color:#3C78B5][:background:#D8E4F1])
		(Portlet interface[:color:#3C78B5][:background:#D8E4F1])
	)
	(Enhanced features[:color:#009900][:background:#DDFFDD]
		(Reporting[:color:#3C78B5][:background:#D8E4F1]
			(Visuals[Charts and graphs][:color:#777777])
			(Performance improvements[:color:#777777])
		)
	)
)
}]

More Examples

See more examples at the ImageGen plugin website.

Charts

Basic

Gantt Chart

[{ GanttChart title='Development Project Plan' yaxislabel='Phases'

:Name|String, Start|Month, End|Month, Percentage
Coding
* 'Design', 3-2006, 4-2006, 0.7
* 'Implementation', 4-2006, 6-2006, 0

Testing
* 'Test case planning', 4-2006, 5-2006, 1.0

Coding
* 'Integration testing', 5-2006, 6-2006, 0.1

Testing
* 'Test execution', 6-2006, 8-2006, 0
}]

Pie Chart

[{ PieChart title='Unit tests' threed='true'

Successful, 22
Failure, 13
Error, 2
}]

Polar Chart

[{ PolarChart title='Database Performance Comparison'

MySQL
* 60, 290
* 23, -120
* -45, 90

PostgreSQL
* -10, 200
* -12, -30
* 13, 140
}]

Scatter Plot Chart

[{ ScatterPlotChart title='System downtime'

Accounting
* 10, 20
* 22, 30
* 33, 45

Reporting
* 60, 10
* 23, 42
* 45, 29
}]

Stacked Area Chart

[{ StackedXYAreaChart title='Issues Over Time' legend='true'

:Date|Day|MM/dd/yyyy,Blocking,Critical,Minor,Cosmetic
03/22/2006,9,17,13,16
03/23/2006,4,8,14,19
03/24/2006,7,11,11,12
03/25/2006,5,6,11,6
03/28/2006,0,1,6,3
}]

Time Series Chart

[{ TimeSeriesChart title='Contributors Over Time'

Programmers
* 10/7/2006, 22
* 12/6/2006, 30
* 11/1/2006, 49

Managers
* 10/9/2006, 2
* 12/13/2006, 4
* 11/8/2006, 2

Testers
* 10/3/2006, 3
* 12/22/2006, 8
* 11/7/2006, 12
}]

Area Chart

[{ XYAreaChart title='Commits By Team'

Team A
* 10, 20
* 12, 30
* 13, 45
* 40, 10

Team B
* 60, 10
* 23, 12
* 45, 50
}]

Line Chart

[{ XYLineChart title='System Response Time'

Queries
* 10, 20
* 20, 30
* 30, 45

Report Generator
* 10, 40
* 20, 20
* 30, 10
}]

Step Area Chart

[{ XYStepAreaChart title='Lines-of-Code Over Weeks'

LOC
* 1, 7545
* 2, 8987
* 3, 7788
* 4, 8544
* 5, 10344
}]

Bar Chart

[{ BarChart title='Number-of-classes By Package' threed=true orientation=horizontal

:Package|String, Classes
persistence, 32
remoting, 16
utils, 23
}]

Stacked Bar Chart

[{ StackedBarChart title='Issues By Version' seriespaint='red,orange,green' threed=true orientation=horizontal

:Version|String, 0.7-pre, 0.9-rc1, 1.0-final
Fatal, 10, 6, 1
Major, 23, 11, 4
Minor, 15, 3, 6
}]

Waterfall Chart

[{ WaterfallChart title='Timeframes'

:Phase|String, Requirements Capture, Analysis, Design, Implementation, Testing, Total
Manweeks, 1, 2, 4, 3, 2, 13
}]

Multiple Pie Chart

[{ MultiplePieChart title='Number of classes' legend='false' height=400

:Country|String, V1, V2, V3
Abstract, 7, 7, 4
Interface, 5, 9, 3
Concrete, 15, 26, 22
}]

Bubble Chart

[{ BubbleChart title='Bubble Chart' seriespaint='red,orange'

Norway, 10, 10
*3, 4, 2
*4, 5, 2.5
*5, 6, 2.7

France, 15, 15
* 1, 14, 5
* 3, 12, 7
* 2, 11, 8
}]

Spider Web Chart

[{ SpiderWebChart title='Radar Plot' direction='clockwise' webfilled='true'
	headpercent='0.02' axislabelgap='0.1' interiorgap='0.2'

:Country|String, Value, Angle, Height, Weight, Coverage
Italy, 10, 10, 40, 30, 50
Norway, 20, 50, 3, 66, 76
France, 15, 100, 20, 56, 100

}]

More Examples

See more examples at the ImageGen plugin website.

Miscellaneous

Miscellaneous Plugins

Excel Spreadsheet Plugin 
[{Excel id='1067'}]
displays the content of the Microsoft Excel spreadsheet having the identifier 1067.

Alternatively, you can use one of the following snippets, if your spreadsheet is not stored in the Document Manager, but is attached to a wiki page: 
[{Excel src='175'}]
[{Excel src='calculations.xls'}]
[{Excel src='Another page/calculations.xls'}]
You can identify the file by its attachment ID, filename (if it's attached to the current page) or page name and filename (if it's attached to another page). 
[{Excel src='http://www.mysite.com/files/calculations.xls'}]
will display the spreadsheet from the given URL.

The optional parameter sheet can contain the name of a sheet. If not given all sheets will be processed.

Shockwave (SWF) Plugin

Embeds an SWF file into a wiki page. Examples: 
[{Flash src='!12!'}]
[{Flash src='!mygame.swf!' controls='false'}]
[{Flash src='!/1034!' parameters='param1=value1&param2=value2'}]
[{Flash src='!/mydir/mygame.swf!'}]
See more examples at the a Flash plugin website.

Image Button Plugin

Creates an elegant visual element that is ideal for highlighting important information:

News
Announcement
Text comes here, after leaving a blank line.
This text is wiki markup, so you can use all the formatting features here.
 
 
 

[{ImageButton link='http://www.intland.com' icon='News' title='Announcement' width='50%'

Text comes here, after __leaving a blank line__.\\
This text is ''wiki markup'', so you can use all the formatting features here.
}]
All parameters are optional.

Google Maps Plugin

Embeds Google Maps into a wiki page. 
[{GoogleMaps lat='48.738142' lng='9.111185' zoom='17'}]
will show you the exact location of the Intland Software headquaters.

See more examples with markers and lines at the Google Maps plugin website.

Note: this plugin requires to obtain an API key from Google Maps.
Add the API key as a new property jspwiki.Google.maps.key=... to the WEB-INF/classes/googlemap.properties configuration file.

CodeBeamer-specific extension:

In that case the lat, lng and zoom parameters will be ignored. Instead of that, a correct pan/zoom will be applied to make all of markers visible.
If used outside of any project context, then the projectId parameter must be specified.

Feed Plugin

Includes content feeds (of any version of RSS and Atom) in a wiki page. 
[{Feed url='http://slashdot.org/index.rss' feedDetails='true'}]
will display the latest news from Slashdot and the details about the feed itself. 
[{Feed url='http://feeds.feedburner.com/Techcrunch' entryDetails='true' max='5'}]
will display the 5 latest news with their details.

Color Code Plugin

Plugin that renders the body text as colorized source code. 
[{ColorCode syntax='sql'

select count(*) from dual

}]

Parameters:
syntax='sql | c | java | vm'.

See more details on plugin's home page http://jspwiki.org/wiki/ColorCodePlugin_page.

Visio Plugin

Plugin that renders visio file. Microsoft Visio Viewer 2003 Control must be installed. 
[{Visio id='1004'}]

Parameters:

Include Plugin

Plugin includes wiki markup. An included document can include others. 
[{Include id='1004'}]
Parameters:

HTML Plugin 
[{Html

<b>bold</b> normal <em>italic</em>
}]

displays bold normal italic. 

[{Html id='2124'}]
displays the content of the html document having the identifier 2124.

Alternatively, you can use one of the following snippets, if your markup is not stored in the Document Manager, but is attached to a wiki page: 

[{Html src='175'}]
[{Html src='markup.html'}]
[{Html src='Another page/markup.html'}]

Emoticons

Signs Emotions
(/) (/) :) :) (doh) (doh)
(x) (x) :( :( (devil) (devil)
(!) (!) ;) ;) (angel) (angel)
(+) (+) :D :D (rotfl) (rotfl)
(-) (-) :O :O
(?) (?) :P :P
(y) (y) B) B)
(n) (n) :@ :@
(*) (*) |) |)
(heart) (heart) :* :*

(For each smiley, you can write the longer version :-) instead of :) if you prefer :).