git.iko.soy/typeable/pandoc
on master help sign in
data/pandoc.lua: regularize constructors.

We now use Pandoc instead of Doc (though Doc remains a deprecated Synonym), and we deprecate DoubleQuoted, SingleQuoted, InlineMath, and DisplayMath.

commit0f658eb46ce3630886b733e8c8ed1086af9b3510 authorJohn MacFarlane <jgm@berkeley.edu> dateThu 29 Jun 2017, 17:08 (9 years ago) parentcb25326
3 files changed+13−14
compare with master
unifiedsplit
data/pandoc.lua+10−11 test/lua/hello-world-doc.lua+2−2 test/lua/implicit-doc-filter.lua+1−1
data/pandoc.lua+10−11
@@ -23,7 +23,7 @@ THIS SOFTWARE.
2323-- @copyright © 2017 Albert Krewinkel
2424-- @license MIT
2525local M = {
26− _VERSION = "0.2.0"
26+ _VERSION = "0.3.0"
2727}
2828
2929------------------------------------------------------------------------
@@ -137,7 +137,7 @@ end
137137-- @function Doc
138138-- @tparam {Block,...} blocks document content
139139-- @tparam[opt] Meta meta document meta data
140−function M.Doc(blocks, meta)
140+function M.Pandoc(blocks, meta)
141141 meta = meta or {}
142142 return {
143143 ["blocks"] = blocks,
@@ -146,6 +146,8 @@ function M.Doc(blocks, meta)
146146 }
147147end
148148
149+-- DEPRECATED synonym:
150+M.Doc = M.Pandoc
149151
150152------------------------------------------------------------------------
151153-- MetaValue
@@ -449,8 +451,7 @@ M.Link = M.Inline:create_constructor(
449451 {"attributes", "content", {"target", "title"}}
450452)
451453
452−--- Creates a Math element, either inline or displayed. It is usually simpler to
453−-- use one of the specialized functions @{InlineMath} or @{DisplayMath} instead.
454+--- Creates a Math element, either inline or displayed.
454455-- @function Math
455456-- @tparam "InlineMath"|"DisplayMath" mathtype rendering specifier
456457-- @tparam string text Math content
@@ -462,7 +463,7 @@ M.Math = M.Inline:create_constructor(
462463 end,
463464 {"mathtype", "text"}
464465)
465−--- Creates a DisplayMath element.
466+--- Creates a DisplayMath element (DEPRECATED).
466467-- @function DisplayMath
467468-- @tparam string text Math content
468469-- @treturn Inline Math element
@@ -471,7 +472,7 @@ M.DisplayMath = M.Inline:create_constructor(
471472 function(text) return M.Math("DisplayMath", text) end,
472473 {"mathtype", "text"}
473474)
474−--- Creates an InlineMath inline element.
475+--- Creates an InlineMath inline element (DEPRECATED).
475476-- @function InlineMath
476477-- @tparam string text Math content
477478-- @treturn Inline Math element
@@ -490,9 +491,7 @@ M.Note = M.Inline:create_constructor(
490491 "content"
491492)
492493
493−--- Creates a Quoted inline element given the quote type and quoted content. It
494−-- is usually simpler to use one of the specialized functions @{SingleQuoted} or
495−-- @{DoubleQuoted} instead.
494+--- Creates a Quoted inline element given the quote type and quoted content.
496495-- @function Quoted
497496-- @tparam "DoubleQuote"|"SingleQuote" quotetype type of quotes to be used
498497-- @tparam {Inline,..} content inline content
@@ -502,7 +501,7 @@ M.Quoted = M.Inline:create_constructor(
502501 function(quotetype, content) return {c = {quotetype, content}} end,
503502 {"quotetype", "content"}
504503)
505−--- Creates a single-quoted inline element.
504+--- Creates a single-quoted inline element (DEPRECATED).
506505-- @function SingleQuoted
507506-- @tparam {Inline,..} content inline content
508507-- @treturn Inline quoted element
@@ -512,7 +511,7 @@ M.SingleQuoted = M.Inline:create_constructor(
512511 function(content) return M.Quoted(M.SingleQuote, content) end,
513512 {"quotetype", "content"}
514513)
515−--- Creates a single-quoted inline element.
514+--- Creates a single-quoted inline element (DEPRECATED).
516515-- @function DoubleQuoted
517516-- @tparam {Inline,..} content inline content
518517-- @treturn Inline quoted element
test/lua/hello-world-doc.lua+2−2
@@ -1,10 +1,10 @@
11return {
22 {
3− Doc = function(doc)
3+ Pandoc = function(doc)
44 local meta = {}
55 local hello = { pandoc.Str "Hello,", pandoc.Space(), pandoc.Str "World!" }
66 local blocks = { pandoc.Para(hello) }
7− return pandoc.Doc(blocks, meta)
7+ return pandoc.Pandoc(blocks, meta)
88 end
99 }
1010}
test/lua/implicit-doc-filter.lua+1−1
@@ -2,5 +2,5 @@ function Doc (doc)
22 local meta = {}
33 local hello = { pandoc.Str "Hello,", pandoc.Space(), pandoc.Str "World!" }
44 local blocks = { pandoc.Para(hello) }
5− return pandoc.Doc(blocks, meta)
5+ return pandoc.Pandoc(blocks, meta)
66end