index-file-name - Return the filename of the document index.

Description

Returns the filename to be used as entry point of the collection of documents. Note that this is different from the (root-file-name), which is a prefix applied to generated file names. In some cases, it might be sensible for (index-file-name) to simply call (root-file-name), but that's not what we want to do in this case.

This can be generated using the document type and DOCNUMBER if present (which need not be the case for all document types). Another way to set this might be through a processing-instruction.

An arguably better way to obtain a root/index file name is to root around in the grove and find the name of the source file, then use that information to generate the output file name. That should be possible, and it almost certainly involves the SosSequence property class (cf, HyTime A.6.1, for example, or <http://www.hytime.org/materials/sgmlpropset/classes/sosseq/index.htm>), which is in the `formal system identifier abstract' (fsiabs) module of the SGML property set. This isn't, however, implemented in Jade.

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.