Merge pull request #13650 from quarto-dev/tests/update-journal-extensions

Author: cderv

tests/docs/extensions/format/academic/_extensions/quarto-journals/acs/print-affiliation.tex renamed to tests/docs/extensions/format/academic/_extensions/quarto-journals/acs/_affiliation.tex

@@ -1,7 +1,30 @@
-name: Elsevier Journal Format
+title: ACS Journal Format
+author: Charles Teague
+version: 0.9.2
 contributes:
-  format:
+  formats:
     common:
       csl: american-chemical-society.csl
+      shortcodes:
+        - fancy-text
+      filters:
+        - latex-environment
+      environments:
+        - scheme
+        - chart
+        - graph
+        - tocentry
+        - acknowledgement
+        - suppinfo
+      commands:
+        - ce
+    html: default
     pdf:
-      template-partials: ["doc-class.tex", "title.tex", "print-affiliation.tex"]
+      cite-method: natbib
+      biblio-config: false
+      format-resources:
+        - achemso.bst
+      template-partials:
+        - "doc-class.tex"
+        - "title.tex"
+        - "_affiliation.tex"

tests/docs/extensions/format/academic/_extensions/quarto-journals/acs/_extension.yml

@@ -0,0 +1,7 @@
+title: Fancy Text
+author: Posit Software, PBC
+version: 1.1.1
+quarto-required: ">=1.2.198"
+contributes:
+  shortcodes:
+    - fancy-text.lua

tests/docs/extensions/format/academic/_extensions/quarto-journals/acs/_extensions/quarto-ext/fancy-text/_extension.yml

@@ -0,0 +1,78 @@
+-- shortcode that provides a nicely formatted 'LaTeX' string
+function latex()
+  if quarto.doc.is_format("pdf") then
+    return pandoc.RawBlock('tex', '{\\LaTeX}')
+  elseif quarto.doc.is_format("html") then
+    return pandoc.Math('InlineMath', "\\LaTeX")
+  else 
+    return pandoc.Span('LaTeX')
+  end
+end
+
+function tex() 
+  if quarto.doc.is_format("pdf") then
+    return pandoc.RawBlock('tex', '{\\TeX}')
+  elseif quarto.doc.is_format("html") then
+    return pandoc.Math('InlineMath', "\\TeX")
+  else 
+    return pandoc.Span('TeX')
+  end
+end
+  
+-- shortcode that provides a nicely formatted 'bibtex' string
+function bibtex()
+  if quarto.doc.is_format("pdf") then
+    return pandoc.RawBlock('tex', '\\textsc{Bib}{\\TeX}')
+  elseif quarto.doc.is_format("html") then
+    return pandoc.RawBlock('html', '<span style="font-variant: small-caps;">Bib</span><span style="letter-spacing:-2px;">T</span><sub style="font-size: inherit; letter-spacing:-1px;">E</sub>X')
+  else
+    return pandoc.Span('BibTeX')
+  end
+end
+
+function ldots()
+  if quarto.doc.is_format("pdf") then
+    return pandoc.RawBlock('tex', '\\ldots')
+  elseif quarto.doc.is_format("html") then
+    return pandoc.RawBlock('html', '&#8230;')
+  else
+    return "..."
+  end
+end
+
+function vdots()
+  if quarto.doc.is_format("pdf") then
+    return pandoc.Math('InlineMath', "\\vdots")
+  elseif quarto.doc.is_format("html") then
+    return pandoc.RawBlock('html', '&#8942;')
+  else
+    return "..."
+  end
+end
+
+function ddots() 
+  if quarto.doc.is_format("pdf") then
+    return pandoc.Math('InlineMath', "\\ddots")
+  elseif quarto.doc.is_format("html") then
+    return pandoc.RawBlock('html', '&#8945;')
+  else
+    return "..."
+  end
+end
+
+function pct()
+  local pct
+  if quarto.doc.is_format("pdf") then
+    return pandoc.Math('InlineMath', '\\%')
+  else 
+    return pandoc.Str("%")
+  end
+end
+ 
+function R2() 
+  if quarto.doc.is_format("pdf") then
+    return pandoc.Math('InlineMath', "R^2")
+  else
+    return {pandoc.Str("R"), pandoc.Superscript("2")} 
+  end
+end

tests/docs/extensions/format/academic/_extensions/quarto-journals/acs/_extensions/quarto-ext/fancy-text/fancy-text.lua

@@ -0,0 +1,9 @@
+title: LaTeX Environment
+author: Posit Software, PBC
+version: 1.2.1
+quarto-required: ">=1.3"
+contributes:
+  filters:
+    - latex-environment.lua
+  format:
+    pdf: default

tests/docs/extensions/format/academic/_extensions/quarto-journals/acs/_extensions/quarto-ext/latex-environment/_extension.yml

@@ -0,0 +1,150 @@
+-- environment.lua
+-- Copyright (C) 2020 by RStudio, PBC
+
+local classEnvironments = pandoc.MetaMap({})
+local classCommands = pandoc.MetaMap({})
+
+-- helper that identifies arrays
+local function tisarray(t)
+  local i = 0
+  for _ in pairs(t) do
+    i = i + 1
+    if t[i] == nil then return false end
+  end
+  return true
+end
+
+-- reads the environments
+local function readEnvironments(meta)
+  local env = meta['environments']
+  if env ~= nil then
+    if tisarray(env) then
+      -- read an array of strings
+      for i, v in ipairs(env) do
+        local value = pandoc.utils.stringify(v)
+        classEnvironments[value] = value
+      end
+    else
+      -- read key value pairs
+      for k, v in pairs(env) do
+        local key = pandoc.utils.stringify(k)
+        local value = pandoc.utils.stringify(v)
+        classEnvironments[key] = value
+      end
+    end
+  end
+end
+
+local function readCommands(meta)
+  local env = meta['commands']
+  if env ~= nil then
+    if tisarray(env) then
+      -- read an array of strings
+      for i, v in ipairs(env) do
+        local value = pandoc.utils.stringify(v)
+        classCommands[value] = value
+      end
+    else
+      -- read key value pairs
+      for k, v in pairs(env) do
+        local key = pandoc.utils.stringify(k)
+        local value = pandoc.utils.stringify(v)
+        classCommands[key] = value
+      end
+    end
+  end
+end
+
+local function readEnvsAndCommands(meta)
+  readEnvironments(meta)
+  readCommands(meta)
+end
+
+-- use the environments from metadata to
+-- emit a custom environment for latex
+local function writeEnvironments(divEl)
+  if quarto.doc.is_format("latex") then
+    for k, v in pairs(classEnvironments) do
+      if divEl.attr.classes:includes(k) then
+        -- process this into a latex environment
+        local beginEnv = '\\begin' .. '{' .. v .. '}'
+        local endEnv = '\n\\end{' .. v .. '}'
+        
+        -- check if custom options or arguments are present
+        -- and add them to the environment accordingly
+        local opts = divEl.attr.attributes['options']
+        if opts then
+          beginEnv = beginEnv .. '[' .. opts .. ']'
+        end
+
+        local args = divEl.attr.attributes['arguments']
+        if args then
+          beginEnv = beginEnv .. '{' .. args .. '}'
+        end
+        
+        -- if the first and last div blocks are paragraphs then we can
+        -- bring the environment begin/end closer to the content
+        if #divEl.content > 0 and divEl.content[1].t == "Para" and divEl.content[#divEl.content].t == "Para" then
+          table.insert(divEl.content[1].content, 1, pandoc.RawInline('tex', beginEnv .. "\n"))
+          table.insert(divEl.content[#divEl.content].content, pandoc.RawInline('tex', "\n" .. endEnv))
+        else
+          table.insert(divEl.content, 1, pandoc.RawBlock('tex', beginEnv))
+          table.insert(divEl.content, pandoc.RawBlock('tex', endEnv))
+        end
+        return divEl
+      end
+    end
+  end
+end
+
+local function buildCommandArgs(opts, format)
+  local function wrap(o) 
+    return string.format(format, o)
+  end 
+  local t = pandoc.List()
+  for str in string.gmatch(opts, "([^"..",".."]+)") do
+    t:insert(str)
+  end
+  return table.concat(t:map(wrap), "")
+end
+
+-- use the environments from metadata to
+-- emit a custom environment for latex
+local function writeCommands(spanEl)
+  if quarto.doc.is_format("latex") then
+    for k, v in pairs(classCommands) do
+      if spanEl.attr.classes:includes(k) then
+
+        -- resolve the begin command
+        local beginCommand = '\\' .. pandoc.utils.stringify(v)
+        local opts = spanEl.attr.attributes['options']
+        local args = spanEl.attr.attributes['arguments']
+        if opts then
+          beginCommand = beginCommand .. buildCommandArgs(opts, "[%s]")
+        end
+        if args then
+          beginCommand = beginCommand .. buildCommandArgs(args, "{%s}")
+        end
+
+        local beginCommandRaw = pandoc.RawInline('latex', beginCommand .. '{')
+
+        -- the end command
+        local endCommandRaw = pandoc.RawInline('latex', '}')
+
+        -- attach the raw inlines to the span contents
+        local result = spanEl.content
+        table.insert(result, 1, beginCommandRaw)
+        table.insert(result, endCommandRaw)
+
+        return result
+      end
+    end
+  end
+end
+
+-- Run in two passes so we process metadata
+-- and then process the divs
+return {
+  { Meta = readEnvsAndCommands },
+  { Div = writeEnvironments, Span = writeCommands }
+}