TWiki Variables » Search » Category: Import

DOXYGENIMPORT{"..."} -- import Doxygen documentation into TWiki

• The %DOXYGENIMPORT{}% variable is handled by the DoxygenImportPlugin - see plugin for details
• Syntax: %DOXYGENIMPORT{"import"}% - show form to import Doxygen archive file
• Syntax: %DOXYGENIMPORT{"navigation"}% - show navigation of the base page
• Category: AttachmentsAndFilesVariables, DevelopmentVariables, ImportVariables
• Related: DoxygenImportPlugin (this topic)

EJS_INCLUDE -- execute and include topic containing EJS tags

• See TWiki06x01.EmbeddedJSPlugin for information about EJS (Embedded JavaScript) template.
• This tag is used to embed an EJS-based component topic. The JavaScript execution context (namespace) within this %EJS_INCLUDE{...}% tag is completely separate from the outside, even if the "including" topic is also EJS-enabled.
• Syntax: %EJS_INCLUDE{"ComponentTopicName" namespace="NamespaceRequiredByComponent" timeout="TimeoutInSeconds"}%
• Category: ApplicationsAndComponentsVariables, DevelopmentVariables, ImportVariables
• Related: INCLUDE (this topic)

EXECUTE{ "script" } -- safely execute shell scripts or Perl code - use TWiki as the user interface for external applications

• Use the %EXECUTE{}% variable to safely execute shell scripts. The variable is handled by the ExecutePlugin - see plugin for details on how to configure external scripts so that they can be used in %EXECUTE{}%.
• Syntax: %EXECUTE{ "script" ... }%
• Supported parameters:

  Parameter	Explanation	Default	Example
  "name"	Name of script to execute, as defined in configure. See ExecutePlugin for details.	(none)	"test-results"
  format="..."	Format each line of the script output. The token $text expands to the text of a line. Additional FormatTokens can be used, such as $percnt for the percent sign.	"$text"	format="| $text |"
  newline="..."	Change newlines of the script output to something else. FormatTokens can be used, such as $n for newline.	"$n"	newline=", "
  ...="..."	Any other parameter can be used as parameter to the script.	(none)	date="2026-02-09"

• Example: %EXECUTE{ "qa_results" date="%URLPARAM{date}%" }%
• Category: ApplicationsAndComponentsVariables, DatabaseAndFormsVariables, DevelopmentVariables, ImportVariables, UIAndVisualizationVariables, WorkflowAndAutomationVariables
• Related: ExecutePlugin, configure (this topic)

HEADLINES{"url"} -- show RSS and ATOM feeds in TWiki pages

• The %HEADLINES{"url"}% variable is handled by the HeadlinesPlugin.
• Syntax: %HEADLINES{ "http://..." }%
• Parameters: (all but the first one are optional)

  "..."	Source of RSS or ATOM feed; this can be a URL (starting with http) or a web.topic location for internal feeds
  refresh="60"	Refresh rate in minutes for caching feed; "0" for no caching
  limit="12"	Maximum number of items shown
  header="..."	Header. May include these variables: - $channeltitle, $title: title of channel (channel.title) - $channellink, $link: link of channel (channel.link) - $channeldescription, $description: description (channel.description) - $channeldate, $date: publication date of the channel (channel.pubDate) - $rights: copyrights of the channel (channel.copyright) - $imagetitle: title text for site (image.title) - $imagelink: link for site (image.link) - $imageurl: URL of image (image.url) - $imagedescription: description of image (image.description)
  format="..."	Format of one item. May include these variables: - $title: news item title (item.title) - $link: news item link (item.link) - $description: news item description (item.description) - $date: the publication date (item.pubDate, item.date) - $category: the article category (item.category)
  newline="$br"	Convert newlines in feed; "$br" becomes <br /> tag, default "$n" (newline)
  filter="..."	Filter out content from feed; for example to delete an encoded break tag specify "&lt;br&gt;"
  Details

• Example: %HEADLINES{ "http://slashdot.org/slashdot.rdf" header="*[[$link][$title]]:* $description" format="$t* [[$link][$title]]" limit="4" }% shows the latest Slashdot news in bullet list format
• Category: ApplicationsAndComponentsVariables, ImportVariables
• Related: HeadlinesPlugin (this topic)

INCLUDEXML -- display any XML document in table format

• This variable is handled by the IncludeXMLPlugin. For details, see IncludeXMLPlugin
• Syntax: %INCLUDEXML{"URL or Topic" records="xpath" fields="xpaths"}%
• Example: %INCLUDEXML{"http://example.com/rss" records="item" fields="link, title, description, pubDate"}%
• Category: ApplicationsAndComponentsVariables, DevelopmentVariables, ImportVariables
• Related: INCLUDE (this topic)

JIRAREST{"..."} -- call JIRA issue tracker using REST API

• Interface to the Atassian JIRA issue tracker via JIRA REST API call. The %JIRAREST{}% variable is handled by the JiraRestPlugin.
• Syntax: %JIRAREST{ "..." command="..." }%
• Parameters:

  Parameter	Description	Default
  "..." or action="..."	Action to take. This is the REST method: "get" for GET, "put" for PUT, "post" for POST, and "delete" for DELETE method.	"" (no action)
  command="..."	REST command, such as: "/rest/api/2/issue/TEST-1"	(required)
  data="..."	Request body sent with REST call, such as: " { \"id\": \"10009\" } "	(required for put and post actions)
  action2="..." command2="..." data2="..."	Conduct a second action after successful execution of the first action. Use this to do multiple REST API calls in one session. No action is taken if there was an error in the first action. In the same way, action3, action4, etc can be executed.	(optional)
  user="..."	User for REST call; default is configure setting {Plugins}{JiraRestPlugin}{User}	(configure setting)
  password="..."	Password for REST call; default is configure setting {Plugins}{JiraRestPlugin}{Password}	(configure setting)

• Example: %JIRAREST{ "get" command="/rest/auth/1/session" }% - see more examples.
• Category: ApplicationsAndComponentsVariables, DatabaseAndFormsVariables, DevelopmentVariables, ImportVariables, WorkflowAndAutomationVariables
• Related: JiraRestPlugin (this topic)

LOADAPP{"id"} -- Load TWiki application code from a hidden web

• Include a TWiki application topic indicated by an ID. The LOADAPP variable is handled by the LoadAppPlugin, and works similar to the INCLUDE variable.
• Syntax: %LOADAPP{"id" ...}%
• Supported parameters:

  Parameter:	Description:	Default:
  "someID"	The ID of the application snippet to include. Example: %LOADAPP{"kbHeader"}% will include the topic KnowledgeBaseHeader from the KB web, assuming the mapping 'kbHeader: KB.KnowledgeBaseHeader' is defined in configure	(required)
  section="name"	Include only the specified named section, as defined in the included topic by the STARTSECTION and ENDSECTION variables. Nothing is shown if the named section does not exists. section="" is equivalent to not specifying a section	""
  PARAMONE="val 1" PARAMTWO="val 2"	Any other parameter will be defined as a variable within the scope of the included topic. The example parameters on the left will result in %PARAMONE% and %PARAMTWO% being defined within the included topic. A default value for a variable can be specified in the included topic in case the corresponding parameter is not specified, such as %PARAMONE{ default="..." }%	(optional)

• Example: See LoadAppPlugin
• Category: ApplicationsAndComponentsVariables, DevelopmentVariables, ImportVariables
• Related: BASETOPIC, BASEWEB, INCLUDE, INCLUDINGTOPIC, INCLUDINGWEB, STARTINCLUDE, STOPINCLUDE, STARTSECTION, ENDSECTION, IncludeTopicsAndWebPages, ParameterizedVariables, LoadAppPlugin (this topic)

Total: 7 variables

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart