Render reStructuredText notes in JIRA output

[KevinGDialpad]

reStructuredText has a concept of notes and warnings.
Confluence has info, tip, note, and warning macros

When converting from RST to Confluence, notes and warnings are currently ignored (essentially):

$ cat input.rst 
This is some text

.. note::

   This is a note

And some more text
$ docker run --rm --volume "$(pwd):/data" --user $(id -u):$(id -g) pandoc/core input.rst --from rst --to jira
This is some text

Note

This is a note

And some more text
$ docker run --rm  pandoc/core -v | head -n 1
pandoc 3.6.2

I'd love to have them converted to note and warnings macros instead. In this specific example, I'd like an output like

This is some text

{note}This is a note{note}

And some more text

which looks great on Confluence:

(FWIW I'd rather use {info} for notes because {note} looks more like a warning...)

---

2 thoughts about this. First, I haven't looked at Pandoc internals, so I'm not sure whether it already detects RST notes and warnings.

Also, it seems that Pandoc doesn't distinguish between JIRA and Confluence. Clicking on "Jira wiki markup" on https://pandoc.org/ goes to https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all, which doesn't mention {note} at all.

It sounds like the {note} macro is a Confluence thing, and I'm guessing it wouldn't work on non-Confluence Atlassian things. So maybe we shouldn't use it in an output format named jira.

Maybe this ticket requires separating JIRA and Confluence as output formats. Which would requires finding a spec for the Confluence format. An alternative would be to use {panel} instead, which is specified in the "Text Formatting Notation Help" document, so it's more likely to be supported across Atlassian products.

[jgm]

Another alternative would be to use a Lua filter to format the output this way.
Something like

function Div(el)
  if el.classes:includes("note") then
    table.remove(el.content, 1) -- remove title
    table.insert(el.content, 1, pandoc.RawBlock("jira", "{note}"))
    table.insert(el.content, pandoc.RawBlock("jira", "{note}"))
    return el
  end
end

This will give you a blank line after {note}; I'm assuming that will still work, but if not, something more complex would be needed.

[KevinGDialpad]

Ah, interesting. I shall look into this as well, thank you! Pretty sure the blank line is indeed okay.