Wiki source code of JIRA
Last modified by Vincent Massol on 2026/08/04 21:49
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | The JIRA integration displays issues stored in a JIRA instance inside wiki pages. The issues are fetched when the page is displayed, so a page never holds a copy of the issue data that goes stale. | ||
| 2 | |||
| 3 | Which issues are displayed is decided in one of two ways: an explicit list of issue keys, or a [[JQL query>>https://support.atlassian.com/jira-software-cloud/docs/use-advanced-search-with-jira-query-language-jql/]] evaluated by JIRA. Either one is written in the content of a JIRA Macro, and the Macro parameters decide which JIRA instance is queried and how the result is presented. | ||
| 4 | |||
| 5 | The JIRA instance is designated either directly by its URL, with the ##url## parameter, or by an id that an administrator has given it in the wiki administration, with the ##id## parameter. Using an id is preferable, for the reasons given in [[JIRA administration>>doc:documentation.extensions.admin.jira.WebHome]], which also states which JIRA versions can be reached and under which account. | ||
| 6 | |||
| 7 | Four different goals are covered, each by its own Macro, and choosing between them is mostly a question of what you want the reader to see: | ||
| 8 | |||
| 9 | * [[Display JIRA Issues in a Page>>doc:documentation.extensions.user.jira.display-issues.WebHome]], to render a set of issues as a table, a bulleted list or an enumeration, when the reader needs the issues themselves | ||
| 10 | * [[Count JIRA Issues in a Page>>doc:documentation.extensions.user.jira.count-issues.WebHome]], to display only the number of issues matching a query, when the count is the information and the issues are noise | ||
| 11 | * [[Display a JIRA Chart in a Page>>doc:documentation.extensions.user.jira.display-chart.WebHome]], to show JIRA's own aggregated statistics as a pie chart, a created-versus-resolved chart or a bidimensional grid, when the reader needs a trend or a distribution rather than individual issues | ||
| 12 | * [[Paste a JIRA URL to Insert a JIRA Macro>>doc:documentation.extensions.user.jira.paste-url.WebHome]], to have any of the above inserted for you, which is the fastest route when you already have the issue or search open in your browser | ||
| 13 | |||
| 14 | Everything the Macros can display is subject to what the account the wiki uses to reach JIRA is allowed to see. When that account may not read an issue a Macro selects, the Macro displays an error in place of the issues, as described in [[JIRA Connection Errors>>doc:documentation.extensions.admin.jira.connection-errors.WebHome]]. |
