TWiki Variables » Search » Category: Administration

DASHBOARD -- build a dashboard with banner and boxes

• Use this variable to quickly create dashboards for intranet home, team homepages, project homepages and knowledge bases. See the TWikiDashboardAddOn for details on enabling and using the %DASHBOARD{...}% variable.
• Syntax: %DASHBOARD{ section="..." ... }%
• Example:
  %DASHBOARD{ section="dashboard_start" }%
%DASHBOARD{ section="banner" image="..." title="..." }%
%DASHBOARD{ section="box_start" title="Box 1 title" }%
Box 1 content
%DASHBOARD{ section="box_end" }%
%DASHBOARD{ section="box_start" title="Box 2 title" }%
Box 2 content
%DASHBOARD{ section="box_end" }%
...
%DASHBOARD{ section="dashboard_end" }%
• Category: AdministrationVariables, ApplicationsAndComponentsVariables, DevelopmentVariables, FormattingAndRenderingVariables, UIAndVisualizationVariables
• Related: TWikiDashboardAddOn (this topic)

GEOLOOKUP -- lookup geo location by IP address or domain name

• The %GEOLOOKUP{}% variable is handled by the GeoLookupPlugin
• Syntax: %GEOLOOKUP{"host" format="..."}%
• Parameters:

  Parameter	Description	Default
  "..."	Host IP address or host name	none, required
  format="..."	Format of geolocation. Supported variables: • $latitude: Latitude • $longitude: Longitude • $city: City name • $region: Region name • $country_name: Country name • $country_code: Two letter country code • $postal_code: Postal code (USA only) • $metro_code: Metropolitan code (USA only) • $area_code: Telephone area code (USA only)	"$city, $region, $country_name"

• Example: %GEOLOOKUP{"75.52.124.86"}% shows default format (city, region, country code)
• Example: %GEOLOOKUP{"75.52.124.86" format="$latitude, $longitude"}% shows comma separated Latitude and Longitude
• Category: AdministrationVariables, ApplicationsAndComponentsVariables, DevelopmentVariables, SecurityAndAccessControlVariables, UsersAndAuthenticationVariables
• Related: GeoLookupPlugin (this topic)

PING{ host="..." } -- ping a host for reachability

• The %PING{}% variable tests if a remote host identified by host name or IP address is reachable via ping command. The variable is handled by the PingPlugin.
• Syntax: %PING{ host="www.google.com" }%
• Supported attributes:

  Attribute	Comment	Default
  host="..."	Host name or IP address	(required)
  wait="..."	Time, in seconds, to wait for a ping response	"5"
  format="..."	Format of output. Use the variables $host for the host and $result for the result (1 for success, 0 for failure)	For success: "%GREEN%host%ENDCOLOR%" For failure: "%RED%host%ENDCOLOR%"

• Example: %PING{ host="www.google.com" wait="2" }%
• Category: AdministrationVariables, DevelopmentVariables, SystemInformationVariables
• Related: PingPlugin (this topic)

RECENTVISITOR -- show statistics of recent visitors to the TWiki site

• The %RECENTVISITOR{}% variable is handled by the RecentVisitorPlugin
• Most recent visit of an individual:
  • Syntax: %RECENTVISITOR{"user" name="..." format="..."}%
  • Parameters:

    Parameter	Description	Default
    "user" or action="user"	Recent visit of an individual report	(none)
    name="..."	WikiName of person	(currently logged in user)
    format="..."	Format of report. Supported tokens: • $date - date of last visit • $time - time of last visit (GMT) • $ago - how long ago • $ip - IP address (only shown to non-administrators if enabled in configure) • $n, $nop, $quot, $percnt, $dollar - standard FormatTokens.	"Last seen $ago ago"
    notfound="..."	Message shown if user is not found.	"Never seen"

• Report of recent visitors:
  • Syntax: %RECENTVISITOR{"recent" format="..."}%
  • Parameters:

    Parameter	Description	Default
    "recent" or action="recent"	Report of recent visitors	(none)
    format="..."	Format of each line of the report. Supported tokens: • $username - login name of user • $wikiname - WikiName of user • $wikusername - WikiName prefixed with Main web name • plus above tokens.	"   * $wikiusername last seen $ago ago"
    separator="..."	Separator between lines. Standard FormatTokens are expanded.	"$n" (newline)
    limit="..."	Limit the number of lines.	"10"

• Examples:
  • %RECENTVISITOR{"user" name="TWikiAdminUser"}% - show most recent visit of TWikiAdminUser.
  • %RECENTVISITOR{"recent" format="| $wikiusername | $ago ago |}% - show 10 most recent visitors.
• Category: AdministrationVariables, UsersAndAuthenticationVariables
• Related: RecentVisitorPlugin (this topic)

REDIRECT{"url"} -- create a redirect to another topic or website

• The %REDIRECT{}% variable is handled by the RedirectPlugin.
• Syntax: %REDIRECT{"TopicName"}%
• Examples:
  • %REDIRECT{"ExampleTopic"}% redirects to the ExampleTopic topic
  • %REDIRECT{"OtherWeb.ExampleTopic"}% redirects to the OtherWeb.ExampleTopic topic
  • %REDIRECT{"http://twiki.org/"}% redirects to http://twiki.org/
• Category: AdministrationVariables, LinkingAndNavigationVariables
• Related: RedirectPlugin (this topic)

REPLACETEXT -- search and replace text in a web

• The %REPLACETEXT{}% variable is handled by the ReplaceTextPlugin; this variable is typically used in conjunction with a web form
• Syntax: %REPLACETEXT{ action="..." web="..." from="..." to="..." }%
• Parameters:

  Parameter	Description	Default
  action="..."	Replace action: • "" - no action • "replace" - do replace action based on below parameters, return result message, such as:   Replaced FOO with BAR in 2 topics in Sandbox web	""
  web="..."	Name of web to search and replace text	(current web)
  topic="..."	Expert mode: Limit topics by name: A topic with asterisk wildcards, such as Bug-*, or a list of topics separated by comma	(all topics)
  filter="..."	Expert mode: Limit topics by filtering topic text with a regex filter, optional	(no filter)
  from="..."	Text to search	(none, required)
  to="..."	Replacement text	(none, required)
  search="..."	Expert mode: Use this for more complex replace using regular expression grouping etc; typically supplied via a hidden input field. Use $from to specify the search text entered by the user	"\b$from\b"
  replace="..."	Expert mode: Use this for more complex replace using regular expression grouping etc; typically supplied via a hidden input field. Use $to to specify the replacement text entered by the user, use $1, $2, etc to reference captured groups	"$to"
  dryrun="1"	Do a dry run, e.g. a search only to simulate the replace action	"0"
  showlist="1"	Show the list of topics replaced	"0"

• Example usage: See raw text of ReplaceTextPlugin
• Category: AdministrationVariables, ApplicationsAndComponentsVariables, DevelopmentVariables
• Related: ReplaceTextPlugin (this topic)

SHAREME -- icon bar to share topics on popular social media sites

• The %SHAREME{}% variable is handled by the ShareMePlugin. Many social media sites are defined in the plugin topic.
• Syntax: %SHAREME% or %SHAREME{"site1, site2"}%
• Examples:
  • %SHAREME% shows the default icon set
  • %SHAREME{"Delicious, Facebook, Twitter"}% shows icons to share the current TWiki topic at Delicious, Facebook and Twitter
• Category: AdministrationVariables, ExportAndPublishingVariables, LinkingAndNavigationVariables, SkinsAndTemplatesVariables
• Related: ShareMePlugin (this topic)

USERREPORT -- show user reports with profile pictures

• Show various user reports documented in UserReports
• Syntax: %USERREPORT{ action="..." ... }%
• Overview of actions with parameters:

  Report	action=	Parameters
  Show a simple list of registered users	"user_list"	search, limit, sort, reverse
  Show the profile picture image of a user	"profile_picture"	user, height, width, title
  Show slim, one line height user boxes	"slim_box_start" "slim_box" or "slim_box_list" "slim_box_end"	style user, style users, style none
  Show small, two line height user boxes	"small_box_start" "small_box" or "small_box_list" "small_box_end"	style user, style users, style none
  Show users in business card format	"business_card_start" "business_card" or "business_card_list" "business_card_end"	style user, style users, style none
  Show a selector to pick a user, for use in HTML forms	"select_one_user"	name, selected, users
  Show rows of checkboxes to select users, for use in HTML forms	"select_users"	name, selected, users, colums, style

• Example: %USERREPORT{ action="user_list" search="jane" limit="5" }%
• Category: AdministrationVariables, DevelopmentVariables, UsersAndAuthenticationVariables
• Related: BUBBLESIG, SEARCH, USERSIG, UserList, UserReports (this topic)

VARCACHE{ attributes } -- cache TWiki variables in selected topics for faster page rendering

• The %VARCACHE{}% variable is handled by the VarCachePlugin.
• Syntax: %VARCACHE{ "24" }%
• Supported attributes:

  Attribute	Comment	Default
  "..." or refresh="..."	Cache refresh period in hours (maximum age of cache)	REFRESH setting
  cachemsg="..."	Message shown when looking at a cached topic. Use $age to indicate the age of cache, $link to indicate the refresh URL	CACHEMSG setting
  updatemsg="..."	Message shown after a cache refresh. Use $link to indicate the refresh URL	UPDATEMSG setting

• Example: %VARCACHE{"168"}% caches the current page for 7 days
• Exclude variables from getting cached:
  • Use <varcache_exclude> ... </varcache_exclude> to exclude sections of a page
    • Example: <varcache_exclude> %SEARCH{...}% </varcache_exclude> runs the search on every page view, regardless of caching
  • Or, prefix variables with VARCACHE_EXCLUDE_
    • Example: %VARCACHE_EXCLUDE_WIKIUSERNAME% renders the WIKIUSERNAME variable on every page view, regardless of caching
• Category: AdministrationVariables, DevelopmentVariables
• Related: VarCachePlugin, VarCachePluginTest (this topic)

Total: 9 variables

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart