Merge pull request #4253 from quarto-dev/feature/footnotes

Confluence:  Footnote Support

Author: Allen Manning

src/publish/confluence/confluence-helper.ts

@@ -745,3 +745,32 @@ export const findAttachments = (
 
   return uniqueResult ?? [];
 };
+
+export const footnoteTransform = (bodyValue: string): string => {
+  const BACK_ANCHOR_FINDER: RegExp = /<a href="#fn(\d)"/g;
+  const ANCHOR_FINDER: RegExp = /<a href="#fnref(\d)"/g;
+  const CONFLUENCE_ANCHOR_FINDER: RegExp =
+    /ac:macro-id="d2cb5be1217ae6e086bc60005e9d27b7"><ac:parameter ac:name="">fn/g;
+
+  if (bodyValue.search(CONFLUENCE_ANCHOR_FINDER) !== -1) {
+    //the footnote transform has already happened
+    return bodyValue;
+  }
+
+  const buildConfluenceAnchor = (id: string) =>
+    `<ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:local-id="a6aa6f25-0bee-4a7f-929b-71fcb7eba592" ac:macro-id="d2cb5be1217ae6e086bc60005e9d27b7"><ac:parameter ac:name="">${id}</ac:parameter></ac:structured-macro>`;
+
+  const replacer =
+    (prefix: string) =>
+    (match: string, p1: string): string =>
+      `${buildConfluenceAnchor(`${prefix}${p1}`)}${match}`;
+
+  let replacedBody: string = bodyValue.replaceAll(
+    BACK_ANCHOR_FINDER,
+    replacer("fnref")
+  );
+
+  replacedBody = replacedBody.replaceAll(ANCHOR_FINDER, replacer("fn"));
+
+  return replacedBody;
+};

src/publish/confluence/confluence.ts

@@ -55,6 +55,7 @@ import {
   doWithSpinner,
   filterFilesForUpdate,
   findAttachments,
+  footnoteTransform,
   getNextVersion,
   getTitle,
   isContentCreate,
@@ -386,6 +387,8 @@ async function publish(
     trace("attachmentsToUpload", attachmentsToUpload, LogPrefix.ATTACHMENT);
 
     const updatedBody: ContentBody = updateImagePaths(body);
+    updatedBody.storage.value = footnoteTransform(updatedBody.storage.value);
+
     const toUpdate: ContentUpdate = {
       contentChangeType: ContentChangeType.update,
       id,
@@ -520,6 +523,7 @@ async function publish(
 
     trace("attachmentsToUpload", attachmentsToUpload, LogPrefix.ATTACHMENT);
     const updatedBody: ContentBody = updateImagePaths(body);
+    updatedBody.storage.value = footnoteTransform(updatedBody.storage.value);
 
     const toCreate: ContentCreate = {
       contentChangeType: ContentChangeType.create,

src/resources/extensions/quarto/confluence/publish-classic.lua

@@ -0,0 +1,284 @@
+-- Confluence Storage Format for Pandoc
+-- https://confluence.atlassian.com/doc/confluence-storage-format-790796544.html
+-- https://pandoc.org/MANUAL.html#custom-readers-and-writers
+
+local stringify = (require "pandoc.utils").stringify
+local confluence = require('overrides')
+
+-- From https://stackoverflow.com/questions/9168058/how-to-dump-a-table-to-console
+function dumpObject(o)
+  if type(o) == 'table' then
+    local s = '{ '
+    for k,v in pairs(o) do
+      if type(k) ~= 'number' then k = '"'..k..'"' end
+      s = s .. '['..k..'] = ' .. dumpObject(v) .. ','
+    end
+    return s .. '} '
+  else
+    return tostring(o)
+  end
+end
+
+
+function dump(object, label)
+  print(label or '' .. ': ', dumpObject(object))
+end
+
+-- The global variable PANDOC_DOCUMENT contains the full AST of
+-- the document which is going to be written. It can be used to
+-- configure the writer.
+local meta = PANDOC_DOCUMENT.meta
+
+-- Choose the image format based on the value of the
+-- `image_format` meta value.
+local image_format = meta.image_format
+        and stringify(meta.image_format)
+        or "png"
+local image_mime_type = ({
+  jpeg = "image/jpeg",
+  jpg = "image/jpeg",
+  gif = "image/gif",
+  png = "image/png",
+  svg = "image/svg+xml",
+})[image_format]
+        or error("unsupported image format `" .. image_format .. "`")
+
+-- Character escaping
+local escape = confluence.escape
+
+-- Helper function to convert an attributes table into
+-- a string that can be put into HTML tags.
+local function attributes(attr)
+  local attr_table = {}
+  for x,y in pairs(attr) do
+    if y and y ~= "" then
+      table.insert(attr_table, ' ' .. x .. '="' .. escape(y,true) .. '"')
+    end
+  end
+  return table.concat(attr_table)
+end
+
+-- Table to store footnotes, so they can be included at the end.
+local notes = {}
+
+-- Blocksep is used to separate block elements.
+function Blocksep()
+  return "\n\n"
+end
+
+-- This function is called once for the whole document. Parameters:
+-- body is a string, metadata is a table, variables is a table.
+-- This gives you a fragment.  You could use the metadata table to
+-- fill variables in a custom lua template.  Or, pass `--template=...`
+-- to pandoc, and pandoc will do the template processing as usual.
+function Doc(body, metadata, variables)
+  local buffer = {}
+  local function add(s)
+    table.insert(buffer, s)
+  end
+  add(body)
+  if #notes > 0 then
+    add('<ol class="footnotes">')
+    for _,note in pairs(notes) do
+      add(note)
+    end
+    add('</ol>')
+  end
+  return table.concat(buffer,'\n') .. '\n'
+end
+
+-- The functions that follow render corresponding pandoc elements.
+-- s is always a string, attr is always a table of attributes, and
+-- items is always an array of strings (the items in a list).
+-- Comments indicate the types of other variables.
+
+function Str(s)
+  return escape(s)
+end
+
+function Space()
+  return " "
+end
+
+function SoftBreak()
+  return "\n"
+end
+
+function LineBreak()
+  return "<br/>"
+end
+
+function Emph(s)
+  return "<em>" .. s .. "</em>"
+end
+
+function Strong(s)
+  return "<strong>" .. s .. "</strong>"
+end
+
+function Subscript(s)
+  return "<sub>" .. s .. "</sub>"
+end
+
+function Superscript(s)
+  return "<sup>" .. s .. "</sup>"
+end
+
+function SmallCaps(s)
+  return '<span style="font-variant: small-caps;">' .. s .. '</span>'
+end
+
+function Strikeout(s)
+  return '<del>' .. s .. '</del>'
+end
+
+function Link(s, tgt, tit, attr)
+  return confluence.LinkConfluence(s, tgt, tit, attr)
+end
+
+function Image(s, src, tit, attr)
+  return confluence.CaptionedImageConfluence(src, tit, '', attr)
+end
+
+function Code(s, attr)
+  return "<code" .. attributes(attr) .. ">" .. escape(s) .. "</code>"
+end
+
+function InlineMath(s)
+  return "\\(" .. escape(s) .. "\\)"
+end
+
+function DisplayMath(s)
+  return "\\[" .. escape(s) .. "\\]"
+end
+
+function SingleQuoted(s)
+  return "&lsquo;" .. s .. "&rsquo;"
+end
+
+function DoubleQuoted(s)
+  return "&ldquo;" .. s .. "&rdquo;"
+end
+
+function Note(s)
+  local num = #notes + 1
+  -- insert the back reference right before the final closing tag.
+  s = string.gsub(s,
+          '(.*)</', '%1 <a href="#fnref' .. num ..  '">&#8617;</a></')
+  -- add a list item with the note to the note table.
+  table.insert(notes, '<li id="fn' .. num .. '">' .. s .. '</li>')
+  -- return the footnote reference, linked to the note.
+  return '<a id="fnref' .. num .. '" href="#fn' .. num ..
+          '"><sup>' .. num .. '</sup></a>'
+end
+
+function Span(s, attr)
+  return "<span" .. attributes(attr) .. ">" .. s .. "</span>"
+end
+
+function RawInline(format, str)
+  if format == "html" then
+    return str
+  else
+    return ''
+  end
+end
+
+function Cite(s, cs)
+  local ids = {}
+  for _,cit in ipairs(cs) do
+    table.insert(ids, cit.citationId)
+  end
+  return "<span class=\"cite\" data-citation-ids=\"" .. table.concat(ids, ",") ..
+          "\">" .. s .. "</span>"
+end
+
+function Plain(s)
+  return s
+end
+
+function Para(s)
+  return "<p>" .. s .. "</p>"
+end
+
+-- lev is an integer, the header level.
+function Header(lev, s, attr)
+  return "<h" .. lev .. attributes(attr) ..  ">" .. s .. "</h" .. lev .. ">"
+end
+
+function BlockQuote(s)
+  return confluence.BlockQuoteConfluence(s)
+end
+
+function HorizontalRule()
+  return "<hr/>"
+end
+
+function LineBlock(ls)
+  return '<div style="white-space: pre-line;">' .. table.concat(ls, '\n') ..
+          '</div>'
+end
+
+function CodeBlock(s, attr)
+  return confluence.CodeBlockConfluence(s, attr)
+end
+
+function BulletList(items)
+  local buffer = {}
+  for _, item in pairs(items) do
+    table.insert(buffer, "<li>" .. item .. "</li>")
+  end
+  return "<ul>\n" .. table.concat(buffer, "\n") .. "\n</ul>"
+end
+
+function OrderedList(items)
+  local buffer = {}
+  for _, item in pairs(items) do
+    table.insert(buffer, "<li>" .. item .. "</li>")
+  end
+  return "<ol>\n" .. table.concat(buffer, "\n") .. "\n</ol>"
+end
+
+function DefinitionList(items)
+  local buffer = {}
+  for _,item in pairs(items) do
+    local k, v = next(item)
+    table.insert(buffer, "<dt>" .. k .. "</dt>\n<dd>" ..
+            table.concat(v, "</dd>\n<dd>") .. "</dd>")
+  end
+  return "<dl>\n" .. table.concat(buffer, "\n") .. "\n</dl>"
+end
+
+function CaptionedImage(src, tit, caption, attr)
+  return confluence.CaptionedImageConfluence(src, tit, caption, attr)
+end
+
+-- Caption is a string, aligns is an array of strings,
+-- widths is an array of floats, headers is an array of
+-- strings, rows is an array of arrays of strings.
+function Table(caption, aligns, widths, headers, rows)
+  return TableConfluence(caption, aligns, widths, headers, rows)
+end
+
+function RawBlock(format, str)
+  if format == "html" then
+    return str
+  else
+    return ''
+  end
+end
+
+function Div(s, attr)
+  return "<div" .. attributes(attr) .. ">\n" .. s .. "</div>"
+end
+
+-- The following code will produce runtime warnings when you haven't defined
+-- all of the functions you need for the custom writer, so it's useful
+-- to include when you're working on a writer.
+local meta = {}
+meta.__index =
+function(_, key)
+  io.stderr:write(string.format("WARNING: Undefined function '%s'\n",key))
+  return function() return "" end
+end
+setmetatable(_G, meta)