Contents Component

The Contents component generates the table of contents information. It does not generate full HTML so you must use it from within a template. The Contents component also links to other templates as specified by the URL parameters so when a user clicks on a tree item, the item's contents appear in the browser.

Function Names

The Contents component does not support URL function requests.

URL Parameters

Name	Purpose
path info	Optional path to the node where you want to expand the table of contents. If you specify a path using the cp parameter, path info is ignored.
fn	Name of a template containing the CONTENTS replacement variable. The default HTML TOC template installed with NXT 4 is contents-frame-h.htm.
cp	Path of the node where you want to expand the table of contents. The path to a node is a list of the names of the node's parent nodes followed by its own name. Names are separated by the slash character (/). NXT 4 nodes can be folders, content collections, content services, or documents. A site's table of contents displays node titles, not node names. In addition, some folders can be hidden from the table of contents. To determine the path to a node, you may wish to view the source of an HTML TOC page, or use the Content Network Manager application. If you do not specify a contents path, the Contents component uses path info. If path info is not specified, the Contents component uses the path to the most recently requested document. The contents component reads the doc cookie dropped by the Document component to determine the path to the most recently requested document.
sp	Optional argument specifying the path to the sub document node to expand the table of contents to. A content collection builder can use special indexing options to make sub document headings appear in a site table of contents. You must use sp to open the HTML TOC to a sub document headings.
t	Filename of the HTML table of contents template to request when the user clicks on an expandable branch image to the left of a HTML TOC heading.
tt	Filename of the template that HREFs created from HTML TOC headings will target. When a user clicks a link in the TOC, this parameter specifies the target attribute for the link. When including an HTML TOC frame in a frame set used to view documents, the target template should specify the file name of a template containing the DOCUMENT replacement variable (for example, document-frame.htm). When including an HTML TOC in a search form frame set, the target template should be the file name of a template containing the CONTENTS replacement variable (contents-frame.htm) because an HTML TOC is used in selection mode when used as part a search form frame set. When used in selection mode, the links from HTML TOC headings are used to change which node of the TOC is selected.
tf	Name of the frame that the HREFs created from HTML TOC headings will target. When including an HTML TOC frame in a frame set used to view documents, the target frame should be the frame used to display documents. When including an HTML TOC in a search form frame set, the target frame should be the HTML table of contents frame (_self) because when users click on a node, they are not requesting to view the document but rather specifying the domain of the site to search.
sync	Optional flag specifying whether or not to synchronize the table of contents to the node specified by the path info argument. Specify sync=1 to synchronize but not highlight. Specify sync=2 to synchronize and highlight. The HTML TOC synchronizes to a specified node by expanding its branches to the node's parent. If highlight is turned on (sync=2), the node's title is selected. See the "SynchronizeContents" Java Script function in the document-tools.htm file for an example.
sel	Optional flag specifying whether or not to turn on "selection" in the HTML TOC. When selection is turned on, NXT 4 highlights the node specified by the path info or by the selection path argument by formatting the title of the node with the HTML SPAN tag. By default selection is turned off. Specify sel=1 to turn selection on. Specify sel=0 or sel= to turn selection off. When serving an HTML contents template requested by a URL with selection turned on, NXT 4 replaces the CONTENTS:SELECTED replacement variable with the path to the currently selected node. Typically this argument is used for URLs that request an HTML TOC page for use in conjunction with a search form. The HTML TOC template used by the search form contains a script that stores the path to the selected branch in a variable. Before submitting search data, the search form retrieves the path to the selected branch and specifies it for the domain of the search.
selp	Optional parameter specifying the path to a node to select (provided by the selection flag sel=1). If selection is turned on, but no selection path is specified, the node specified by the contents path argument is selected.
c	Specifies the maximum number of items to return. Default is 75. NEXT and PREV replacement variables will be replaced with no empty values, as necessary, if more than n items are present.
start	Optional argument specifying the name of the first node to display in the HTML TOC. NXT 4 uses this argument to allow a user to move between portions of a table of contents whose lines exceed the value specified by the maximum lines argument.
end	Optional argument specifying the name of the last node to display in the HTML TOC. NXT 4 uses this argument to allow a user to move between portions of a table of contents whose lines exceed the value specified by the maximum lines argument. NXT 4 ignores the start argument if a URL also specifies an end argument.

Replacement Variables

Name	Purpose
CONTENTS	Streams the Contents-h.htm template.
CONTENTS:PARENTS	Lists parents of the current Contents path.
CONTENTS:CHILDREN	Lists children of the current Contents path.
CONTENTS:PREV	Insert a URL that points to the previous section of contents. If there is no previous section of contents, then this parameter is replaced with an empty string.
CONTENTS:NEXT	Insert a URL that points to the next section of contents. If there is no next section of contents, then this parameter is replaced with an empty string.
CONTENTS:SELECTED	Current Contents selected path. Only valid when the contents is in selection mode.
CONTENTS:BACKTOTOP	Insert a URL that points to the top of the contents.

Style Sheet Styles

Name	Purpose
CONTENTS-SELECT	Selected path is displayed in this style.
CONTENTS-PARENT-ANCHOR	Parent labels with document links are displayed in this style.
CONTENTS-PARENT-LABEL	Parent labels without document links are displayed in this style.
CONTENTS-CHILD-ANCHOR	Child labels with document links are displayed in this style.
CONTENTS-CHILD-LABEL	Child labels without document links are displayed in this style.