Module:Documentation

local p = {} -- Creating a documentation page or transclution through function p.create( f ) local args = require( 'Module:ProcessArgs' ).norm page = mw.title.getCurrentTitle namespace = args.type or page.nsText docPage = args.page or namespace .. ':' .. page.baseText .. '/doc' local out if page.fullText == docPage then out = f:preprocess( '' ) else local templateArgs = {} if args.type then table.insert( templateArgs, 'type=' .. args.type ) end if args.page then table.insert( templateArgs, 'page=' .. args.page ) end out = '\n' out = out:gsub( '|}}', '}}' ) end if not mw.isSubsting then out = f:preprocess( out ) if not args.nocat then out = out .. ''		end end return out end

-- Header on the documentation page function p.docPage( f ) local args = require( 'Module:ProcessArgs' ).merge( true ) local badDoc = args.baddoc if f:callParserFunction( '#dplvar:noheader' ) == '1' then if badDoc then f:callParserFunction( '#dplvar:set', 'baddoc', '1' ) end return '' end local page = mw.title.getCurrentTitle local namespace = args.type or page.nsText local pageType = 'template' if namespace == 'Module' then pageType = 'module' elseif page.fullText:find( '.css$' ) then pageType = 'stylesheet' elseif page.fullText:find( '.js$' ) then pageType = 'script' elseif namespace == 'MediaWiki' then pageType = 'message' end local colour = 'EAF4F9' local message = '' if badDoc then colour = 'F9F2EA' message = "'''This " .. pageType .. "'s documentation needs improving or additional information.'''" end local certainty = 'should' if pageType == 'module' then certainty = 'will' end local category = '' if not args.nocat then category = '' end local out = table.concat( {		'',		' ' .. page:fullUrl( 'action=purge' ) .. ' purge ',			'This is the documentation page, it ' .. certainty .. ' be transcluded into the main ' .. pageType .. ' page. See Template:Documentation for more information. ',			message,		' ',		category	}, '\n' ) return mw.text.trim( out ) end

-- Wrapper around the documentation on the main page function p.page( f ) local args = require( 'Module:ProcessArgs' ).merge( true ) local page = mw.title.getCurrentTitle local namespace = args.type or page.nsText local docPage = mw.title.new( args.page or namespace .. ':' .. page.text .. '/doc' ) local noDoc = args.nodoc or not docPage.exists local badDoc = args.baddoc local pageType = 'template' if namespace == 'Module' then pageType = 'module' elseif page.fullText:find( '.css$' ) then pageType = 'stylesheet' elseif page.fullText:find( '.js$' ) then pageType = 'script' elseif namespace == 'MediaWiki' then pageType = 'message' end local docText = '' if not noDoc then f:callParserFunction( '#dplvar:set', 'noheader', '1' ) docText = mw.text.trim( f:expandTemplate{ title = ':' .. docPage.fullText } ) if f:callParserFunction( '#dplvar:baddoc' ) == '1' then badDoc = 1 end if docText == '' then noDoc = 1 else docText = '\n' .. docText .. '\n' end end local action = 'edit' local preload = '' local colour = 'EAF4F9' local message = '' local category = '' if noDoc then action = 'create' preload = '&preload=Template:Documentation/preload' colour = 'F9EAEA' message = "'''This " .. pageType .. " has no documentation. If you know how to use this " .. pageType .. ", please create it.'''" if not args.nocat then if mw.title.new( 'Category:' .. pageType .. 's with no documentation' ).exists then category = '' else category = '' end end elseif badDoc then colour = 'F9F2EA' message = "'''This " .. pageType .. "'s documentation needs improving or additional information.'''\n" if not args.nocat then if mw.title.new( 'Category:' .. pageType .. 's with bad documentation' ).exists then category = '' else category = '' end end end local links = { '[' .. docPage:fullUrl( 'action=edit' .. preload ) .. ' ' .. action .. ']',		'[' .. page:fullUrl( 'action=purge' ) .. ' purge]' }	local footer = '' if not noDoc then table.insert( links, 1, 'view' ) footer = table.concat( {			'\n',				' ' .. mw.text.nowiki( '[' ) .. table.concat( links, ' | ' ) .. '] \n',				'The above documentation is transcluded from ' .. docPage.fullText .. '. \n',			' \n'		} ) end local out = { '\n', '\n', ' ' .. mw.text.nowiki( '[' ) .. table.concat( links, ' | ' ) .. '] \n', ' Documentation ', ' \n', message, docText, footer, ' \n', category }	return mw.text.trim( table.concat( out ) ) end return p