Tag library that defines the basic layouts of Jenkins pages.
Deprecated, do not use.
Creates a clickable "Stop" button.
Link target. Relative to the current page.
Alt text for image.
If defined, the user will be asked for confirmation first, and the value will be used as question.
'tabBarFrame' class specification. This will allow styling.
Set to true to show the baseline
Generates the bar that shows breadcrumbs, along with its associated dynamic behaviours.
This tag is used by l:layout and not expected to be used by anyone else,
but it's written as separate tag for better readability of code.
To render additional breadcrumb items (for example to provide in-page navigations),
use the <l:breadcrumb> tag.
Instance of jenkins.util.ProgressiveRendering.
JavaScript expression that evaluates to the function taking one JSON-valued parameter which renders results as they come.
Optional tooltip for progress bar.
Generates the body as the main content part of a Jenkins page.
Opinionated helper to use icons via <svg> tags. Can be used by passing an href or a body:
# <l:svgIcon href="/path/to/my/sprite.svg#my-icon" />
# <l:svgIcon><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z"></path></l:svgIcon>
Extra CSS classes passed to the icon. Currently only the 'svg-icon' class is applied by default.
Href of the 'use' tag. Normally path to a sprite plus an icon id
viewbox (default 0 0 24 24)
Whether the icon can receive keyboard focus. Possible values 'true' or 'false'
onclick handler.
style
tooltip
aria-hidden
Load Yahoo UI module.
YUI module name to load.
Generates the page header, along with its associated dynamic behaviours.
This tag is used by l:layout and not expected to be used by anyone else,
but it's written as separate tag for better readability of code.
Page title and title attribute for the logo
Alt text for the logo
Placeholder text for the search input
Link value for the help icon on the search box
Text for the logout link
Produces a hyperlink which when clicked first asks for confirmation, then goes to that URL if confirmed.
The body is displayed as the link text.
@since 1.512
The URL to go to.
Use POST rather than GET (recommended).
A confirmation dialog message.
A CSS class to use to style the link.
Header portion of the HTML page, that gets rendered into the <head> tag.
Multiple <l:header> elements can be specified, and can even come after
<l:main-panel>.
This tag can be placed inside <l:layout>.
@since 1.576
The icon class specification e.g. 'icon-help icon-sm', 'icon-blue icon-md', 'icon-blue-anime icon-xlg'.
Icon source raw URL. Only relevant if the 'class' attribute is NOT specified.
onclick handler.
title
style
tooltip
alt
The name of the tab
The url of the tab
Whether the tab is active or not
The title of the tab
Renders the body only if the current user has the specified permission
By default it will reuse the current context.
If the provided value does not inherit from hudson.security.AccessControlled,
the tag will look for the first ancestor satisfying the condition.
The hasPermission will be performed against that value.
permission object to check. If this is null, the body will be also rendered.
Place holder HTML tag. By default it's DIV, but depending on where this is used,
you might need other tags (e.g., inside a table.)
Additional CSS class names, so that you can discover this tag more easily from your JavaScript.
','-separated list of variables to capture and make available when later evaluating the body.
Client-side CSS loading tag. Similar to adjunct, but driven from the client. See page-init.js.
@since 2.0
CSS source path (relative to Jenkins).
Declares a view as dispatchable. Views that do not use this tag or another tag that invokes this are
considered fragment views and are not dispatchable.
HTTP Content-Type header value to use for this view.
Generates a left side content as part of a Jenkins page. Typically known as two-column or left-side + main-content layouts
Client-side JavaScript loading tag. Similar to adjunct, but driven from the client. See page-init.js.
@since 2.0
JavaScript source path (relative to Jenkins).
Creates a space for the right-hand side of the page.
This sticks to the right of the page even when the content overflows.
This tag inside <l:tasks> tag renders the left navigation bar of Hudson.
Each <task> tag gets an icon and link.
Link target. Relative to the current page.
URL to an icon image, or the icon class specification. If using an image URL,
the image should be 24x24 in size and relative to the context path of Hudson.
Common values include:
# "icon-folder icon-md" is an example of using a class spec for a medium folder icon
# "images/24x24/..." then points to the stock icon resources
# "plugin/foobar/abc/def.png" that points to "src/main/webapp/abc/def.png" in your plugin resources
Human readable text that follows the icon.
If specified, then this controls whether the task is enabled or not.
If "false", remove this item from the context menu.
If specified, the link will be only displayed when the current user
has the specified permission against the "it" object.
This is useful for showing links to restricted pages, as showing
them to unprivileged users don't make sense.
If both permission and permissions is set, then permissions will be used
If specified, the link will be only displayed when the current user has
one or more of the specified permissions against the "it" object.
If both permission and permissions is set, then permissions will be used
If true, send a POST rather than a GET request.
(onclick supersedes this except in the context menu.)
(since 1.504)
If true, require confirmation before clicking.
Generally used with post="true".
(onclick supersedes this except in the context menu.)
(since 1.512)
Message to use for confirmation, if requested; defaults to title.
(since 1.512)
The url of the tab
The title of the tab
Outer-most tag for a normal (non-AJAX) HTML rendering.
This is used with nested <header>, <side-panel>, and <main-panel>
to form Jenkins's basic HTML layout.
Title of the HTML page. Rendered into <title> tag.
Deprecated: Used to disable auto refresh for a page. The feature has been removed.
specify path that starts from "/" for loading additional CSS stylesheet.
path is interpreted as relative to the context root. e.g.,
{noformat}<l:layout css="/plugin/mysuperplugin/css/myneatstyle.css">{noformat}
This was originally added to allow plugins to load their stylesheets, but
*the use of the attribute is discouraged now.*
plugins should now do so by inserting <style> elements and/or <script> elements
in <l:header/> tag.
If given, this page is only made available to users who have the specified permission.
(The permission will be checked against the "it" object.)
If given, this page is made available to users who have one or more of the specified permissions.
(The permissions will be checked against the "it" object.)
Available values: two-column (by default), one-column (full-width size) or full-screen (since 2.53).
Do not include Bootstrap 3 grid. When a plugin wants to use a more recent version of Bootstrap then
the bundled grid will cause conflicts.
Send escaped value to output decorated to be safely broken into lines when necessary
@since 1.517
Unescaped value to output
Used inside <l:layout> to render additional breadcrumb items.
URL that the breadcrumb item links to. Can be omitted.
If specified, this ID will be assigned to the LI element.
This is useful for programmatically adding the context menu
Display name of the breadcrumb.
Used in the <l:side-panel> to draw a box with a title.
The box is drawn as a table, and the body of this tag
is expected to draw a series of <TR>s to fill in the contents
of the box.
Title of the box. Can include HTML.
Specify the number of columns in the table
(so that the title can stretch to the entire table width.
@id of the table, if specified.
Pane table class specification.
Footer of the box. Can include HTML.
Sets up the same 'global' variables that the l:layout tag does for content loaded by AJAX scripts.
Content-type of the response page. This will be ignored if this tag is encountered while
evaluating a page that has called l:layout tag.
Creates a small button that lets the user copies a text into clipboard
Tooltip of the button.
Text to be copied into the clipboard.
Confirmation message to be shown once the text is copied.
This is required as in some browsers, button doesn't properly provide feedback to user actions
due to the nature of the hack needed to make copy work.
Specify the CSS selector (like ".foo") that points to the ancestor block element that has "positive:relative".
According to ZeroClipboard documentation, having such container would improve the accuracy of invisible flash
overlay.
Additional CSS styles to apply.
Additional CSS class names, so that you can discover this tag more easily from your JavaScript.
Outputs a help icon
The help link is rendered as an SVG with an (?) icon.
@since 2.234
Icon size, available are: small, medium, large, xlarge
The tooltip to display
Class name to apply
This Jelly tag is deprecated, use tag instead. Defined on layout.jelly.
Outer-most tag for a normal (non-AJAX) HTML rendering.
This is used with nested <header>, <side-panel>, and <main-panel>
to form Jenkins's basic HTML layout.
Title of the HTML page. Rendered into <title> tag.
Deprecated: Used to disable auto refresh for a page. The feature has been removed.
specify path that starts from "/" for loading additional CSS stylesheet.
path is interpreted as relative to the context root. e.g.,
{noformat}<l:layout css="/plugin/mysuperplugin/css/myneatstyle.css">{noformat}
This was originally added to allow plugins to load their stylesheets, but
*the use of this attribute is discouraged now.*
plugins should now do so by inserting <style> elements and/or <script> elements
in <l:header/> tag.
If given, this page is only made available to users that has the specified permission.
(The permission will be checked against the "it" object.)