Editing in the Wiki
The following sections describe various ways to edit in the wiki.
Creating and Editing Content
The wiki content is saved in Wiki markup syntax which is a simple and flexible language to produce clean and structured online information.
Besides the basic text elements such as paragraphs and headings, Codebeamer offers more advanced options such as tables and inline images.Codebeamer also offers additional markup constructs targeting the developer audience.
New documents can be created and the contents of existing wiki pages can be edited.
Creating Content on New Wiki Pages
To create a new wiki page within a project, click the New Child Page icon.
The Adding new child Wiki page to window displays. On this page you can add the page title and content.
The toolbar on the bottom left of the editor offers several formatting, inserting, and viewing options. Click Save to save the changes made on the page.
Editing Existing Wiki Pages
To edit the content of an existing wiki page, click .
The Updating Wiki page window displays. From this window you can edit the content using the various formatting, inserting, and view options on the toolbar.
Click Save to save your changes.
Creating a New Dashboard
To create a new child dashboard, complete the following steps:
1. Click . The Create Dashboard window opens.
2. Enter the Name and Description for the new dashboard. You can format the content inside the Description by using the toolbar located at the bottom of the page.
3. Click Add.
Toolbar for Editing Wiki Pages
The content of wiki pages can be edited, and formatted using actions on the toolbar that is located at the bottom left of the page being edited. The toolbar consists of the following options:
1. Formatting—Click to choose from the formatting options. For more information, see Formatting.
2. Advanced—Click to see the list of advanced options:
Insert Table—Click to insert a table inside the Description box.
Create Work Item—Click to create a related item for the selected text in the editor.
Insert Wiki Markup—Click to insert wiki markup in the Description box. Clicking this icon, displays a list with the following options:
Insert Wiki Markup
Insert Information
Insert Warning
Insert Error
Insert Preformatted
Horizontal Line
Add Attached Image
Table of Contents
For more information see also: Wiki Markup and Plugins
3. Link—Click to insert any URL or link in the Description box. The following options are displayed after you click this icon:
Artifact Link
Unlink
4. Upload File—Click to upload any file from your computer to the Description box.
Multiple files can be uploaded at the same time using drag and drop or the Upload File icon of the editor.
5. Emoticons—Click to enter an emoticon of your choice from the list of available ones.
6. Rich Text—Click to switch to using the rich text view or rich text markup while you are editing the wiki content. Rich text has familiar word-processing features and buttons to include images and links. It is useful for adding tables, images, links and easily editing text.
Markup—Shows the raw text, links, plugins, and so on as they are stored, interpreted and compiled by the wiki engine.
Make Default—Click this option to make any of the views a default view .
Preview—Provides a quick view of what the saved wiki page will look like. This view is not editable Preview does not refresh the table of contents and other wiki plugin contents.
Was this helpful?