Module:Documentation

[查看 | 编辑 | 历史 | 清除缓存]文档页面跳转至代码 ↴

该模块用于实现{{Documentation}}。

依赖项

• Module:ProcessArgs

语言

• English
• español
• 日本語
• 한국어
• polski
• русский

[查看 | 编辑 | 历史 | 清除缓存]上述文档是从Module:Documentation/doc引用的。

local p = {}
local defaultDocPage = 'doc'

local getType = function( namespace, page )
	local pageType = 'template'
	if namespace == '模块' then
		pageType = 'module'
	elseif namespace == 'Widget' then
		pageType = 'widget'
	elseif page.fullText:gsub( '/' .. defaultDocPage .. '$', '' ):find( '%.css$' ) then
		pageType = 'stylesheet'
	elseif page.fullText:gsub( '/' .. defaultDocPage .. '$', '' ):find( '%.js$' ) then
		pageType = 'script'
	elseif namespace == 'MediaWiki' then
		pageType = 'message'
	end
	
	return pageType
end

local getTypeDisplay = function( pageType )
	local pageTypeDisplay = '模板'
	if pageType == 'module' then
		pageTypeDisplay = '模块'
	elseif pageType == 'widget' then
		pageTypeDisplay = '小工具'
	elseif pageType == 'stylesheet' then
		pageTypeDisplay = '样式表'
	elseif pageType == 'script' then
		pageTypeDisplay = '脚本'
	elseif pageType == 'message' then
		pageTypeDisplay = '界面信息'
	end
	
	return pageTypeDisplay
end

-- Creating a documentation page or transclution through {{subst:doc}}
function p.create( f )
	local args = require( 'Module:ProcessArgs' ).norm()
	local page = mw.title.getCurrentTitle()
	local docPage = args.page or page.nsText .. ':' .. page.baseText .. '/' .. defaultDocPage
	
	local out
	if not args.content and tostring( page ) == docPage then
		out = f:preprocess( '{{subst:Template:Documentation/preload}}' )
	else
		local templateArgs = {}
		for _, key in ipairs{ 'type', 'page', 'content' } do
			local val = args[key]
			if val then
				if key == 'content' then val = '\n' .. val .. '\n' end
				table.insert( templateArgs, key .. '=' .. val )
			end
		end
		
		out = '{{documentation|' .. table.concat( templateArgs, '|' ) .. '}}'
		out = out:gsub( '|}}', '}}' )
		
		if not args.content then
			out = out .. '\n<!-- 请将分类/语言链接放在文档页面 -->'
		end
		out = '<noinclude>'..out..'</noinclude>'
	end
	
	if not mw.isSubsting() then
		out = f:preprocess( out )
		if not args.nocat then
			out = out .. '[[Category:需要替换模板的页面]]'
		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', '$doc noheader' ) == '1' then
		if badDoc then
			f:callParserFunction( '#dplvar:set', '$doc bad', '1' )
		end
		return
	end
	
	local page = mw.title.getCurrentTitle()
	local namespace = page.nsText
	local pageType = mw.ustring.lower( args.type or getType( namespace, page ) )
	local pageTypeDisplay = getTypeDisplay( pageType )
	
	local body = mw.html.create( 'div' )
	body
		:css{
			['margin-bottom'] = '0.8em',
			padding = '0.8em 1em 0.7em',
		}
		:attr( 'class', 'documentation-header documentation-docpage' .. ( badDoc and ' documentation-baddoc' or '' ) )
		:tag( 'div' )
			:css( 'float', 'right' )
			:wikitext( '[[', page:fullUrl( 'action=purge' ), ' 清除缓存]]' )
		:done()
		:wikitext(
			'这是文档页面，它',
			pageType == 'module' and '将' or '应该',
			'被放置到[[', namespace, ':',page.baseText,
			']]，查看[[Template:Documentation]]以获取更多信息。'
		)
	if badDoc then
		body:wikitext( "<br>'''此", pageTypeDisplay, "的文档页面需要改进或添加附加的信息。'''" )
	end
	if not ( args.nocat or namespace == 'User' ) then
		body:wikitext( '[[Category:文档页面]]' )
	end
	
	return body
end

-- Wrapper around the documentation on the main page
function p.page( f )
	-- mw.text.trim uses mw.ustring.gsub, which silently fails on large strings
	local function trim( s )
		return string.gsub( s, '^[\t\r\n\f ]*(.-)[\t\r\n\f ]*$', '%1' )
	end
	local args = require( 'Module:ProcessArgs' ).merge( true )
	local page = mw.title.getCurrentTitle()
	local namespace = page.nsText
	local docText = trim( args.content or '' )
	if docText == '' then docText = nil end
	
	local docPage
	local noDoc
	if docText then
		docPage = page
	else
		docPage = mw.title.new( args.page or namespace .. ':' .. page.text .. '/' .. defaultDocPage )
		noDoc = args.nodoc or not docPage.exists
	end
	local badDoc = args.baddoc
	local pageType = mw.ustring.lower( args.type or getType( namespace, page ) )
	local pageTypeDisplay = getTypeDisplay( pageType )
	
	if not docText and not noDoc then
		f:callParserFunction( '#dplvar:set', '$doc noheader', '1' )
		docText = trim( f:expandTemplate{ title = ':' .. docPage.fullText }  )
		if f:callParserFunction( '#dplvar', '$doc bad' ) == '1' then
			badDoc = 1
		end
		
		if docText == '' then
			docText = nil
			noDoc = 1
		end
	end
	if docText then
		docText = '\n' .. docText .. '\n'
	end
	
	local action = '编辑'
	local preload = ''
	local classes = ''
	local message
	local category
	if noDoc then
		action = '创建'
		preload = '&preload=Template:Documentation/preload'
		classes = ' documentation-nodoc'
		message = "'''此" .. pageTypeDisplay .. "没有文档页面。" ..
			"如果你知道如何使用" .. pageTypeDisplay .. "，请创建它。'''"
		if not ( args.nocat or namespace == 'User' ) then
			category = '没有文档的' .. pageTypeDisplay
			if not mw.title.new( 'Category:' .. category ).exists then
				category = '没有文档的页面'
			end
		end
	elseif badDoc then
		classes = ' documentation-baddoc'
		message = "'''此" .. pageTypeDisplay .. "的文档页面需要改进或添加附加信息。'''\n"
		if not ( args.nocat or namespace == 'User' ) then
			category = '文档质量较低的' .. pageTypeDisplay
			if not mw.title.new( 'Category:' .. category ).exists then
				category = '文档质量较低的页面'
			end
		end
	end
	
	local links = {
		'[' .. docPage:fullUrl( 'action=edit' .. preload ) .. ' ' .. action .. ']',
		'[' .. docPage:fullUrl( 'action=history' ) .. ' 历史]',
		'[' .. page:fullUrl( 'action=purge' ) .. ' 清除缓存]'
	}
	if not noDoc and page ~= docPage then
		table.insert( links, 1, '[[' .. docPage.fullText .. '|查看]]' )
	end
	links = mw.html.create( 'span' )
		:css( 'float', 'right' )
		:wikitext( mw.text.nowiki( '[' ), table.concat( links, ' | ' ), mw.text.nowiki( ']' ) )
	
	local body = mw.html.create( 'div' )
	body:css{
		padding = '0.8em 1em 0.7em',
		['margin-top'] = '1em'
	}
	:attr( 'class', 'documentation' .. classes )
	
	local header = mw.html.create( 'div' ):addClass( 'documentation-header' )
	header:css{
			margin = '-0.8em -1em 0.8em',
			padding = '0.8em 1em 0.7em',
			['border-bottom'] = 'inherit'
		}
	
	header
		:node( links )
		:tag( 'span' )
			:css{
				['font-weight'] = 'bold',
				['font-size'] = '130%',
				['margin-right'] = '1em',
				['line-height'] = '1'
			}
			:wikitext( '文档页面' )
	
	if not noDoc and pageType ~= 'template' and pageType ~= 'message' then
		header
			:tag( 'span' )
				:css( 'white-space', 'nowrap' )
				:wikitext( '[[#the-code|跳转至代码 ↴]]' )
	end
	
	body
		:node( header ):done()
		:wikitext( message )
		:wikitext( docText )
	
	if not noDoc and page ~= docPage then
		body
			:tag( 'div' )
				:addClass( 'documentation-footer' )
				:css{
					margin = '0.7em -1em -0.7em',
					['border-top'] = 'inherit',
					padding = '0.8em 1em 0.7em',
					clear = 'both'
				}
				:node( links )
				:wikitext( '上述文档是从[[', docPage.fullText, ']]引用的。' )
	end
	
	if category then
		body:wikitext( '[[Category:', category, ']]' )
	end
	
	local anchor = ''
	if not noDoc and pageType ~= 'template' and pageType ~= 'message' then
		anchor = mw.html.create( 'div' ):attr( 'id', 'the-code' )
	end
	
	return tostring( body ) .. tostring( anchor )
end

return p