Module:PublicationRecommendedItems: Difference between revisions

From MaRDI portal
rendering the list with mw.html.create()
adding dialogue box thrugh jscript via li linkage
Line 16: Line 16:
     local likeIcon = '👍'
     local likeIcon = '👍'
     local dislikeIcon = '👎'
     local dislikeIcon = '👎'
    -- Current page title
    local pageTitle = mw.title.getCurrentTitle().fullText


     if jsonResults and jsonResults.results and jsonResults.results.bindings then
     if jsonResults and jsonResults.results and jsonResults.results.bindings then
Line 31: Line 34:


                 local modifiedLink = link .. "?source=recommendation&referrer=" .. currentPublicationId
                 local modifiedLink = link .. "?source=recommendation&referrer=" .. currentPublicationId
                 local likeLink = link .. "?source=recommendation&referrer=like"
                local itemEncoded = mw.uri.encode(link)
                 local dislikeLink = link .. "?source=recommendation&referrer=dislike"
 
                -- Updated like/dislike links (stay on same page + Matomo-friendly)
                 local likeLink = pageTitle .. "?referrer=like&item=" .. itemEncoded
                 local dislikeLink = pageTitle .. "?referrer=dislike&item=" .. itemEncoded
 
                -- JavaScript onclick to show dialog then reload
                local jsLike = 'onclick="event.preventDefault(); alert(\'Thank you for your feedback!\'); window.location.href=\'' .. likeLink .. '\';"'
                local jsDislike = 'onclick="event.preventDefault(); alert(\'Thank you for your feedback!\'); window.location.href=\'' .. dislikeLink .. '\';"'


                 -- Build list item using HTML
                 -- Build list item using HTML
                 local li = mw.html.create('li')
                 local li = mw.html.create('li')
                 li:wikitext('[' .. modifiedLink .. ' ' .. name .. '] ')
                 li:wikitext('[' .. modifiedLink .. ' ' .. name .. '] ')
                 li:wikitext('[' .. likeLink .. ' ' .. likeIcon .. '] ')
                 li:tag('a')
                 li:wikitext('[' .. dislikeLink .. ' ' .. dislikeIcon .. ']')
                    :attr('href', likeLink)
                    :attr('style', 'cursor:pointer; margin-left: 8px;')
                    :attr('onclick', jsLike)
                    :wikitext(likeIcon)
                li:wikitext(' ')
                 li:tag('a')
                    :attr('href', dislikeLink)
                    :attr('style', 'cursor:pointer; margin-left: 4px;')
                    :attr('onclick', jsDislike)
                    :wikitext(dislikeIcon)


                 ul:node(li)
                 ul:node(li)
Line 75: Line 94:
ORDER BY ?propertyLabel
ORDER BY ?propertyLabel
]]
]]
   
    -- mw.log( sparqlQuery )
      
      
-- Executing the SPARQL query and retrieving results in JSON format
-- Executing the SPARQL query and retrieving results in JSON format
Line 99: Line 116:
local rawList = p.convertJsonToCommaSeparatedList(jsonResults, target1)
local rawList = p.convertJsonToCommaSeparatedList(jsonResults, target1)
local linkList = mw.getCurrentFrame():preprocess(rawList)
local linkList = mw.getCurrentFrame():preprocess(rawList)
-- mw.log(linkList)


local result = [[
local result = [[
Line 106: Line 122:
<div class="keywords-line"></div>
<div class="keywords-line"></div>
</div>
</div>
<div class="keywords-list"> ]] .. linkList .. [[</div>
<div class="keywords-list">]] .. linkList .. [[</div>
]]
]]


return result
    return result
end
end


-- Return the created html table
-- Return the created html table
return p
return p

Revision as of 12:13, 21 April 2025

Documentation for this module may be created at Module:PublicationRecommendedItems/doc

-- Required module containing helper methods
local helper = require('Module:HelperMethods')

-- Required modules for SPARQL queries and HTML table generation
local sparql = require('SPARQL')
local mwHtml = require('mw.html')

-- Main table to hold all functions
local p = {}

-- Function to convert JSON results into a comma-separated string
function p.convertJsonToCommaSeparatedList(jsonResults, currentPublicationId)
    local ul = mw.html.create('ul')

    -- Like and dislike Icons 
    local likeIcon = '👍'
    local dislikeIcon = '👎'

    -- Current page title
    local pageTitle = mw.title.getCurrentTitle().fullText

    if jsonResults and jsonResults.results and jsonResults.results.bindings then
        local bindings = jsonResults.results.bindings
        for i = 0, #bindings do
            local binding = bindings[i]
            if binding and binding.valueLabel and binding.valueLabel.value then
                local name = binding.valueLabel.value
                if string.find(name, "https://") then
                    name = "Unnamed Item"
                end

                local link = binding.value.value
                link = link:gsub("entity/Q", "wiki/Publication:")

                local modifiedLink = link .. "?source=recommendation&referrer=" .. currentPublicationId
                local itemEncoded = mw.uri.encode(link)

                -- Updated like/dislike links (stay on same page + Matomo-friendly)
                local likeLink = pageTitle .. "?referrer=like&item=" .. itemEncoded
                local dislikeLink = pageTitle .. "?referrer=dislike&item=" .. itemEncoded

                -- JavaScript onclick to show dialog then reload
                local jsLike = 'onclick="event.preventDefault(); alert(\'Thank you for your feedback!\'); window.location.href=\'' .. likeLink .. '\';"'
                local jsDislike = 'onclick="event.preventDefault(); alert(\'Thank you for your feedback!\'); window.location.href=\'' .. dislikeLink .. '\';"'

                -- Build list item using HTML
                local li = mw.html.create('li')
                li:wikitext('[' .. modifiedLink .. ' ' .. name .. '] ')
                li:tag('a')
                    :attr('href', likeLink)
                    :attr('style', 'cursor:pointer; margin-left: 8px;')
                    :attr('onclick', jsLike)
                    :wikitext(likeIcon)
                li:wikitext(' ')
                li:tag('a')
                    :attr('href', dislikeLink)
                    :attr('style', 'cursor:pointer; margin-left: 4px;')
                    :attr('onclick', jsDislike)
                    :wikitext(dislikeIcon)

                ul:node(li)
            end
        end
    end

    return tostring(ul)
end

-- Function to build the list
function p.getCitesWorkList(frame)
	
    -- Retrieve target1 from frame arguments or return error message if not set
	local target1 = frame.args[1]
    if not target1 or target1 == '' then
        return "No records found"
    end    
    
    -- Constructing the SPARQL query with dynamic entity target1
    local sparqlQuery = [[
PREFIX target: <https://portal.mardi4nfdi.de/entity/]] .. target1 .. [[>
PREFIX wdt: <https://portal.mardi4nfdi.de/prop/direct/>
PREFIX wd: <https://portal.mardi4nfdi.de/entity/>

SELECT ?property ?propertyLabel ?value ?valueLabel
WHERE {
    target: wdt:P1643 ?value .
    OPTIONAL {
        ?value rdfs:label ?valueLabel .
        FILTER(LANG(?valueLabel) = "en")
    }
    BIND(wdt:P1643 AS ?property)
    SERVICE wikibase:label { bd:serviceParam wikibase:language "[AUTO_LANGUAGE],en". }
}
ORDER BY ?propertyLabel
]]
    
	-- Executing the SPARQL query and retrieving results in JSON format
	local jsonResults = sparql.runQuery(sparqlQuery)
	
	mw.logObject(jsonResults)

	-- Handle error in SPARQL query execution
	if jsonResults and jsonResults.error then
    	mw.log("Error in SPARQL query: " .. tostring(jsonResults.error))
    	return nil
	end

	if not jsonResults then
        return nil
	end
	
	if helper.countElementsInBindings(jsonResults.results.bindings) == 0 then
        return nil
	end

	local rawList = p.convertJsonToCommaSeparatedList(jsonResults, target1)
	local linkList = mw.getCurrentFrame():preprocess(rawList)

	local result = [[
<div class="keywords-header">
<span class="keywords-title">Recommendations</span>
<div class="keywords-line"></div>
</div>
<div class="keywords-list">]] .. linkList .. [[</div>
]]

	return result
end

-- Return the created html table
return p