Changeset 1283

Show
Ignore:
Timestamp:
11/25/08 23:08:04 (16 months ago)
Author:
mpaschal
Message:

Document the StreamActionRollup tag
BugzID: 80160

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • trunk/ActionStreams/plugins/ActionStreams/doc/template-guide.txt

    r1281 r1283  
    378378### `mt:StreamActionRollup` ### 
    379379 
    380 TODO 
     380When in an `<mt:ActionStreams>` loop, provides an inner loop of the next 
     381several actions that are of the same type. For example, if in the middle of 20 
     382random actions are five actions for links posted to Delicious, 
     383`StreamActionRollup` provides a loop of just those five actions. 
     384 
     385When a roll-up loop is used, the similar actions are automatically consumed 
     386from the outer loop. In the above example, if a template uses 
     387`StreamActionRollup` to roll up the five Delicious links, the next iteration 
     388of the outer `ActionStreams` loop will skip ahead five actions to the first 
     389action that was *not* a Delicious link. 
     390 
     391If there are no similar actions to consume, `StreamActionRollup` renders the 
     392template code in its `<mt:Else>` block instead, in the context of the single 
     393action from the outer `ActionStreams` loop. That is, you can use the regular 
     394template code you would use for a single action of that type in this 
     395`<mt:Else>` section. 
     396 
     397Attributes available on `StreamActionRollup` are: 
     398 
     399#### by #### 
     400 
     401The criteria on which to determine whether actions are similar. Possible 
     402criteria are: 
     403 
     404* `day`, the date on which the action occurred, in the currently publishing 
     405  blog's time zone 
     406* `service`, the profile service from which this action was collected, such as 
     407  `digg`, `flickr`, or `vox` 
     408* `stream`, the type of stream to which this action belongs, such as `links` 
     409  or `photos` 
     410* `action`, the particular action stream to which the action belongs; that is, 
     411  the combination of `service` and `stream` 
     412 
     413You can combine criteria by listing them together, delimited with commas. The 
     414default behavior if `by` is not given is to roll up by `day, action`. 
     415 
     416#### glue #### 
     417 
     418If given, the `glue` value is added between the result of each iteration of 
     419the loop. That is, the `glue` is inserted between the result of the loop for 
     420each similar action.