Template parameter reference

There are four main places where templates are used. This section describes the template parameters available in each case.

The following template parameters are always available:
Parameter Description
REPEAT-NUMBER Returns the repeat number (1-based) when used inside a repeating section.
@ Returns the result of the evaluated parameter value of the last conditional parameter.
APP-BASE-DIR The Awasu installation directory.

Template parameters may always have encode and chars attributes to specify encoding.

Template parameters that return date/time stamps may also have a format attribute that specifies a strftime-style format string.

 


Channel summary pages

The following parameters are available in channel summary pages.
Parameter Description
CHANNEL-METADATA Inserts channel metadata.
LAST-UPDATE-TIME When the channel was last updated.
LAST-SUCCESSFUL-UPDATE-TIME When the channel was last successfully updated.
CHANNEL-UPDATE-INFO Returns the last successful update time and the number of previous update errors.
FEED-ITEM-COUNT-INFO Set if the number of feed items being shown is less than the number of available feed items.
This returns a string of the form "Showing ... of ... items"
BACKGROUND-IMAGE The file path to the watermark image.
OFFLINE-ITEM-IMAGE-URL The URL to the image used to indicate that a feed item is available for offline reading.
SHOW-BRIEF-HEADERS Set if the user has configured channel summary pages to only show brief headers.
SHOW-BRIEF-FEED-ITEMS Set if the user has configured channel summary pages to only show brief feed items.

The following parameters are available in channel summary pages and must be inside a FeedItems repeating section.
Parameter Description
ITEM-METADATA Inserts item metadata.
IS-ITEM-READ Set if the current feed item has been marked as read.
IS-TRUNCATED-ITEM-DESCRIPTION Flags if the previous {%ITEM-METADATA% description} was a truncated excerpt.
OFFLINE-ITEM-URL A special URL to show a feed item if it is available for offline reading.
ITEM-RELATED-LINKS-INFO An HTML fragment that lists the related links for a feed item.
While an item's links are available via its link metadata, this parameter does additional processing such as eliminating duplicates, the URL for the item itself, Atom service links, etc.

Legacy template parameters are still recognized for backwards-compatibility. They will be removed in a later release.

 


Channel reports

The following parameters are available in channel reports.
Parameter Description
BACKGROUND-IMAGE The file path to the watermark image.
REPORT-TIME The time the report was generated.

The following parameters are available in channel reports and must be inside a Channels repeating section.
Parameter Description
CHANNEL-METADATA Inserts channel metadata.

The following parameters are available in channel reports and must be inside a FeedItems repeating section.
Parameter Description
ITEM-METADATA Inserts item metadata.
ITEM-IMAGE The URL to the item's image.

The following parameters are available in workpad reports only.
Parameter Description
WORKPAD-NAME The name of the workpad.
WORKPAD-DESCRIPTION The workpad's description.
ITEM-NOTES Any notes that have been entered for the feed item.

Legacy template parameters are still recognized for backwards-compatibility. They will be removed in a later release.

NOTE: Workpad reports are not yet hooked into the CHANNEL/ITEM-METADATA infrastructure. {%CHANNEL-METADATA%} will always return an empty string while {%ITEM-METADATA%} only supports a limited set of metadata (name, url and description)
This will be fixed in a later release.

 


Search channels

The following parameters are available in search channel templates.
Parameter Description
CHANNEL-METADATA Inserts channel metadata.
If this is outside a SearchResults repeating section, it refers to the search channel itself.

The following parameters are available in search channel templates and must be inside a SearchResults repeating section.
Parameter Description
CHANNEL-METADATA Inserts channel metadata.
If this is inside a SearchResults repeating section, it refers to the channel the current search result came from.
ITEM-METADATA Inserts item metadata from the current search result.
ITEM-SCORE Returns the current search result's score.
OPEN-CHANNEL-URL Returns a special URL that will open the channel the current search result came from in Awasu.
OPEN-ITEM-URL Returns a special URL that will open the current search result in Awasu.
OPEN-ITEM-CS-URL Returns a special URL that will open the current search result in Awasu.
This parameter differs from {%OPEN-ITEM-URL%} in that it will try to show the item in the channel's summary page if possible, otherwise it will open the item's URL itself.

 


Search results

The search results template file offers the same template parameters as
search channels plus the following additional ones.
Parameter Description
SEARCH-QUERY-STRING The original query string.
SEARCH-RESULT-COUNT-MSG The number of search results found (in the form "Found ... results").
NO-SEARCH-RESULTS Set if no search results were found.
PAGE-NUMBER-MSG The search results page number (in the form "Showing page ... of ...).
PREV-PAGE-URL The URL for the previous page of search results (if available).
NEXT-PAGE-URL The URL for the next page of search results (if available).
ITEM-IMAGE The URL of each item's image.
PREV-PAGE-IMAGE-URL The URL for the "previous page" image.
NEXT-PAGE-IMAGE-URL The URL for the "next page" image.
SPACER-IMAGE-URL The URL for a spacer image.