Tags:
create new tag
, view all tags
ALERT! NOTE: This is a DistributionDocument. Please help maintain high quality documentation: This is a wiki, please fix the documentation if you find errors or incomplete content. Put questions and suggestions concerning the documentation of this topic in the comments section below. Use the Support web for problems you are having using TWiki.

TWiki Variables » Search » Category: Administration

ACTIVATEDPLUGINS -- list of currently activated plugins

ALLVARIABLES -- list of currently defined TWikiVariables

AUTHREALM -- authentication realm

DASHBOARD -- build a dashboard with banner and boxes

EDITACTION -- select an edit template

  • EDITACTION defined in a topic or preference setting will define the use of an editaction template instead of the standard edit. If EDITACTION is defined as text, then hide the form. If EDITACTION is defined as form hide the normal text area and only edit the form.
  • Syntax: %EDITACTION% (returning either text or form)
  • Expands to: %EDITACTION%
  • Note: When EDITACTION is defined as text or form the Edit and Edit Raw buttons simply add ;action=text or ;action=form to the URL for the edit script. If you have defined EDITACTION in a topic setting or preference setting you can still edit the topic content or the form by removing the ;action=form or ;action=text from the edit URL in the browser and reload.
  • Category: AdministrationVariables, EditingAndContentUpdateVariables, SkinsAndTemplatesVariables
  • Related: TWikiScripts#edit (this topic)

FAILEDPLUGINS -- debugging for plugins that failed to load, and handler list

LANGUAGE -- current user's language

  • Returns the language code for the language used as the current user. This is the language actually used by TWiki Internationalization (e.g. in user interface).
  • The language is detected from the user's browser, unless some site/web/user/session-defined setting overrides it:
    • If the LANGUAGE preference is set, it's used as user's language instead of any language detected from the browser.
    • Avoid defining LANGUAGE at a non per-user way, so each user can choose his/her preferred language.
  • Category: AdministrationVariables, SystemInformationVariables
  • Related: LANGUAGES (this topic)

LANGUAGES -- list available TWiki languages

  • List the languages available (as PO files) to TWiki. Those are the languages in which TWiki's user interface is available.
  • Syntax: %LANGUAGES{...}%
  • Supported parameters:
    Parameter: Description: Default:
    format format for each item. See below for variables available in the format string. "   * $langname"
    separator separator between items. "\n" (newline)
    marker="selected" Text for $marker if the item matches selection "selected"
    selection="%LANGUAGE%" Current language to be selected in list (none)
  • format variables:
    Variable Meaning
    $langname language's name, as informed by the translators
    $langtag language's tag. Ex: en, pt-br, etc.
  • Category: AdministrationVariables, SystemInformationVariables
  • Example: <select>%LANGUAGES{format="<option $marker value='$langtag'>$langname</option>" selection="%LANGUAGE%"}%</select> creates an option list of the available languages with the current language selected (this topic)

LOCALSITEPREFS -- web.topicname of site preferences topic

MDREPO -- retrieve data from metadata repository

  • Attention: This variable works only if MetadataRepository is in use. Otherwise, it always returns a zero length string.
  • This retrieves data from the specified metadata repository table.
  • Syntax: %MDREPO{ "table" ...}% (generic form), %MDREPO{ web="..." ...}% (web specific form)
  • Parameters (generic form without web="..." parameter):
    Parameter Description Default
    "..." Specify the table to retrieve This or below is required
    table="..." (Alternative to above) This or above is required
    separator="..." The separator string of records "$n" (new line)
    format="..." Format of one record. It may contain the following items. In addtion, the standard special tokens are handled accordingly.
    Item Description
    $_ or $_() the record ID
    $__ or $__() The record value in the following format:
    FIELD_NAME=FIELD_VALUE FIELD_NAME=FIELD_VALUE ...
    $marker or $marker() Expands to marker for the item matching selection only
    $_FILED_NAME or $_FIELD_NAME() Please be noted that you need to put _ (underscore) in front of a field name. $_FIELD_NAME$ yields the value of the specified field. If the specified field does not exist in the record, it returns the null string ("").
    ?FIELD_NAME?IF_FIELD_HAS_VALUE? If the specified field has value and it's neither 0 nor the null string (""), it's evaluated as IF_FIELD_HAS_VALUE. Otherwise, it's evaluated as the null string. This is like q/.../ in Perl. A non-word character following ?FIELD_NAME becomes the terminator; i.e. you can write: ?FIELD_NAME:IF_TRUE:
    Specifically, the following characters can be used as the delimiter: ! # % ' / : ? @ ^ ` | ~
    = is excluded because it clashes with a parameter specification in a URL (?name=value).
    ?!FIELD_NAME?IF_FIELD_HAS_NO_VALUE? Similar to above but it's opposite. If the field has value, it's evaluated as the null string. Otherwise, it's evaluated as IF_FIELD_HAS_NO_VALUE.
    $question Replaced with ? after the ?FIEL_DNAME and ?!FIELD_ANME constructs are processed.
    "| $_ | $__ |"
    selection="..." The record ID to be regarded as the selected. It affects how $marker in the format is evaluated. none
    marker="..." Text for $marker in the format if the item matches selection "selected"
    filter="..." The regular expression of record IDs to filter records. Matching is case-insensitive none
    exclude="..." Comma separated list of record IDs to be excluded. You can use regular expression. If you specify Trash\d*, then Trash, Trash1, Trash2, ... are exluded but LightTrash and TrashBag are not excluded none
  • Example: %MDREPO{"webs" filter="^A" format="| $_ | $_admin | $_master |"}%
    This would show the metadata of webs whose names start with A.
  • Paramerers (web specific form):
    Parameter Description Default
    web="..." Specify the web. If it's a subweb, the corresponding top level web is specified This is required
    "..." Specify the format of the return value in the same manner as the format parameter in the generic form $__
    default="..." Specify the value to be returned when the specified or implied top level web does not exist in MDREPO "" (null string)
  • Example: %MDREPO{web="Foo/Bar" "$_admin"}%
    This would show the admin field of the Foo web.
  • Category: AdministrationVariables, SystemInformationVariables
  • Related: MetadataRepository (this topic)

PLUGINDESCRIPTIONS -- list of plugin descriptions

  • Syntax: %PLUGINDESCRIPTIONS%
  • Expands to:
    • SpreadSheetPlugin (2014-09-23, $Rev: 28085 (2014-09-23) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables or anywhere in topic text
    • AutoSectionsPlugin (2014-10-08, $Rev: 29491 (2016-02-16) $): Automatically make editable sections based on headings
    • BackupRestorePlugin (2013-02-16, $Rev: 25448 (2013-10-14) $): Administrator utility to backup, restore and upgrade a TWiki site
    • BlackListPlugin (2013-02-28, $Rev$): Utility to keep malicious users away from a public TWiki site
    • CalendarPlugin (2016-01-22, 29936): Show a monthly calendar with highlighted events
    • ChartPlugin (2013-05-23, $Rev: 25974 (2013-05-23) $): Visualize TWiki tables with area charts, bar charts, line graphs, scatter charts and sparklines
    • ColorPickerPlugin (2013-02-15, $Rev: 25074 (2013-10-14) $): Color picker, packaged for use in TWiki forms and TWiki applications
    • CommentPlugin (2013-02-10, $Rev: 24977 (2013-10-14) $): Quickly post comments to a page without an edit/preview/save cycle
    • DatePickerPlugin (2013-09-04, $Rev: 26272 (2013-10-14) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
    • EditTablePlugin (2013-12-03, $Rev: 26647 (2013-12-03) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
    • GaugePlugin (2013-05-16, $Rev: 25944 (2013-05-16) $): Create gauges (graphical or not), typically used for dashboards
    • GeoLookupPlugin (2012-11-21, $Rev: 24174 (2012-11-21) $): Lookup geolocation by IP address or domain name
    • HeadlinesPlugin (2013-11-18, 26619): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
    • IfThenActionPlugin (2015-04-20, $Rev: 29087 (2015-04-20) $): Execute if-then actions on topic view, save, file upload, and user registration, with rules defined in a topic
    • InterwikiPlugin (2013-02-12, $Rev: 25126 (2013-10-14) $): Text ExternalSite:Page links to a page on an external site based on aliases defined in a rules topic
    • JQueryPlugin (2013-09-28, $Rev: 26439 (2013-10-14) $): jQuery JavaScript library for TWiki
    • LocalCityTimePlugin (2011-07-13, $Rev: 21742 (2011-07-13) $): Shows the local time of a city embedded in a TWiki topic.
    • PercentCompletePlugin (2012-12-05, $Rev: 24337 (2012-12-06) $): Percent complete selector, for use in TWiki forms and TWiki applications
    • PreferencesPlugin (2013-09-08, $Rev: 26286 (2013-10-14) $): Allows editing of preferences using fields predefined in a form
    • QRCodePlugin (2012-11-14, $Rev: 24045 (2012-11-15) $): Create QR Code (a matrix barcode) in TWiki pages, useful for mobile applications
    • RecentVisitorPlugin (2012-12-22, $Rev: 24176 (2012-11-22) $): Show recent visitors to a TWiki site
    • RenderListPlugin (2013-01-28, $Rev: 24820 (2013-10-14) $): Render bullet lists in a variety of formats
    • SetGetPlugin (2015-04-09, $Rev: 29040 (2015-04-09) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
    • ShareMePlugin (2012-12-01, $Rev: 24254 (2012-12-01) $): Icon bar to share a TWiki page on popular social media sites such as Facebook, StumbleUpon, Twitter
    • SlideShowPlugin (2015-01-14, $Rev: 28669 (2015-01-14) $): Create web based presentations based on topics with headings.
    • SmiliesPlugin (2013-01-13, $Rev: 24784 (2013-10-14) $): Render smilies as icons, like  :-)  as smile or  :eek:  as eek!
    • TWikiDrawPlugin (2013-05-17, $Rev: 25952 (2013-05-17) $): Vector drawing editor and clickable maps for diagrams and workflows
    • TWikiOrgPlugin (1.001): TWiki.org specific extensions
    • TWikiSheetPlugin (2016-04-14, $Rev: 30150 (2016-04-14) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
    • TablePlugin (2013-09-25, $Rev: 26425 (2013-10-14) $): Control attributes of tables and sorting of table columns
    • TagMePlugin (2014-05-15, $Rev: 27384 (2014-05-15) $): Tag wiki content collectively or authoritatively to find content by keywords
    • TinyMCEPlugin (2013-09-18, $Rev: 26397 (2013-10-14) $): Integration of the Tiny MCE WYSIWYG Editor
    • TwistyPlugin (2013-03-22, $Rev: 25508 (2013-10-14) $): Twisty section JavaScript library to open/close content dynamically
    • VarCachePlugin (2012-11-14, $Rev: 24077 (2012-11-15) $): Cache TWiki variables in selected topics for faster page rendering
    • WatchlistPlugin (2016-02-13, $Rev$): Watch topics of interest and get notified of changes by e-mail
    • WysiwygPlugin (2013-09-18, $Rev: 26391 (2013-10-14) $): Translator framework for WYSIWYG editors
  • Category: AdministrationVariables, SystemInformationVariables
  • Related: ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINVERSION, TWikiPlugins, InstalledPlugins (this topic)

PLUGINVERSION -- the version of a TWiki Plugin, or the TWiki Plugins API

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: SEARCH, 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
  • Use <varcache_exclude> ... </varcache_exclude> to exclude sections of a page from getting cached
  • Example: %VARCACHE{"168"}% caches the current page for 7 days
  • Category: AdministrationVariables, DevelopmentVariables
  • Related: VarCachePlugin, VarCachePluginTest (this topic)

WEBPREFSTOPIC -- name of web preferences topic

WIKIHOMEURL -- site home URL

WIKILOGOALT -- site logo tooltip message

WIKILOGOIMG -- site logo image URL

WIKILOGOURL -- site logo home URL

WIKIPREFSTOPIC -- name of site-wide preferences topic

WIKIVERSION -- the version of the installed TWiki engine

Total: 21 variables

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart



Comments & Questions about this Distribution Document Topic

Please use the Support forum if you have questions about TWiki features. This comment section is about the documentation of this topic.
Topic revision: r1 - 2012-11-17 - PeterThoeny
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2016 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.