Modulo:FunzioniGeneriche

Da WikiTrek.
Jump to navigation Jump to search

Il modulo FunzioniGeneriche contiene la definizione di funzioni utili per tutta la wiki in generale

Funzioni

EsempioTemplate

serve per inserire nella pagina di un template sia il codice che il rendering di un esempio catturato da una sottopagina.

Information icon4.svg
Avviso di trasclusione da /man
Il testo riportato qui sopra è la documentazione del modulo e non ne fa parte, ma è trascluso da Il modulo vero e proprio inizia qui sotto.

-- Keyword: wikitrek
local p = {} --p stands for package

function p.EsempioTemplate(frame)
    local SubPageName
    local SubPageTitle
    local Title
    local Content
    local pre = mw.html.create('pre')
    local DoubleLF = string.char(10) .. string.char(10)

    if not frame.args[1] then
        SubPageName='Esempio'
    else
        SubPageName=frame.args[1]
    end

    Title =  mw.title.getCurrentTitle()
    SubPageTitle = mw.title.makeTitle(Title.namespace, Title.text .. '/' .. SubPageName)

    local Intro = 'Questo esempio è automaticamente generato tramite script LUA a partire dal codice di esempio presente in <code>[[' .. SubPageTitle.prefixedText .. ']]</code>'
    local CodeString = '=== Il codice ==='
    local ReturnString = '=== restituisce ==='

	Content = SubPageTitle:getContent()
	
	if not Content then
		return "La pagina <code>[[" .. SubPageTitle.prefixedText .. "]]</code> non esiste: non è possibile estrarre il testo e generare l'esempio"
	else
		pre
			:css( 'width', '65%' )
			:wikitext(mw.text.nowiki(Content))
    	return  Intro .. DoubleLF .. CodeString .. DoubleLF .. tostring(pre) .. DoubleLF  .. ReturnString .. DoubleLF .. frame:expandTemplate{ title = SubPageTitle }
    end
end
function p.EsempioBreve(frame)
	--<code><nowiki>{{DTItem|Q11}}</nowiki></code> → {{DTItem|Q11}}
	local ExampleText
	
	if frame.args[1] == nil then
        Return "Error"
    else
        ExampleText=frame.args[1]
    end

	return "<code><nowiki>" .. mw.text.nowiki(ExampleText) .. "</nowiki></code> → " .. frame:expandTemplate{ title = ExampleText }
end
function p.TableFromArray(AllRows)
	local Table = mw.html.create('table')
	local First
	local Tr
	local Cell
	
	for _, Row in pairs(AllRows) do
		Tr = mw.html.create('tr')
		First = true
		for _, Field in pairs(Row) do
			if First then
				First = false
				Cell = mw.html.create('th')
				if (type(Field) == "table") then
					Cell
						:attr('id', Field[1])
						:attr('title', Field[1])
						:wikitext(Field[2]..":")
				else
					Cell
						:wikitext(Field)
				end
			else
				Cell = mw.html.create('td')
				if #Field > 1 then
					List = mw.html.create('ul')
					for _, Item in pairs(Field) do
						LI = mw.html.create('li')
						LI:wikitext(Item)
						List:node(LI)
					end
					Cell:node(List)
				else
					Cell
						:wikitext(Field[1])
				end
			end
			
			Tr:node(Cell)
		end
		Table:node(Tr)
	end
	
	--[==[if mw.wikibase.getEntity() then
		Text = "Modifica i dati nella [[:datatrek:Item:" .. mw.wikibase.getEntityIdForCurrentPage() .. "|pagina della entità]] su ''DataTrek''"
	else
		Text = "Impossibile trovare l'entità collegata"
	end
	
	Table
	   :css('font-size', 'smaller')
       :css('text-align', 'right')
       :css('margin', '1px')
       ]==]
    --return tostring(Table)
    return Table
end
	
function p.NoWiki(frame)
    return mw.text.nowiki(frame.args[1])
end
--- Returns the color to use in CSS for the text depending on the luminance
-- of the background
-- @param BackColor The hex code of the background color
-- @return name of the color
function p.TextColor(frame)
	local hex = string.sub(frame.args[1], 2)
	local R, G, B
	local L
	
    if hex:len() == 3 then
      --return (tonumber("0x"..hex:sub(1,1))*17)/255, (tonumber("0x"..hex:sub(2,2))*17)/255, (tonumber("0x"..hex:sub(3,3))*17)/255
      R = tonumber("0x"..hex:sub(1,1))*17/255
      G = tonumber("0x"..hex:sub(2,2))*17/255
      B = tonumber("0x"..hex:sub(3,3))*17/255
    else
    	R = tonumber("0x"..hex:sub(1,2))/255
    	G = tonumber("0x"..hex:sub(3,4))/255
    	B = tonumber("0x"..hex:sub(5,6))/255
    end
    
    L = (R * 0.299 + G * 0.587 + B * 0.114) --/ 256
    if L < 0.6 then --0.5 then
    	return "white"
    else
    	return "black"
    end
		
end
--- Test function for array manipulation
-- 
-- @param frame The interface to the parameters passed to {{#invoke:}}
-- @return Processed string
function p.TestArray(frame)
	local TestGroups = {"A", "B", "C", "B", "C"}
	local TestValues = {"Alpha", "Beta"}
	local FinalArray = {}
	local FinalString = ""
	
	for _, Group in pairs(TestGroups) do
		for _, Value in pairs(TestValues) do
			if FinalArray[Group] == nil then
				FinalArray[Group] = {}
			end
			
			table.insert(FinalArray[Group], Value)
		end
	end
	
	for ID, Group in pairs(FinalArray) do
		FinalString = FinalString .. "* " .. ID .. ": " .. table.concat(Group, ", ") .. string.char(10)
	end
	
	--return FinalArray["A"][1]
	return FinalString
end
function p.TestArray2(frame)
	local FinalArray = {}
	local FinalString = ""
	--local Actor = "Annie Wersching"
	local Actor = "Emily Coutts"
	local QueryResult = mw.smw.getQueryResult('[[Interprete::' .. Actor .. ']]|?' .. Actor .. '|sort=Numero di produzione|order=asc')
	
	if QueryResult == nil then
        return "''Nessun risultato''"
    end

    if type(QueryResult) == "table" then
    	for k, v in pairs(QueryResult.results) do
        	-- v.fulltext						represents EPISODE
        	-- v.printouts[Actor][1].fulltext	represents CHARACTER
        	local Episode = v.fulltext
        	local Character
        	
        	if v.printouts[Actor][1] == nil then
        		Character = "''Senza pagina''"
        	else
        		--[==[
        		Character = v.printouts[Actor][1].fulltext
        		if FinalArray[Character] == nil then
        			FinalArray[Character] = {}
        		end
				table.insert(FinalArray[Character], Episode)
				]==]
				for _, CurrChar in pairs(v.printouts[Actor]) do
					Character = CurrChar.fulltext
					if FinalArray[Character] == nil then
						FinalArray[Character] = {}
					end
    				table.insert(FinalArray[Character], Episode)
				end
        	end
        	
    	end
    else
    	return "''Il risultato non è una TABLE''"
    end
	
	for ID, Group in pairs(FinalArray) do
		FinalString = FinalString .. "* [[" .. ID .. "]]: [[" .. table.concat(Group, "]], [[") .. "]]" .. string.char(10)
	end
	
	return FinalString
end
--- Test function for spaces identifiaction
-- using regex
-- @param frame The interface to the parameters passed to {{#invoke:}}
-- @return Processed string
function p.TestSpaces(frame)
	local TestString = "Seven of Nine"
	local Match = string.match(TestString, "[^%s]+$")
	return Match .. " - " .. string.upper(string.sub(Match, 1, 1))
end
--- Extract the name of a ship from its full designation
--
-- @param frame The interface to the parameters passed to {{#invoke:}}
-- @return Bare name of the ship
function p.ShipName(frame)
	local FullName = frame.args[1]
	
	return p.ShipNameCore(FullName)
end
--- Extract the name of a ship from its full designation
--
-- @param designation The full designation to process
-- @return Bare name of the ship
function p.ShipNameCore(designation)
	local FullName = designation
	local Prefixes = {"USS ", "IKS ", "ECS ", "''", "<i>", "</i>", " %(reboot%)", " %(Kelvin Timeline%)"}
	
	-- Removes prefix
	for _, Prefix in ipairs(Prefixes) do
		FullName = FullName:gsub((Prefix), "")
	end
	
	--Removes suffix
	FullName = FullName:gsub("%s[^%s]+$", "")
	
	return FullName
end
--- Test function to check properties sorting
-- 
-- @param frame The interface to the parameters passed to {{#invoke:}}
-- @return Comma-separated list of properties
function p.SortedPropertiesList(frame)
	local AllP
	Item = mw.wikibase.getEntity('Q11160')
	AllP = mw.wikibase.orderProperties(Item:getProperties())
	
	return table.concat(AllP, ",")
end
--- Process the value assigned to parameter of the "old"-style template
-- (pre-DataTrek) to sanitize it and pass it as clean value to
-- SMW property using the #set function
--
-- @param frame The interface to the parameters passed to {{#invoke:}}
-- No return @return Sanitized string representing one or more property values
function p.ParameterToSemantic(frame)
	local Separator = ";"
	local SepDeclaration = "|+sep=" .. Separator
	local ParaString
	local FinalArray = {}
	local PropName
	local PropValue
	local LIPattern
	
	if frame.args[1] == nil then
        PropName = "Error"
    else
        PropName = frame.args[1]
        if frame.args[2] == nil then
        	PropValue = "Error"
        else
        	ParaString = frame.args[2]
        	if string.find(ParaString, "<li>") == nil then
        		-- Add dummy tags to use a single process afterwards
        		ParaString = "<li>" .. ParaString .. "</li>"
        	end
        	
        	-- Determine if property is Assignment
    		if PropName == "Assegnazione" then
    			-- Look for <i> to get the object of assignment
    			LIPattern = "<li>.-<i>%[%[(.-)%]%]</i>.-</li>"
    		else
    			LIPattern = "<li>.-%[%[(.-)%]%].-</li>"
    		end
				
    		--Process UL or OL
    		for Item in string.gmatch(ParaString, LIPattern) do
    			Item = string.gsub(Item, "(|.*)", "")
    			table.insert(FinalArray, Item)
    		end
    		PropValue = table.concat(FinalArray, Separator) .. SepDeclaration
        end
    end
	mw.smw.set(PropName .. " = " .. PropValue)
end
--- OLD simpler original version
-- Process the value assigned to "EpisodioPersonaggi" of the "old-style"
-- template (pre-DataTrek) to sanitize it and pass it as clean value to
-- SMW property using the #set function
--
-- @param frame The interface to the parameters passed to {{#invoke:}}
-- No return @return Sanitized string representing one or more property values
function p.PerformersToSemanticOriginal(frame)
	local InputString
	local Character
	local Performer
	local Pattern = "%*.-%[%[(.-)%]%].-:%s?%[%[(.-)%]%]"

	--InputString = "* [[Vina]]: [[Melissa George]]* [[Spock]]: [[Ethan Peck]]* [[Leland]]: [[Alan van Sprang]]* [[Nhan]]: [[Rachael Ancheril]]* Un [[Talosiani|Talosiano]]: [[Dee Pelletier]]* Il ''Keeper'' [[Talosiani|Talosiano]]: [[Rob Brownstein]]* Lt. Cmdr. [[Airiam]]: [[Hannah Cheesman]]* Lt. [[Keyla Detmer]]: [[Emily Coutts]]* [[Talosiani|Talosiano]] n.3: [[Nicole Dickinson]]"
	InputString = frame.args[1]
	
	--_, _, Character, Performer = string.find(InputString, Pattern)
	
	for Character, Performer in string.gmatch(InputString, Pattern) do  
		Character = string.gsub(Character, "|.*","")
		--print("Character: " .. Character, "Performer: " .. Performer)
		mw.smw.set("Personaggio=" .. Character)
		mw.smw.set("Interprete=" .. Performer)
		mw.smw.set(Performer .. " = " .. Character)
	end
end
--- NEW improved version 
-- Process the values assigned to "EpisodioPersonaggi" parameter of the
-- "old-style" template (pre-DataTrek) to sanitize it and pass it
-- as clean value to SMW property using the #set function
--
-- @param frame The interface to the parameters passed to {{#invoke:}}
-- No return @return Sanitized string representing one or more property values
function p.PerformersToSemantic(frame)
	local InputString
	local Pattern

	InputString = frame.args[1] .. "\n"
	
	for FullRow in string.gmatch(InputString, "%*.-\n") do
		local Character
		local Performer
		--print (FullRow)
		local CountLiks = select(2, string.gsub(FullRow, "%[%[", ""))
		--print (CountLiks)
		if string.find(FullRow, ":") == nil then
			--Character only, unknown performer
			Pattern = "%*.-%[%[(.-)%]%].-"
			_, _, Character = string.find(FullRow, Pattern)
			Performer = "Interprete non accreditato"
		else
			if CountLiks == 2 then
				--Two links in the string, process both
				--print("Two links")
				Pattern = "%*.-%[%[(.-)%]%].-:%s?%[%[(.-)%]%]"      
			elseif CountLiks == 1 then
				--Character is not a linked entity
				--print("One link")
				Pattern = "%*%s?(.-)%s?:%s?%[%[(.-)%]%]"
			else
				--error no links on either side
	    		Pattern = "%*%s?(.-)%s?:%s?(.-)%s?\n"
			end
			_, _, Character, Performer = string.find(FullRow, Pattern)
		end
		Character = string.gsub(Character, "|.*","")
		--print("          Character: " .. Character, "Performer: " .. Performer)
		--print(string.rep("-",100))
		mw.smw.set("Personaggio=" .. Character)
		mw.smw.set("Interprete=" .. Performer)
		mw.smw.set(Performer .. " = " .. Character)
	end
end
function p.ParameterToSemanticTest(frame)
	local Separator = ";"
	local SepDeclaration = "|+sep=" .. Separator
	local TestString = "<ul><li>[[Michael Perricone]]</li><li>[[Greg Elliot]]</li></ul>"
	local FinalArray = {}
	
	for Item in string.gmatch(TestString, "<li>(.-)</li>") do
		table.insert(FinalArray, Item)
	end
	return mw.text.nowiki(table.concat(FinalArray, Separator) .. SepDeclaration)
end
return p