Depending on CONTEXT:
Once you have exported one of your JIRA issues, you will receive a Word document. Here's the magical part: it's not a simple layout, but a document based on styles. when you use styles to format your document, you can quickly and easily apply a set of formatting choices consistently throughout your document. A style is a set of formatting characteristics, such as font name, size, color, paragraph alignment and spacing. Some styles even include borders and shading.
For example, instead of taking three separate steps to format your heading as 16-point, bold, Cambria, you can achieve the same result in one step by applying the built-in Heading 1 style. You do not need to remember the characteristics of the Heading 1 style. For each heading in your document, you just click in the heading. Here's more info about styles for the curious: clickety click!
Each of your JIRA issue fields is assigned to a specific style name, which tells us how to format a given field value when you export. If you do not see a field, please let us know at email@example.com!
Remember that you can upload your own files as templates. This means that you can download one of the supplied ones, customize it using styles and upload again to have your own template!
Let's have a look at an example document from BigTemplate, the leave application:
And select some text, such as the description. As you can see, we can choose a different font style at the top, and they are named after JIRA values such as fixVersion or Project. You can click the small triangle below the top list of styles to show them s a separate, vertical floating window for more convenient work
Right-clicking the style at the top allows you to rename it, remove the style or modify it easily. Here's more info about styles for the curious: clickety click!
The text is exported as standard text, so spellcheck will catch and correct all errors for you (unless you have it turned off). Life is easy!
GANTT, ROADMAP, RESOURCES, RISKS
Documentation will be available soon!
Let us show the list of available styles as a separate window:
You will note that all JIRA fields start with a prefix "BT.task." The first word is also starting with lowercase, next ones depending on how they were named, there's no spaces between words.
You can add a space after the name of a style:
and type your own custom parameters to create many flavors of the same style:
In version 2.0 the prefix was changed from SP (like SoftwarePlant) to BT (like BigTemplate).
Supported field types
Jira standard fields
These are the names of BigTemplate styles, and how you should name the styles of your own templates so that the export are good-looking. For standard JIRA fields, it's rather simple:
|JIRA field||Style name|
You can find the full list of all styles with examples in this sample document: Click!
Assignee and reporter e-mail support are supported. To make them appear in a document, use the identifiers:
Image identifier BT.task.key#qr generates QR code with a link to the issue.
Custom field types
- Select List (multiple choice)
- Select List (single choice)
- User Picker
- Date Picker
- Text Field (multi-line)
- Text Field (single line)
For custom fields, you need to find out how a given field is named in your JIRA instance - the field ID is used for this. To do so, go to JIRA Administration->Issues→Custom Fields:
To obtain the ID, you need to right-click a custom field on your JIRA issue screena and hit Inpsect Element - the Id will be clearly shown as a numerical value (10400 as an example below for field 123):
The pattern is BT.task.custom.ID-here. e.g. BT.task.custom.customfield_10001