Wiki

What is a Wiki?

Wiki, an abbreviation for "What I Know Is", is a widely used concept in collaborative networks. A wiki is a collection of interconnected pages with a simple text based syntax for formatting. A wiki page supports hyper links to other pages. Wikis are also used as a knowledge sharing tool that allow users to add, remove, or otherwise edit and change all content very quickly and easily. To better understand the wiki concept http://en.wikipedia.org/wiki/Wiki is well worth a read.

Also see Wiki Markup and Plugins

Document Baselines is an important new feature in CodeBeamer 5.5 . It enables you to capture a snapshot of wikis & documentation at a particular time, with particular revision numbers. Please see Baselining: Document- and Wiki Baselines for more details.
Credit: CodeBeamer's Wiki implementation includes many source code modules and ideas from the Open Source JSPWiki system. It uses the same Wiki syntax. Many JSPWiki plugins were implemented and ported to CodeBeamer. Thanks to Janne Jalkanen and to the JSPWiki community for the contribution.

What is codeBeamer's Wiki?

Unlike many wiki implementations, CodeBeamer's built-in wiki implementation is an enterprise grade tool. It helps you to capture and manage knowledge in an open, scalable, secured and controlled way. Interrelated artifacts, such as Trackers, Office/Wiki Documents, or Tasks, can be as structured as you wish while allowing a large degree of artifact inter-connectedness.

You can extend codeBeamer's Wiki with your own plugins. Using codeBeamer's open-source plugins and writing your own plugins as necessary, your work environment can be customized to fit your needs. For example, a plugin could be created to identify the dependency structure, or graph of artifact inter-relatedness.

CodeBeamer's Wiki can allow your information-flow to be as democratic as Wiki system used by communities, or it can instead allow structured document approval to, for example, implement publication processes.

Efficient communication is a key factor in any successful development project. You can use the wiki to collaborate and to prevent communication problems.

Each project has a separate wiki space that can be accessed by the Wiki tab.

A wiki space consists of individual wiki pages, that can be organized into a hierarchical structure, cross-referenced in various ways and browsed navigating along the links.

For each page, besides maintaining its content, you can:

  • set up access rights,
  • set approval workflow,
  • set up notification settings,
  • add comments,
  • add attachments,
  • check history and restore older versions
  • list child pages,
  • change permissions based on roles or groups.

Wiki Page Structure

A wiki page has content and a navigation section and property section. In the example below, the navigation section is a box on the right, with various links. The property section can be reached by clicking on the Properties button near the top left. The content shown is the top of a wiki for mathematical abstractions, with the document title, and the Table of Contents.

Figure: Wiki page in Codebeamer.

Writing Content

When you edit a Wiki Document, the pop-up Wiki editor window has 3 tabs. The first 2 tabs, WYSIWYG and Wiki Markup, allow edits. The third tab Preview does not allow edits, and is only for viewing.

Wiki content is saved in a special notation, the so-called wiki markup syntax. This is a simple and flexible language to produce clean, structured on-line information. Besides the standard basic text elements like paragraphs and headings or more advanced ones like tables and inline images, CodeBeamer supports additional markup constructs targeting the developer audience.

WYSIWYG View

For instant editing, use the WYSIWYG editor. It has familiar word-processing features and buttons to include images and links. The WYSIWYG view removes the learning curve typically required to start with Wiki. It help you to add tables, images, links and easily edit text.

The Toggle Basic/Advanced mode button allows you to set the editor to allow a larger or smaller number of word-processing-like features.

Figure: WYSIWYG View in Wiki Edit Window

Wiki Markup View

Alternatively you can switch to Wiki Markup view of the editor. This shows the raw tex, links, plugins, etc. as they are stored and interpreted/compiled by the Wiki engine.

Figure: Wiki Markup View in Wiki Edit Window


Wiki Preview

This tab allows a quick view of how the finished Wiki page will appear. This view is not editable. The Preview does not refresh the Table of Contents and other Wiki Plugin Contents.

Edit Wikis in MS Word

CodeBeamer wikis can be edited in MS Word. Please see Editing Wiki Pages Using Microsoft Word for more information.

Copying and Pasting Wiki Documents

In CB-5.3 wiki pages and their children can be copied recursively. To copy a wiki page and its children to the clipboard, select Copy from the Actions menu of the source page.

To paste the wiki page and its children, select Paste from the Actions menu of the destination Wiki page, or select Paste from the More actions ... menu in the Children tab of the destination (or target) Wiki page.´ The copied Wiki page becomes a new child under the (destination) parent page. It is visible under Properties, in the Children tab. Its children are visible under its own Properties → Children tab, and so on.

Upon paste, you will be presented with a popup that shows the hierarchy of pages to be pasted and allows you to continue or cancel.

Figure: Pop-Up Showing Paste Hierarchy with Options to Paste or Cancel


The pasted pages will be added as children of the destination/target page. Because the destination page does not contain references to these new children, you will not be able to see/navigate to the new child pages, unless you edit the destination page and manually add references to them. The document numbers of the new child wiki pages will appear either in the URL field when you navigate to them by clicking the link in the Children tab in Properties, or the document number will appear in a tooltip, when you hold the cursor over the document name in the Children tab of Properties .

Wiki Page Properties

Wiki page properties are used to add:

  • child pages
  • comments and attachments
  • links
  • associations

or to view:

  • page history
  • document approval

or change:

  • permissions

Figure: Wiki Properties Display

Commenting Pages and Attaching Files

You can leave your questions, answers or notes as comments attached to any page by opening the Comments & Attachmentstab:

Figure: Comments and Attachments Tab in Wiki Properties



Discussions related to the topic of the page are an essential part of a content reviewing process.

You can also easily upload and associate files with any page by opening the Comments & Attachments tab and clicking Add Comment. The resulting Wiki-Editor-type pop-up window allows you to enter comments and to browse for documents to attach.

These attachments are used for:

  • sharing content with other users;
  • inclusion in the owner page, for example to display inline images.

Associations

Associations are used to list related documents and functions.

Figure: Associations Tab in Wiki Properties



Links

The Links tab shows incoming links (other documents that link to this document) and outgoing links to other documents.

Figure: Links Tab in Wiki Properties

Children Pages

Using the Children tab in Properties, you can organize your pages into a tree hierarchy, using any grouping based on your demands. At project creation time only the root of the page tree exists. You can start adding information immediately by editing it or by adding new pages.

When you are editing the wiki page and need a new child page, the simplest way to add a child page is to enter:

[my marketing page]

When you save the current page a new child page called my marketing page will be created. The Wiki link in the parent page will point to the non-existing my marketing page Wiki page. It will be decorated with a little new icon as shown below, and clicking the new link brings up the Wiki editor, to allow you to add content to the new child page.

The document number will be assigned after the new child page has content. Then the document will be viewable under the Children tab. One easy way to find the document number is to place the cursor over the link to the child page, and look at the last number displayed on the bottom area of your browser.

Alternatively, you can

  1. Click the Properties link,
  2. Select the Children tab,
  3. Click New Child Page link,
  4. Edit the contents of the new child page,
  5. Click Save.

The child pages (Children) of a document are displayed under the Children tab under the Properties.

Figure: Children Tab in Wiki Properties

Notifications

You can subscribe to individual wiki pages to keep track of changes by opening Notifications tab in Propertiesview:

Figure: Notification Tab in Wiki Properties

After activating it, you will receive notification e-mails about every page access (read) and update (write).

Permissions

The Wiki page Permissions are based on user role and group level. Read and edit (write) access is controlled at each wiki page level, in a very similar way to how the Document Manager works.

To set page level read/edit security:

  1. Select the Properties link,
  2. Click on the Permissions tab,
  3. Select the checkboxes from the Read and Edit columns for each of the user roles,
  4. Click on Save to activate the settings.

Figure: Permissions in Wiki Properties

You can set the permissions recursively for all child pages

Approvals

In Properties, you can view the Document Approval Workflow approvals flow of this document using the Approvals tab.

For more information, please see Wiki- and Document Approval Workflows

Figure: Approvals Tab in Wiki Properties

Page History

Page content is fully audited and versioned. The History tab in Properties allows you to see the changes between the revisions. You can also restore a previous version of the page at any time.

Figure: History Tab in Wiki Properties

Wiki Approval Workflows, Publishing Workflows

Approval workflows can be applied to Wiki pages, see more information Document Approval Workflows.

Importing Issues and Wiki Pages from RTF (Microsoft Word Documents)

Importing Requirements from RTF

You can create issues from your RTF document. This option is available under more menu in Requirements tracker.

Rules of import:

  • Each heading creates a new issue.
  • Heading texts will be used as issue summaries.
  • Paragraphs between headings will be used as issue descriptions.
  • Hierarchy of paragraphs in original document is ppreserved. If paragraph B has smaller heading then paragraph A, issue B will be child of issue A.

Importing Requirements from Non-RTF Documents

It is possible to import doc and docx formats. In this case, CodeBeamer performs Doc to RTF to Wiki conversion. This requires OpenOffice or LibreOffice installation on server. The feature is available for importing requirements only.

  1. Expand more menu of Requirements tracker.
  2. Click Import from Word or Excel.
  3. Select option Word/Office Documents or Rich Text Format.

Importing Wiki Pages from RTF (MS Word Documents)

Codebeamer can convert RTF (Rich Text Format) files to wiki markup. You can find this option as Import From Word in wiki page action bar.

Known Limitations of Importing RTF

  1. RTF Specification, Version 1.9.1 is supported. This means documents that are created in Microsoft Office Word 2003 or newer.
  2. Supported image formats: gif, png, jpeg. Other image format (including vector graphics) will not be converted.
  3. Headings (paragraphs) are detected by their conventional style names: Heading 1, Heading 2, Heading 3, Heading 4, Heading 5. Other text independently of font size and style will be threated as normal text body.
  4. For tables, the converter doesn't support special cell styles (custom background and border color, border width, margins, spacing).
  5. Text placed inside vector objects (like rectangles) is ignored.
  6. Equation formulas are not supported.
  7. MS Office-specific list styles are not preserved. List a) b) c) will be converted to 1. 2. 3.

Generating Specification Documents: Exporting Issues (Requirements) to MS Word Documents

Codebeamer can export issues from requirements trackers into DOC files. To find this option open Requirements tracker, move mouse over the more menu and click Export to Word.

Technically speaking, the generated document is in MHTML format, a multipart HTML document format that is natively supported by newer MS Word version. The .doc extension makes Word the default editor for created file.


The following properties of the issues are exported to the document:

  • Summary
  • Description
  • Revision
  • Business value (priority)
  • Status
  • Issue references (associated issues, child and parent issues, etc.)

Customizing the MS Word Output

It is possible to freely customize the document generated from requirements. You can tune both the content and its formatting.

As mentioned above, the output document is in MHTML format. The content is generated by rendering two Velocity templates. In order to customize the output, modify the following templates:

  • <cb tomcat dir/webapps/cb/config/templates/html/requirement-document-export-body.vm
  • <cb tomcat dir/webapps/cb/config/templates/html/requirement-document-export-headerfooter.vm

The following objects are available in the Velocity context and can be used in template:

Key Class Description
request HttpServletRequest
user UserDto
currentDate Date
project ProjectDto
requirementTracker TrackerDto
requirements SortedMap<ReleaseId, TrackerItemDto> ReleaseId class provides indexing and sorting for requirements.
Use ReleaseId.getRelease()
baseline Baseline Only available when exporting a baselined set of issues.
When exporting the HEAD (the latest revision), it's not available.
wikiMarkupProcessor WikiMarkupProcessor
incomingReferencesByIssue Map<Integer, Map<String, List<TrackerItemDto>>> Keyed first by the item ID, then by the field name and it maps to a list of tracker items.
outgoingReferencesByIssue Map<Integer, Map<String, List<TrackerItemDto>>> Same like the previous.

Tip: check this paragraph for details on the CodeBeamer domain model classes.

Generating Documents: Exporting Wiki Pages to PDF, RTF and HTML

You can export the content of the current wiki page to a PDF-file (suited for printing to paper or for static export), an RTF file or an HTML document. There are a few options:

To export the current page only to PDF, click more -> Export to PDF when viewing a wiki page.

To export a set of pages to PDF, use the ExportWiki plugin (see Printing to PDF), or use the more -> Export Multiple Pages to PDF GUI.

To export anything to HTML, use the more -> Export Multiple Pages to PDF GUI, and there is a button to select HTML output.

To export to rtf, use the ExportWiki plugin which is documented in Printing to PDF. The ExportWiki plugin documentation describes how to select RTF output format.

For example, generate a PDF Document from the Wiki pages with IDs 1004 and 1005 using the ExportWiki plugin with the following statement put in a wiki:

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

This results in a link in the existing wiki page called "Export as PDF" that creates a document when selected:

For more information about how to use the ExportWiki plugin, please see Printing to PDF

Customizing the PDF Output

The ExportWiki plugin offers both content- and formatting customizations, beyond the parameter selections defined in the ExportWiki documentation, however they require XSL-FO experience. CodeBeamer relies on the open source Apache FOP project as print formatter.

CodeBeamer will transform the HTML output of a wiki page to XSL-FO using the INSTALL_DIR/tomcat/webapps/cb/WEB-INF/classes/xhtml2fo.xsl stylesheet. You can freely edit this stylesheet to fine tune the output to fit your needs and company standards.

Changing the Font Set to Support Asian and Eastern European Languages

For Asian or Eastern European language characters, you have to switch the formatter to use character sets that support the special Chinese, Korean, Japanese, Czech, Hungarian, etc. glyphs. There are 4 separate font families to support them, in addition to the default "Helvetica". Make sure that exactly one of the font families is activated!

To make the switch, please uncomment the appropriate section in WEB-INF/classes/xhtml2fo.xsl (around line 65) and restart codeBeamer:

<!-- Remove this if you want to use Eastern European, Chinese, Japanese or Korean character support -->
<xsl:attribute name="font-family">Helvetica</xsl:attribute>
<!-- Uncomment this for Eastern European support (arial*.ttf) -->
<!--
<xsl:attribute name="font-family">Arial</xsl:attribute>
-->
<!-- Uncomment this for simplified Chinese serif character support (simsun.ttc) -->
<!--
<xsl:attribute name="font-family">SimSun</xsl:attribute>
-->
<!-- Uncomment this for Japanese serif character support (msmincho.ttc) -->
<!--
<xsl:attribute name="font-family">MSMincho</xsl:attribute>
-->
<!-- Uncomment this for Korean serif character support (batang.ttc) -->
<!--
<xsl:attribute name="font-family">Batang</xsl:attribute>
-->
-->

Known limitations of the PDF/RTF export

Cause Description
FOP limitation Glyphs in Asian .ttf files are available only as "normal", no "bold" or "italic". FOP will not render these, but will ignore formatting.
FOP limitation No implicit auto line-breaks for Asian text if there is no explicit whitespace character inserted.
FOP limitation FOP can't fit table columns to the minimum necessary width, but all columns of a table will be 100%/noOfColumns wide.
FOP bug FOP throws exceptions when <table>'s have different cell count per row. This can be caused by both XLS plugin and regular wiki tables.
FOP limitation GIF export in RTF is not supported. It was added after FOP release 0.93!
FOP bug horizontal rulers are not exported to RTF!
FOP bug exporting structure of lists and ordered lists to RTF is buggy.
FOP limitation images are never resized, so it's very likely they can flow beyond the right margin.

Editing Wiki Pages Using Microsoft Word

Edit your wikis using Microsoft Word.  See Editing Wiki Pages Using Microsoft Word

Wiki as Framework - Combine Content using Plugins

Using these enhanced features you can:

  • reference CodeBeamer documents, tracker items, reports or forums,
  • add graphical charts, graphs or even UML class diagrams.

Figure Wiki Chart Plug-in examples.

Figure Wiki UML and MindMap Plug-in examples.

For detailed information about Plug-ins and the Wiki markup syntax, please see the Wiki Markup and Plugins page.

Wiki - Advanced

Most of the complex or dynamic content of a wiki page, like reports, charts, MS-Excel or graphs, is served by plug-ins.

You can combine (embed) codeBeamer internal content such as reports, documents, tasks, requirements, bug and other artifacts into wiki pages.

The document data/Screenshots/asset/DemoBudgetPlan.xls can be embedded into this page

[{ExcelPlugin id='22950'}]

with the Excel plugin using the syntax above.

The result is:

DemoBudgetPlan.xls

 Budget Plan
   2006 2007 2007
 Staff $750,000.00 $850,000.00 $950,000.00
 Infrastructure $100,000.00 $100,000.00 $75,000.00
 Tools $600,000.00 $120,000.00 $40,000.00
 External Help $350,000.00 $390,000.00 $100,000.00
 Ads $170,000.00 $222,222.00 $30,000.00
        
 Total $1,972,006.00 $1,684,229.00 $1,197,007.00

You can make the spreadsheet editable, and you change the spreadsheet the Wiki content is changing.

Embedding the BestContentPlugin using the syntax:

[{BestContentPlugin max='5' projectId='37' entityType='WIKIPAGE' title='Best Wiki pages'}]
will result:

You can combine ratings into a Table, using the following syntax

[{Table

|(vertical-align:top;) [{BestContentPlugin max='5' projectId='37' entityType='WIKIPAGE'
title='Best Voted Wiki pages'}] |(vertical-align:top;)[{BestContentPlugin  max='5'
projectId='37' entityType='FTC' title='Best Voted Forum
posts'}]|(vertical-align:top;)[{BestContentPlugin max='5' projectId='37' entityType='DOC'
title='Best Proposals in Documents'}]
}]

will result:

BestContentPlugin plugin failed: Invalid entityType parameter, please use BestIssues plugin for entities, because this plugin is for Forums or Artifacts only!
(com.ecyrd.jspwiki.plugin.PluginException:Invalid entityType parameter, please use BestIssues plugin for entities, because this plugin is for Forums or Artifacts only!)
Best Proposals in Documents
DocumentRating
No pages rated.

See Wiki Markup and Plugins and at Developing Wiki Plugins. To integrate with external systems or customize your own wiki, the plug-in mechanism is the primary extension point.

Embedding Reports into Wiki pages

You can embed reports into Wiki pages using the Report Wiki plugin.

The Wiki plugin

[{Report id='22556'}]

will result:

Innovations by Release and Catagory (2)  Last modified: Dec 10 2009 by j.koppany Totally found 9 records.
Tracker:   Participate > Product Innovation found 9 records

ID Priority Solicitations Status Owner Submitted at Category Submitted by Modified at Modified by Assigned to Released Proposal Due
25248 Normal -- Contractor Jun 15 2008 21:00 Space j.koppany Feb 18 2009 16:21 j.koppany Partner Jun 14 2008 02:00 Nov 13 2008 01:00!
25249 Normal -- Contractor Jun 15 2008 21:01 Space j.koppany Feb 18 2009 16:21 j.koppany Partner Jun 14 2008 02:00 Nov 13 2008 01:00!
25250 Normal Reopened -- Jun 15 2008 21:01 Green j.koppany Feb 18 2009 16:21 j.koppany -- Jun 11 2008 02:00 Sep 27 2008 02:00!
25251 Normal Reopened -- Jun 15 2008 21:01 Green j.koppany Feb 18 2009 16:21 j.koppany -- Jun 11 2008 02:00 Sep 27 2008 02:00!
25252 High Reopened Partner Jun 15 2008 21:02 Green j.koppany Feb 18 2009 16:21 j.koppany -- Jun 11 2008 02:00 Sep 27 2008 02:00!
25253 High Reopened Partner Jun 15 2008 21:02 Green j.koppany Feb 18 2009 16:21 j.koppany -- Jun 11 2008 02:00 Sep 27 2008 02:00!
25280 Low -- -- Jun 16 2008 19:41 -- j.koppany Feb 18 2009 16:21 j.koppany -- -- --
25479 Low Verified -- Jul 08 2008 14:22 Enegry j.koppany Feb 18 2009 16:21 j.koppany -- -- --
25267 High -- Mark Jun 15 2008 22:54 Green j.koppany Oct 29 2009 17:53 j.koppany -- -- --
There are two additional fields that can be used for display and sorting in merged reports: Project and Key. The Project field represents the CodeBeamer project the tracker belongs to. The Key field is the internal tracker key in the system.

Embedding Tracker Item State History Report Plugin

The TrackerItemStateHistory Wiki plugin shows the state change history of an issue (or bug, task, etc.), identified by its task-id. New CMDB ideas

The Wiki plugin

[{TrackerItemStateHistory id='25479'}]

will display the issue's state change history.

State Change History for Task [INNO-25479] - New CMDB ideas :

Submit
j.koppany
--
Jul 08 2008 14:22
Verify
j.koppany
Verified
Sep 14 2008 21:54


Wiki Markup Help

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.

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.

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.
And this is my answer.

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.''
Which would be seen as
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]
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.

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.

Pictures from page- and 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!]

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:

  • One
  • Two
  • Three
    • Three.One

Numbered lists

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

Creates

  1. One
  2. Two
  3. Three

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.
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!
  • 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

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

Custom text styles

You can also define almost any CSS style command:

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

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.

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

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

}]

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;) [{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
%%

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

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

Basic link types

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

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.

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

For example:
[{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}]
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.

Project content

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:
  • 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'}]
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.

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 all trackers of the current project, with statistics.
[{TrackerList projectId='2'}]
displays the same for another project.
[{TrackerList items='work'}]
displays the work trackers of the current project, with statisctics.
[{TrackerList items='configuration'}]
displays the configuration trackers of the current project, with statisctics.
[{TrackerList items='both'}]
displays all trackers of the current project, with statisctics

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

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

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.

Reporting

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:

  • 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

Displays statistical information about the source code of a project.

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

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

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

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}]
When used in the context of a project uses the default requirement tracker to collect the data.
[{RequirementCoverage id='1'}]
Collects the coverage data from the default requirement tracker of the project with id 1.
[{RequirementCoverage trackerId='1001,1002'}]
Collects the coverage data for the requirements in tracker 1001 and 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}]
Shows a chart created based on the default test case tracker of the enclosing project.

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}]
Shows a chart created based on the default test run tracker of the enclosing project.

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}]
Shows a chart created based on the default test run tracker of the enclosing project.

Test Runs by Assignee Plugin

Shows a chart based on all test runs in a project or some test run trackers. The chart contains a bar for each user that has ever run a test and one for the test runs that have no assignee. The bars show the distribution of the results of the runs of that given user.

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}]
Shows a chart created based on the default test run tracker of the enclosing project.

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.

My Issue Summary Plugin

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

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'}]
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 Current Issues Plugin

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

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.

Note: only one or none of the paramters projectId, trackerId, releaseId 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 releaseId='1396'}]
displays the open issues in that release/sprint.
[{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 Subscriptions Plugin

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

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

Displays the burn down chart for a release or sprint.

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

Displays the bubble chart.

Velocity Trends Plugin

[{VelocityTrends releaseId='1000'}]

Displays the velocity changing over time for a release or sprint. Velocity is essentially the number of issues resolved per day.

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

Displays the status distribution of the issues in a release or a sprint. This gives a quick and easy to understand overview about the progress status.

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

Displays the velocity of the last known day within a release or sprint.
This is typically yesterday's velocity, but in a Monday it can be the velocity for last Friday.

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

Displays the number of days left until the end (planned release date) of a release or sprint. Releases and sprints in the agile world are strictly time-boxed, so this information is crucial.

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

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

The ExportWiki plugin generates a download link for PDFs exported from wiki pages.
[{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'}]
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.

Miscellaneous

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

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:

  • showMembers='true' - if specified then project members' geo locations will be marked.
    [{GoogleMaps showMembers='true' }]
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.
  • If trace='true' then geoCoding statistics line will be added: total members count / located count.

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.

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

Plugin that renders the body text as colorized source code.
[{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.jspwiki.org/wiki/ColorCodePlugin_page.

Visio Plugin

Plugin that renders visio file. Microsoft Visio Viewer 2003 Control must be installed.
[{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

Plugin includes wiki markup. An included document can include others.
[{Include id='1004'}]
Parameters:
  • 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'}]
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'}]

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: 2\sum_{i=1}^n a_i \;\int_a^b f_i(x)g_i(x)\,dx

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:

\documentclass{article}
\pagestyle{empty}
\begin{document}
this some LaTeX  text
\end{document}

The example below shows how to use formula identifiers:

[{Math

\( x > y \)
}]

is rendered as:

\( x > y \)

or

[{Math

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

is rendered as:

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

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)
(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 :).

Traceability Matrix

Traceability Matrix plugin renders trace-ability report between one or more trackers and their views in a Matrix form.

Parameters:

  • horizontalTrackersAndViews='Contains ids of trackers and optionally their views to show on the horizontal axis'. This is in form of "<tracker-id>/<view-id>,<tracker-id>/<view-id>..." format where there is a "/" character between tracker-ids and view ids and "," between the next tracker/view id.
  • verticalTrackersAndViews='Contains ids 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'




${content}
}]

Risk Traceability Matrix

Risk Traceability Matrix plugin renders a trace-ability report between two or more trackers based on their associations in a Matrix form.

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

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:

A1 B1 C1 D1
D2
C2 D3
B2 C3 D4
C4 D5
A2 B3