make-section-reference

Description

Return a sosofo with the title of the given node, prefixed by its section number. If the optional argument ts is given, it is used as the title sosofo, rather than extracting it from the node.

You can generate a reference to a node either by calling this function with that node as argument, or by processing the node in the section-reference mode (which might well call this function in turn. In the former case, you can include keyword attributes.

This function should be able to generate a reference to at least all the functions listed in the returnvalue of function (section-element-list) (mmm, how about (target-element-list)?).

In the body of the function, we call (process-node-list) on the first child of the target node. This is because we call this function for elements both within the Starlink General DTD and within the DocumentSummary DTD. The former has sub*sect enclosing subhead enclosing title, and the latter has sub*sect enclosing title, and in both cases it is the title we wish to get at.

Note that, if you specify both the title and set-prefix keywords, you seem to be doing all the work. You should still call this routine in that case, however, so that it can do any other processing required.

Argument list

target = singleton-node-list (Given), keyword

The node we wish to generate a reference to

title = sosofo (Given), keyword

A sosofo specifying a title to be used, rather than extracting it from the node

specify-type = boolean (Given), keyword

If true, then include the section's type (ie, appendix or section) in the reference.

set-prefix = sosofo (Given), keyword

If provided, this overrides the section-number prefix

short-ref = boolean (Given), keyword

If true, then generate only a short reference (which currently means, just the prefix)

Return value

Type: sosofo

Name of section, prefixed by section number