Basic formatting

Writing text

----         = Make a horizontal ruler. Extra '-' is ignored.
\\           = Force a line break, \\\=force line break and clear.
// comment   = markup comment line (nothing is rendered)
[link]       = Creates a hyperlink to an internal wiki page called 'link'.
[alias|link] = Creates a hyperlink to an internal wiki page 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]'.
~[link~]     = Creates text '[link]' by escaping the square brackets with the tilde character.
!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'

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.

Hyperlinks

Preformatted 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.

Quotes

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.

Comments

A 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.''

Comment here.

Pictures

External pictures

You can embed external pictures by using the following markup:

[http://www.intland.com/images/intland_01.gif]

You can also assign a URL to the inline picture:

[http://www.intland.com|http://www.intland.com/images/intland_01.gif]

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.

Image plugin supports following parameters:

• src The image's url (src attribute) for fetching images outside of codebeamer or from static urls
• wiki The wiki markup points to the image. Especially useful if you want to reference an image which is attached to the current wiki page or issue.
  Just use wiki="[!apple.jpg!]" parameter to add the "apple.jpg" image that is attached to the current wiki page or issue.
• width The width of the image. Allows you to resize images manually. The same resizing is easily performed in wysiwyg editor by dragging the image's corners and resizing it using the mouse.
• height The height of the image
• ...any... Any other attributes is passed to the image html tag, so you can add css styling, borders or similar to images using this

Pictures from page- and issue attachments

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

[!mypic.jpg!]

[!mypic.jpg#1!]

[!My favourite page/mypic.jpg!]

[![ISSUE:4711]/attachment.gif!]

[!28!]

[http://www.intland.com|!mypic.jpg!]
[http://www.intland.com|!My favourite page/mypic.jpg!]
[http://www.intland.com|!28!]

[BUG:1000|!mypic.jpg!]
[PROJ:1|!My favourite page/mypic.jpg!]
[DOC:1000|!28!]

Pictures from "Documents"

[!/My pictures/Buttons/button.gif!]

[!/1723!]

[!/My pictures/Buttons/button.gif#2!]
[!/1723#2!]

[http://www.intland.com|!/My pictures/Buttons/button.gif!]
[http://www.intland.com|!/1723!]

Lists

Bulleted lists

* One
* Two
* Three
** Three.One

Creates:

• One
• Two
• Three
  • Three.One

Numbered lists

# 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.

• This is a single-line item.
• This is actually a multi-line item.

• The third line is again a single-line item for your convinience.

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

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

%%red
This is red text.%%

Styles for the following colors are pre-defined:

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

Custom text styles

You can also define almost any CSS style command:

%%( font-size: 150%; color: green; )
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

Video box

%%videobox You may find a tutorial video in the Knowledge Base. %%

You may find a tutorial video in the Knowledge Base.

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
%%

Comment box

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

%%commentbox
__Hi there!__
%%

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.
%%
%%

Collapsable lists

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

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

Advanced tables

Table Plugin

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

• merge cells horizontally and/or vertically (i.e. colspan and rowspan)
• auto-numbering of rows
• multi-line table markup to ease the entry of large or complex table cells, including nested tables
• additional formatting for odd/even rows, headers, etc.
  

[{Table
|Nr |A |< |C |<
|#  |a |b |c |(background:yellow;)d
|#  |^ |b |^ |(background:yellow;)d
}]

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

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

See more details on the plugin's home page.

Zebra striped 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
%%

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
%%

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
%%

Interwiki links

Basic link types

[PROJ:37]

[WIKIPAGE:1037]

[WIKIPAGE:1037/HEAD]

[WIKIPAGE:1037/17]

[WIKIPAGE:1037#My favourite paragraph]

[WIKIPAGE:1037/HEAD#My favourite paragraph]

[WIKIPAGE:1037/17#My favourite paragraph]

[DIR:1320]

[DOC:2798]

[TAG:2798]

[DOC:2798/HEAD]

[DOC:2798/23]

[NOTES:2860]

[TRACKER:91]

[ISSUE:567]

[REPORT:965]

[FORUM:98]

[FTC:1007]

[BUILD:435]

[BUILDLOG:671]

[SRC:3564]

[USER:1]

[USER:bond]

Link stereotypes

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

An interwiki link stereotype defines:

• whether a hyperlink to the target object should be rendered, and what should be the hyperlink text.
• whether a link popup/tooltip should be rendered, and what should be the popup/tooltip text.
• whether additional object attributes (e.g. status, description, etc.) should be rendered in a body section below the hyperlink.

[<<stereotype>>|ISSUE:XXX]

[<<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>

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

<description>
   <link></link>
   <popup></popup>
   <body>description</body>
</description>

[<<description>>|ISSUE:124]

Page specific stereotypes

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

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

[{SET <<special>> = status, namedPriority}]
[<<special>>|ISSUE:123]

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
}]

Tag Cloud Plugin

[{TagCloud}]

Project content

Project List Plugin

[{ProjectList}]

• id='<comma-separated list of project ids>'
• name='<regexp>'
• category='<regexp>'

Filtering rules:

• If the id parameter is specified, then name and category will be ignored.
• name and category filters can be used together and their result sets will be joined by OR.

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

• name: "name" is the visible only column (default)
• brief: "name", "members" and "created"
• full: most details

Usage examples:

[{ProjectList id='12,1'}]

[{ProjectList name='Test.*' format='brief'}]

Project Info Plugin

[{ProjectInfo}]

[{ProjectInfo projectId='2'}]

[{ProjectInfo projectId='2' description='true'}]

Members Plugin

[{Members}]

[{Members projectId='2'}]

Tracker List Plugin

[{TrackerList}]

[{TrackerList projectId='2'}]

[{TrackerList items='work'}]

[{TrackerList items='configuration'}]

[{TrackerList items='both'}]

[{TrackerList sorting='name'}]

[{TrackerList sorting='key'}]

[{TrackerList sorting='lastmodified'}]

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'}]

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'}]

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}]

[{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'}]

[{ActivityStream tag='customer, client' title='Recently in the Customer Projects' max='30'}]

Artifact Activity Trends Plugin

[{ArtifactActivityTrends artifactId='1000'}]

[{ArtifactActivityTrends artifactId='1000,1002' display='table'}]

[{ArtifactActivityTrends title='Updates on MySql' tag='mysql, rdbms' activity='update' period='Past 30 days' display='both' cssStyle='background-color:#DEEFF6'}]

Artifact Count Trends Plugin

[{ArtifactCountTrends}]

[{ArtifactCountTrends projectId='11,27' type='document' display='table'}]

[{ArtifactCountTrends title='Knowledge Base Size' tag='knowledge-base, kb' period='Past 30 days' display='both' cssStyle='background-color:#DEEFF6'}]

Issue Count Trends Plugin

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:

• projectId='1,33' Optional parameter specifies the comma separated ids of those projects to collect issue-trends from.
• trackerId='44,55' Optional parameter specifies the comma sepeated ids of those trackers to collect issue-trends from. Note: either "projectId" or "trackerId" paramter can be used, but not both!
• period='[{Past|Last|This}] [x] {day|week|month|quarter|year}[s]' Optional parameter defaults to 'Past 7 days'. Specifies the chart/reporting period in a number of last/past calendar days, weeks, months, quarters or years. The period is always relative to the current date, and is either the current day/week/month/quarter/year (e.g. 'This month'), or spans the specified number of days/weeks/months/quarters/years, either directly before (e.g. 'Past 7 days') or including (ending with) the current day/week/month/quarter/year (e.g. 'Last 6 weeks').
• grouping='daily|weekly|monthly' Optional parameter -defaults to 'daily'. Specifies how the data is aggregated within the period. For example when the 'weekly' grouping is selected that means that issues created over any week during the period are added up, and this total number is displayed for the whole week.

Appearance parameters:

• display ='chart|table|both' Optional parameter, defaults to 'chart'. Specifies whether the chart image and the data table is displayed.
• title='any-text' Optional parameter, the title text displayed above the chart/data-table.
• tooltip='any-text' Optional parameter, the tooltip information displayed as a little tooltip when the mouse hovers over the chart image.
• width='400' Optional, the width of the chart in pixels. Defaults to 400 pixel.
• height='200' Optional, the height of the chart in pixels. Defaults to 200 pixel.
• cssClass='class-name' Optional, CSS class to apply to the box that encloses the chart and the table.
• cssStyle='css-rules' Optional, CSS style to modify the appearance of the box that encloses the chart and the table.

Samples:

[{IssueCountTrends}]

[{IssueCountTrends projectId='11,27' display='table'}]

[{IssueCountTrends trackerId='33,21' period='Last 13 weeks' grouping='weekly' display='both' cssStyle='background-color:#DEEFF6'}]

[{IssueCountTrends tag='enterprise' period='This Month'}]

[{IssueCountTrends tag='funtional-req, nonfunctional-req, req' period='This year'}]

Issue Count By Field Plugin

[{IssueCountByField}]

[{IssueCountByField projectId='11,27' display='table'}]

[{IssueCountByField trackerId='81,85' title='Bugs by Priority' field='priority' display='both'}]

[{IssueCountByField tag='java,mysql,acme-corp' title='Acme Corp. Issues' display='both' cssStyle='background-color:#DEEFF6'}]

Release Activity Trends Plugin

Release Activity Trends plugin displays the list of the available releases and sprints of the current project in a tree map with the number of the containing items and optionally a burn down chart per release/sprint.

Parameters:

• title='any-text' Optional parameter to override the default title (Release Activity Trends)
• projectId='3' Optional parameter specifies the project (if omitted and plugin is in project context, the current project will be used, error thrown otherwise)
• releaseStatus='Unreleased|Released|All' Optional parameter specifies the displaying release/sprint status (default: 'Unreleased')
• trackerItemStatus='Unresolved|Resolved|All' Optional parameter specifies the number of items per release/sprint (default: 'Unresolved')
• showUnscheduledItems='true|false' Optional parameter specifies if unscheduled items will be shown or not below the releases/sprints (default: 'false')
• showBurnDownChart='true|false' Optional parameter specifies if a burn down chart per release/sprint will be shown or not (default: 'true')
• showDropdownFilters='true|false' Optional parameter, if true two dropdowns will be shown in the plugin header to be able to select/change the desired release status and tracker item status (default: 'true').

Samples:

[{ReleaseActivityTrends}]

[{ReleaseActivityTrends title='Project (3) Releases' projectId='3'}]

[{ReleaseActivityTrends showUnscheduledItems='true' showBurnDownChart='false' trackerItemStatus='Resolved'}]

[{ReleaseActivityTrends showDropdownFilters='false'}]

Risk Matrix Diagram Plugin

Risk Matrix Diagram Plugin shows the number of requirement/risk items according to the related risk(s) likelihood and severity values. The plugin draws a matrix, the Y axis is the Likelihood values, the X axis is the Severity values, both are configured in a custom choice field in the Risk tracker (Likelihood intervals field, Severity intervals field). Furthermore you can configure also the background colors of the matrix cells in the Risk tracker configuration page, below the Risk management tab. Note that this plugin works properly only if the used risk tracker has proper field configuration!

Parameters:

• trackedId='12345' Tracker ID, can be a requirement or a risk type tracker.
• trackerKey='REQ' Tracker key (can be used instead of trackerId parameter), can be a requirement or a risk type tracker.
• riskTrackerId='12346' Optional parameter, you can filter the result by this risk type tracker ID.
• riskTrackerKey='RISK' Optional parameter, you can filter the result by this risk type tracker key (can be used instead of riskTrackerID parameter).
• reduction='before|after|afterthenbefore' Optional parameter, shows which likelihood and severity values of the related risk items will be used counting the requirement items. If omitted, default 'before' value will be used.
• countBasedOn='requirement|risk' Optional parameter, shows the item counts based on requirements or risks. If omitted, default 'requirement' value will be used.
• title='any-text' Optional parameter, if omitted title does not appear

Samples:

[{RiskMatrixDiagram trackerId='12345'}]

[{RiskMatrixDiagram title='Risk Matrix Diagram' trackerId='12345'}]

[{RiskMatrixDiagram trackerId='12346' riskTrackerId='123456' reduction='after'}]

Resourcing Extraction Plugin

Resourcing Extraction Plugin shows the open tracker items (and their story points) group by projects and assigned members (user groups).

Parameters:

• projectIds='12345,12346' Comma separated list of project IDs (or one project ID). Required if plugin is used outside project, if plugin is used in project context, it can be omitted and the current project will be used.
• displayGroups='true|false' If true, members will group by user groups. Default: false
• groupIds='123,124' You can filter displaying user groups, comma separated list of group IDs. Default: all user groups
• fromDate='2015-01-01' toDate='2015-02-01' You can filter the tracker items by date (Start date and End date fields of the tracker items), ISO date format is required. If you use this date filtering, tracker items with empty Start/End date fields will not be displayed in the result table. Default: no date filtering.

Samples:

[{ResourcingExtraction}]

[{ResourcingExtraction projectIds='12345,12346' displayGroups='true'}]

[{ResourcingExtraction projectIds='12345,12346' displayGroups='true' groupIds='123,124'}]

[{ResourcingExtraction projectIds='12345,12346' fromDate='2015-01-01' toDate='2015-02-01'}]

Reporting

Report Plugin

[{Report id='9875'}]

Tracker Item State History Plugin

[{TrackerItemStateHistory id='1000' showHeader='true'}]

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:

• id='1000' Required (except on an issue page) parameter should contain the numerical id of the related issue.
• showHeader='true' Optional boolean parameter determines if the header information about the issue is shown. Defaults to true.

Source Code

Source Code Summary Plugin

Parameters:

• projectId='integer' Optional parameter, single number for the project's id. If missing then plugin will show the data for the current project.

Appearance parameters:

• title='any-text' Optional parameter, the title text displayed above the chart/data-table.
• tooltip='any-text' Optional parameter, the tooltip information displayed as a little tooltip when the mouse hovers over the table.
• cssClass='class-name' Optional, CSS class to apply to the box that encloses the chart and the table.
• cssStyle='css-rules' Optional, CSS style to modify the appearance of the box that encloses the chart and the table.

Samples:

[{SourceCodeSummary}]

[{SourceCodeSummary projectId='2'}]

Commit Statistics Plugin

[{CommitStatistics}]

[{CommitStatistics detailed='true'}]

[{CommitStatistics repositoryId='2,133' layout='column'}]

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:

• repositoryId='1,33' Optional parameter specifies the comma separated ids of those repositories to collect commits from. If missing then data for all repositories of the current project are displayed.
• projectId='1' Optional parameter specifies the that project where the repositories are displayed from. This is ignored if the repositoryId parameter is specified.
• period='[{Past|Last|This}] [x] {day|week|month|quarter|year}[s]' Optional parameter defaults to 'Past 7 days'. Specifies the chart/reporting period in a number of last/past calendar days, weeks, months, quarters or years. The period is always relative to the current date, and is either the current day/week/month/quarter/year (e.g. 'This month'), or spans the specified number of days/weeks/months/quarters/years, either directly before (e.g. 'Past 7 days') or including (ending with) the current day/week/month/quarter/year (e.g. 'Last 6 weeks').
• grouping='daily|weekly|monthly' Optional parameter -defaults to 'daily'. Specifies how the data is aggregated within the period. For example when the 'weekly' grouping is selected that means that issues created over any week during the period are added up, and this total number is displayed for the whole week.

Appearance parameters:

• display ='chart|table|both' Optional parameter, defaults to 'chart'. Specifies whether the chart image and the data table is displayed.
• title='any-text' Optional parameter, the title text displayed above the chart/data-table.
• tooltip='any-text' Optional parameter, the tooltip information displayed as a little tooltip when the mouse hovers over the chart image.
• width='400' Optional, the width of the chart in pixels. Defaults to 400 pixel.
• height='200' Optional, the height of the chart in pixels. Defaults to 200 pixel.
• cssClass='class-name' Optional, CSS class to apply to the box that encloses the chart and the table.
• cssStyle='css-rules' Optional, CSS style to modify the appearance of the box that encloses the chart and the table.

Samples:

[{CommitTrends}]

[{CommitTrends repositoryId='4,5' period='This year' grouping='Weekly' title='This years commits weekly' display='both'}]

Committed Issues Plugin

Parameters:

Data-collection parameters:

• repositoryId='1' Required parameter. Specifies the comma separated ids of the repositories.
• max='20' The plugin displays the most recently committed issues on top, and only displays the a limited number of issues (only the latest 20 by default). The maximum number of issues displayed can be specified by the max parameter.
• startDate='2011-06-21 11:00' endDate='2011-06-21 12:00' Filters the committed issues for those issues only where there were commits within that period
• startRevision='rev12' endRevision='rev33' Filters the committed issues for those issues only where there were commits within that revision ids. Either start or end revision can be omitted. If both start/end date and start/end revisions are provided then their common range (intersection) is displayed.
• branchOrTag='branch-name' Show only issues had commits on the specified branch or with the specified tag.

Appearance parameters:

• title='any-text' Optional parameter, the title text displayed above the chart/data-table.
• cssClass='class-name' Optional, CSS class to apply to the box that encloses the html markup
• cssStyle='css-rules' Optional, CSS style to modify the appearance of the box that encloses the html markup.

Samples:

[{CommittedIssues}]

[{CommitTrends repositoryId='4,5' title='Committed issues in repository A and B' display='both'}]

Version Control

Pull Requests Plugin

This plugin lists the pull requests sent by you or sent to you and pending. You can filter the list by projects or by repositories. By default all repositories you have access to contribute to the list.

Parameters:

• projectId='15,23' Optional parameter. Specifies the comma separated ids of the projects from which pull requests to be included. All repositories of those projects contribute to the list.
• repositoryId='47,66,82' Optional parameter. Specifies the comma sepeated ids of the repositories from which pull requests to be included.

Requirements Management

Requirement Coverage Plugin

This plugin shows a histogram based on the coverage of some requirements. The length of the bars tell that how many requirements are covered by a given number of test cases. the most important piece of data is the bar at the zero point since this shows the number of requirements that are not covered at all.

Parameters:

• id='1' Optional parameter (required only when you're using the plugin on a personal wiki page). Specifies the id of the project from which the coverage data is collected.
• trackerId='1001,1002' Optional parameter. Specifies the comma sepeated ids of those requirement trackers to collect requirement coverage data from
• display ='chart|table|both' Optional parameter, defaults to 'chart'. Specifies whether the chart image and the data table is displayed.

Samples:

[{RequirementCoverage}]

[{RequirementCoverage id='1'}]

[{RequirementCoverage trackerId='1001,1002'}]

Test Management

Test Cases by Last Run Result Plugin

This plugin shows a pie chart created from the results of the latest runs of some test cases. The chart may have one section for each possible result (passed, failed, blocked or not run). The plugin also has two filters: you can filter the test runs by test configuration and release.

Parameters:

• id='1' Optional parameter (required only when you're using the plugin on a personal wiki page). Specifies the id of the project to collect the test runs from.
• trackerId='1001,1002' Optional parameter. Specifies the comma sepeated ids of those test case trackers to collect the data from.
• display ='chart|table|both' Optional parameter, defaults to 'chart'. Specifies whether the chart image and the data table is displayed.

Samples:

[{TestCasesByLastRunResult}]

Test Runs by Configuration Plugin

Shows a chart based on all test runs in a project. The chart contains a bar for each test configuration. The bars show the distribution of the test run results on that given configuration.

Parameters:

• id='1' Optional parameter (required only when you're using the plugin on a personal wiki page). Specifies the id of the project to collect the test runs from.
• display ='chart|table|both' Optional parameter, defaults to 'chart'. Specifies whether the chart image and the data table is displayed.

Samples:

[{TestRunsByConfiguration}]

Test Runs by Test Set Plugin

Shows a chart based on all test runs in a project or some test run trackers. The chart contains a bar for each test set. The bars show the distribution of the test run results of the runs of that given test set.

Parameters:

• id='1' Optional parameter (required only when you're using the plugin on a personal wiki page). Specifies the id of the project to collect the test runs from.
• trackerId='1001,1002' Optional parameter. Specifies the comma sepeated ids of those test set trackers to collect the data from.
• display ='chart|table|both' Optional parameter, defaults to 'chart'. Specifies whether the chart image and the data table is displayed.

Samples:

[{TestRunsByTestSet}]

Test Runs by Assignee Plugin

Parameters:

• id='1' Optional parameter (required only when you're using the plugin on a personal wiki page). Specifies the id of the project to collect the test runs from.
• trackerId='1001,1002' Optional parameter. Specifies the comma sepeated ids of those test set trackers to collect the data from.
• display ='chart|table|both' Optional parameter, defaults to 'chart'. Specifies whether the chart image and the data table is displayed.

Samples:

[{TestRunsByAssignee}]

Personal content

User Profile Plugin

[{UserProfile}]

[{UserProfile id='12'}]

[{UserProfile name='john.doe'}]

My Issue Summary Plugin

[{MyIssueSummary}]

Parameters:

• title='<text>': (optional) Plugin title if you want to override the default one.
• show='{Any status|Open|Closed|Resolved|Successful|Unresolved|Unsuccessful}>': (optional, defaults to 'Unresolved') Filter the issues to include in the summary.
• onlyDirectUserItems='true|false': (optional, defaults to 'true') Whether to show only the issues directly assigned to/supervised by the user.
• showNewIssue='true|false': (optional, defaults to 'false') Whether to show a convenience link under the table, to ease submitting new issues.

Examples:

[{MyIssueSummary show='Successful' onlyDirectUserItems='false'}]

[{MyIssueSummary show='Open' onlyDirectUserItems='true'}]

My Current Issues Plugin

Parameters:

• title='My Linux Issues': Optional parameter to override the default title.
• projectId='1,33': Optional parameter specifies the comma separated ids of the projects to collect issues from.
• trackerId='44,55': Optional parameter specifies the comma separated ids of the trackers to collect issues from.
• releaseId='1245,5389': Optional parameter specifies the comma separated ids of the releases/sprints to collect issues from.
• tag='mysql,#runtime': Optional parameter specifies what tags the issues, their enclosing projects or their trackers should be tagged with. (Only the issues tagged with these, and not resolved or closed will be included in the result list.) Hint: use "#Starred" to get your starred issues.
• onlyIssuesAssignedToMe='true|false': Optional boolean parameter. If set to true or false then only those issues are displayed which assigned to (or false-> not assigned to) the current user. If the "tag" paramter is present then this defaults to "false", so will show all issues regardless of the assigned-to status.

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

Samples:

[{MyCurrentIssues}]

[{MyCurrentIssues projectId='11,27'}]

[{MyCurrentIssues releaseId='1396'}]

[{MyCurrentIssues tag='mysql,#runtime'}]

[{MyCurrentIssues title='My Starred Issues' tag='#Starred'}]

My Subscriptions Plugin

[{MySubscriptions}]

Agile Content

Agile plugins work both with releases and sprints (if you are working agile), or releases and sub-releases (if you are not). You can pass the ID of the release, sprint or sub-release using the releaseId parameter. If the corresponding release or sprint has children (further sprints, sub-releases, sub-sprints), then all of the issues addressed in the children will be recursively processed by these plugins.

Burn Down Chart Plugin

[{BurnDownChart releaseId='1000' showBurnDown='false' showVelocity='false' showNew='false'}]

Parameters:

• releaseId='1000' (optional) ID of the sprint. When omitted, the plugin makes an attempt to guess the active sprint.
• showBurnDown='false' (optional) Whether to display the burn down line. Defaults to true.
• showVelocity='false' (optional) Whether to display the velocity (the number of issues burnt) for each day. Defaults to false.
• showNew='false' (optional) Whether to display the number of issues added to the sprint for each day. Defaults to false.

Bubble Visualization Plugin

[{BubbleVisualization}]

Velocity Trends Plugin

[{VelocityTrends releaseId='1000'}]

Parameters:

• releaseId='1000' (optional) ID of the sprint. When omitted, the plugin makes an attempt to guess the active sprint.

Sprint Break Down Plugin

[{SprintBreakDown releaseId='1000'}]

Parameters:

• releaseId='1000' (optional) ID of the sprint. When omitted, the plugin makes an attempt to guess the active sprint.

Current Velocity Plugin

[{CurrentVelocity releaseId='1000'}]

Parameters:

• releaseId='1000' (optional) ID of the sprint. When omitted, the plugin makes an attempt to guess the active sprint.

Remaining Time Plugin

[{RemainingTime releaseId='1000'}]

Parameters:

• releaseId='1000' (optional) ID of the sprint. When omitted, the plugin makes an attempt to guess the active sprint.

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

[{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
}]

Dynamic Gantt Chart

Dynamic Gantt plugin is a new and more flexible tool to visualize Gantt charts in a wiki page. It can display tasks represented by horizontal bars and optionally links between them to express their logical relations.

There are two ways to feed data to the plugin. Both of them require that you provide the data in the plugin body.

Simple method: Wiki table format

You must specify the tasks and optionally the links by using the familiar wiki syntax for table data. The advantage of this method is its simplicity, but you can not use all the advanced features of the underlying Gantt component.

[{DynamicGantt
| 1 | First Task   | 2015-03-10 | 3 | 0.5 |   | true |
| 2 | Another Task | 2015-03-15 | 5 | 0.7 | 1 |
| 3 | Third Task   | 2015-03-09 | 2 |     |
| 4 | Fourth Task  | 2015-03-17 |
| 1 -> 2 | finish-to-start  |
| 4 -> 3 | finish-to-finish |
| 2 -> 3 | start-to-start   |
}]

The columns of the task table (and their default values):

1. ID: a unique numeric ID of this task - other tasks might reference it
2. Label: label of the task
3. Start date
4. Duration (1): length of the task in days
5. Progress (1.0): progess of this task
6. Parent: parent ID of this task, is used to build a tree hierarchy
7. Open (true): state of node if the task has children

1. Source task ID -> Destination task ID
2. Type of link: "finish-to-start" (default), "finish-to-finish" or "start-to-start"

Advanced method: JSON format

This way you can take advantage of the full potential of the underlying Gantt component. Disadvantage is the syntax being less concise and more technical.

To see which properties are supported, check out this documentation.

Please notice that you have to specify the inputType parameter set to 'json' to use this feature.

[{DynamicGantt inputType='json'
{
    data:[
        {id:1, text:"Project #1",start_date:"2013-04-01", duration:11,
        progress: 0.6, open: true},
        {id:2, text:"Task #1",   start_date:"2013-04-03", duration:5,
        progress: 1,   open: true, parent:1},
        {id:3, text:"Task #2",   start_date:"2013-04-02", duration:7,
        progress: 0.5, open: true, parent:1},
        {id:4, text:"Task #2.1", start_date:"2013-04-03", duration:2,
        progress: 1,   open: true, parent:3},
        {id:5, text:"Task #2.2", start_date:"2013-04-04", duration:3,
        progress: 0.8, open: true, parent:3},
        {id:6, text:"Task #2.3", start_date:"2013-04-05", duration:4,
        progress: 0.2, open: true, parent:3}
    ],
    links:[
        {id:1, source:1, target:2, type:"1"},
        {id:2, source:1, target:3, type:"1"},
        {id:3, source:3, target:4, type:"1"},
        {id:4, source:4, target:5, type:"0"},
        {id:5, source:5, target:6, type:"0"}
    ]
}
}]

Optional parameters

You can provide these optional parameters to the plugin that allow more advanced customizations:

• height is the diagram height, you can use CSS units here. Default is 15em
• inputType is 'wiki' or 'json', default is 'wiki'
• cssClass adds one or more custom CSS classes to the wiki plugin container
• cssStyle adds one or more custom CSS styling rules to the wiki plugin container

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.

Printing to PDF

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

[{ExportWiki id='1004,1005' format='pdf'}]

Parameters:

• id='<comma-separated list of wiki page ids>'
• linkText='<some text>' (optional) - the text of the link.
• format='pdf| rtf' (optional) - output file format; if omitted then 'pdf' will be used. ('rtf' is experimental because of the known issues in the formatter library.)
• path='<path>' - path in the Document Manager where the resulting document will be saved. Note that the directory in target path must exist, it will not be automatically created. If this parameter is omitted, then the plugin renders a direct download link.
• headerText='<some text>' (optional) - text to be printed at head of each page of resulting document.
• footerText='<some text>' (optional) - text to be printed on footer of each page of resulted document.
• dpi='<value>' (optional) - sets the source resolution for the document (in DPI). This is used internally to determine the pixel size for SVG (Scalable Vector Graphics) images and bitmap images without resolution information.

Examples of Use

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

[{ExportWiki id='1004' path='result.rtf' format='rtf' footerText='Some footer text'}]

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

Miscellaneous

Excel Spreadsheet Plugin

[{Excel id='1067'}]

[{Excel src='175'}]
[{Excel src='calculations.xls'}]
[{Excel src='Another page/calculations.xls'}]

[{Excel src='http://www.mysite.com/files/calculations.xls'}]

The optional parameter sheet can contain the name of a sheet. If not given all sheets will be processed. The optional parameters maxRows and maxColumns can be used to limit the number of rows/columns rendered on the wiki page. The default limits are 1000 rows and 100 columns.

Word Plugin

The Word plugin will automatically detect the file format and convert the Word document to HTML and embeds that to the Wiki page. Also displays images, however it can only display images supported by the browser. Usage is same as the Excel Plugin, so src attribute can contain references to Word files attached to current Wiki page or external or internal URLs.

Examples:

[{Word id='1067'}]

Shockwave (SWF) Plugin

• src: reference to the SWF file. References can point to an SWF file attached to the current or to another wiki page, or located in the document management system. See details about the different syntaxes in the "Adding pictures from attachments" section.
• height and width (optional): dimensions in pixels.
• controls (optional): 'true' or 'false' to show or hide the controls. Defaults to true.
• play (optional): whether to start playing immediately. Defaults to true.
• loop (optional): whether to loop the playback. Defaults to true.
• parameters (optional): additional parameters to pass to the Shockwave Player.

[{Flash src='!12!'}]
[{Flash src='!mygame.swf!' controls='false'}]
[{Flash src='!/1034!' parameters='param1=value1¶m2=value2'}]
[{Flash src='!/mydir/mygame.swf!'}]

Google Maps Plugin

Embeds Google Maps into a wiki page.

[{GoogleMaps lat='48.738142' lng='9.111185' zoom='17'}]

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:

• showMembers='true' - if specified then project members' geo locations will be marked.
  

  [{GoogleMaps showMembers='true' }]

• If trace='true' then geoCoding statistics line will be added: total members count / located count.

Feed Plugin

[{Feed url='http://slashdot.org/index.rss' feedDetails='true'}]

[{Feed url='http://feeds.feedburner.com/Techcrunch' entryDetails='true' max='5'}]

Parameters (with defaults):

• url='<the url of the rss feed to render>'
• max='10' The maximum number of feed entries to show
• feedDetails='false' true/false: if the feed details are shown
• entryDetails='false' true/false: if the feed entries' details are shown
• cacheTime='300' the feed plugin caches the feed content for so many seconds for better performance

Color Code Plugin

[{ColorCode syntax='sql'
select count(*) from dual
}]

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

• sql - SQL syntax highlighting (Oracle flavor)
• c - C & C++, full C++ '98 keyword set
• java - Java
• vm - Velocity template syntax highlighing

See more details on plugin's home page http://www.ecyrd.com/JSPWiki/wiki/ColorCodePlugin_page.

Visio Plugin

[{Visio id='1004'}]

Parameters:

• id='<id of wiki-page comment with attachment>'
• name='<name of attachment of the current wiki-page>'
• doc-id='<id of document>'
• issue-attachment-id='<id of an attachment of an issue>'
• src='<URL of visio file>'

Include Plugin

[{Include id='1004'}]

• id='<id of document>'
• src='<URL of wiki-markup>'
• template='<Relative path to template file>'
• message='<Key/Code of message resource>'
• control='true' (optional) parameter, provide only if you want to control whether control should be rendered for included documents.

HTML Plugin

[{Html
<b>bold</b> normal <em>italic</em>
}]

displays bold normal italic.

[{Html id='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'}]

Math and Latex Plugins

Math plugin is capable of rendering mathematical formulas in Wiki. These formulas are defined in the powerful LaTex language and will appear as an image embedded within the Wiki document.

Behind the scenes Math plugin is using the more powerful Latex plugin for rendering the content. For both plugins some extra configuration is necessary which is described in the CodeBeamer documentation

Samples:

[{Math
2\sum_{i=1}^n a_i \;\int_a^b f_i(x)g_i(x)\,dx
}]

displays the mathematical formula as an image:

The more flexible Latex plugin needs a complete LaTeX formatted document like in this example:

[{Latex title='some text'
\documentclass{article}
\begin{document}
this some LaTeX  text
\end{document}
}]

is rendered as:

The example below shows how to use formula identifiers:

[{Math
\( x > y \)
}]

is rendered as:

y \)" title="\( x > y \)" style="vertical-align: middle"/>

or

[{Math
\[
\frac{\frac{1}{x}+\frac{1}{y}}{y-z}
\]
}]

is rendered as:

Parameters:

• id='artifact Id which contains the formula or LaTeX text'.
• src='source URL or attachment name' Alternative location of the LaTeX text or formula.
• text='alternatively you can put the text to here'.
• title='optional tooltip for the rendered image'
• usePng='true' By default an PNG formatted image is rendered, but setting this to false will generate a GIF image.
• cache='true' If the image can be cached
• density='120' The DPI setting for the generated image
• timeout='30' Timeout in seconds to render the content.

Emoticons

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

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

Traceability Matrix

Parameters:

• horizontalTrackersAndViews='Contains ids or keys of trackers and optionally their views to show on the horizontal axis'. This is in form of "<tracker-id>/<view-id>,<tracker-key>/<view-id>..." format where there is a "/" character between tracker-ids and view ids and "," between the next tracker/view id.
• verticalTrackersAndViews='Contains ids or keys of trackers/views on the vertical axis.
• title='optional title of the plugin output'
• max='100' Maximum number of issues displayed on the horizontal/vertical axis.
• includeFolders='false' If the folder issues are displayed, defaults to false
• defaultView='-2' The id of the default view when the view is missing from the horizontal/vertical id list. Defaults to -2 which is the "All Items" view for trackers
• allowEditing='false' If the dependencies between issues can be edited as on the Traceability Matrix management page.

Additionally to the parameters the matrix's body optionally can contain a Velocity script. This script is called during rendering of the matrix for each cell, and allows you to customize the look and content of each cell. The output of this script is put to the cell. The script gets following variables in its scope:

• {content} The original content of the cell. So if you want to keep the original content just add ${content} to the script
• {cssClass} The original css class of the cell. You can change this value if you want some other class
• {cssStyle} The original css style of the cell. Change this to add custom style
• {horizontalTrackerItem} The current issue/tracker-item on the row (left)
• {verticalTrackerItem} The current issue in the column (above)
• {suspectedLink} Boolean if the cell contains a suspected link
• {dependency} The TraceabilityMatrixController.TraceDependencyMapEntry instance defines the dependency between the horizontal/vertical items
• {direction} The dependency direction between the issues, possible values are: 'NONE', 'H2V', 'V2H', 'BI'
• {resolver} TrackerItemFieldHandler's instance can be used to resolve custom field values in the issues
• {request}, {pageContext} and many more standard JSP attributes...

Here is an example of usage with a customized cell content:

[{TraceabilityMatrix horizontalTrackersAndViews='1250' verticalTrackersAndViews='1250'
#set($field = "Software safety classification")
#set($safetyHorizontal = $resolver.getItemFieldValueByFieldName($horizontalTrackerItem, $field))
#set($safetyVertical = $resolver.getItemFieldValueByFieldName($verticalTrackerItem, $field))
#set($color ="")
#if ($safetyHorizontal == "A" || $safetyVertical == "A")
  #set($color ="green")
#end
#if ($safetyHorizontal == "B" || $safetyVertical == "B")
  #set($color ="orange")
#end
#if ($safetyHorizontal == "C" || $safetyVertical == "C")
  #set($color ="red")
#end
#if ($color != "")
 #set($cssStyle = "background-color: ${color};")
#end
${content}
}]

Risk Traceability Matrix

You can specify a comma separated list of tracker IDs in the trackers parameter. The generated matrix will contain the corresponding trackers in the very same order, one column representing one tracker.

[{RiskTraceabilityMatrix trackers='1035,1032,1034,1029'}]

The matrix rows will contain tracker items. By default all of the items will be displayed (with respect to the generation rules, see below), but you may also manually exclude particular tracker items from any of the trackers. To do that, just add the tracker ID(s) or key(s) in parentheses after their containing tracker, separated by dashes, like this:

[{RiskTraceabilityMatrix trackers='1035(1123),1032,1034(1341-1322-1345),1029'}]

The matrix will be generated based on the following rules:

• The first column will contain all the items from the first tracker (with one or more manually excluded if you specify that)
• Other than the first, each column will contain only the tracker items that have associations pointing to at least one of the items in the previous column. Of course manually excluded items will not be shown.
• If tracker is of Test Case type, the last run result of the test case will also be indicated in the item cells.
• Each item in a cell will imply at least one cell on its right, but that cell might be empty.

Other optional parameters:

• title adds a caption to the matrix
• cssClass adds one or more custom CSS classes to the wiki plugin container
• cssStyle adds one or more custom CSS styling rules to the wiki plugin container
• showAssociations tells whether to consider associations between items while constructing the matrix. Can be 'true' or 'false', default is 'true'
• showRelations tells whether to consider relations (via reference fields) between items while constructing the matrix. Can be 'true' or 'false', default is 'true'

Example

In this example, we use letters as IDs to make it easier to follow:

Assume we have 4 trackers, their IDs are: A,B,C,D

• A has 2 items: A1,A2
• B has 3 items: B1,B2,B3
• C has 5 items: C1,C2,C3,C4,C5
• D has 6 items: D1,D2,D3,D4,D5,D6

Associations:

• B1,B2 are derived from A1 (associations A1->B1, A1->B2)
• B3 is derived from A2 (association A2->B3)
• C1,C2 are derived from B1 (associations B1->C1, B1->C2)
• C3,C4 are derived from B2 (associations B2->C3, B2->C4)
• C5 is derived from B3 (associations B3->C5)
• D1,D2 are derived from C1 (associations C1->D1, C1->D2)
• D3 is derived from C2 (associations C2->D3)
• D4 is derived from C3 (associations C3->D4)
• D5 is derived from C4 (associations C4->D5)
• D6 is derived from C5 (associations C5->D6)

[{RiskTraceabilityMatrix trackers='A,B,C(C5),D'}]

will generate this matrix: