Summary

Example extract

The following example will make a bookmark link tag, which when executed, will open the demo.3d file normally located in the /3d directory, and goto the bookmark within that document called 'demo--lnk--1'. Also including the link in Acrobat's outline list and the outline for page number five.

Syntax (7.06a)

The bookmark name.

Up to 127 characters describing the bookmark. The description will be used as the name of the link in Acrobat, if no description is defined then the name is used instead.

This parameter identifies the bookmark name when pointing a bookmark to another document.

This parameter identifies the filename when pointing a bookmark to another document

or a URI if the '*' prefix operator is used.

URI type links do not appear in the PDF bookmarks list even if specified to do so as they do not have a document page associated with them and therefore should not apear in the document navigation bookmarks.

When creating a bookmark which points to a bookmark in another document, it is possible to have the bookmark you are creating listed in Acrobat's outline list of bookmarks for the current document. However, Arbortext APP needs to know which page of the current document the outline is related to so that it can be added to the PostScript file in the appropriate place. For example, specifying page 5 will include the outline amongst other outline entries for that page.

When viewing a PDF file, the bookmarks are listed as a navigational aid to the left of the page. These bookmarks are in a hierarcical tree format, each level has its own number level 1, level 2 etc. This parameter controls at which level a bookmark should be placed in this tree.

If the hierarchy is not complete i.e. a level is missed, the bookmark will still appear on the specified level, but the missing level on which it sits beneath will be given a default name of 'Outline placeholder'.

In 3B2 setting the bookmark or link parameters is done in one of two ways depending on the type you need. Inter document bookmark links are generaly generated with the tmark macro for simplicity although this command can also be used. But when generating inter-document and URI links the only applicable command is this one. The command for defining the target text or graphic from which to jump to the specified link once clicked is the same for all link types, .

Example

With the URI link type the 'mailto' can be changed to any URI type you need following the standard conventions.

The first syntax below illustrates external links, the second is one way of generating internal links:

Example

This example sets a bookmark link to the same point in the demo.3d file, but from within the same document. Again including the link in the outline list, and instructing Arbortext APP to fit the whole page.

Example

The process of link generation can be enhanced by showing the link to a tag, which is then run using trun to activate the links. In this case trun "connect". Note the inclusion of $10# at the end of the command, to insert a return in 'connect.rf' after every entry.

However the example above still requires manual intervention to set the name(s) etc. To achieve total automation of this process, requires a tag similar to the example show below, using a getvar, variable value and/or counter values to generate the names, which in turn could be set from attribute tag values and text yanked from the text stream.

For instance the first section of the example (tpmkset "$^link_name^$x(99)") simply says, 'show contents of the link_name variable and the current value of counter x99' to make up this link's name. At the top of the tag you will see that the counter has been set to increment by 1 each time the tag is appears, therefore creating a unique number for each occurrence.

See , ,