summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2024-03-09 17:23:18 +0100
committerJonas Smedegaard <dr@jones.dk>2024-03-09 17:24:13 +0100
commitaf0c0b7a40b1106b6f2fecade30ca8e4e95bd342 (patch)
treeb07cf727000c9be835673db4703484d4c9859ea1
parentb673da7ff8e0936221b944f9da73eb86780788f7 (diff)
install and use extension abstract-section
``` quarto add pandoc-ext/abstract-section ```
-rw-r--r--_extensions/pandoc-ext/abstract-section/_extension.yaml6
-rw-r--r--_extensions/pandoc-ext/abstract-section/abstract-section.lua85
-rw-r--r--_quarto.yml1
3 files changed, 92 insertions, 0 deletions
diff --git a/_extensions/pandoc-ext/abstract-section/_extension.yaml b/_extensions/pandoc-ext/abstract-section/_extension.yaml
new file mode 100644
index 0000000..f6a946b
--- /dev/null
+++ b/_extensions/pandoc-ext/abstract-section/_extension.yaml
@@ -0,0 +1,6 @@
+name: abstract-section
+author: Albert Krewinkel
+version: 1.2.0
+contributes:
+ filters:
+ - abstract-section.lua
diff --git a/_extensions/pandoc-ext/abstract-section/abstract-section.lua b/_extensions/pandoc-ext/abstract-section/abstract-section.lua
new file mode 100644
index 0000000..4badeb4
--- /dev/null
+++ b/_extensions/pandoc-ext/abstract-section/abstract-section.lua
@@ -0,0 +1,85 @@
+--[[
+abstract-section – move an "abstract" section into document metadata
+
+Copyright: © 2017–2023 Albert Krewinkel
+License: MIT – see LICENSE file for details
+]]
+local stringify = (require 'pandoc.utils').stringify
+local section_identifiers = {
+ abstract = true,
+}
+local collected = {}
+--- The level of the highest heading that was seen so far. Abstracts
+--- must be at or above this level to prevent nested sections from being
+--- treated as metadata. Only top-level sections should become metadata.
+local toplevel = 6
+
+--- Extract abstract from a list of blocks.
+local function abstract_from_blocklist (blocks)
+ local body_blocks = {}
+ local looking_at_section = false
+
+ for _, block in ipairs(blocks) do
+ if block.t == 'Header' and block.level <= toplevel then
+ toplevel = block.level
+ if section_identifiers[block.identifier] then
+ looking_at_section = block.identifier
+ collected[looking_at_section] = {}
+ else
+ looking_at_section = false
+ body_blocks[#body_blocks + 1] = block
+ end
+ elseif looking_at_section then
+ if block.t == 'HorizontalRule' then
+ looking_at_section = false
+ else
+ local collect = collected[looking_at_section]
+ collect[#collect + 1] = block
+ end
+ else
+ body_blocks[#body_blocks + 1] = block
+ end
+ end
+
+ return body_blocks
+end
+
+Pandoc = function (doc)
+ local meta = doc.meta
+
+ -- configure
+ section_identifiers_list =
+ (doc.meta['abstract-section'] or {})['section-identifiers']
+ if section_identifiers_list and #section_identifiers_list > 0 then
+ section_identifiers = {}
+ for i, ident in ipairs(section_identifiers_list) do
+ section_identifiers[stringify(ident)] = true
+ end
+ end
+ -- unset config in meta
+ doc.meta['abstract-section'] = nil
+
+ local blocks = {}
+ if PANDOC_VERSION >= {2,17} then
+ -- Walk all block lists by default
+ blocks = doc.blocks:walk{Blocks = abstract_from_blocklist}
+ elseif PANDOC_VERSION >= {2,9,2} then
+ -- Do the same with pandoc versions that don't have walk methods but the
+ -- `walk_block` function.
+ blocks = pandoc.utils.walk_block(
+ pandoc.Div(doc.blocks),
+ {Blocks = abstract_from_blocklist}
+ ).content
+ else
+ -- otherwise, just check the top-level block-list
+ blocks = abstract_from_blocklist(doc.blocks)
+ end
+ for metakey in pairs(section_identifiers) do
+ metakey = stringify(metakey)
+ local abstract = collected[metakey]
+ if not meta[metakey] and abstract and #abstract > 0 then
+ meta[metakey] = pandoc.MetaBlocks(abstract)
+ end
+ end
+ return pandoc.Pandoc(blocks, meta)
+end
diff --git a/_quarto.yml b/_quarto.yml
index f5b5665..b8740f5 100644
--- a/_quarto.yml
+++ b/_quarto.yml
@@ -61,6 +61,7 @@ resource-path:
- /usr/share/citation-style-language/styles
filters:
+ - abstract-section
- diagram
resources: