Moduł:Dokumentacja

[ podgląd | edytuj | historia | odśwież ]DokumentacjaPrzejdź do kodu ↴

Używana w {{Dokumentacja}} i {{Dokumentacja/Nagłówek}}

Zależności

• Moduł:ProcessArgs

[ podgląd | edytuj | historia | odśwież ]Powyższy opis jest dołączany ze strony Moduł:Dokumentacja/opis.

local p = {}

local defaultDocPage = 'opis'

local getType = function( namespace, page )
	local pageType = 'template'
	if namespace == 'Moduł' or namespace == 'Module' 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 getTypeForms = function( pageType )
	if pageType == 'module' then
		return {gen = 'tym module', acc = 'tego modułu', pronoun_gen = "его", nomP = 'Moduły'}
	elseif pageType == 'widget' then
		return {gen = 'tym widżecie', acc = 'tego widżetu', pronoun_gen = "его", nomP = 'Widżety'}
	elseif pageType == 'stylesheet' then
		return {gen = 'tym arkuszu stylów', acc = 'tego arkusza stylów', pronoun_gen = "еro", nomP = 'Arkusze stylów'}
	elseif pageType == 'script' then
		return {gen = 'tym skrypcie', acc = 'tego skryptu', pronoun_gen = "его", nomP = 'Skrypty'}
	elseif pageType == 'message' then
		return {gen = 'tej wiadomości systemowej', acc = 'tej wiadomości systemowej', pronoun_gen = "его", nomP = 'Wiadomości'}
	else -- type == 'template'
		return {gen = 'tym szablonie', acc = 'tego szablonu', pronoun_gen = "его", nomP = 'Szablony'}
	end
end

-- Creating a documentation page or transclution through {{subst:doc}}
function p.create( f )
	local args = require( 'Moduł:ProcessArgs' ).norm()
	local page = mw.title.getCurrentTitle()
	local docPage = args['strona'] or page.nsText .. ':' .. page.baseText .. '/' .. defaultDocPage
	
	local out
	if not args["treść"] and tostring( page ) == docPage then
		out = f:preprocess( '{{subst:Szablon:Dokumentacja/preload}}' )
	else
		local templateArgs = {}
		for _, key in ipairs{ 'typ', 'strona', 'treść' } do
			local val = args[key]
			if val then
				if key == 'treść' then val = '\n' .. val .. '\n' end
				table.insert( templateArgs, key .. '=' .. val )
			end
		end
	
		out = '{{Dokumentacja|' .. table.concat( templateArgs, '|' ) .. '}}'
		out = out:gsub( '|}}', '}}' )
		
		if not args["treść"] then
			out = out .. '\n<!-- Kategorie i interwiki umieść na stronie dokumentacji.  -->'
		end
	end
	
	if not mw.isSubsting() then
		out = f:preprocess( out )
		if not args['niekat'] then
			out = out .. '[[Kategoria:Pages with templates requiring substitution]'
		end
	end
	
	return out
end

-- Header2 on the documentation page
function p.docPage( f )
	local args = require( 'Moduł:ProcessArgs' ).merge( true )
	local badDoc = args['zladok']
	local forceNoDoc = args['brakdok']
	
	local docclass = "documentation-norm"
	if badDoc then
		docclass = "documentation-bad"
	elseif forceNoDoc then
		docclass = "documentation-no"
	end
	if forceNoDoc then
		f:callParserFunction( '#dplvar:set', '$doc forced_none', '1' )
	end
	
	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['typ'] or getType( namespace, page ) )
	local typeForms = getTypeForms( pageType )

	local body = mw.html.create( 'div' ):addClass( 'documentation-header' )
	body
		:css{
			['margin-bottom'] = '0.8em',
			padding = '0.8em 1em 0.7em',
		}
		:tag( 'div' )
			:css( 'float', 'right' )
			:wikitext( '[[', page:fullUrl( 'action=purge' ), ' ' .. f:preprocess('{{lc:{{int:purge}}}}') .. ']]' )
		:done()
		:wikitext(
			'To jest strona dokumentacji, ',
			pageType == 'module' and 'będzie ona dołączona' or 'powinna ona być dołączona',
			' na stronie głównej. ',
			'Aby uzyskać więcej informacji sprawdź [[Szablon:Dokumentacja]].'
		)
	if badDoc then
		body:wikitext( "<br>'''Dokumentacja " .. typeForms.gen .. " wymaga uzupełnienia lub ulepszenia.'''" )
	elseif forceNoDoc then
		body:wikitext( "<br>'''W " .. typeForms.gen .. " nie ma dokumentacji. Jeśli wiesz jak używać " .. typeForms.acc .. ", udokumentuj to.'''" )
	end

	if not ( args["niekat"] or namespace == 'Użytkownik' or namespace == 'Użytkowniczka' ) then
		body:wikitext( '[[Kategoria:Szablony dokumentacji]]' )
	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 (s:gsub( '^[\t\r\n\f ]+', '' ):gsub( '[\t\r\n\f ]+$', '' ))
	end
	local args = require( 'Moduł:ProcessArgs' ).merge( true )
	local page = mw.title.getCurrentTitle()
	local namespace = page.nsText
	local docText = trim( args["treść"] or '' )
	if docText == '' then docText = nil end
	
	local docPage
	local noDoc
	local forceNoDoc
	if docText then
		docPage = page
	else
		docPage = mw.title.new( args["strona"] or namespace .. ':' .. page.text .. '/' .. defaultDocPage)
		noDoc = args["brakdok"] or not docPage.exists
	end
	local badDoc = args["zladok"]
	local pageType = mw.ustring.lower( args['typ'] or getType( namespace, page ) )
	local typeForms = getTypeForms( 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
		forceNoDoc = f:callParserFunction( '#dplvar', '$doc forced_none' ) == '1'
		
		if docText == '' and not forceNoDoc then
			docText = nil
			noDoc = 1
		end
	end
	if docText then
		docText = '\n' .. docText .. '\n'
	end
	
	local action = f:preprocess('{{lc:{{int:edit}}}}')
	local preload = ''
	local docclass = "documentation-norm"
	local message
	local category
	if noDoc then
		action = f:preprocess('{{lc:{{int:create}}}}')
		preload = '&preload=Szablon:Dokumentacja/preload'
		docclass = "documentation-no"
		message = "'''W " .. typeForms.gen .. " nie ma dokumentacji. " ..
			"Jeśli wiesz jak używać  " .. typeForms.acc .. ", proszę, podaj odpowiednie informacje.'''"
		if not ( args["niekat"] or namespace == 'Użytkownik' or namespace == 'Użytkowniczka' ) then
			category = typeForms.nomP .. ' bez dokumentacji'
			if not mw.title.new( 'Kategoria:' .. category ).exists then
				category = 'Strony bez dokumentacji'
			end
		end
	elseif forceNoDoc then
		docclass = "documentation-no"
		message = "'''W " .. typeForms.gen .. " nie ma dokumentacji. " ..
			"Jeśli wiesz jak używać  " .. typeForms.acc .. ", proszę, podaj odpowiednie informacje.'''"
		if not ( args["niekat"] or namespace == 'Użytkownik' or namespace == 'Użytkowniczka' ) then
			category = typeForms.nomP .. ' bez dokumentacji'
			if not mw.title.new( 'Kategoria:' .. category ).exists then
				category = 'Strony bez dokumentacji'
			end
		end
	elseif badDoc then
		docclass = "documentation-bad"
		message = "'''Dokumentacja " .. typeForms.gen .. " wymaga uzupełnienia lub ulepszenia.'''\n"
		if not ( args["niekat"] or namespace == 'Użytkownik' or namespace == 'Użytkowniczka' ) then
			category = typeForms.nomP .. ' ze złą dokumentacją'
			if not mw.title.new( 'Kategoria:' .. category ).exists then
				category = 'Strony ze złą dokumentacją'
			end
		end
	end
	
	local historyLink =	f:preprocess('{{lc:{{int:history short}}}}')
	local purgeLink =	f:preprocess('{{lc:{{int:purge}}}}')
	local viewLink =	f:preprocess('{{lc:{{int:view}}}}')

	local links = {
		'[' .. docPage:fullUrl( 'action=edit' .. preload ) .. ' ' .. action .. ']',
		'[' .. docPage:fullUrl( 'action=history' ) .. ' ' .. historyLink .. ']',
		'[' .. page:fullUrl( 'action=purge' ) .. ' ' .. purgeLink .. ']'
	}
	if not noDoc and page ~= docPage then
		table.insert( links, 1, '[[' .. docPage.fullText .. '|' .. viewLink .. ']]' )
	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 ' .. docclass )
	body:css{
		padding = '0.8em 1em 0.7em',
		['margin-top'] = '1em',
		clear = 'both'
	}
	
	local header = mw.html.create( 'div' )
		:addClass( 'documentation-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( 'Dokumentacja' )
	
	if not noDoc and pageType ~= 'template' and pageType ~= 'message' then
		header
			:tag( 'span' )
				:css( 'white-space', 'nowrap' )
				:wikitext( '[[#the-code|Przejdź do kodu ↴]]' )
	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( 'Powyższy opis jest dołączany ze strony  [[' .. docPage.fullText .. ']].' )
	end
	
	if category then
		body:wikitext( "[[Kategoria:" .. 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