clean the lua filter

Author: cderv

inst/resources/lua/custom-environment.lua

@@ -2,7 +2,7 @@
      A Pandoc 2 lua filter to deal with custom environment in bookdown
 --]]
 
--- theroem types available to be used
+-- theorem types available to be used
 local theorem_abbr = {
     theorem = 'thm',
     lemma = 'lem',
@@ -14,16 +14,15 @@ local theorem_abbr = {
     exercise = 'exr'
 }
 
--- other special envs
+-- other special proof envs
 local proof_label = {
     proof = 'Proof',
     remark = 'Remark',
     solution = 'Solution'
 }
 
--- just for debuging purpose
+-- for debuging purpose
 local debug_mode = os.getenv("DEBUG_PANDOC_LUA") == "TRUE"
-
 function print_debug(label,obj,iter)
     obj = obj or nil
     iter = iter or pairs
@@ -71,16 +70,15 @@ end
 
 -- Modify Pandoc AST for supported custom environment
 Div = function (div)
-    -- checking if classes correponds to a custom one
     local classes = div.classes
     -- we do nothing if no classes
     if (#classes == 0) then
         print_debug("No classes in the Div.")
         return div
     end
-
     print_debug("Div classes -> " , classes)
 
+    -- checking if the class is one of the supported custom environment
     local env_type = {type = nil, env = nil}
     for i,v in ipairs(classes) do
         if (theorem_abbr[v] ~= nil) then 
@@ -93,13 +91,11 @@ Div = function (div)
             break
         end
     end
-
     -- classes is not a supported one, we return as is
     if not env_type.env then
         print_debug("Not a bookdown supported custom class")
         return div
     end
-
     print_debug("Found types -> ", env_type)
 
     -- get the id if it exists - it will we use to build label for reference
@@ -109,6 +105,7 @@ Div = function (div)
     print_debug("id -> ", id)
     -- remove unwanted identifier on the div, as it will be on the span
     div.identifier = ""
+
     -- get the attributes
     local options = div.attributes
     if (options["data-latex"] ~= nil) then 
@@ -135,23 +132,20 @@ Div = function (div)
     end
 
     -- create the custom environment
-
     local label
+    -- Create a label for referencing - only for theorem like env
     if (env_type.type == "theorem") then
         label = string.format("%s:%s", theorem_abbr[env_type.env], id)
     end
     print_debug("label for reference -> ", label)
 
     -- TODO: should we support beamer also ?
     if (FORMAT:match 'latex') then
-        
         local label_part 
         if label then
             label_part = string.format( "\n\\protect\\hypertarget{%s}{}\\label{%s}", label, label)
         end
-
         local name = get_name('latex', options)
-        
         table.insert(
             div.content, 1,
             pandoc.RawBlock('tex', string.format('\\begin{%s}%s%s', env_type.env, name, label_part or ""))
@@ -160,15 +154,13 @@ Div = function (div)
             div.content,
             pandoc.RawBlock('tex', string.format('\\end{%s}', env_type.env))
         )
-    end
-
-    if (FORMAT:match 'html') then
+    elseif (FORMAT:match 'html') then
         local name = get_name('html', options)
 
         -- if div is already processed by eng_theorem, it would also modify it. 
         -- we can ignore knowing how eng_theorem modifies options$html.before2
         -- It can be Plain or Para depending if a name was used or not.
-        -- NOT VERY RELIABLE THOUGH
+        -- MAYBE NOT VERY RELIABLE THOUGH
         if (div.content[1].t == "Plain" or div.content[1].t == "Para") then
             for i,el in pairs(div.content[1].content) do
                 if (el.t == "Span" and el.classes[1] == env_type.env) then
@@ -177,6 +169,8 @@ Div = function (div)
                 end
             end
         end
+
+        -- inserted the correct span depending on the environment type
         local span
         if (env_type.type == "theorem") then
             span = pandoc.Span(