Next Up Previous Contents
Next: document-release-info
Up: Common functions for the Starlink stylesheets
Previous: index-file-name
[ID index][Keyword index]

root-file-name - Return the filename root.

Description

Returns the filename to be used as the `root part' of the name when generating HTML file names. Note that this is not the same as the (index-file-name), which is the name of the `index' file which is the entry point of the collection of documents.

This is also used by the LaTeX stylesheet, when generating the names of various auxiliary files.

Note that the parameter (%override-root-file-name%) does not override within this function, since this function is not merely used for the name of the single root file. See (html-file).

Argument list
nd = node-list (Given), optional

Node which identifies the grove we want the root file name of

Return value

Type: string

Complete filename for the `entry-point' HTML file.


Next Up Previous Contents
Next: document-release-info
Up: Common functions for the Starlink stylesheets
Previous: index-file-name
[ID index][Keyword index]