Example

{%%Enum.List ID="Default" Type="Bullet" Target="Doc" Path="Template" Match="*.*" Text="<a href='{%Doc.URL%}'>{%Doc.Name%}</a> {%Doc.Size .Format='#,### bytes'%}"%%}

Note that there are embedded tags in params. In such cases single quotes must be used instead of double quotes (as in Size .Format) because it is already inside of a set of double quotes.

Parameters

Type

There is no default.

Target

Default is "Doc".

Path

Path where enumerated items exist. Path is relative to current directory. If absolute, it is relative to wwwroot.

Default is the current directory.

Match

A pattern match used to select which files or directories are enumerated. Example, "*.jpg", "*.props.html".

For Target="Dir", default is "*.*". For Target="Doc", default is "*.html".

Text

Specifies the text to display using Doc or Dir variables. When Path="Dir", only Dir variables may be used.

Default is Doc.Name or Dir.Name depending on Type.

Delimeter

Used for Type=Delim.

Default is ", ".

ExcludeIndex

Specifies whether or not to exclude index.html in the enumeration.

Default is "True".

SortBy

Variable used to sort the results. Currently for documents only Doc.* variables are valid when Target="Doc" and File.* variables when Target="Dir". Only a single variable can be specified and the .Format parameter cannot be specified. In the future, all of these restrictions will be removed allowing other variables, multiple variables, and formatting to be specified.

Examples:

Numbers will be sorted as numbers, timestamps as timestamps, and strings as strings.

If no value is specified, a default sort will be looked for in #Dir.cfg of the target directory. If none is specified in #Dir.cfg, no sorting will be applied and the order should be considered random.

SortOrder

Default is "Asc".

ID

An optional document unique ID. ID is used to enable RSS functionality and for Doc.EnumPageNo. If no ID is specified, RSS and other functionality will be disabled for the enumerator. "Default" is a special string, and specifies that this enum is the default RSS feed for the document. ID values are case insensitive.

Title

An optional title used for title of the RSS feed. If no Title is specified, the ID is used. Titles are used when describing or publishing the RSS feed.

MaxItems

Specifies the maximum number of items to be returned.

Default is 0, which means return all items.

Page

Optional page number of items to return. Page numbers start from 1. If no MaxItems value is specified, Page's only valid value is 1 or not specified.

Default value is 1.