Reference nodes are used to link to additional external reference material, which can be in the form of a web link or Word document etc. In addition, they can also be linked to images, which will then be scaled and used instead of the usual reference node icon.
For information on how to create a reference node see Creating Nodes).
When you open the reference node by double-clicking, or select contents from the right-click menu (for further information see The Node Right-Click Menu), you will see a window similar to the following:
In the lower half of figure 1, you will see that there are two additional sections not found on other node types. The first is labelled 'Ref:' and is used for linking to external material.
The second is called 'Icon Image:' and is used for linking to an image which is used to replace the map icon for that node. You will see below this that the user can specify the sizing of the image as an icon. The default is to Diaplay the image as a thumbnail image which will scale the image to a ratio of 96 pixels. The second option is to display the image at it's acutal size. The last option is to specify the size you wish to display the image at. When you select this option the 'Specify' button becomes available. When you click this it will open the following dialog:
To add a link to an external document, either type the path to the file into the 'Ref:' field or click the '.\.' button to open the file selection window. If you use the file selection window, navigate to the file you want, select it then click "Open". You will see the file path has been entered into the reference field, (see figure 2 below).
Once the path to the external document has been entered, click the 'OK' button to save it.
There are two ways to view the external document once it is linked. You can either open it from the node's contents panel using the 'Launch' button, which is located next to the reference field (see figure 2), or you can double-click the node itself.
N.B. If you wish to add a reference to a local html file and include an anchor in the reference then you need to place 'file:///' at the start of the reference, e.g: 'file:///Applications/Compendium/ReadMe.html#support'. This will lauch the browser and correctly run the path and gto the anchor. ('file://' works on Windows).
To add a link to an image, either type the path to the image file into the 'Image:' field or click the '.\.' button to open the file selection window. If you use the file selection window, navigate to the file you want, select it then click "Open". You will see the file path has been entered into the image field, (see figure 3 below).
Once the path to the image has been entered, click the 'OK' button to save it. You will see that a scaled version of the image has been used instead of the standard reference node icon, (see figure 4 below).
If you wish to view the image in its original size, you can use the 'View' button on the node contents panel, which is located next to the image field (see figure 3). If the reference node has only been linked to an image and no external document, then double-clicking it will also view the image in its original size.
N.B. Large images consume a lot of system resources, it's better to create thumbnail images if you want to have several of them on one map.
These can only be created through the node right-click menu.
They have the following icon ![]()
They are a special type of reference node where the contents of the reference field is system generated (so don't mess with it!!), and has a special format. It references a specific instance of a node in a specific map. This way, you can use internal reference nodes to jump to or 'GO TO' another node in another map. This could be useful for many reasons like navigation, reminders etc, (see also Group Working for their use with the inbox).
To remove either an external reference link or an image link, simply remove its path from the appropriate field in the contents panel of the reference node. The change either an external reference link or an image link simply follow the same procedure as you did to add them.
Due to historical reasons, an external document link can point to an image file, and that image will be used as the icon on the reference node. If both the reference field and the image field point to image files, the image field will always take precedence and be used as the image for icon.
The behaviour on double-clicking a reference node depends on the node settings. If the reference node does not have an attached reference or the reference it does have cannot be launched for some reason, then double-clicking will open the node contents dialog. If it does have a valid reference, then double-clicking will launch the reference.
On windows this should automatically open the correct application for the file type of the reference. On Mac and Linux this is a little more complex. The first time you open a specific reference type you will be asked to choose the application to view the file with. Compendium will then store this information in its 'LaunchApplications.properties' file against the file type, so next time it will launch the file correctly without asking you. The LaunchApplications.properties file has been pre-seeded to recognise urls and launch either safari or mozilla automatically.
If you attach an image in the image field, this does not count as a reference and so double-clicking will not open the image, but open the node contents dialog. You must add the link to the image in the 'Reference' field for double-click to open the image.