Category:Technical Framework Documentation

General Technical Framework Documentation Process

Instructions on Using MS-Word for Editors of the IHE Technical Framework

1) To maintain the stability and integrity of the Technical Framework (TF) documents and their template, it is imperative that all editors avoid importing formatted text from other documents. Unfortunately, this is the default behavior of MS-Word when performing a simple cut-and-paste from document to document. Thus, an editor importing text into the TF from any other document must perform the following steps: a. Cut or copy from the source document b. Place cursor where the selection is to be added c. Select "Edit:Paste Special: Unformatted Text"

2) To maintain the consistency of the TF, apply only the Styles defined by the ihe.dot template to text in the document. The Styles are selectable in a window on the Word toolbar.

3) When starting a new TF document, begin by using either an existing TF document or the ihe.dot template (available on the ftp site at ftp://ftp.ihe.net/IHE/Document_templates/) as a basis.

4) To create stable diagrams in the TF document, editors must use the following method: a. Place cursor in the text where the diagram is to be inserted; the cursor should be on a blank line with only a paragraph tag. b. Select "Insert: Object: Microsoft Word Picture" For efficiency and consistency it is generally best to base new diagrams on existing ones (e.g., Use Cases, Transaction Diagrams, etc.). After creating the new diagram (as described above), find a similar diagram from which to draw content. Double click on the source diagram to open it, copy all the desired pieces to the clipboard (using Shift+mouseclick to select). Open the new diagram, paste in the borrowed pieces and edit as desired. Redraw the diagram boundaries as necessary and close the picture.