Documentation for JIRA 6.3 EAP developer (EAP) releases only. Not using this? See below:
(JIRA 6.2.x documentation | JIRA OnDemand documentation | earlier versions of JIRA)

Skip to end of metadata
Go to start of metadata

The Text gadget displays your specified HTML text on the dashboard.

Icon

This gadget is only available if your JIRA administrator has enabled it. It is disabled by default because it is a potential security risk, as it can contain arbitrary HTML which could potentially make your JIRA system vulnerable to XSS attacks.

To enable the text gadget: Choose > Add-ons. The 'Find add-ons' screen shows add-ons available via the Atlassian Marketplace. Choose Manage Add-ons to view the plugins currently installed on your JIRA site. Enable the Text module in the Atlassian JIRA - Plugins - Gadgets Plugin (You need to select the System add-ons from the drop-down).

If you cannot enable the text gadget, please contact Atlassian Support for assistance.

What does it look like?

The Text gadget should appear as follows on the dashboard:

Adding the 'Text' Gadget to your Dashboard

  1. Go to your JIRA dashboard and click 'Add Gadget'.
  2. The 'Gadget Directory' will appear. Locate the 'Text' gadget and click the 'Add it Now' button. Then click the 'Finished' button at the bottom of the Gadget Directory.
  3. The Text gadget will appear on your dashboard as follows, ready for you to configure:
    1. 'Title'  — type a heading for this gadget.
    2. 'Body'  — type the body text; this may include HTML.
  4. Click the 'Save' button.

To move the gadget to a different position on the dashboard, simply drag-and-drop. You can also change the look and behavior of the gadget.

20 Comments

  1. Is there a plugin for displaying text on a dashboard without taking the risk of XSS?

    For example by using the wiki syntax or by showing plain text only.

    1. Hi Dennis,

      You are right that the solution is to have a wiki syntax gadget. We have not yet developed this nor do we yet have a concrete schedule for doing so.

      I have raised a feature request for it here: http://jira.atlassian.com/browse/JRA-21965

      At this time the only solutions are:

      1. If you have Confluence you can display wiki content in a confluence page gadget.

      2. Use a gadget capable of displaying arbitrary text published from elsewhere. Note that you would need to trust the gadget publisher because gadgets are a form of software and a nefarious gadget publisher could take advantage of you. Also, if the gadget can display arbitrary html then it probably has the same XSS vulnerability as the text gadget. The following search may be a good place to start looking for such a gadget: http://desktop.google.com/plugins/search/?query=notes&hl=en

      3. Develop a custom gadget with your desired content. It's not as hard as programming but it will need to be either hosted on a server or installed as a plugin. Some links follow. Bear in mind the problem with most of the material is that it focuses on creating dynamic gadget content implemented in JavaScript whereas you probably only want html.

      http://confluence.atlassian.com/display/FECRUDEV/Gadget+Tutorial http://confluence.atlassian.com/display/GADGETDEV/Gadget+Development

      regards,

      Chris.

      1. Anonymous

        "1. If you have Confluence you can display wiki content in a confluence page gadget."

        Hi, I have JIRA v4.1.1#522 and Confluence 4.3.3, but I don't see this confluence gadget, I only see a "Greenhopper Card View". Where would I find this?

        Thanks,

        -Matt

    2. A workaround can be to use the Activity Stream gadget, and publish your comments through the API under a custom Activity Provider.

      The Gadget will then let you apply filters to show only those providers and content types you are interested in.

      See Adding the Activity Stream Gadget

       

  2. Anonymous

    Sorry, but I fail to see how this gadget makes XSS attacks possible. The content displayed by the gadget is provided by the same user to that it will be displayed later on. Shall I run a XSS attack on myself? That's ridiculous. How shall a different user set the content of my gadget, other than a user having access to the JIRA database (and such a user could modify pretty much everything to do a XSS attack, he certainly won't need that gadget).

    1. Dashboards can be shared. You just have to trick someone to view your dashboard and your malicious script will be executed.

  3. Anonymous

    I am sorry but I cannot find it right now. Is there any guide to enable it. I looked everywhere....

    1. Same problem here. No clue on how to activate it....
      Went through the enable plugin, did all system plug in one by one. Couldn't find it.
      Can you please help !! 

      1. Anonymous

        Administration -> Plugins -> Manage My Plugins -> System Plugins -> Atlassian JIRA - Plugins - Gadgets Plugin -> Text (enable this)

         

         

        1. Hi 

          I have followed the address to enable the Text Gadget. 

          But it will not allow me to enable.  I am using JIRA on demand.  Is it possible to enable using this version?

          I just want to share a dashboard across teams with a gadget listing useful internal 'How to documents'.  Any ideas?

          1. Anonymous

            Looks like it is no longer listed in the new plugin manager

          2. Hi Linus,

            You are correct, the text gadget is not available in OnDemand because it is a security risk. You can customise the 'Introduction Gadget' which is done via admin/general configuration/settings.

            1. The 'Introduction Gadget' is  for the JIRA instance, we need different text for different project.

        2. Anonymous

          Perfect, had a very difficult time find where to do this. Thanks!

  4. I have a problem with this gadget. I have one line og text in the gadget. But when viewing the dashboard as a wallboard, there are a big black empty space under the text gadget.

    Anyone know how to limit this space? Have tried to use <H1> ,<p> but both have the same black empty space after the text. No html tags at all also have the same problem.

  5. Anonymous

    Is there a limit on the number of characters you can type into this gadget? I get Request Entry Too Large Error.

    1. Anonymous

      Just a clarification...I want to provide set of navigation links to the other Jira Dashboards in the Text box gadget. I am using <a href=...> tags to provide these links. I think that the Text box widget somehow limits the number of characters in the box to a fixed number. If this is the case, is there a workaround (other than creating multiple Text Box gadgets)? Thanks for all your help!

  6. nice and simple gadget. We use it to publish release information and contacts on our release dashboard for our stakeholders.

    Only problem: It's not visible for anonymous users. And I don't find a way to edit any permissions for this :-/

    Any ideas?

  7. No hay un gadget 'Text ' para la version de JIRA 5.06? gracias

     

  8. If for example I have two dashboards and I want to display the same Text Data in both, is there a way I can set up the text gadget to

    display the text from another text gadget?