From 8fdbe8f867ee7c488d74d5e56a8297803d2fac42 Mon Sep 17 00:00:00 2001 From: strangelookingnerd <49242855+strangelookingnerd@users.noreply.github.com> Date: Tue, 5 Nov 2024 13:23:43 +0100 Subject: [PATCH] Update documentation --- .../plugins/badge/dsl/AddBadgeStep/help-icon.html | 14 +++++++------- .../badge/dsl/AddSummaryStep/help-icon.html | 12 ++++++------ 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/src/main/resources/com/jenkinsci/plugins/badge/dsl/AddBadgeStep/help-icon.html b/src/main/resources/com/jenkinsci/plugins/badge/dsl/AddBadgeStep/help-icon.html index 1f83a27..f86973c 100644 --- a/src/main/resources/com/jenkinsci/plugins/badge/dsl/AddBadgeStep/help-icon.html +++ b/src/main/resources/com/jenkinsci/plugins/badge/dsl/AddBadgeStep/help-icon.html @@ -1,13 +1,13 @@
- The plugin supports symbols from the ionicons library through the ionicons-api-plugin. - More symbols can be added by installing additional plugins, such as font-awesome-api-plugin or custom-folder-icon-plugin. + The plugin supports symbols from the Ionicons API as well as the Emoji Symbols API. + More symbols can be added by installing additional plugins, such as Font Awesome API or IT Symbols API. Symbols from plugins are referenced as "symbol-icon-name plugin-plugin-name" and Jenkins Core icons as "icon-icon-name" or "symbol-icon-name" - see Jenkins Design Library for more details. For example, the following are all valid references to symbols:
addBadge icon: 'symbol-alert-circle-outline plugin-ionicons-api', text: 'This is an alert symbol'
addBadge icon: 'symbol-bar-chart-filled plugin-ionicons-api', text: 'This is a bar chart symbol'
addBadge icon: 'symbol-battery-half-sharp plugin-ionicons-api', text: 'This is a half filled battery symbol'
addBadge icon: 'symbol-sloth plugin-emoji-symbols-api', text: 'This is a sloth symbol'
addBadge icon: 'symbol-cube', text: 'This is a Jenkins Core symbol'
addBadge icon: 'icon-gear', text: 'This is a Jenkins Core icon'
- The plugin includes icons as GIF images and also supports the 16x16 icons that are offered by Jenkins. + The plugin also supports the 16x16 icons that are offered by Jenkins. These icons are listed in the plugin documentation and are referenced as "image-name.gif". For example, the following are all valid references to icons included with the plugin:
addBadge icon: 'completed.gif', text: 'This is a completed symbol'
addBadge icon: 'success.gif', text: 'This is a success icon'
addBadge icon: 'warning.gif', text: 'This is a warning icon'
addBadge icon: 'aborted.gif', text: 'This is a aborted symbol'
addBadge icon: 'folder-open.gif', text: 'This is a folder icon'
addBadge icon: 'document_edit.gif', text: 'This is a document icon'
- The plugin supports symbols from the ionicons library through the ionicons-api-plugin. - More symbols can be added by installing additional plugins, such as font-awesome-api-plugin or custom-folder-icon-plugin. + The plugin supports symbols from the Ionicons API as well as the Emoji Symbols API. + More symbols can be added by installing additional plugins, such as Font Awesome API or IT Symbols API. Symbols from plugins are referenced as "symbol-icon-name plugin-plugin-name" and Jenkins Core icons as "icon-icon-name" or "symbol-icon-name" - see Jenkins Design Library for more details. For example, the following are all valid references to symbols:
addSummary icon: 'symbol-alert-circle-outline plugin-ionicons-api', text: 'This is an alert symbol'
addSummary icon: 'symbol-bar-chart-filled plugin-ionicons-api', text: 'This is a bar chart symbol'
addSummary icon: 'symbol-battery-half-sharp plugin-ionicons-api', text: 'This is a half filled battery symbol'
addSummary icon: 'symbol-sloth plugin-emoji-symbols-api', text: 'This is a sloth symbol'
addSummary icon: 'symbol-cube', text: 'This is a Jenkins Core symbol'
addSummary icon: 'icon-gear', text: 'This is a Jenkins Core icon'
addSummary icon: 'completed.gif', text: 'This is a completed symbol'
addSummary icon: 'success.gif', text: 'This is a success icon'
addSummary icon: 'warning.gif', text: 'This is a warning icon'
addSummary icon: 'aborted.gif', text: 'This is a aborted symbol'
addSummary icon: 'folder-open.gif', text: 'This is a folder icon'
addSummary icon: 'document_edit.gif', text: 'This is a document icon'