You are not logged in. Click here to log in.

codeBeamer ALM
Tags:  not added yet

Editing Wiki Pages Using Microsoft Word

This new feature allows you to edit your wikis in Microsoft Word. Simply click on Edit in Word and the wiki is automatically locked and the wiki is opened in an MS Word session. After editing, saving and closing MS Word, the wiki is automatically uploaded and unlocked for the next user. Headings, tables, links, bullet lists, and many symbols are automatically converted between Word and Wiki formats, so that you can either create them in Word, and have them upload into codeBeamer wikis, or edit them in MS Word.

The Edit in Word link is visible to all users, but it will only work for those users who have purchased a license. For more information on licensing, please see codeBeamer Licensing.

This feature is useful for document text updates using simple Wiki markup formatting. The conversion process takes a wiki, converts its format to RTF for Editing in Word, and then reconverts to wiki upon upload. Wiki offers a subset of all the features offered in Word, so many Word documents will not properly up-convert (when pasted into the Wiki's Edit in Word session, for example).

Edit in Word Usage Examples

To really see what's going on in the following examples, try selecting more... (above) and Wiki Markup View on this wiki, to see the actual contents of the wikis used for these examples. The regular wiki view comment (gray) boxes are also helpful, but if you are confused, the Wiki Markup View may help.


Important Notes:
  1. Wiki markup constructs that are not in the following list are not supported.
  2. Only MS Word 2003 and 2007 versions are supported.
  3. Sun's JDK-1.5 or higher must be installed on the client computer.

Forced Line Break

Example:

Hello
World!

To reproduce this in MS Word:

Use the Enter key to start new paragraphs.

Wiki Markup:

__Hello\\World!
__

Example:
This is a link to the Codebeamer home page.

To reproduce this in MS Word:

  1. Select some text.
  2. Make right click on selection.
  3. Click the Hyperlink option in the pop-up menu.
Wiki Markup:

__This is a link to the [Codebeamer home page|http://codebeamer.com] home page.
__
Interwiki references like [WIKIPAGE:1037] or [My page|WIKIPAGE:1037] can be created in same way.

Headings

Example: Not shown here, as headings would distort the Table of Contents of this page. Click You must login to see this link. Register now, if you have no user account yet. for an example of headings.
To reproduce this in MS Word:
  1. Select some text.
  2. Select Heading1, Heading2 or Heading3 style in the Styles section.
Wiki Markup:
!!!Heading 1
!!Heading 2
!Heading 3

Text effects

Example:

Here is some bold, italic, and monospaced text.

To reproduce this in MS Word:

  • For bold and italic: select some text and click Bold or Italic in the Font section.
  • For monospaced: select some 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 MS Word:
Select some text and click the Bulleted List icon in the Paragraph section.

Wiki Markup:

*Item 1
**Item 2
**Item 3

Numbered list

Example:
  1. Item 1
    1. Item 2
    2. Item 3

To reproduce this in MS Word:
Select some text and click the Numbered List icon in the Paragraph section.

Wiki Markup:

#Item 1
##Item 2
##Item 3

Preformatted text

Example:
This is the first line.
 This is the second line with a space char in the first position.
  This is the last line with 2 space chars in the start positions.

To reproduce this in MS Word:
Create dotted border around some text paragraphs using Borders and Shading option in Paragraph section.

Wiki Markup: It uses three consecutive curly braces ({) to open a block, and three consecutive curly braces (}) to close a block.

Info boxes

Example:
information box
warning box
error box
comment box

To Reproduce this in MS Word:

  1. Select some text
  2. In the Paragraph section select Borders and Shading, and set solid border of the appropriate color: red for error box, yellow for warning box, blue for information box and gray for comment.
Wiki Markup:

%%information
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 MS Word: To create a new table switch to the Insert tab and select Table. After the table has been created, you can merge its cells by selecting them and clicking Merge Cells in the pop-up menu. To add a heading, simply fill the heading cells with any color.

Wiki Markup:

[{Table

||Table heading|<
|cell 1|cell 2
|cell 3|^

}]


Colored text

Example:
This is a red text and this is a text with lime background

To Reproduce this in MS Word:
Select some text and use Font Color and Text Highlighting options in Font section to set text foreground and background color.

Wiki Markup:

%%(color:red)This is red text%% and %%(background-color:lime)this is text with lime background%%

Pictures

Example: file or clip art. The picture is included as an attachment to the wiki, in the Properties.

To Reproduce this in MS Word:
Choose Insert... Picture .... From File. 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 upload/convert will attach the picture in the Properties .... Comments and Attachments.

For a step-by-step example of using Edit in Word to insert and upload pictures into your wiki, see Pictures in EiW.

Limitations of Editing in MS Word

Limitations inherent in this wiki-RTF-wiki double conversion include:

  • MS Word pictures are automatically uploaded and inserted into the wikis, and vice versa. However, vector graphics (eg, graphics created in MS Word) are not supported. Pictures can also be separately uploaded to the CodeBeamer server and linked inline.  Pictures that are inserted in MS Word and then resized will not reflect the resizing when displayed in the wiki.  That is, the pictures may be too large or too small.
  • Table of Contents: Use the Wiki markup plugin definition
     [{TableOfContents}] 
    , not the MS Word Table of Contents, as the MS Word Table of Contents will not import into the wiki.
  • Similarly, complex Tables and other more complex MS Word constructions, that have wiki equivalents, should be defined in the MS 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, use copy and paste from other RTF files (into the Wiki in Edit in Word) with great caution. Very large RTF files (for example, RTF files that contain pictures) will not convert properly.
  • Colors: a limited number of colors convert from RTF to wiki
  • Font Sizes: relative font sizes are not converted, unless they are part of formatted markup-style headings.