Lua: add info on when functions became available in pandoc

doc/lua-filters.md

@@ -3749,6 +3749,8 @@ Returns:
 
 -   parsed options, using their JSON-like representation. (table)
 
+*Since: 3.0*
+
 ### repl {#pandoc.cli.repl}
 
 `repl ([env])`
@@ -3783,6 +3785,8 @@ Returns:
 The result(s) of the last evaluated input, or nothing if the last
 input resulted in an error.
 
+*Since: 3.1.2*
+
 <!-- END: AUTOGENERATED CONTENT -->
 
 # Module pandoc.utils
@@ -4642,6 +4646,8 @@ Returns:
 
 -   The filepath up to the last directory separator. (string)
 
+*Since: 2.12*
+
 ### filename {#pandoc.path.filename}
 
 `filename (filepath)`
@@ -4657,6 +4663,8 @@ Returns:
 
 -   File name part of the input path. (string)
 
+*Since: 2.12*
+
 ### is_absolute {#pandoc.path.is_absolute}
 
 `is_absolute (filepath)`
@@ -4673,6 +4681,8 @@ Returns:
 -   `true` iff `filepath` is an absolute path, `false` otherwise.
     (boolean)
 
+*Since: 2.12*
+
 ### is_relative {#pandoc.path.is_relative}
 
 `is_relative (filepath)`
@@ -4689,6 +4699,8 @@ Returns:
 -   `true` iff `filepath` is a relative path, `false` otherwise.
     (boolean)
 
+*Since: 2.12*
+
 ### join {#pandoc.path.join}
 
 `join (filepaths)`
@@ -4704,6 +4716,8 @@ Returns:
 
 -   The joined path. (string)
 
+*Since: 2.12*
+
 ### make_relative {#pandoc.path.make_relative}
 
 `make_relative (path, root[, unsafe])`
@@ -4728,6 +4742,8 @@ Returns:
 
 -   contracted filename (string)
 
+*Since: 2.12*
+
 ### normalize {#pandoc.path.normalize}
 
 `normalize (filepath)`
@@ -4750,6 +4766,8 @@ Returns:
 
 -   The normalized path. (string)
 
+*Since: 2.12*
+
 ### split {#pandoc.path.split}
 
 `split (filepath)`
@@ -4765,6 +4783,8 @@ Returns:
 
 -   List of all path components. ({string,\...})
 
+*Since: 2.12*
+
 ### split_extension {#pandoc.path.split_extension}
 
 `split_extension (filepath)`
@@ -4784,6 +4804,8 @@ Returns:
 -   filepath without extension (string)
 -   extension or empty string (string)
 
+*Since: 2.12*
+
 ### split_search_path {#pandoc.path.split_search_path}
 
 `split_search_path (search_path)`
@@ -4801,6 +4823,8 @@ Returns:
 
 -   list of directories in search path ({string,\...})
 
+*Since: 2.12*
+
 ### treat_strings_as_paths {#pandoc.path.treat_strings_as_paths}
 
 `treat_strings_as_paths ()`
@@ -4808,6 +4832,8 @@ Returns:
 Augment the string module such that strings can be used as path
 objects.
 
+*Since: 2.12*
+
 <!-- END: AUTOGENERATED CONTENT -->
 
 <!-- BEGIN: AUTOGENERATED CONTENT for module pandoc.structure -->
@@ -4859,6 +4885,8 @@ Returns:
 
 -   processed blocks ([Blocks])
 
+*Since: 3.0*
+
 ### slide_level {#pandoc.structure.slide_level}
 
 `slide_level (blocks)`
@@ -4876,6 +4904,8 @@ Returns:
 
 -   slide level ([integer]{unknown-type="integer"})
 
+*Since: 3.0*
+
 ### split_into_chunks {#pandoc.structure.split_into_chunks}
 
 `split_into_chunks (doc[, opts])`
@@ -4923,6 +4953,8 @@ Returns:
 
 -    ([ChunkedDoc])
 
+*Since: 3.0*
+
 ### table_of_contents {#pandoc.structure.table_of_contents}
 
 `table_of_contents (toc_source[, opts])`
@@ -4942,6 +4974,8 @@ Returns:
 
 -   Table of contents as a BulletList object ([Block])
 
+*Since: 3.0*
+
 <!-- END: AUTOGENERATED CONTENT -->
 
 # Module pandoc.system
@@ -5848,6 +5882,8 @@ Returns:
 
 -   new Archive ([zip.Archive])
 
+*Since: 3.0*
+
 ### Entry {#pandoc.zip.Entry}
 
 `Entry (path, contents[, modtime])`
@@ -5870,6 +5906,8 @@ Returns:
 
 -   a new zip archive entry ([zip.Entry])
 
+*Since: 3.0*
+
 ### read_entry {#pandoc.zip.read_entry}
 
 `read_entry (filepath[, opts])`
@@ -5888,6 +5926,8 @@ Returns:
 
 -   a new zip archive entry ([zip.Entry])
 
+*Since: 3.0*
+
 ### zip {#pandoc.zip.zip}
 
 `zip (filepaths[, opts])`
@@ -5907,6 +5947,8 @@ Returns:
 
 -   a new archive ([zip.Archive])
 
+*Since: 3.0*
+
 ## Types {#pandoc.zip-types}
 
 ### zip.Archive {#type-pandoc.zip.Archive}

pandoc-lua-engine/src/Text/Pandoc/Lua/Init.hs

@@ -21,6 +21,7 @@ import Control.Monad (forM, forM_, when)
 import Control.Monad.Catch (throwM, try)
 import Control.Monad.Trans (MonadIO (..))
 import Data.Maybe (catMaybes)
+import Data.Version (makeVersion)
 import HsLua as Lua hiding (status, try)
 import Text.Pandoc.Class (PandocMonad (..))
 import Text.Pandoc.Data (readDataFile)
@@ -95,10 +96,18 @@ loadedModules =
   , Pandoc.Types.documentedModule
   , Pandoc.Utils.documentedModule
   , Module.Layout.documentedModule { moduleName = "pandoc.layout" }
+    `allSince` [2,18]
   , Module.Path.documentedModule { moduleName = "pandoc.path" }
+    `allSince` [2,12]
   , Module.Text.documentedModule
+    `allSince` [2,0,3]
   , Module.Zip.documentedModule { moduleName = "pandoc.zip" }
+    `allSince` [3,0]
   ]
+ where
+  allSince mdl version = mdl
+    { moduleFunctions = map (`since` makeVersion version) $ moduleFunctions mdl
+    }
 
 -- | Initialize the lua state with all required values
 initLuaState :: PandocLua ()

pandoc-lua-engine/src/Text/Pandoc/Lua/Module/CLI.hs

@@ -13,6 +13,7 @@ module Text.Pandoc.Lua.Module.CLI
   ) where
 
 import Control.Applicative ((<|>))
+import Data.Version (makeVersion)
 import HsLua
 import HsLua.REPL (defaultConfig, replWithEnv, setup)
 import Text.Pandoc.App (defaultOpts, options, parseOptionsFromArgs)
@@ -47,8 +48,9 @@ documentedModule = Module
            , "Typically this function will be used in stand-alone pandoc Lua"
            , "scripts, taking the list of arguments from the global `arg`."
            ]
+        `since` makeVersion [3, 0]
 
-      , repl
+      , repl `since` makeVersion [3, 1, 2]
       ]
   , moduleOperations = []
   , moduleTypeInitializers = []

pandoc-lua-engine/src/Text/Pandoc/Lua/Module/Format.hs

@@ -11,6 +11,7 @@ module Text.Pandoc.Lua.Module.Format
   ( documentedModule
   ) where
 
+import Data.Version (makeVersion)
 import HsLua
 import Text.Pandoc.Error (PandocError)
 import Text.Pandoc.Extensions (getAllExtensions, getDefaultExtensions)
@@ -46,6 +47,7 @@ functions =
         , "function does not check if the format is supported, it will return"
         , "a fallback list of extensions even for unknown formats."
         ]
+     `since` makeVersion [3,0]
 
   , defun "all_extensions"
      ### liftPure getAllExtensions
@@ -58,6 +60,7 @@ functions =
         , "can have an effect when reading a format but not when"
         , "writing it, or *vice versa*."
         ]
+     `since` makeVersion [3,0]
 
   , defun "extensions"
      ### liftPure getExtensionsConfig
@@ -73,4 +76,5 @@ functions =
         , "This function can be used to assign a value to the `Extensions`"
         , "global in custom readers and writers."
         ]
+     `since` makeVersion [3,0]
   ]

pandoc-lua-engine/src/Text/Pandoc/Lua/Module/JSON.hs

@@ -22,7 +22,7 @@ where
 import Prelude hiding (null)
 import Data.Maybe (fromMaybe)
 import Data.Monoid (Alt (..))
-import Data.Version (Version, makeVersion)
+import Data.Version (makeVersion)
 import HsLua.Aeson
 import HsLua.Core
 import HsLua.Marshalling
@@ -70,8 +70,8 @@ null = Field
 
 functions :: [DocumentedFunction PandocError]
 functions =
-  [ decode
-  , encode
+  [ decode `since` makeVersion [3, 1, 1]
+  , encode `since` makeVersion [3, 1, 1]
   ]
 
 -- | Decode a JSON string into a Lua object.
@@ -102,7 +102,6 @@ decode = defun "decode"
      , "The special handling of AST elements can be disabled by setting"
      , "`pandoc_types` to `false`."
      ]
-  `since` initialVersion
 
 -- | Encode a Lua object as JSON.
 encode :: LuaError e => DocumentedFunction e
@@ -133,8 +132,3 @@ encode = defun "encode"
      , "the sole argument. The result of that call is expected to be a"
      , "valid JSON string, but this not checked."
      ]
-  `since` initialVersion
-
--- | First published version of this library.
-initialVersion :: Version
-initialVersion = makeVersion [1,0,0]

pandoc-lua-engine/src/Text/Pandoc/Lua/Module/MediaBag.hs

@@ -42,15 +42,15 @@ documentedModule = Module
   , moduleDescription = "mediabag access"
   , moduleFields = []
   , moduleFunctions =
-      [ delete
-      , empty
-      , fetch
-      , fill
-      , insert
-      , items
-      , list
-      , lookup
-      , write
+      [ delete  `since` makeVersion [2,7,3]
+      , empty   `since` makeVersion [2,7,3]
+      , fetch   `since` makeVersion [2,0]
+      , fill    `since` makeVersion [2,19]
+      , insert  `since` makeVersion [2,0]
+      , items   `since` makeVersion [2,7,3]
+      , list    `since` makeVersion [2,0]
+      , lookup  `since` makeVersion [2,0]
+      , write   `since` makeVersion [3,0]
       ]
   , moduleOperations = []
   , moduleTypeInitializers = []

pandoc-lua-engine/src/Text/Pandoc/Lua/Module/Structure.hs

@@ -15,11 +15,12 @@ module Text.Pandoc.Lua.Module.Structure
 import Control.Applicative ((<|>), optional)
 import Data.Default (Default (..))
 import Data.Maybe (fromMaybe)
+import Data.Version (makeVersion)
 import HsLua ( DocumentedFunction, LuaError, Module (..), Peeker
              , (###), (<#>), (=#>), (#?)
              , defun, functionResult, getfield, isnil, lastly, liftLua
              , opt, liftPure, parameter , peekBool, peekIntegral
-             , peekFieldRaw, peekText, pop, pushIntegral, top )
+             , peekFieldRaw, peekText, pop, pushIntegral, since, top )
 import Text.Pandoc.Chunks ( ChunkedDoc (..), PathTemplate (..)
                           , tocToList, splitIntoChunks )
 import Text.Pandoc.Definition (Pandoc (..), Block)
@@ -45,10 +46,10 @@ documentedModule = Module
     "hierarchical sections and the table of contents."
   , moduleFields = []
   , moduleFunctions =
-      [ make_sections
-      , slide_level
-      , split_into_chunks
-      , table_of_contents
+      [ make_sections     `since` makeVersion [3,0]
+      , slide_level       `since` makeVersion [3,0]
+      , split_into_chunks `since` makeVersion [3,0]
+      , table_of_contents `since` makeVersion [3,0]
       ]
   , moduleOperations = []
   , moduleTypeInitializers = []

pandoc-lua-engine/src/Text/Pandoc/Lua/Module/System.hs

@@ -31,15 +31,17 @@ documentedModule = Module
       ]
   , moduleFunctions =
       [ cputime `since` makeVersion [3, 1, 1]
-      , setName "environment" env
-      , setName "get_working_directory" getwd
-      , setName "list_directory" ls
-      , setName "make_directory" mkdir
-      , setName "remove_directory" rmdir
-      , setName "with_environment" with_env
-      , setName "with_temporary_directory" with_tmpdir
-      , setName "with_working_directory" with_wd
+      , setName "environment" env                      `since` v[2,7,3]
+      , setName "get_working_directory" getwd          `since` v[2,8]
+      , setName "list_directory" ls                    `since` v[2,19]
+      , setName "make_directory" mkdir                 `since` v[2,19]
+      , setName "remove_directory" rmdir               `since` v[2,19]
+      , setName "with_environment" with_env            `since` v[2,7,3]
+      , setName "with_temporary_directory" with_tmpdir `since` v[2,8]
+      , setName "with_working_directory" with_wd       `since` v[2,7,3]
       ]
   , moduleOperations = []
   , moduleTypeInitializers = []
   }
+ where
+  v = makeVersion

pandoc-lua-engine/src/Text/Pandoc/Lua/Module/Template.hs

@@ -11,6 +11,7 @@ module Text.Pandoc.Lua.Module.Template
   ( documentedModule
   ) where
 
+import Data.Version (makeVersion)
 import HsLua
 import HsLua.Module.DocLayout (peekDoc, pushDoc)
 import Text.Pandoc.Error (PandocError)
@@ -53,6 +54,7 @@ functions =
      , "table as values, where the table can be either be a list of the"
      , "aforementioned types, or a nested context."
      ]
+    `since` makeVersion [3,0]
 
   , defun "compile"
      ### (\template mfilepath -> unPandocLua $
@@ -64,6 +66,7 @@ functions =
      <#> opt (stringParam "templ_path" "template path")
      =#> functionResult (either failLua pushTemplate) "pandoc Template"
            "compiled template"
+    `since` makeVersion [2,17]
 
   , defun "default"
      ### (\mformat -> unPandocLua $ do
@@ -76,6 +79,7 @@ functions =
               "writer for which the template should be returned.")
      =#> functionResult pushText "string"
            "string representation of the writer's default template"
+    `since` makeVersion [2,17]
 
   , defun "meta_to_context"
      ### (\meta blockWriterIdx inlineWriterIdx -> unPandocLua $ do
@@ -101,4 +105,5 @@ functions =
      , "data, using the given functions to convert [Blocks] and [Inlines]"
      , "to [Doc] values."
      ]
+    `since` makeVersion [3,0]
   ]

pandoc-lua-engine/src/Text/Pandoc/Lua/Module/Types.hs

@@ -13,8 +13,9 @@ module Text.Pandoc.Lua.Module.Types
   ( documentedModule
   ) where
 
+import Data.Version (makeVersion)
 import HsLua ( Module (..), (###), (<#>), (=#>)
-             , defun, functionResult, parameter)
+             , defun, functionResult, parameter, since)
 import HsLua.Module.Version (peekVersionFuzzy, pushVersion)
 import Text.Pandoc.Error (PandocError)
 import Text.Pandoc.Lua.PandocLua ()
@@ -37,6 +38,7 @@ documentedModule = Module
                        , "or a Version object"
                        ])
         =#> functionResult pushVersion "Version" "A new Version object."
+        `since` makeVersion [2,7,3]
       ]
   , moduleOperations = []
   , moduleTypeInitializers = []

pandoc-lua-engine/src/Text/Pandoc/Lua/Module/Utils.hs

@@ -22,7 +22,7 @@ import Control.Monad ((<$!>))
 import Data.Data (showConstr, toConstr)
 import Data.Default (def)
 import Data.Maybe (fromMaybe)
-import Data.Version (Version)
+import Data.Version (Version, makeVersion)
 import HsLua as Lua
 import HsLua.Module.Version (peekVersionFuzzy, pushVersion)
 import Text.Pandoc.Citeproc (getReferences, processCitations)
@@ -59,6 +59,7 @@ documentedModule = Module
             "blocks" ""
       <#> opt (parameter (peekList peekInline) "Inlines" "sep" "")
       =#> functionResult pushInlines "list of inlines" ""
+      `since` v[2,2,3]
 
     , defun "citeproc"
       ### unPandocLua . processCitations
@@ -69,12 +70,14 @@ documentedModule = Module
           , "rendered citations and adding a bibliography. "
           , "See the manual section on citation rendering for details."
           ]
+      `since` v[2,19,1]
 
     , defun "equals"
       ### equal
       <#> parameter pure "AST element" "elem1" ""
       <#> parameter pure "AST element" "elem2" ""
       =#> functionResult pushBool "boolean" "true iff elem1 == elem2"
+      `since` v[2,5]
 
     , defun "make_sections"
       ### liftPure3 Shared.makeSections
@@ -85,6 +88,7 @@ documentedModule = Module
             "blocks" "document blocks to process"
       =#> functionResult pushBlocks "list of Blocks"
             "processes blocks"
+      `since` v[2,8]
 
     , defun "normalize_date"
       ### liftPure Shared.normalizeDate
@@ -97,8 +101,10 @@ documentedModule = Module
       , "or equal to 1583, but MS Word only accepts dates starting 1601)."
       , "Returns nil instead of a string if the conversion failed."
       ]
+      `since` v [2,0,6]
 
     , sha1
+      `since` v [2,0,6]
 
     , defun "Version"
       ### liftPure (id @Version)
@@ -119,6 +125,7 @@ documentedModule = Module
          , "document (either with a genuine citation or with `nocite`) are "
          , "returned. URL variables are converted to links."
          ]
+      `since` v[2,17]
 
     , defun "run_json_filter"
       ### (\doc filterPath margs -> do
@@ -134,28 +141,33 @@ documentedModule = Module
       <#> opt (parameter (peekList peekString) "list of strings"
                "args" "arguments to pass to the filter")
       =#> functionResult pushPandoc "Pandoc" "filtered document"
+      `since` v[2,1,1]
 
     , defun "stringify"
       ### stringify
       <#> parameter pure "AST element" "elem" "some pandoc AST element"
       =#> functionResult pushText "string" "stringified element"
+      `since` v [2,0,6]
 
     , defun "from_simple_table"
       ### from_simple_table
       <#> parameter peekSimpleTable "SimpleTable" "simple_tbl" ""
       =?> "Simple table"
+      `since` v[2,11]
 
     , defun "to_roman_numeral"
       ### liftPure Shared.toRomanNumeral
       <#> parameter (peekIntegral @Int) "integer" "n" "number smaller than 4000"
       =#> functionResult pushText "string" "roman numeral"
       #? "Converts a number < 4000 to uppercase roman numeral."
+      `since` v[2,0,6]
 
     , defun "to_simple_table"
       ### to_simple_table
       <#> parameter peekTable "Block" "tbl" "a table"
       =#> functionResult pushSimpleTable "SimpleTable" "SimpleTable object"
       #? "Converts a table into an old/simple table."
+      `since` v[2,11]
 
     , defun "type"
       ### (\idx -> getmetafield idx "__name" >>= \case
@@ -163,12 +175,15 @@ documentedModule = Module
               _ -> ltype idx >>= typename)
       <#> parameter pure "any" "object" ""
       =#> functionResult pushByteString "string" "type of the given value"
-    #? ("Pandoc-friendly version of Lua's default `type` function, " <>
+      #? ("Pandoc-friendly version of Lua's default `type` function, " <>
         "returning the type of a value. If the argument has a " <>
         "string-valued metafield `__name`, then it gives that string. " <>
         "Otherwise it behaves just like the normal `type` function.")
+      `since` v[2,17]
     ]
   }
+ where
+  v = makeVersion
 
 -- | Documented Lua function to compute the hash of a string.
 sha1 :: DocumentedFunction e

tools/update-lua-module-docs.lua

@@ -159,6 +159,7 @@ local function render_function (doc, level, modulename)
     .. List{paramlist}
     .. List(#doc.results > 0 and {Para 'Returns:'} or {})
     .. render_results(doc.results)
+    .. Blocks(doc.since and {Para{Emph{'Since: ' .. doc.since}}} or {})
 end
 
 local function render_field (field, level, modulename)