Modul:SoftwareDoku

---

--[=[ SoftwareDoku 2022-10-14
Module for software documentation templates
Author: Vollbracht

template functions
* functionDoc(frame)	standard description of a function
]=]

--Module globals
local p = {}

local _, Parser = pcall(require, "Modul:SimpleStruct")

local tcDef = {
	td = '<td style="text-align:left; vertical-align:top; padding:0.2em;">',
	th = '<th style="text-align:left; vertical-align:top; padding:0.2em;">'
}

--[[
	functionDoc(frame)
	standard description of a function
	parameters:
		frame.args.name			name of function
		frame.args.short		short description
		frame.args.parameters	parsable parameters list for en table header
		frame.args.Parameter	parsable parameters list for de table header
		frame.args.returns		wikitext return description for en table header
		frame.args.Rueckgabe	wikitext return description for de table header
		frame.args.example		code for en intro
		frame.args.Beispiel		code for de intro
]]
p.functionDoc = function(frame)
	if not frame.args.name then return '' end
	if not frame.args.short then return '' end
	local result =	'<h2>' .. frame.args.name .. '</h2><p>' .. frame.args.short
				..	'</p><table style="width:100%;"><tr>'
				..	'<th colspan="3" style="text-align:left;">'
	local pars = frame.args.parameters
	if pars then
		result = result .. 'parameters:</th></tr><tr>'
	else
		pars = frame.args.Parameter
		if pars then
			result = result .. 'Parameter:</th></tr><tr>'
		else return '' end
	end
	if pars == 'none' then
		result = result .. '<td></td><td colspan="2">no parameters</td></tr>'
	else
		local pList = Parser.altParse(pars)
		result = result .. '<td rowspan="' .. #pList .. '"></td>'
		local pRows = {}
		for _, v in ipairs(pList) do
			table.insert(pRows,
				tcDef.th .. v[1] .. '</th><td>' .. v[2] .. '</td>')
		end
		result =	result .. table.concat(pRows, '</tr><tr>')
				..	'</tr><tr>' .. tcDef.th
	end
	local ret = frame.args.returns
	if ret then
		result = result .. 'returns'
	else
		ret = frame.args.Rueckgabe
		if ret then
			result = result .. 'Rückgabewert'
		else return '' end
	end
	result = result .. ':</th><td colspan="2">' .. ret .. '</td></tr></table>'
	local ex = frame.args.example
	if ex then
		mw.log('example: ' .. ex)
		ex = frame:preprocess('<pre>' .. ex .. '</pre>')
		result = result .. '<h4>Example</h4>' .. pre
	else
		ex = frame.args.Beispliel
		if ex then
			ex = frame:preprocess('<pre>' .. ex .. '</pre>')
			result = result .. '<h4>Example</h4>' .. pre
		end
	end
	return result
end

--[[
	moduleName()
	name of module based on site name
]]
p.moduleName = function(frame)
	local siteName = mw.title.getCurrentTitle()
	local full = siteName:match('Modul:%.*')
	if not full then
		full = siteName:match('Modul/%.*')
	end
	if full then
		full = full:sub(8)
		local subNP = full:find('/')
		if subNP then return full:sub(1, subNP) end
		return full
	end
end

return p