Creating Help for a Custom Field

Customizations to JIRA, such as including Javascript in the Custom Field description are not included in the scope of  Atlassian Support .

To provide online help for a custom field, use HTML or Javascript in the field's description. E.g. you can have a simple link to an external help page:

<a href="http://www.mycompany.com/jirahelp/fieldhelp.html">get help</a>

Or using Javascript, you can have help text right in the field:

where clicking the help icon makes hidden help text appear:

This can be done by entering the following as the field's description:

Quality Assurance contact
<script type="text/javascript">
  function showHelp() {
        var listenersDiv = document.getElementById("qaFieldHelp");
        if (listenersDiv.style.display == 'none') {
          listenersDiv.style.display = '';
        } else {
          listenersDiv.style.display='none';
        }
  }
</script>
<a href="#"  onclick="showHelp(); return false;"><img src="/images/icons/ico_help.png"/></a>
<div id="qaFieldHelp" style="display:none">
  The QA Contact is a member of the QA department responsible for taking this issue through testing.
  They will be notified by email of this and subsequent issue state transitions.
</div>

(Incidentally, Javascript in descriptions can also be used to set field values.)

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport