Difference between revisions of "Carma upcoming"
From TMM Wiki
Jump to navigationJump to searchm |
TMMMikeSopko (talk | contribs) |
||
Line 9: | Line 9: | ||
* Optional: count, start, section, site, type, tpl, easy_keys, data_only, assign_prefix, assign, display_on_assign, actors, locations, categories, groups | * Optional: count, start, section, site, type, tpl, easy_keys, data_only, assign_prefix, assign, display_on_assign, actors, locations, categories, groups | ||
* Default Template: upcoming_items | * Default Template: upcoming_items | ||
− | * Variables created: $carma_upcoming_content, $params | + | * Variables created: $carma_upcoming_content, $params, $carma_upcoming_content_total |
== Parameters == | == Parameters == |
Latest revision as of 11:30, 27 April 2010
carma_upcoming
- Purpose: Display the upcoming content that will be available soon.
- Usage: {carma_upcoming count=5 section=1 type=any}
- Required: none
- Optional: count, start, section, site, type, tpl, easy_keys, data_only, assign_prefix, assign, display_on_assign, actors, locations, categories, groups
- Default Template: upcoming_items
- Variables created: $carma_upcoming_content, $params, $carma_upcoming_content_total
Parameters
(Required parameters in bold)
Parameter | Description | Possible Values | Default Value | Example |
---|---|---|---|---|
count | Show this many comments | Any whole number greater than zero | 5 (Shows 5 comments) | count=20 |
start | Don't show the comments lower than this number | Any whole number, zero or greater | 0 (Shows all comments) | start=20 |
section | get items from this section | A comma-delimited list of section I.Ds. or a specific section I.D. | None. (Uses all sections) | section="123" |
site | The site I.D. to use | Any valid site I.D. | None. (Uses just this site) | site="123" |
type | The type of items to display | gal, video, any | any | type="gal" |
tpl | Display comments using this template | Any valid template name | comments_display (Display comments using the comments_display template) | tpl="my_template" |
easy_keys | Use continuous keys instead of keys based on the gallery's I.D. in the $carma_content array | 1 | None. Does not use continuous keys | easy_keys="1" |
data_only | Put the comments in an array | 1 | None. Displays comments | data_only=1 |
assign_prefix | Prefix output variables with this word. (Click link for details) | Any valid Smarty variable name | None. (No prefix is used) | assign_prefix="myvar" |
assign | Name of the Smarty variable that stores the output | Any valid Smarty variable name | None. Output is displayed, not stored | assign="my_var" |
display_on_assign | Display comments even when the assign parameter (above) is used | 1 | None If assign is used, no comments are displayed | display_on_assign=1 |
actors | Get information about actors | 1 | None. Does not get this information | actors="1" |
locations | Get information about locations | 1 | None. Does not get this information | locations="1" |
categories | Get information about categories | 1 | None. Does not get this information | categories="1" |
groups | Get information about groups | 1 | None. Does not get this information | groups="1" |
Description
Displays the number of upcoming content sets of type for a given section or set of sections. It uses the upcoming_items template to display this information.