Uploaded image for project: 'Jira Data Center'
  1. Jira Data Center
  2. JRASERVER-44495

Add warning regarding HTML tags in HTML macros in JIRA and Confluence docs

XMLWordPrintable

    • We collect Jira feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

      NOTE: This suggestion is for JIRA Server. Using JIRA Cloud? See the corresponding suggestion.

      Problem Definition

      Both JIRA and Confluence have HTML macros, which allow users to add HTML code to any issues and pages respectively.

      However, if the user adds the required HTML tags inside the macro (<html>, <body> or <header>, the user may end up breaking the page formatting.

      Similarly, if the user adds a "style" for tags, it may override JIRA's CSS. For example:

      <style type="text/css">
body { font-family: serif, verdana; font-size: smaller; }
</style>

      Suggested Solution

      Inform users that they should not use those tags - rather, they should only use the formatting as if they were including something inside the <body> directly.

      Example of pages that should be edited are:

            [JRASERVER-44495] Add warning regarding HTML tags in HTML macros in JIRA and Confluence docs

            Katherine Yabut made changes -
            Workflow Original: JAC Suggestion Workflow [ 3044246 ] New: JAC Suggestion Workflow 3 [ 3673641 ]
            Status Original: RESOLVED [ 5 ] New: Closed [ 6 ]
            Owen made changes -
            Workflow Original: Confluence Workflow - Public Facing v4 [ 2604029 ] New: JAC Suggestion Workflow [ 3044246 ]
            Rachel Lin (Inactive) made changes -
            Workflow Original: JIRA PM Feature Request Workflow v2 - TEMP [ 2553901 ] New: Confluence Workflow - Public Facing v4 [ 2604029 ]
            Status Original: Closed [ 6 ] New: Resolved [ 5 ]
            Ignat (Inactive) made changes -
            Workflow Original: JIRA Bug Workflow w Kanban v6 - TEMP [ 2342216 ] New: JIRA PM Feature Request Workflow v2 - TEMP [ 2553901 ]
            Status Original: Resolved [ 5 ] New: Closed [ 6 ]
            Katherine Yabut made changes -
            Workflow Original: JIRA Bug Workflow w Kanban v6 [ 2121822 ] New: JIRA Bug Workflow w Kanban v6 - TEMP [ 2342216 ]
            Katherine Yabut made changes -
            Workflow Original: JIRA Bug Workflow w Kanban v6 - TEMP [ 2083190 ] New: JIRA Bug Workflow w Kanban v6 [ 2121822 ]
            Katherine Yabut made changes -
            Workflow Original: JIRA Bug Workflow w Kanban v6 [ 918335 ] New: JIRA Bug Workflow w Kanban v6 - TEMP [ 2083190 ]
            jonah (Inactive) made changes -
            Description Original: h3. Problem Definition
            Both *JIRA* and *Confluence* have *HTML* macros, which allow users to add _HTML code_ to any issues and pages respectively.

            However, if the user adds the required HTML tags inside the macro ({{<html>}}, {{<body>}} or {{<header>}}, the user may end up breaking the page formatting.

            Similarly, if the user adds a "style" for tags, it may override JIRA's CSS. For example:
            {noformat}
            <style type="text/css">
            body { font-family: serif, verdana; font-size: smaller; }
            </style>
            {noformat}

            h3. Suggested Solution
            Inform users that they should not use those tags - rather, they should only use the formatting as if they were including something inside the {{<body>}} directly.

            Example of pages that should be edited are:
            * [Editing Rich-Text Fields|https://confluence.atlassian.com/display/JIRA/Editing+Rich-Text+Fields] in the JIRA documentation, and;
            * [HTML Macro|https://confluence.atlassian.com/display/DOC/HTML+Macro] in Confluence's.             		New: {panel:bgColor=#e7f4fa}
              *NOTE:* This suggestion is for *JIRA Server*. Using *JIRA Cloud*? [See the corresponding suggestion|http://jira.atlassian.com/browse/JRACLOUD-44495].
              {panel}

            h3. Problem Definition
            Both *JIRA* and *Confluence* have *HTML* macros, which allow users to add _HTML code_ to any issues and pages respectively.

            However, if the user adds the required HTML tags inside the macro ({{<html>}}, {{<body>}} or {{<header>}}, the user may end up breaking the page formatting.

            Similarly, if the user adds a "style" for tags, it may override JIRA's CSS. For example:
            {noformat}
            <style type="text/css">
            body { font-family: serif, verdana; font-size: smaller; }
            </style>
            {noformat}

            h3. Suggested Solution
            Inform users that they should not use those tags - rather, they should only use the formatting as if they were including something inside the {{<body>}} directly.

            Example of pages that should be edited are:
            * [Editing Rich-Text Fields|https://confluence.atlassian.com/display/JIRA/Editing+Rich-Text+Fields] in the JIRA documentation, and;
            * [HTML Macro|https://confluence.atlassian.com/display/DOC/HTML+Macro] in Confluence's.
            jonah (Inactive) made changes -
            Link New: This issue relates to JRACLOUD-44495 [ JRACLOUD-44495 ]
            Confluence Escalation Bot (Inactive) made changes -
            Labels Original: jw-documentation New: affects-server jw-documentation

              wthompson Wazza
              mfernandes@atlassian.com Matheus Fernandes
              Votes:
              1 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated:
                Resolved: