addedValuesDocs

 
Home

Variables

Forms

Reports

Queries

Groups

Globals

Preferences

Triggers

Updaters

Audit Tables

Timed Tasks

Import

Export

Remote Search

Tropes

Help

Macros

Report a Bug

 
 

Editing Report storyListerRico2.

A Report template to build text using values from addedValues variables in a context. A context can be the current message, the current member or a refererence to and item in a "Hit list" returned by a search.

Use this page to modify the layout of the search results report storyListerRico2. This report uses AJAx techniques from the Rico open-source javascript library, and constructs a hitlist in a select box. Clicking one hit causes the page to open a connection to the server and run one more onchange reports and insert the results into thr current page. There is no page refresh. There are two layouts to consider here, the layout to be applied to each hit (which has to be valid between an <option>> tag and its close) and the arrangement of the select menu and the text from the onchange report runs.

In the report definition, which defines the layout of an individual hit, you may use variables in several ways. Most importantly any appearance of variable in a macro expression will be replaced by the current value. You also may use all legal macros and Builtins. In the following variable means either the name of an eligible variable or the name of a counter for this search hitNumber or pageHitNumber, or hiturl and hitDGurl which return the best url and a Discussion group url for the hit, respectively, while hitkeyValue is the sorting value of the hit (the sortedby property).

  • [[variable]] - Inserts current value of variable. The variable may be a global.
  • [[variable linktoHit]] - Inserts link to the entity (messsage, gem) that contains the hit. The variable may not be a global.
  • [[variable linktoDG]] - Inserts link to the messsage that contains the hit. The variable must be a message variable.
  • [[variable pictureRef]] - Inserts current value of variable as a picture. The variable may be a global.
  • [[variable shortcut]] - Inserts current value of variable as a shortcut. The variable may be a global.
  • [[variable shortcuturl]] - assumes current value of variable is a shortcut, and returns the url it contains. The variable may be a global.
  • [[variable shortcutStaticURL("optional template name"e;)]] - assumes current value of variable is a shortcut, and returns the url it contains, converting to the static site url if the page is being static rendered. The optional template name applies in sites configured for Scalable Content. The variable may be a global.
  • [[variable shortcut]] - Inserts current value of variable as a shortcut. The variable may be a global.
  • [[variable activeLink]] - Inserts current value of variable as an active link. The variable may be a global, but must take a string value which is an email address or url
  • [[variable mailthisPage("reportname", "target", "templatename")]] - Inserts current value of variable as the text of a link to the addedValues mailpage data entry page, specifying the report called reportname. target is optional, when provided sets the target in the link. templatename is optional, when provided sets the template of the page the user sees to specify the destination and personal message.
  • [[variable reportpageLink("reportname", "templatename", "target")]] - Inserts current value of variable as the text of a link to a page which displays the hit details using the report called reportname. templatename is optional, when provided sets the template of the page. target is optional, when provided sets the target in the link.
  • [[variable reportpagePopup("reportname", "templatename", "width", "height", "scrollbars", "resizable")]] - Inserts current value of variable as the text of a link to a popup window which displays the hit details using the report called reportname. templatename is optional, when provided sets the template of the page. Width, height, scrolbars and rresizable are optional, they will override the default parameters of the addedValueMacros.getPopupLink macro which generates the link
  • [[variable processmacros]] - Inserts current value of variable with shortcuts expanded and macros processed . Illegal macros in the text are first neutered.
  • [[variable labellookup("global variable name")]] - 'looks up' value of variable in the title part of the pre-defined values of the global variable and returns value part if found. Inside macros expression use the builtin string function labelLookup(<string expression>, global variable name) to lookup the value of an expression.
  • [[variable asLinkTo("linked variable name")]] - Returns the value of the linked variable for the entity pointed at by variable. The variable must be string valued, and take vaue shortcut, pictureRef or gem which each point at other entities.
  • [[[parameter name)]] - returns the value of the named query parameter. Inside macros expression use the builtin string function parameter(name).

Two other shorthand ways to report all the values of a multiple valued variable are

  • [[variable list(delimiter)]] - Inserts current values of variable as a list. delimiter is optional, if absent, no parentheses are permitted and a comma is used to separate values. If present, the delimiter must be a quoted character string. The variable may be a global.
  • [[variable ul(params)]] - Inserts current values of variable as a an HTML unordered list. params is optional, if absent, no parentheses are permitted. If present, the params must be 1 to 4 quoted strings specifying the string to start the report (default "<ul>"), the string to end it (default "</ul>"), the string to start each item (default "<li>"), and a string to end each item (default "</li>") - in that order.

Most powerfully, any appearance of a variable name in a macro expression will be replaced by the current value just before the macro is evaluated at run-time. You may use all legal macros and Builtins. For example, if variables called picName and picWidth existed, you might write

{pictureRef(picName, "alt text here", width:picWidth)}

You control pagination by setting the number of hits per page and defining a layout for the hits in a page, using the items [[hit1]] ... to [[hitN]] intermixed with whatever legal html tags and calls to legal macros you need. Useful pagination needs next and previous links and access to the total number of hits which you can add to the layout with

  • [[hitsPerPage]] - the number of hits to be displayed per page
  • [[hitnumber]] - the cardinal number of this hit
  • [[totalHits]] - the total number of hits yielded by your search
  • [[firstPageHit]] - the number of the first hit on this page
  • [[lastPageHit]] - the number of the last hit on this page
  • [[prevLink]] - a link to the previous page of hits. You may set the link text below
  • [[nextLink]] - a link to the next page of hits. You may set the link text below
  • [[groupText]] - the concatened text from each break on sortedBy variable, see below
These identifiers may also be used inside macro expressions.

There is second consideration for pagination, which is whether the report is called with a hitList sorted on another variable (the sortBy variable) or not. When it is you can "break the report" on a change in value of the sortedby variable. The layout of hits within a group determines what each group look like, a page is composed of as many of these as needed to fill the page. The values that define a group are named

  • [[groupKey]] - the name of the sortedBy variable
  • [[groupKeyValue]] - the value of the sortedBy variable for this group of hits
  • [[hitsPerGroup]] - the number of the hits in this group
These identifiers may also be used inside macro expressions.

All search hit reports can be called with either type of hitlist, so you should normally define both layouts here. The default templates do this in very simple way.

See also Search Navigation Reports.


Revert to:   discarding saved version

Use this page to modify the layout of the search results report storyListerRico2. This report uses AJAx techniques from the Rico open-source javascript library, and constructs a hitlist in a select box. Clicking one hit causes the page to open a connection to the server and run one more onchange reports and insert the results into thr current page. There is no page refresh. There are two layouts to consider here, the layout to be applied to each hit (which has to be valid between an <option>> tag and its close) and the arrangement of the select menu and the text from the onchange report runs.

In the report definition, which defines the layout of an individual hit, you may use variables in several ways. Most importantly any appearance of variable in a macro expression will be replaced by the current value. You also may use all legal macros and Builtins. In the following variable means either the name of an eligible variable or the name of a counter for this search hitNumber or pageHitNumber, or hiturl and hitDGurl which return the best url and a Discussion group url for the hit, respectively, while hitkeyValue is the sorting value of the hit (the sortedby property).

  • [[variable]] - Inserts current value of variable. The variable may be a global.
  • [[variable linktoHit]] - Inserts link to the entity (messsage, gem) that contains the hit. The variable may not be a global.
  • [[variable linktoDG]] - Inserts link to the messsage that contains the hit. The variable must be a message variable.
  • [[variable pictureRef]] - Inserts current value of variable as a picture. The variable may be a global.
  • [[variable shortcut]] - Inserts current value of variable as a shortcut. The variable may be a global.
  • [[variable shortcuturl]] - assumes current value of variable is a shortcut, and returns the url it contains. The variable may be a global.
  • [[variable shortcutStaticURL("optional template name"e;)]] - assumes current value of variable is a shortcut, and returns the url it contains, converting to the static site url if the page is being static rendered. The optional template name applies in sites configured for Scalable Content. The variable may be a global.
  • [[variable shortcut]] - Inserts current value of variable as a shortcut. The variable may be a global.
  • [[variable activeLink]] - Inserts current value of variable as an active link. The variable may be a global, but must take a string value which is an email address or url
  • [[variable mailthisPage("reportname", "target", "templatename")]] - Inserts current value of variable as the text of a link to the addedValues mailpage data entry page, specifying the report called reportname. target is optional, when provided sets the target in the link. templatename is optional, when provided sets the template of the page the user sees to specify the destination and personal message.
  • [[variable reportpageLink("reportname", "templatename", "target")]] - Inserts current value of variable as the text of a link to a page which displays the hit details using the report called reportname. templatename is optional, when provided sets the template of the page. target is optional, when provided sets the target in the link.
  • [[variable reportpagePopup("reportname", "templatename", "width", "height", "scrollbars", "resizable")]] - Inserts current value of variable as the text of a link to a popup window which displays the hit details using the report called reportname. templatename is optional, when provided sets the template of the page. Width, height, scrolbars and rresizable are optional, they will override the default parameters of the addedValueMacros.getPopupLink macro which generates the link
  • [[variable processmacros]] - Inserts current value of variable with shortcuts expanded and macros processed . Illegal macros in the text are first neutered.
  • [[variable labellookup("global variable name")]] - 'looks up' value of variable in the title part of the pre-defined values of the global variable and returns value part if found. Inside macros expression use the builtin string function labelLookup(<string expression>, global variable name) to lookup the value of an expression.
  • [[variable asLinkTo("linked variable name")]] - Returns the value of the linked variable for the entity pointed at by variable. The variable must be string valued, and take vaue shortcut, pictureRef or gem which each point at other entities.
  • [[[parameter name)]] - returns the value of the named query parameter. Inside macros expression use the builtin string function parameter(name).

Two other shorthand ways to report all the values of a multiple valued variable are

  • [[variable list(delimiter)]] - Inserts current values of variable as a list. delimiter is optional, if absent, no parentheses are permitted and a comma is used to separate values. If present, the delimiter must be a quoted character string. The variable may be a global.
  • [[variable ul(params)]] - Inserts current values of variable as a an HTML unordered list. params is optional, if absent, no parentheses are permitted. If present, the params must be 1 to 4 quoted strings specifying the string to start the report (default "<ul>"), the string to end it (default "</ul>"), the string to start each item (default "<li>"), and a string to end each item (default "</li>") - in that order.

Most powerfully, any appearance of a variable name in a macro expression will be replaced by the current value just before the macro is evaluated at run-time. You may use all legal macros and Builtins. For example, if variables called picName and picWidth existed, you might write

{pictureRef(picName, "alt text here", width:picWidth)}

You control pagination by setting the number of hits per page and defining a layout for the hits in a page, using the items [[hit1]] ... to [[hitN]] intermixed with whatever legal html tags and calls to legal macros you need. Useful pagination needs next and previous links and access to the total number of hits which you can add to the layout with

  • [[hitsPerPage]] - the number of hits to be displayed per page
  • [[hitnumber]] - the cardinal number of this hit
  • [[totalHits]] - the total number of hits yielded by your search
  • [[firstPageHit]] - the number of the first hit on this page
  • [[lastPageHit]] - the number of the last hit on this page
  • [[prevLink]] - a link to the previous page of hits. You may set the link text below
  • [[nextLink]] - a link to the next page of hits. You may set the link text below
  • [[groupText]] - the concatened text from each break on sortedBy variable, see below
These identifiers may also be used inside macro expressions.

There is second consideration for pagination, which is whether the report is called with a hitList sorted on another variable (the sortBy variable) or not. When it is you can "break the report" on a change in value of the sortedby variable. The layout of hits within a group determines what each group look like, a page is composed of as many of these as needed to fill the page. The values that define a group are named

  • [[groupKey]] - the name of the sortedBy variable
  • [[groupKeyValue]] - the value of the sortedBy variable for this group of hits
  • [[hitsPerGroup]] - the number of the hits in this group
These identifiers may also be used inside macro expressions.

All search hit reports can be called with either type of hitlist, so you should normally define both layouts here. The default templates do this in very simple way.

See also Search Navigation Reports.

Reporting mode :  Paged table of hits, with onclick reports
Number of hits displayed per page
Text of link to next hits page
Text of link to previous hits page
Layout of hits in a page without sortBy variable
Layout of hits in a page breaking on value of sortBy variable
Layout of 'grouptext' , hits within a group (of same sortBy variable value)
Layout of each hit
Optional variable properties (select report(s) and/or form(s))
Variable 1st onClick report(s) onClick forms(s)
subject  
member  
Text when there are no hits

Eligible Variables (see also Builtins)

  • global String addedValues.logo
  • global String domainNamePattern
  • global String groupNames
  • global String USPhoneNumber
  • global String USstates
  • global String USZipCode
  • String alsoListedIn
  • String attachFile
  • String authorName
  • String body
  • String bodyType
  • Integer ctReads
  • Row Placeholder episodeIPTC []
  • String episodeIPTCnumber [] (episodeIPTC)
  • String episodeIPTCnumberString [] (episodeIPTC)
  • Integer image.height
  • String image.mimetype
  • String image.shortcut
  • String image.url
  • Integer image.width
  • Integer inResponseTo
  • String ipAddress
  • Boolean isStaticRenderCurrent
  • Timestamp lastUpdate
  • String member
  • Timestamp mostRecentChange
  • Integer msgnum
  • Boolean neverTrackChanges
  • String newsItem.department
  • String newsItem.description
  • Boolean newsItem.flPosted
  • Boolean newsItem.flReleased
  • Timestamp newsItem.PostTime
  • String newsItem.url
  • Row Placeholder pluginInfo.commentIt []
  • String pluginInfo.commentIt.content [] (pluginInfo.commentIt)
  • String pluginInfo.commentIt.email [] (pluginInfo.commentIt)
  • String pluginInfo.commentIt.permaLinkURL [] (pluginInfo.commentIt)
  • String pluginInfo.commentIt.permalinkURLfragmentID [] (pluginInfo.commentIt)
  • String pluginInfo.commentIt.poster [] (pluginInfo.commentIt)
  • Timestamp pluginInfo.commentIt.postTime [] (pluginInfo.commentIt)
  • Boolean pluginInfo.commentIt.privateComment [] (pluginInfo.commentIt)
  • Timestamp postTime
  • String responses
  • String setNameTo
  • String setPathTo
  • String setSubjectTo
  • String siteStructurePaths []
  • String imageShortcut
  • String lowcaseSubject
  • String memberName
  • String storytype
  • String subject
  • String template
  • Row Placeholder trackback.inbound.urls []
  • String trackback.inbound.urls.excerpt [] (trackback.inbound.urls)
  • Boolean trackback.inbound.urls.flPosted [] (trackback.inbound.urls)
  • String trackback.inbound.urls.title [] (trackback.inbound.urls)
  • String trackback.inbound.urls.url [] (trackback.inbound.urls)
  • String trackback.inbound.urls.weblogName [] (trackback.inbound.urls)
  • Timestamp trackback.inbound.urls.whenPing [] (trackback.inbound.urls)



Create your own Manila site in minutes. Everyone's doing it!