Você pode seguir a nossa conta no Twitter onde são publicadas notícias sobre Minecraft e links rápidos para a Wiki

Módulo:Documentation

De Minecraft Wiki
Ir para: navegação, pesquisa

Este módulo implementa {{Documentação}}.

Dependências[editar código-fonte]

[ver | editar | histórico | purgar]A documentação acima é transcluída de Módulo:Documentation/doc.
local p = {}
local defaultDocPage = 'doc'

local getType = function( namespace, page )
	local pageType = 'predefinição'
	if namespace == 'Módulo' then
		pageType = 'módulo'
	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 = 'mensagem'
	end
	
	return pageType
end

-- Creating a documentation page or transclution through {{subst:doc}}
function p.create( f )
	local args = require( 'Módulo: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:Predefinição:Documentação/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 = '{{documentação|' .. table.concat( templateArgs, '|' ) .. '}}'
		out = out:gsub( '|}}', '}}' )
		
		if not args.content then
			out = out .. '\n<!-- Coloque categorias/interwiki na página de documentação -->'
		end
	end
	
	if not mw.isSubsting() then
		out = f:preprocess( out )
		if not args.nocat then
			out = out .. '[[Categoria:Páginas com predefinições que requerem substituição]]'
		end
	end
	
	return out
end

-- Header on the documentation page
function p.docPage( f )
	local args = require( 'Módulo:ProcessArgs' ).merge( true )
	local badDoc = args.baddoc
    local trad = args.translation
	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 body = mw.html.create( 'div' ):addClass( 'documentation-header' )
	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' ), ' purgar]]' )
		:done()
		:wikitext(
			'Esta é a página de documentação, ela ',
			pageType == 'módulo' and 'irá' or 'deverá',
			' ser transcluída na página principal ',
			pageType == 'predefinição' and 'da ' or (pageType == 'mensagem' and 'da ' or 'do ' ),
			pageType, '. ',
			'Veja [[Predefinição:Documentação]] para mais informações.'
		)
	if badDoc then
		body:wikitext( "<br>'''Esta documentação de " .. pageType .. " precisa melhorar ou de informações adicionais.'''" )
    elseif trad then
		body:wikitext( "<br>'''Esta documentação de " .. pageType .. " precisa ser [[Ajuda:Tradução|traduzida]].'''" )
	end
	if not ( args.nocat or namespace == 'Usuário' ) then
		body:wikitext( '[[Categoria:Páginas de documentação]]' )
	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( 'Módulo: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 trad = args.translation
	local pageType = mw.ustring.lower( args.type or getType( namespace, page ) )
	
	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 = 'editar'
	local preload = ''
	local classes = ''
	local message
	local category
	if noDoc then
		action = 'criar'
		preload = '&preload=Predefinição:Documentação/preload'
		classes = 'documentation-nodoc'
		message = "'''" .. (pageType == "predefinição" and "Esta " or (pageType == "mensagem" and "Esta " or "Este " )) .. pageType .. " não tem documentação. " ..
			"Se você souber como usar " .. (pageType == "predefinição" and "esta " or (pageType == "mensagem" and "esta " or "este " )) .. pageType .. ", por favor crie.'''"
		if not ( args.nocat or namespace == 'Usuário' ) then
			category = pageType .. ' sem documentação'
			if not mw.title.new( 'Categoria:' .. category ).exists then
				category = 'Páginas sem documentação'
			end
		end
	elseif badDoc then
		classes = 'documentation-baddoc'
		message = "'''Esta documentação de " .. pageType .. " precisa melhorar ou de informações adicionais.'''\n"
		if not ( args.nocat or namespace == 'Usuário' ) then
			category = pageType .. ' com má documentação'
			if not mw.title.new( 'Categoria:' .. category ).exists then
				category = 'Páginas com má documentação'
			end
		end
    elseif trad then
		classes = 'documentation-trad'
		message = "'''Esta documentação de " .. pageType .. " precisa ser [[Ajuda: Tradução|traduzida]]'''\n"
		if not ( args.nocat or namespace == 'Usuário' ) then
			category = pageType .. ' com má documentação'
			if not mw.title.new( 'Categoria:' .. category ).exists then
				category = 'Páginas para traduzir'
			end
		end
	end
	
	local links = {
		'[' .. docPage:fullUrl( 'action=edit' .. preload ) .. ' ' .. action .. ']',
		'[' .. docPage:fullUrl( 'action=history' ) .. ' histórico]',
		'[' .. page:fullUrl( 'action=purge' ) .. ' purgar]'
	}
	if not noDoc and page ~= docPage then
		table.insert( links, 1, '[[' .. docPage.fullText .. '|ver]]' )
	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' ):addClass( 'documentation' )
	body:css{
		padding = '0.8em 1em 0.7em',
		['margin-top'] = '1em',
		clear = 'both'
	}

    :attr( 'class', 'documentation ' .. classes )
	
	local header = mw.html.create( 'div' )
		: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( 'Documentação' )
	
	if not noDoc and pageType ~= 'predefinição' and pageType ~= 'mensagem' then
		header
			:tag( 'span' )
				:css( 'white-space', 'nowrap' )
				:wikitext( '[[#the-code|Ir para o código ↴]]' )
	end
	
	body
		:node( header ):done()
		:wikitext( message )
		:wikitext( docText )
	
	if not noDoc and page ~= docPage then
		body
			:tag( 'div' )
				:css{
					margin = '0.7em -1em -0.7em',
					['border-top'] = 'inherit',
					padding = '0.8em 1em 0.7em',
					clear = 'both'
				}
				:node( links )
				:wikitext( 'A documentação acima é transcluída de [[', docPage.fullText, ']].' )
	end
	
	if category then
		body:wikitext( f:expandTemplate{ title = 'Categoria de tradução', args = { category, project = '0' } } )
	end
	
	local anchor = ''
	if not noDoc and pageType ~= 'predefinição' and pageType ~= 'mensagem' then
		anchor = mw.html.create( 'div' ):attr( 'id', 'the-code' )
	end
	
	return tostring( body ) .. tostring( anchor )
end

return p