Difference between revisions of "Carma list gals"
From TMM Wiki
Jump to navigationJump to searchm |
|||
(One intermediate revision by one other user not shown) | |||
Line 7: | Line 7: | ||
* Usage: {carma_list_gals count=20 start=0 section=1} | * Usage: {carma_list_gals count=20 start=0 section=1} | ||
* Required: none | * Required: none | ||
− | * Optional: count, start, section, order, tpl, easy_keys, data_only, assign_prefix, assign, display_on_assign, actors, locations, categories, groups | + | * Optional: count, start, section, order, tpl, easy_keys, data_only, assign_prefix, assign, display_on_assign, actors, locations, categories, groups, views |
* Default Templates Used: list_gals | * Default Templates Used: list_gals | ||
* Variables created: $carma_content, $carma_content_count, $params | * Variables created: $carma_content, $carma_content_count, $params | ||
Line 104: | Line 104: | ||
| None. Does not get this information | | None. Does not get this information | ||
| groups="1" | | groups="1" | ||
+ | |- | ||
+ | | views | ||
+ | | Returns total view count | ||
+ | | 1 | ||
+ | | None. Does not get this information | ||
+ | | views="1" | ||
|} | |} | ||
== Description == | == Description == | ||
− | This function displays galleries using the '' | + | This function displays galleries using the ''list_gals'' |
template. | template. |
Latest revision as of 10:20, 27 May 2011
carma_list_gals
- Purpose: Display a list of galleries on any template.
- Usage: {carma_list_gals count=20 start=0 section=1}
- Required: none
- Optional: count, start, section, order, tpl, easy_keys, data_only, assign_prefix, assign, display_on_assign, actors, locations, categories, groups, views
- Default Templates Used: list_gals
- Variables created: $carma_content, $carma_content_count, $params
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 | Show items from this section | A comma-separated list of section ids or a specific section id. | None. (Uses the current section) | section="my_section" |
order | Sort the galleries in this order | active, caption | active | order="caption" |
tpl | use this template | Any valid template name | list_gals | 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" |
views | Returns total view count | 1 | None. Does not get this information | views="1" |
Description
This function displays galleries using the list_gals template.