Carma show video
From TMM Wiki
Jump to navigationJump to searchThe printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
carma_show_video
- Purpose: Show a specific video gallery or a part of a video gallery
- Usage: {carma_show_video count=20 start=0 galid=1}
- Required: galid (section defaults to the current section. if video is in a different section you must also provide that parameter)
- Optional: count, start, tpl, data_only, assign_prefix, assign, display_on_assign, actors, locations, categories, groups, section
- Default Templates Used: show_video_inline
- Variables created: $carma_video, $galid, $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 |
galid | Display this gallery | Any valid gallery I.D. | None. | galid="123" |
section | The section I.D. of the gallery it was published to | Any valid section I.D. | Current section | section="123" |
tpl | Display comments using this template | Any valid template name | comments_display (Display comments using the comments_display template) | tpl="my_template" |
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 all data from the specified set (galid). It uses the show_video_inline template to display this information. The show_video.php script also uses this function to build its output using the template show_video in that circumstance.