TWiki Variables » Search » Category: System Information

CHILDREN -- find children of a topic

• Find direct children of a topic, as defined by the parent-child relationship between topics.
• To find children recursively (topic tree) use the TWiki:Plugins.TreePlugin (not yet installed).
• Syntax: %CHILDREN{...}%
• Supported parameters:

  Parameter:	Description:	Default:
  web="%WEB%"	Wiki web.	Current web
  topic="%TOPIC%"	The topic to find the children.	Current topic
  format="..."	Custom format for each topic found. Supports same format strings as SEARCH. See FormattedSearch for usage, variables & examples	"$topic"
  separator="..."	Separator between topics.	", "
  default="none"	Default text shown if no children found.	"" (empty)

• Example: %CHILDREN{ topic="%TOPIC%" }%
• Category: SearchingAndListingVariables, SystemInformationVariables
• Related: META, PARENTTOPIC, METASEARCH, SEARCH (this topic)

CONTENTMODE{web="WEB"} -- content mode

• Returns the content mode of the specified web. It's either 'local', 'read-only', 'master', or 'slave'. Read ReadOnlyAndMirrorWebs#Content_modes for more detail.
• Syntax: %CONTENTMODE{web="WEB"}%
• Supported parameters:

  Parameter:	Description:	Default:
  web	The name of the web.	The current web

• Category: SystemInformationVariables
• Related: SITENAME, ReadOnlyAndMirrorWebs, MetadataRepository (this 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)

PARENTTOPIC -- parent of current topic

• Syntax: %PARENTTOPIC% or %PARENTTOPIC{ format="..." topic="..." }%
• Expands to: TWikiVariables, renders as TWikiVariables
• Parameters:

  Item	Description	Default
  format="..."	Format string used to display parent topic, where $web expands to the web name, and $topic expands to the topic name. Additional formatting tokens can be used.	"$topic" (topic name)
  topic="..."	Get parent of "Topic" or "Web.Topic"	"%WEB%.%TOPIC%" (current topic)

• Category: SystemInformationVariables
• Related: CHILDREN, META, METASEARCH, PARENTBC, SEARCH, TOPIC (this topic)

SITENAME -- the current site name

• Syntax: %SITENAME%
• Supported parameters: none
• Returns the current site name defined by {ReadOnlyAndMirrorWebs}{SiteName} if defined. Returns the null string if not.
• Category: SystemInformationVariables
• Related: CONTENTMODE, ReadOnlyAndMirrorWebs (this topic)

SITESTATISTICSTOPIC -- name of site statistics topic

• Note: The site statistics topic is assumed to be in the Main web.
• Syntax: %SITESTATISTICSTOPIC%
• Expands to: SiteStatistics
• Example: %USERSWEB%.%SITESTATISTICSTOPIC% renders as SiteStatistics?
• Category: SystemInformationVariables
• Related: HOMETOPIC, NOTIFYTOPIC, STATISTICSTOPIC, TOPIC (this topic)

TOPICTITLE -- title of a topic

• The topic title is defined by, in order of sequence:
  • form field named "Title",
  • topic preference setting named TITLE,
  • topic name.
• Syntax: %TOPICTITLE% or %TOPICTITLE{ topic="TopicName" }%
• Supported parameters:

  Parameter:	Description:	Default:
  encode="html"	Encode special characters into HTML entities. If a TOPICTITLE is passed into an HTML form field it should be encoded as "html". Additional encodings: encode="quote", encode="moderate", encode="safe", encode="entity" and encode="url". See ENCODE for details.	"" (no encoding)
  "..." or topic="..."	Topic to get the title from. Can be of form TopicName or Web.TopicName.	Current topic

• Example: %TOPICTITLE{Projects.SushiProject}% returns Sushi Project assuming the topic has a form field named "Title" with value "Sushi Project"
• Expands to: TWikiVariablesCategoryBody
• Hint: Write [[+SomeTopicName]] to get the topic title link of a topic, see TWikiEditingShorthand#TopicTitleLinks
• Category: SystemInformationVariables
• Related: BASETOPIC, INCLUDINGTOPIC, PARENTTOPIC, TOPIC, TOPICLIST, TOPICURL, WEB (this topic)

WIKILOGOALT -- site logo tooltip message

• Syntax: %WIKILOGOALT%
• Expands to: Powered by TWiki
• Defined in: TWikiPreferences
• Category: AdministrationVariables, SystemInformationVariables
• Related: WIKILOGOIMG, WIKILOGOURL, WIKITOOLNAME (this topic)

WIKILOGOIMG -- site logo image URL

• Syntax: %WIKILOGOIMG%
• Expands to: https://skladowanie.pgi.gov.pl/twiki/pub/TWiki/TWikiLogos/T-logo-140x40-t.gif
• Renders as:
• Defined in: TWikiPreferences
• Category: AdministrationVariables, SystemInformationVariables
• Related: WIKILOGOALT, WIKILOGOURL, WIKITOOLNAME (this topic)

WIKILOGOURL -- site logo home URL

• Syntax: %WIKILOGOURL%
• Expands to: http://TWiki.org/
• Defined in: TWikiPreferences, default %SCRIPTURLPATH{"view"}%/%USERSWEB%/%HOMETOPIC%
• Category: AdministrationVariables, SystemInformationVariables
• Related: WIKILOGOALT, WIKILOGOIMG, WIKITOOLNAME (this topic)

WIKIWEBMASTER -- email address of the administrator

• %WIKIWEBMASTER% expands to the email address of the administrator of this TWiki installation.
• Syntax: %WIKIWEBMASTER%, expands to: Marcin.Slodkowski@pgi.gov.pl
• Category: SystemInformationVariables
• Related: WIKIWEBMASTERNAME (this topic)

WIKIWEBMASTERNAME -- name of the administrator

• %WIKIWEBMASTERNAME% expands to the name of the administrator of this TWiki installation.
• Syntax: %WIKIWEBMASTERNAME%, expands to: TWiki Administrator
• Category: SystemInformationVariables
• Related: WIKIWEBMASTEMER (this topic)

Total: 12 variables

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart