LiveWhale CMS

Welcome, Guest Login

Support Center

Widget Arguments & Examples

Last Updated: Mar 30, 2017 09:17AM PDT

Note: the below arguments apply to most widgets. See here for arguments specific to the calendar (i.e., the widget that creates the main view of your calendar).

Basic

Argument Description Examples Widgets
group  Show items from group(s) <arg id="group">me</arg>
​<arg id="group">biology</arg>
 
all
exclude_group Don't show items from group(s) <arg id="exclude_group">biology</arg> all
header Header (formatted as h3) <arg id="header">My Widget</arg> all
max Total number of items <arg id="max">10</arg> (most)
paginate Display "Show more..." link after this many items are displayed <arg id="paginate">25</arg>
<arg id="paginate">false</arg>
(most)
max_days How many days from the current date to display <arg id="max_days">10</arg> events
type Used for widgets that divide content by types <arg id="type">status</arg>
<arg id="type">staff</arg>
<arg id="type">mini</arg>
​<arg id="type">places</arg>
blurbs
facebook
inline gallery
images
places
profiles

 
show_owner_only Show only posts made by the wall owner <arg id="show_owner_only">true</arg> facebook
main_nav Group's main navigation to be associated with a breadcrumb nav <arg id="main_nav">academics</arg> breadcrumb
separator Separator character <arg id="separator">*</arg> breadcrumb
levels Max # of nav levels to show in breadcrumb nav <arg id="levels">3</arg> breadcrumb
user_id username for Facebook wall posts <arg id="user_id">username</arg> facebook
id display the following navigation, form, or gallery based on the provided id
available in: breadcrumb, inline form, inline gallery
<arg id="id">1</arg> breadcrumb
inline form
inline gallery
navigation

 
url URL of a web feed <arg id="url">http://feed.com/feed.xml</arg> feeds
path directory path for images or file includes <arg id="path">/test/foo.php</arg> file
images
width   <arg id="width">100</arg> images
places
height   <arg id="height">200</arg> images
places
zoom display map at specific zoom level <arg id="zoom">20</arg> places
center force map to center on specified coordinates <arg id="center">37.7528, -122.186</arg> places
navigation display only the selected navigation(s)  <arg id="navigation">5</arg> sitemap
exclude_navigation exclude the selected navigation(s)  <arg id="exclude_navigation">5</arg> sitemap
use_widget select the widget(s) to combine  <arg id="use_widget">1</arg>
<arg id="use_widget">5</arg>
stream
min_size minimum size (em) of scale range in tag cloud <arg id="min_size">.9</arg> tags
max_size maximum size (em) of scale range <arg id="max_size">2</arg> tags
min_items minimum number of items that can appear in a tag cloud <arg id="min_items">1</arg> tags

Dates and Archives

Argument Description Examples Widgets
start_date Starting date for widget items
Note: Various types of content entry are allowed.  See other date examples here.
<arg id="start_date">09/10/2014</arg>
<arg id="start_date">10-09-2014</arg>
<arg id="start_date">-1 weeks</arg>
<arg id="start_date">monday this week</arg>
galleries
images
news
places
end_date Ending date for widget items <arg id="end_date">9/17/2014</arg>
See start_date for more formatting examples
galleries
images
news
places
show_archived show archived items <arg id="show_archived">true</arg>
<arg id="show_archived">false</arg>
<arg id="show_archived">both</arg>
news

Categories

Argument Description Examples Widgets
category show items in selected category <arg id="category">lectures</arg> events
exclude_category do not show items in selected category <arg id="exclude_category">Deadlines</arg> events
category_mode require that items match any or all categories <arg id="category_mode">any</arg> events
use_category_classes apply categories as css classes
(livewhale 1.6+)
<arg id="use_category_classes">true</arg> events
calendar

​Tags

Argument Description Examples Widgets
tag show items that are tagged with specific tag(s) <arg id="tag">apples</arg> all
exclude_tag show items that are not tagged with specific tag(s) <arg id="exclude_tag">oranges</arg> all
tag_mode require that items match any/all the specified tags <arg id="tag_mode">any<arg> all
use_tag_classes apply tags as css classes <arg id="use_tag_classes">true</arg> all

Filtering and Sorting

Argument Description Examples Widgets
only_today display only events occurring today <arg id="only_today">true</arg> events
only_starred show only starred items <arg id="only_starred">true</arg> (most)
hide_repeats Only show next instance of a repeating/multi-day event <arg id="hide_repeats">true</arg> (most)
search show items matching the search term <arg id="search">apples</arg> (most)
filter_mode require items match any/all filters below <arg id="filter_mode">any</arg> (all)
filter select one of the options below with an action and a value to filter based on your criteria <arg id="filter" name="title" action="contains">Apples</arg> (all)
sort_order sort items by the following attributes (by default, sorting will start with balloons and then newest to top)
  • Oldest to top 
  • Newest to top 
  • Oldest to top (time only)
  • Newest to top (time only)
  • A-Z
  • Z-A
  • Popularity (google analytics)
<arg id="sort_order">date</arg>
<arg id="sort_order">reverse-date</arg>
<arg id="sort_order">time</arg>
<arg id="sort_order">reverse-time</arg>
<arg id="sort_order">alphabetical</arg>
<arg id="sort_order">reverse-alphabetical</arg>
<arg id="sort_order">random</arg>
all (options vary by widget type)
filetype select the file type(s) to display <arg id="filetype">Document</arg> files
host filter based on host(s) entered <arg id="host">www.localhost.com</arg> pages
username display feed for username(s) <arg id="username">name</arg> twitter
mention display feed for mention(s) <arg id="mention">mentions</arg> twitter
favorites display favorites for username(s) <arg id="favorites">username</arg> twitter
require_picture only show tweets with a picture <arg id="require_picture">true</arg> twitter

Places 

Argument Description Examples Widgets
has_location require location on map <arg id="has_location">true</arg> (most)
near_location show only items near coordinates or place ID <arg id="near_location">30</arg>
<arg id="near_location">37.7528, -122.186</arg>
(most)
near_distance show items within given number of miles <arg id="near_distance">10</arg> (most)

 

Format

Argument Description Examples Widgets
hide_date_header hide date headers <arg id="hide_data_header">true</arg> events
thumb_width format thumb image width <arg id="thumb_width">100</arg> (most)
thumb_height format thumb image height <arg id="thumb_height">100</arg> (most)
thumb_crop crop thumb images <arg id="thumb_crop">true</arg> (most)
ignore_cropper ignore custom thumbnail crops <arg id="ignore_cropper">true<arg> (most)
date_format_header display date headers in the format
See Formatting Date and Time for examples
<arg id="date_format_header">%F %j%S, %Y</arg>
see example formatting options here
events
date_format display event dates in the specified format.
See Formatting Date and Time for examples
<arg id="date_format">%F %j</arg>

 
blurbs
events
news
time_format display event times in the format

See Formatting Date and Time for examples
<arg id="date_time">%g%i %A</arg>

 
events
format format results with the select attributes.

See Widget Formatting for details 
<arg id="format">
    <div class="lw_blurb_title">{title}</div>
    <div class="lw_blurb_body">{body}</div>
</arg> 
all
format_starred format starred results with the selected attributes.
 
<arg id="format_starred">
    <div class="lw_blurb_title">{title}</div>
    <div class="lw_blurb_body">{body}</div>
</arg> 
(most)
excerpt_length limit feed content to a specific number of words <arg id="excerpt_length">5</arg> feed
crop
 
<arg id="crop">true</arg> images
src_region using a portion of the source image with coordinates in the format x,y,x2,y2 <arg id="src_region"></arg> feed
format_news   <arg id="format_news"></arg> places
format_events   <arg id="format_events"></arg> places
format_galleries   <arg id="format_galleries"></arg> places
format_blurbs   <arg id="format_blurbs"></arg> places
format_profiles   <arg id="format_profiles"></arg> places
format_images   <arg id="format_images"></arg> places
format_places   <arg id="format_places"></arg> places
shorten_urls   <arg id="shorten_urls">false</arg> save and share
facebook_suffix   <arg id="facebook_suffix"></arg> save and share
twitter_suffix   <arg id="twitter_suffix"></arg> save and share
google_suffix   <arg id="google_suffix"></arg> save and share
script

pull in custom scripts for galleries

<arg id="script">/_assets/gallery-detail/slideshow.js</arg> galleries
stylesheet

pull in custom styles for galleries

<arg id="stylesheet">/_assets/gallery-detail/slideshow.css</arg> galleries

Advanced

Argument Description Examples Widgets
item_url location of template to use <arg id="item_url">/path/to/template.php</arg> galleries
news
places
profiles
​tags
show_rss_link displays or hides rss link <arg id="show_rss_link">true</arg> blurbs
feeds
galleries
news
profiles
show_ical_link include a link to an iCAL feed of items
available in: events
<arg id="show_ical_link">true</arg> feeds
related_to only show items related to the currently viewed event <arg id="related_to"></arg> galleries
news
profiles
columns display results across # of columns <arg id="columns">3</arg> blurbs
facebook
feeds
files
galleries
navigation
news
pages
profiles
stream
show_public     events
fallback if no results, add/overwrite arguments Expand date range:
<arg id="fallback"><arg id="max_days">90</arg></arg> 

Unset all filters:
<arg id="fallback"><arg id="filter"></arg></arg>     
all
no_results if no results—even after fallback, above—display a message (or another widget) <arg id="no_results">There are no results</arg>

<arg id="no_results">
   <widget id="123_another_widget"/>
</arg>
blurbs
feeds
files
galleries
navigation
news
pages
places
profiles
stream
show_tags show tag selector <arg id="show_tags">true</arg>
<arg id="starred">true</arg>
blurbs
files
galleries
news
pages
profiles
stream
tags_header display a tag header <arg id="tags_header">Header</arg> files
galleries
news
profiles
class apply a custom class <arg id="class">your-custom-class</arg> all
require_image require attached image <arg id="require_image">true</arg> news
profiles
is_remote Use cross-site urls for remote usage <arg id="is_remote">true</arg> blurbs
files
news
pages
profiles
tags
slideshow apply slideshow effect <arg id="slideshow">true</arg> (most)
slideshow_interval slideshow interval in milliseconds to apply to effect <arg id="slideshow_interval">100</arg> (most)
slideshow_no_pausing disable slideshow pausing on mouseover <arg id="slideshow_no_pausing">true</arg> (most)
       
since only show items since <arg id="since">09/18/2014</arg>
<arg id="since"> -1 week </arg>
facebook
twitter
until only show items until <arg id="until">09/30/2014</arg>
<arg id="until">  + 2 week </arg>
feeds
minutes caching the feed for specified minutes <arg id="minutes">30</arg> facebook
twitter
extract display the html extract
available in: file
<arg id="extract"></arg> file
pages
no_format disable automatic formatting/repair of included content <arg id="no_format">true</arg> files
disable_preview disable click to preview effect
available in: images
<arg id="disable_preview">true</arg> images
include_hidden include all menu items in HTML markup, including hidden items
available in: navigation
<arg id="include_hidden">true</arg> navigation
aggregate_markers aggregate markers when zoomed out
available in: places
<arg id="aggregate_markers">false</arg> events
places
list_order By default, columns are filled horizontally (1 in column A, 2 in column B, etc.), but you can now configure them to fill vertically (first half in column A, second half in column B). <arg id="list_order">vertical</arg>
<arg id="list_order">horizontal</arg>
most
eb8f96c071020d8b0923da726d6cab65@livewhale.desk-mail.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete?b_id=4256