ID Component
The ID component resolves document ID links and redirects the path info to the
specified document. The ID component should not be used in user-defined
templates. It should be used by content authors to link to other documents.
In general, you should reference the ID component in the document stream
returned by the NXT 4 server. Do not use it as a replacement variable in a
template. The actual text that replaces the tag is the corresponding URL for
the ID component request in the proper format.
Function Names
| ID |
Resolves the given ID and redirects to the resulting location. |
URL Parameters
| f |
ID |
Function name |
| id |
ID name |
ID to replace |
| cid |
Collection ID |
(Optional) ID of the collection that contains the document whose ID is given by
the ID parameter. If this parameter is given and the collection is not present
(for example, the CD is not in the drive at the moment), a local media template
is sent back. If this parameter is not given and the collection whose document
is referenced by ID is not present, an ID not found error template is the
returned. |
| p |
Name path |
Path to a document below (in hierarchy) the information represented by the ID. |
| t |
File name |
Template to use. |
| tc |
Template name |
Name of the template for the Contents component. |
| fc |
Frame name |
Frame where the Contents Component resides. |
 |
The t, tc,
and fc parameters are supported by the Document
component. The ID component simply passes those values to the Document
component when it redirects. |
Replacement Variables
| ID:<ID>[#NamePath] |
Replaced with the URL represented in the query parameters.
<ID> is the URL-encoded ID that you want to replace. [#NamePath] is
an optional name path to a specific location underneath the location specified
by the <ID> field. This is useful if you do not want to specify IDs for
everything in your document collection, but still want to do ID linking. |
|
It is good practice to URL encode (percent encode) ID's in all
tags and URLs. However, the only special characters that are absolutely
required to be encoded are: % (percent), ? (question mark), # (pound sign), =
(equals), + (plus), & (ampersand), space, and : (colon). Any other
non-alphanumeric character will work either way. |
Style Sheet Styles
The ID component does not support styles.
Copyright © 2006-2023, Rocket Software, Inc. All rights reserved.