addedValues Plugin

addedValueMacros.showIndexMacro

Syntax

{addedValueMacros.showIndex(variable, constrainQueryID="", reportId="m5_showIndex", sortBy="", sortDirection="", maxItems=50 ,includeSelf="", indexDirection="", dateFormat="", suppressEmptyTerms=false, headingsOnly=false)}

• variable - the name of a of an addedValeus indexed variable.
• constrainQueryID - optional, the name of a query to select valeus from the index.
• reportID - optional, the name fo a report to format and paginate the results.
• sortBy - optional, the name fo a variable to sort the results by.
• sortDirection - optional, if the value begins with 'reverse' then descending, otherwise ascending.
• maxitems - optional, numebr fo hist to display.
• includeSelf - optional, if 'includeSelf' means include the current page as a hit.
• indexDirection - optional, direction to traverse the index.
• dateFormat - optional, the name fo a known date formatter.
• suppressEmptyTerms - optional, dunno what this does.
• headingsOnly - optional, dunno what this does.

Examples

Semantics

See also

• Metadata Plugin