Creating document links

Introduction

It can be useful to create links within your document to other external documents, or to insert these documents into your document as images or text. To do this, you must first create a document link, as shown in Figure 5, before running one of four possible commands on it (Figure 6).

Note: If you don't run one of the commands available on your document link, the file you want to insert through the document link in question will not actually appear in the generated documentation.

Creating a document link

To create a document link, carry out the steps shown in Figure 5 below.

Figure 5. Creating a document link

Steps:

1. Select the "Training system" package in the explorer.

2. Click on the "Create a document link" icon. The "Document link" window then appears.

3. Enter a name for your document link and then enter the path of the document which you wish to link to your document. A file browser is opened by clicking on the icon. Confirm by clicking on "OK".

4. If you wish to generate a hypertext link to the specified document (instead of physically inserting the linked document into your document), check the "Generate a hypertext link" tickbox.

Note: The "File" field can contain environment variables (previously defined by the user), which must respect the following syntax: $(VariableName). For example, $(VariableName)\Documentation\DocToInsert.doc.

Running commands on your document link

After creating your document link, the next step is to run one of the four commands available on it via the context menu, as shown in Figure 6.

If you do not run one of the available commands on your document link, the file you want to insert through the document link in question will not actually appear in the generated documentation.

Figure 6. The context menu available on a document link

Key:

· "Edit linked document": This command edits the linked document using the appropriate tool.

· "Insert linked document as text": This command inserts the document you specified into your document in text format.

· "Insert linked document as text without format": This command inserts the document you specified into your document and retains its layout.

· "Insert linked document as image": This command inserts the document you specified into your document as an image.

Note: The "Insert linked document as text without format" command only work for the RTF format.