Using Microsoft Word ML

Modified on 2009/07/13 18:28 by Charles — Categorized as: WordML


System Requirements

This section describes the system requirements that you need to work with TrackerRealm Content Management solution.

Microsoft Word 2003: Microsoft Word 2003 is the required version for use with TrackerRealm Content Management.

XML Plug-ins: XML Plug-ins are available free of charge from the Microsoft website. This plug-in allows the user to see XML tags within the MS Word document.

File Transfer Program: A File Transfer Program is used to transfer the MS Word files to the website.

Installing the XML Plug-ins

The MS Word XML Plug-ins is found at http://microsoft.com.
  1. Download the following software.
  2. Install the plug-ins.
  3. Restart your PC.
  4. Open MS Word.
  5. Verify that the XML Plug-in is properly installed.

Creating the MS Word XML document

This section explains how to create MS Word documents for use in TrackerRealm Content Managed websites. This section assumes that the user is starting with an MS Word doc file.

The basic difference between using MS Word as a text editor and as a web page content editor for the TrackerRealm Content Management solution is the file type. To have your documents transferred directly to your website, the file type is XML vs DOC , e.g sample.doc that is converted into a sample.xml file. The XML file type allows the use of XML tags that are interpreted by content management program into web page formatting.

Figure 1: XML Schema Dialog

To convert the MS Word doc file into an MS Word XML file,
  1. Open the MS Word document
  2. Import the XML schema
    1. Click the XML Schema Dialog button.
    2. Click the ‘Schema-Page’ checkbox.
    3. Verify that ‘Validate document against attached schemas’ is checked. This provides the user with an automatic confirmation of the content inside the XML tags.
    4. Verify that ‘Allow saving as XML even is not valid’ is NOT checked. This ensures that files are only saved if they are valid and hence reduces mistakes in the web page.
  3. Insert the XML tags into the MS Word document. Remember that all elements in the document structure must be present in the document.

Figure 2: XML Toolbox

This section explains the XML commands used in MS Word. The XML commands include:
Figure 3: XML Structure Task pane

The XML Structure Task Pane shows the outline of the document. It has two uses: to correct errors and to add additional tags.

  1. In the event that there is an error in the XML structure, the XML Structure Task Pane shows exactly where the error is. Hint: Make sure that the ‘Show XML tags in the document’ checkbox is checked.
  2. Add additional tags to the document. Hint: Make sure that the ‘List only child elements of current element’ checkbox is checked.
    1. To add a paragraph, position your cursor where you want to add the paragraph. The lower box shows what tags can be added.
    2. Click the Paragraph XML tag. The cursor is now positioned inside the Paragraph XML tag.
    3. Click the SubTitle XML tag. The cursor is now positioned inside the SubTitle XML tag. Add the paragraph heading. Note: there are not child elements shown in the lower box.
    4. Position the cursor at the end of the SubTitle XML label. The child elements box now shows SubText. Click SubText. Enter the body of the paragraph.

Hints for Editing an MS Word Document

This section is a list of hints that may be useful in editing the MS Word document.

Paragraph Formatting

  1. Formatting in the paragraph - Use the formatting options to add emphasis to the MS Word document. Styles, such as Heading 3, are not transferred from the MS Word document to the web page.
  2. End of the paragraph - The end of the paragraph is the closing SubText XML tag. If this tag is positioned on the next line, past the text, an extra line appears in the MS Word document and the web page.
  3. Table of Contents - To include text in the MS Word document that is not included in the web page, such as a table of contents, include the text outside of the XML tags. Note: The text must be included inside of the Paragraph XML tag, but outside of the SubText and SubTitle XML tags.

XML Tags

  1. Check the XML Tags - It is not necessary to have the XML tags visible when editing the document. However, turn on the XML tags and verify that ALL text is inside the correct XML tags.
  2. No content inside the XML tags - The XML tags must be included in the MS Word document. This guarantees that the user considers whether to include content inside the tag.

If there is no content (text or picture) inside the XML tag, it will not be shown in the web page when the MS Word content is transferred.

MS Word Template

  1. Use the MS Word Template
    A MS Word template is provided. Use it. The template includes the XML tags. The template speeds up how the content is included in the document.
  2. Web Page footer
    If there is no content inside the Bottom Title XML tag, the footer will not appear in the web page. If the user wishes the footer to appear in the web page, include a space inside the Bottom Title XML tags.