12.12.3 HTML node functions

filename(node)

Parameters

node is one of the following HTML node identifiers: current (this is the default), top, up, next, previous, or filenamekey (the filenamekey for a specified node)

Returns a character string with the filename of the node file.

For example:

filename(top) --> "document_1.html"

headingnumber(node)

Parameters

node is one of the following HTML node identifiers: current (this is the default), up, next, previous.

Returns a character string with the FrameMaker autonumber of the heading paragraph that triggered node. See also number(currprev)and headingtext(node).

For example:

headingnumber(next) --> "4.5.3"

headingtext(node)

Parameters

node is one of the following HTML node identifiers: current (this is the default), up, next, previous.

Returns a character string with the text of the FrameMaker paragraph that triggered node.

Note: The returned string contains no markup (character highlights, image data, hypertext links). This function is meant to be used to isolate the HTML TITLE of a node, which does not allow any markup. The same paragraph will be separately translated as a heading according to rules specified for its FrameMaker paragraph tag. See also heading(level, string, class:classname).

For example:

headingtext(next) --> "Overview of the Software"

index(markertype, indexoption)

Parameters:

markertype

The type of the source marker, which is one of the following values:

2 or Index
3 or Comment
4 or Subject
5 or Author
6 or Glossary
11, 12, ..., 24

indexoption

May be one of the following values: simple, letter, or node.

simple creates single node index with letter groups separated only by a space.

letter creates a single node index with letter groups separated by letter headings.

node creates one node per letter group, in which case a letter button is generated in the top index node for each letter group for which there is at least one index entry. Node rules may only be specified for the top index node which is also the only node that may be accessed using filename(node).

Returns the character string that contains the HTML markup for the generated index and, if indexoption is node, creates all the sub index nodes corresponding to each letter entry.

For example:

index(index,simple)

maintitle()

Returns the character string that is the main title of the Web. When the WebMaker user interface is used, this is the value specified in the Make a Web dialog, in the Main Title area. When the webmaker command line is used, this is the value specified with the -t switch.

This function provides the HTML TITLE of the entry page of a translated document.

toc(depth, scope)

Parameters

depth

A positive integer

scope

local or global. The default is local.

Returns a string that contains the HTML markup for a table of contents for a node of the given depth, starting from the level immediately below current if scope is local, or starting from the topmost node if scope is global.

Only paragraph tags declared as TYPE Heading are considered as eligible entries in a table of contents.

The depth corresponds to the LEVEL parameter of paragraphs of TYPE Heading only when the scope is global. For example:

toc(3,global)

The example above returns the table of contents for all occurrences of paragraphs of TYPE Heading that have LEVEL attribute values of either 1, 2, or 3.