Editing Wiki Pages with Microsoft Word
Codebeamer wiki pages can be edited with Microsoft Word. This is useful for document updates using simple wiki markup formatting.
To edit wiki pages using Microsoft Word, complete the following steps:
1. View the wiki page that you want to edit in Microsoft Word.
2. Select 
.
.3. Select Edit via Office.
 | When you select the Edit via Office menu option for the first time, Codebeamer displays information at bottom left of the screen about the plugins to be installed to be able to use this function. Click the Codebeamer Office Edit installation guide on the Office edit help window, or see Office Launcher Installation for details and instructions about the plugins. |
The content of the wiki page can be edited in as a Word document. After editing, saving and closing Microsoft Word, the updated wiki page is automatically uploaded and unlocked for other users. Headings, tables, links, bullet lists and many symbols are also converted between Word and wiki formats.
The conversion process:
1. A wiki page is converted into RTF format for editing with Word.
2. The format is reconverted to wiki upon upload.
| | The Edit via office option is visible to all users but only works for those who have the related license. For more information on licensing, see Codebeamer Licensing. |
| | Wiki offers a subset of all the features offered in Microsoft Word. As a result,, Word documents may not be converted properly when pasted into the Edit via Office sessions. |
 | The following sections describe the wiki markup constructs that are supported for editing wiki documents in Microsoft Word. |
Forced Line Break
Example:
HelloWorld!
To reproduce this in Microsoft Word, use the ENTER key to start new paragraphs.
Wiki markup:
__Hello\\World!
__
__
Links
Example:
This is a link to the Codebeamer home page.
To reproduce this in Microsoft Word complete the following steps:
1. Select the relevant text.
2. Right click on the selection.
3. Click on the Hyperlink option in the click menu.
Wiki markup:
__This is a link to the [Codebeamer home page|http://codebeamer.com] home page.
__
__
| | References between wiki pages ,such as [WIKIPAGE:1037] or [My page|WIKIPAGE:1037] can be created in same way. |
Headings
Example:(Not shown as headings would distort the Table of Contents of this page.)
To reproduce this in Microsoft Word, complete the following steps:
1. Select the relevant text.
2. Select Heading1, Heading2 or Heading3 style in the Styles section.
Wiki markup:
!!!Heading 1
!!Heading 2
!Heading 3
!!Heading 2
!Heading 3
Text Effects
Example:
Here is some bold , italic, and monospaced text.
To reproduce this in Microsoft Word take the following actions:
• For bold and italic: select the relevant text and click Bold or Italic in the Font section.
• For monospaced text select the relevant text and change the font to Courier.
Wiki markup:
Here is some __bold__, ''italic'', and {{monospaced}} text
Bulleted List
Example:
• Item 1
◦ Item 2
◦ Item 3
To reproduce this in Microsoft Word, select the relevant text and click on the Bullet icon in the Paragraph section.
Wiki markup:
*Item 1
**Item 2
**Item 3
**Item 2
**Item 3
Numbered List
Example:
1. Item 1
a. Item 2
b. Item 3
To reproduce this in Microsoft Word, select the relevant text and click on the Numbering icon in the Paragraph section.
Wiki markup:
#Item 1
##Item 2
##Item 3
##Item 2
##Item 3
Preformatted Text
Example:
This is the first line.
This is the second line with a space character in the first position.
This is the last line with 2 space characters in the start positions.
This is the second line with a space character in the first position.
This is the last line with 2 space characters in the start positions.
To reproduce this in Microsoft Word, create a dotted border around the relevant text paragraphs by selecting the Borders and Shadingoptions from the dropdown next to the Borders icon in the Paragraphsection.
Wiki markup:
Use three consecutive curly brackets {{{to open a block, and three consecutive curly brackets }}} to close a block.
Notification Boxes
To customize the text color and style In Microsoft Word, complete the following steps:
1. Select the relevant text.
2. In the Paragraph section, go to the Borders icon and select the Borders and Shading option from the dropdown, and set solid border of the appropriate color:
◦ Red for error box.
◦ Yellow for warning box.
◦ Blue for an information box.
◦ Gray for a comment box.
Wiki markup:
%%information
information box
%%
%%warning
warning box
%%
%%error
error box
%%
%%commentbox
comment box
%%
information box
%%
%%warning
warning box
%%
%%error
error box
%%
%%commentbox
comment box
%%
Tables
Example:
Table heading | |
|---|---|
cell 1 | cell 2 |
cell 3 | |
To reproduce this in Microsoft Word, complete the following steps:
1. To create a new table, go to the > .
2. Once the table is created, its cells can be merged by selecting them, and clicking Merge Cells in the right-click menu.
3. To add a heading, fill the heading cells with any color.
Wiki markup:
[{Table
||Table heading|<
|cell 1|cell 2
|cell 3|^
}]
||Table heading|<
|cell 1|cell 2
|cell 3|^
}]
Colored Text
In Microsoft Word, select the relevant text and use Font Color and Text Highlighting Color options in the Font section to set the text foreground and background colors.
Wiki markup:
%%(color:red)This is red text%% and %%(background-color:lime)this is text with lime background%%
Pictures
• Pictures can be inserted from a file or clip art.
• The picture is included as an attachment to the wiki, listed among the Properties.
To reproduce this in Microsoft Word, complete the following steps:
• From the menu bar, select > >
• When the picture is inserted, do not resize it. Any resizing should occur in the properties of the picture itself, as performed by an image editor.
• The uploaded and converted picture can be found in the > for the wiki page.
For a step-by-step guide on using Edit via Office to insert and upload pictures to wiki, see Using Pictures in Edit via Office.
Limitations
Limitations inherent in this wiki-to-RTF-to-wiki double conversion include:
• Microsoft Word pictures are automatically uploaded and inserted into the wikis, and the other way around. However, vector graphics such as graphics created in Microsoft Word, are not supported. Pictures can also be separately uploaded to the Codebeamer server and linked inline. Pictures inserted into and resized in Microsoft Word do not reflect the resizing when displayed in the wiki. Such pictures may appear large or too small.
• Table of contents—Use the wiki markup plugin definition [{TableOfContents}] , not the Microsoft Word Table of Contents functionality, as the Table of Contents from Microsoft Word is not imported into the wiki.
• Similarly, complex tables and other more complex Microsoft Word constructions that have wiki equivalents should be defined in the Microsoft Word document using wiki markup-type commands, or the simpler table commands as shown above.
• Symbols or uncommon fonts or formats—Testing has been limited to English and German with common symbols only. Problems may occur with uncommon fonts or symbols.
• Although the wiki converts to RTF, copy and paste content from other RTF files into the wiki document in Edit via Office with great caution. Very large RTF files, such as RTF files that contain pictures,may not be converted properly.
• Colors—A limited number of colors are converted from RTF to wiki.
• Font sizes—Relative font sizes are not converted, unless they are part of formatted markup-style headings.