Module:CodeToText
Appearance
Documentation for this module may be created at Module:CodeToText/doc
-- Module:TranscludeModuleCode
-- Extracts a snippet of content from a specified page using either:
-- 1. A defined line range (from/to parameters)
-- 2. Hook markers like emojis (hook parameter)
--
-- The module finds content between matching instances of the same hook,
-- either on different lines or within the same line. Any emoji can be used
-- as a hook (🪝, 📌, 🔖, 🏷️, 🚩, ⭐, etc.) - just place the same emoji at
-- the beginning and end of the content you want to extract.
--
-- Example:
-- {{#invoke:TranscludeModuleCode|showSnippet|page=Module:Example|hook=⭐}}
local p = {}
function p.showSnippet(frame)
local pageName = frame.args.page
if not pageName then
return "Error: 'page' parameter is required"
end
local hook = frame.args.hook
-- Fallback to line numbers if hook isn't provided
local fromLine = tonumber(frame.args.from) or 1
local toLine = tonumber(frame.args.to) or fromLine
local titleObj = mw.title.new(pageName)
if not titleObj then
return "Failed to create mw.title object for '" .. pageName .. "'"
end
local content = titleObj:getContent()
if not content then
return "No content for '" .. pageName .. "'"
end
local lines = {}
for line in content:gmatch("[^\r\n]+") do
table.insert(lines, line)
end
local snippet = {}
-- If hook is provided, use it to extract the snippet
if hook then
-- First, check if any line contains multiple instances of the hook
local inlineHookFound = false
for i, line in ipairs(lines) do
-- Find first occurrence of hook in the line
local startPos = line:find(hook, 1, true)
if startPos then
-- Find second occurrence of hook in the same line
local endPos = line:find(hook, startPos + #hook, true)
if endPos then
-- We found a line with multiple hooks - extract content between them
inlineHookFound = true
-- Extract the content between the hooks (excluding the hooks themselves)
local extractedContent = line:sub(startPos + #hook, endPos - 1)
table.insert(snippet, extractedContent)
break
end
end
end
-- If we didn't find inline hooks, look for hooks on different lines
if not inlineHookFound then
local hookPositions = {}
-- Find all instances of the hook
for i, line in ipairs(lines) do
if line:find(hook, 1, true) then
table.insert(hookPositions, i)
end
end
if #hookPositions < 2 then
return "Error: Need at least 2 instances of hook '" .. hook .. "' in '" .. pageName .. "'"
end
-- Extract content between first two hook instances (excluding the hook lines)
local startLine = hookPositions[1]
local endLine = hookPositions[2]
-- Always exclude the hook lines
local startIndex = startLine + 1
local endIndex = endLine - 1
for i = startIndex, endIndex do
table.insert(snippet, lines[i])
end
end
else
-- Fallback to line number-based extraction
for i = fromLine, math.min(toLine, #lines) do
table.insert(snippet, lines[i])
end
end
return table.concat(snippet, "\n")
end
return p