For a quick introduction, see the documentation for JSPwiki, which is the wiki engine that drives the TeamForge wiki tool.
Text Effects on Wiki Pages
Wiki markup is great for making text look the way you need it to look.
Syntax | Effect | Details |
---|---|---|
- - - - | Creates a horizontal rule. | |
\\ |
Creates a line break. | |
!!!text | Creates a level 1 (large) header. | |
!!text | Creates a level 2 (medium) header. | |
!text | Creates a level 3 (small) header. | |
’ ‘text’ ‘ | Creates italic text. (That’s two single quotes on each side.) | |
__text__ | Creates bold text. (That’s two underscores on each side.) | |
{{text}} | Creates monospaced text. | |
*text | Creates a bulleted list item. | |
#text | Creates a numbered list item. | |
;term:ex | Creates a definition for the word “term’“with the explanation “ex.” | |
{{{text}}} | Creates pre-formatted text. | |
%%(<css-style>)<your text>%% | Defines a CSS style command. | %%(font-size: 150%; color: red;) Hello, world!%% |
Blank line | Starts a new paragraph. |
Bring TeamForge Data into Wiki Pages
Use this markup format to bring in data from elsewhere on your TeamForge site.
Syntax | Effect | Details |
---|---|---|
[{INSERT ExcelToHTMLPlugin src='c:\somesheet.xls'}] or [{INSERT ExcelToHTMLPlugin border='1' src='\\the_server\somesheet.xls'}] | Reads a Microsoft Excel file and displays it as an HTML table. | Parameters:
|
Text Navigation Tools for Wiki Pages
You can use wiki syntax to help readers get around.
Syntax | Effect | Details |
---|---|---|
%%insert-toc%% | Creates a table of contents consisting of the header text on the page. | |
[link] | Creates a link to a new Wiki page called "link." | If the link is a complete URL, a link to the URL is created. If the link points to a .gif, .jpg, or .png image, the image is rendered directly in the page. |
[title|link] | Creates a link to a new Wiki page called "link" with the text "title" displayed for the URL. | If the link is a complete URL, a link to the URL is created. If the link points to a .gif, .jpg, or .png image, the image is rendered directly on the page with "title" as ALT text. |
~TestText | Disables link creation for a CamelCase word. | CamelCase words are two or more uppercase words with no spaces. By default, a CamelCase word automatically creates a link to a new Wiki page. |
[[link] | Creates the text "[link]." | |
[{IFramePlugin url='http://open.collab.net/' width='100%' height='500' border='1' scrolling='yes' align='center'}] | Embeds an iframe into a wiki page. |
|
Tab Completion <Keyword+Tab> | You can type a keyword and hit the Tab key (under the Tab Completion mode). The editor will fill in with a sample template for the specific markup represented by the keyword. |
|
Attachments for Wiki Pages
You can use wiki markup to bring in information from external sources.
Syntax | Effect | Details |
---|---|---|
[WikiPageName/attachmentName] | Embeds an attachment in the page. | If the attachment is a .gif, .jpg, or .png image file, the attachment will be embedded in the page; otherwise, the name of the attachment will display as a downloadable link. After adding attachments, the exact syntax for including the current page's attachments is shown next to each attachment's name in the Attachments section of the Edit Wiki page. You can use the same syntax to embed attachments from other wiki pages in the same project. |
[{InsertAttachment page='WikiPage/attachment'}] | Inserts the contents of an attachment (text file) into a page. |
If the attachment is a text file, the content of the text file is inserted into the page. For more information, click here.
|
[{Mediaplayer src='fileName.wmv'}] | Embeds a Windows Media Player or Quicktime Player on a wiki page. |
|
[{INSERT ExcelToHTMLPlugin src='WikiPage\somesheet.xls'}] or [{INSERT ExcelToHTMLPlugin border='1' src='\\the_server\somesheet.xls'}] | Reads a Microsoft Excel file and displays it as an HTML table. | Parameters:
|
[{arnaud.Flash src='yourAttachedFlash.swf'}] | Embeds a Flash Player on your wiki page. |
|
[{IFramePlugin url='http://open.collab.net/' width='100%' height='500' border='1' scrolling='yes' align='center'}] | Embeds an iframe into a wiki page. |
|
Tables on Wiki Pages
You can use wiki markup to organize information in tables on a wiki page.
Syntax | Effect | Details |
---|---|---|
[{Table <table-parameters> || Table Header Example || More… | Table Data Example | More… }] |
Inserts a table on the wiki page. See this page for the markup for table elements. |
|
||head1||head2 | Creates a table column with header text "head1" in the first cell and "head2" in the second cell. | |
|col1|col2 | Creates a table row containing the text "col1" in the first cell and "col2" in the second cell. | |
|< | Collapses a cell with the previous cell so it spans multiple columns. | http://www.ecyrd.com/JSPWiki/wiki/TablePlugin |
||< | Collapses a header cell with the previous header cell so it spans multiple columns. | http://www.ecyrd.com/JSPWiki/wiki/TablePlugin |
|^ | Collapses a cell with the cell above so that it spans multiple rows. | http://www.ecyrd.com/JSPWiki/wiki/TablePlugin |
||^ | Collapses a header cell with the header cell above so that it spans multiple rows. | http://www.ecyrd.com/JSPWiki/wiki/TablePlugin |
( <css-style> ) |
Inside a table cell, adds specific formatting to a cell. | http://www.ecyrd.com/JSPWiki/wiki/TablePlugin |
# | Inside a table cell, displays the current row number with auto row numbering. | http://www.ecyrd.com/JSPWiki/wiki/TablePlugin |
[{INSERT ExcelToHTMLPlugin src='WikiPage\somesheet.xls'}] or [{INSERT ExcelToHTMLPlugin border='1' src='\\the_server\somesheet.xls'}] | Reads a Microsoft Excel file that is attached to a wiki page, and displays it as an HTML table. | Parameters:
|
[{TableOfContents }]\\ | Creates a table of contents consisting of the header text on the page. |
Wiki Plugins
You can use pre-defined wiki plugins to format your current page.
Plugin Name | Details |
---|---|
Section Headings Template | Inserts a page template that includes a table of contents and several section headings. Typically, this can be used in a new or blank page. |
Sortable Table | Inserts a new table that can be sorted when you click on the column headers. |
Zebra Table | Inserts a new table that has alternating background colors for each row. |
Table of Contents Plugin | This plugin automatically generates table of contents that provides links to all the headings on your page. |
Insert Page Plugin | This plugin will insert a copy of another page into the current page. You must specify the name of the page to insert. |
Current Time Plugin | This plugin displays the current date and local time of the server when the page is viewed. |
Insert Attachment | The insert attachment plugin allows you to insert the contents of an attachment into a page. |
Media Player | This is an embedded player in your wiki page, supporting Windows Media Player and Apple QuickTime. |
Insert Table | Additional table support including multi-line table editing, cell merging, and automatic row numbering. |
Flash Player | An embedded flash player for the wiki page. |
Insert Excel | Allows you to insert a Microsoft Excel file as a table. |
Insert iFrame | Allows embedding attachments, external urls, and files (relative to the docbase). |
Code to HTML | Allows source code syntax to be rendered as a HTML output and supports syntax from 130 different programming languages. |
Index Plugin | Displays all the pages in wiki in a alphabetical order. |
Recent Changes Plugin | Inserts the latest changes in order. |
Referred Pages Plugin | Finds and lists all the pages that are referred to by the current page. The depth parameter allows to display a recursive tree of referred pages. |
Referring Pages Plugin | Finds and lists all the pages that refer to the current page. |
Undefined Pages Plugin | Lists all the pages that are referred to, but not yet created. |
Unused Pages Plugin | Lists all the pages that are not currently referred to by any other page. |
ExcelToHTMLPlugin | Provides a HTML view for the Excel spread sheet files. |
PDFPlugin | Provides the PDF output for the files. |
WikiContentToHTML Plugin | Exports a specific page to HTML. |
[]:
[]: