Customise Word Export Template for Jira Applications

プラットフォームについて: Data Center - この記事は、Data Center プラットフォームのアトラシアン製品に適用されます。

このナレッジベース記事は製品の Data Center バージョン用に作成されています。Data Center 固有ではない機能の Data Center ナレッジベースは、製品のサーバー バージョンでも動作する可能性はありますが、テストは行われていません。サーバー*製品のサポートは 2024 年 2 月 15 日に終了しました。サーバー製品を利用している場合は、アトラシアンのサーバー製品のサポート終了のお知らせページにて移行オプションをご確認ください。

*Fisheye および Crucible は除く

背景

This KB article outlines how to customise the output from JIRA applications while exporting issues to Word documents.

ソリューション

本ページの内容には、Atlassian ソフトウェアのカスタマイズや拡張 (CSS ルール、HTML、JavaScript の追加/変更など) を行う手順が含まれています。アトラシアン サポートの提供 の通り、Atlassia 製品に加えられたカスタマイズはサポートされません。この資料は情報提供のみを目的として提供されています。内容はお客様自身の責任でご利用ください。

本件またはカスタマイズに関するご質問は、コミュニティの Atlassian Answers で質問してください。または、アトラシアン ソリューション パートナー にご相談いただくことをご検討ください。

  1. The output of word export is controlled by the four velocity templates located at atlassian-jira/WEB-INF/classes/templates/plugins/issueviews located under Jira applications Installation Directory. 
    1. single-word-css.vm - Defines the html styles used for export
    2. single-word-header.vm - Defines the header part of the exported document
    3. single-word.vm - The content part of the exported document
    4. single-word-footer.vm - The footer part of the exported document
  2. Open these files in your favorite text editor and make the required changes and save it.
  3. アプリケーションを再起動します。

There is a feature request for this functionality to be handled within the core of Jira applications, as tracked at: JRASERVER-12813 - Export to Word: more control

Example: Changing Word Export to A4 size

  1. Access single-word-css.vm.
  2. Open in a text editor and Add the following css under <style type="text/css">:

    @page
    {
    /The A4 paper size is 210 mm wide by 297 mm long/
    size: 210mm 297mm!important;
    }

  3. Save and restart your JIRA application.


Example: Increase the Character Length of Issue Summary in Issue Export to Word File

Edit the single-word.vm file to increase the length of Issue Summary on each node. There are char limits for some of the items in the template. The default value is 40 chars

<!-- Line 27 ## -->                $textutils.htmlEncode($stringUtils.abbreviate($issue.summary, 40))

<!-- Line 367 -->                        <a href="$baseurl/browse/$textutils.htmlEncode($encoder.encode($subTask.key))">$textutils.htmlEncode($stringUtils.abbreviate($subTask.summary, 40))</a>
Change the number of chars to a higher value and restart your nodes to apply the changes.

<!-- Line 27 ##  -->              $textutils.htmlEncode($stringUtils.abbreviate($issue.summary, 100))

<!-- Line 367    -->                     <a href="$baseurl/browse/$textutils.htmlEncode($encoder.encode($subTask.key))">$textutils.htmlEncode($stringUtils.abbreviate($subTask.summary, 100))</a>

You will see more chars from the Summary is added to the Word file. Please see screenshot of Word file export before and after changes applied.



最終更新日 2025 年 4 月 2 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.