Module:CodeToText: Difference between revisions

← Older edit

@@ Line 1: / Line 1: @@
--- Extracts and returns a snippet of lines from a specified page, allowing for selective display of content within a defined range
+--[[
+* Name: CodeToText
+* Author: Mark W. Datysgeld
+* Description: Utility for extracting content snippets from wiki pages using emoji hook markers placed at the beginning and end of desired content sections
+* Notes: Example usage: {{#invoke:CodeToText|showSnippet|page=Module:Example|hook=⭐}}; Supports emoji hooks like 🪝, 📌, 🔖, ⭐ for both inline and block content extraction
+]]
 local p = {}
 function p.showSnippet(frame)
-     local pageName = frame.args.page or 'Module:Sandbox'
+     local pageName = frame.args.page
-     local fromLine = tonumber(frame.args.from) or 1
+    if not pageName then
-     local toLine   = tonumber(frame.args.to)   or fromLine
+        return "Error: 'page' parameter is required"
+    end
+     local hook = frame.args.hook
+    if not hook then
+        return "Error: 'hook' parameter is required"
+     end
      local titleObj = mw.title.new(pageName)
@@ Line 18: / Line 29: @@
      end
-     local lines = {}
+    -- Try inline hooks first
-    for line in content:gmatch("[^\r\n]+") do
+     local inlineSnippet = content:match(hook .. "(.-)" .. hook)
-         table.insert(lines, line)
+    if inlineSnippet then
+         return inlineSnippet
      end
-     local snippet = {}
+     -- Find block hooks
-     for i = fromLine, math.min(toLine, #lines) do
+     local s, e = content:find(hook, 1, true)
-         table.insert(snippet, lines[i])
+    if not s then
+         return "Error: Need at least 2 instances of hook '" .. hook .. "' in '" .. pageName .. "'"
      end
-     if frame.args.remove then
+     local s2, e2 = content:find(hook, e + 1, true)
-         local removeToken = frame.args.remove
+    if not s2 then
-         local escaped = removeToken:gsub("([^%w])", "%%%1")
+        return "Error: Need at least 2 instances of hook '" .. hook .. "' in '" .. pageName .. "'"
-         local pattern = "^" .. escaped .. "%s*"
+    end
-         for i, line in ipairs(snippet) do
-              snippet[i] = line:gsub(pattern, "")
+    -- Extract text between the two hooks, excluding the hook lines
-         end
+    local snippet = content:sub(e + 1, s2 - 1)
+    -- Trim leading and trailing newlines
+    if snippet:sub(1,1) == "\n" then
+        snippet = snippet:sub(2)
+    end
+    if snippet:sub(-1) == "\n" then
+        snippet = snippet:sub(1, -2)
      end
-     return table.concat(snippet, "\n")
+     return snippet
 end
 return p