Module:ServicesList: Difference between revisions
From MaRDI portal
No edit summary |
No edit summary |
||
(53 intermediate revisions by the same user not shown) | |||
Line 9: | Line 9: | ||
local p = {} | local p = {} | ||
function p.convertJsonToHTMLCards(jsonResults) | function p.convertJsonToHTMLCards(jsonResults, landingpage) | ||
local resultsHTML = "" | |||
-- check whether we need to display landing page specific parts | |||
local isLandingPage = (landingpage == "true") | |||
local resultsHTML = [[ | |||
<div style="display: grid; grid-template-columns: repeat(auto-fit, minmax(600px, 1fr)); gap: 20px; padding: 10px;"> | |||
]] | |||
if jsonResults and jsonResults.results and jsonResults.results.bindings then | if jsonResults and jsonResults.results and jsonResults.results.bindings then | ||
local bindings = jsonResults.results.bindings | local bindings = jsonResults.results.bindings | ||
Line 19: | Line 26: | ||
-- Extract fields from the bindings | -- Extract fields from the bindings | ||
local name = binding.name and binding.name.value or "Unnamed Service" | local name = binding.name and binding.name.value or "Unnamed Service" | ||
local category = binding. | local category = binding.categories and binding.categories.value or "No Category" | ||
local maintainer = binding.maintainer and binding.maintainer.value or "Unknown maintainer" | local maintainer = binding.maintainer and binding.maintainer.value or "Unknown maintainer" | ||
local maintainer_url = binding.maintainer_url and binding.maintainer_url.value or " " | local maintainer_url = binding.maintainer_url and binding.maintainer_url.value or " " | ||
Line 25: | Line 32: | ||
local status = binding.status and binding.status.value or "No status available." | local status = binding.status and binding.status.value or "No status available." | ||
local link = binding.item and binding.item.value:gsub("entity/Q", "wiki/Service:") or "#" | local link = binding.item and binding.item.value:gsub("entity/Q", "wiki/Service:") or "#" | ||
local imageName = binding.icon and binding.icon.value or " | local imageName = binding.icon and binding.icon.value or "File:nologo.jpg" -- Default placeholder image | ||
-- Extract only the "File:..." portion from the URL | -- Extract only the "File:..." portion from the URL | ||
imageName = imageName:match("File:.*") or imageName | imageName = imageName:match("File:.*") or imageName | ||
local image = "[[" .. imageName .. "|200px|left|link=]]" | local image = "[[" .. imageName .. "|200px|left|link=]]" | ||
-- Create the teaser variable, ensuring it only takes the first 60 characters from description | |||
local teaser = string.sub(description, 1, 120) | |||
if #description > 60 then | |||
teaser = teaser .. "..." | |||
end | |||
-- Build individual card HTML | -- Build individual card HTML | ||
resultsHTML = resultsHTML .. string.format([[ | resultsHTML = resultsHTML .. string.format([[ | ||
<table style="border: | <div style="border: 1px solid #ddd; border-radius: 5px; margin: 10px 0; padding: 15px; background-color: #fff; box-shadow: 0 2px 5px rgba(0, 0, 0, 0.1);"> | ||
<table style="border-collapse: collapse; width: 100%%; margin: 10px 0;"> | |||
<tr> | |||
<!-- Left column for the image --> | |||
<td style="width: 200px; vertical-align: top; padding-right: 10px; padding-top: 18px;"> | |||
%s | |||
</td> | |||
<!-- Right column for the text --> | |||
<td style="vertical-align: top;"> | |||
]], image) | |||
-- Add title link and service status and maintainer info - if not landing-page | |||
if not isLandingPage then | |||
resultsHTML = resultsHTML .. string.format([[ | |||
<h3 style="font-weight: bold; margin: 0;">[%s %s]</h3> | |||
<div style="font-weight: bold; margin: 2px 0 0 0;">%s (%s)</div> | |||
<p style="margin: 10px 0;">%s</p> | |||
<div style="font-size: 12px; color: #888;">Maintained by: [%s %s]</div> | |||
]], link, name, category, status, description, maintainer_url, maintainer) | |||
end | |||
-- Add title and category and teaser-description - if landing-page | |||
if isLandingPage then | |||
resultsHTML = resultsHTML .. string.format([[ | |||
<h3 style="font-weight: bold; margin: 0;">%s</h3> | |||
<div style="font-weight: bold; margin: 2px 0 0 0;">%s</div> | |||
<p style="margin: 10px 0;">%s</p> | |||
]], name, category, teaser) | |||
end | |||
-- Add button "discover more" on landing page | |||
if isLandingPage then | |||
resultsHTML = resultsHTML .. string.format([[ | |||
<div style="margin-top: 15px; text-align: right;"><span style="display: inline-block; padding: 10px 20px; background-color: #D0662B; color: white; text-decoration: none; font-weight: bold; border-radius: 5px;">[%s <span style="color: white;">Discover more</span>]</span></div> | |||
]], link) | |||
end | |||
-- Close the table and container | |||
resultsHTML = resultsHTML .. [[ | |||
</td> | |||
</tr> | |||
</table> | |||
</div> | |||
]] | |||
end | end | ||
end | end | ||
-- Close the grid container | |||
resultsHTML = resultsHTML .. "</div>" | |||
return resultsHTML | return resultsHTML | ||
Line 56: | Line 100: | ||
-- Function to build the list | -- Function to build the list | ||
function p.buildServiceList(frame) | function p.buildServiceList(frame) | ||
local landingpage = frame.args["landingpage"] or "false" | |||
-- Constructing the SPARQL query with dynamic entity target1 | -- Constructing the SPARQL query with dynamic entity target1 | ||
Line 62: | Line 108: | ||
PREFIX wd: <https://portal.mardi4nfdi.de/entity/> | PREFIX wd: <https://portal.mardi4nfdi.de/entity/> | ||
SELECT ?item ?name ?maintainer ?maintainer_url ?icon ?category ?description ?status | SELECT ?item ?name ?maintainer ?maintainer_url ?icon | ||
(GROUP_CONCAT(DISTINCT ?category; SEPARATOR=" | ") AS ?categories) | |||
?description ?status | |||
WHERE { | WHERE { | ||
?item wdt:P1460 wd:Q6503324 . | ?item wdt:P1460 wd:Q6503324 . | ||
Line 76: | Line 124: | ||
FILTER(LANG(?status) = "en") } | FILTER(LANG(?status) = "en") } | ||
} | } | ||
GROUP BY ?item ?name ?maintainer ?maintainer_url ?icon ?description ?status | |||
]] | ]] | ||
Line 99: | Line 148: | ||
end | end | ||
local serviceList = p.convertJsonToHTMLCards(jsonResults) | local serviceList = p.convertJsonToHTMLCards(jsonResults, landingpage) | ||
return serviceList | return serviceList |
Latest revision as of 13:56, 22 January 2025
Documentation for this module may be created at Module:ServicesList/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 p.convertJsonToHTMLCards(jsonResults, landingpage)
-- check whether we need to display landing page specific parts
local isLandingPage = (landingpage == "true")
local resultsHTML = [[
<div style="display: grid; grid-template-columns: repeat(auto-fit, minmax(600px, 1fr)); gap: 20px; padding: 10px;">
]]
if jsonResults and jsonResults.results and jsonResults.results.bindings then
local bindings = jsonResults.results.bindings
for i = 0, #bindings do
local binding = bindings[i]
-- Extract fields from the bindings
local name = binding.name and binding.name.value or "Unnamed Service"
local category = binding.categories and binding.categories.value or "No Category"
local maintainer = binding.maintainer and binding.maintainer.value or "Unknown maintainer"
local maintainer_url = binding.maintainer_url and binding.maintainer_url.value or " "
local description = binding.description and binding.description.value or "No description available."
local status = binding.status and binding.status.value or "No status available."
local link = binding.item and binding.item.value:gsub("entity/Q", "wiki/Service:") or "#"
local imageName = binding.icon and binding.icon.value or "File:nologo.jpg" -- Default placeholder image
-- Extract only the "File:..." portion from the URL
imageName = imageName:match("File:.*") or imageName
local image = "[[" .. imageName .. "|200px|left|link=]]"
-- Create the teaser variable, ensuring it only takes the first 60 characters from description
local teaser = string.sub(description, 1, 120)
if #description > 60 then
teaser = teaser .. "..."
end
-- Build individual card HTML
resultsHTML = resultsHTML .. string.format([[
<div style="border: 1px solid #ddd; border-radius: 5px; margin: 10px 0; padding: 15px; background-color: #fff; box-shadow: 0 2px 5px rgba(0, 0, 0, 0.1);">
<table style="border-collapse: collapse; width: 100%%; margin: 10px 0;">
<tr>
<!-- Left column for the image -->
<td style="width: 200px; vertical-align: top; padding-right: 10px; padding-top: 18px;">
%s
</td>
<!-- Right column for the text -->
<td style="vertical-align: top;">
]], image)
-- Add title link and service status and maintainer info - if not landing-page
if not isLandingPage then
resultsHTML = resultsHTML .. string.format([[
<h3 style="font-weight: bold; margin: 0;">[%s %s]</h3>
<div style="font-weight: bold; margin: 2px 0 0 0;">%s (%s)</div>
<p style="margin: 10px 0;">%s</p>
<div style="font-size: 12px; color: #888;">Maintained by: [%s %s]</div>
]], link, name, category, status, description, maintainer_url, maintainer)
end
-- Add title and category and teaser-description - if landing-page
if isLandingPage then
resultsHTML = resultsHTML .. string.format([[
<h3 style="font-weight: bold; margin: 0;">%s</h3>
<div style="font-weight: bold; margin: 2px 0 0 0;">%s</div>
<p style="margin: 10px 0;">%s</p>
]], name, category, teaser)
end
-- Add button "discover more" on landing page
if isLandingPage then
resultsHTML = resultsHTML .. string.format([[
<div style="margin-top: 15px; text-align: right;"><span style="display: inline-block; padding: 10px 20px; background-color: #D0662B; color: white; text-decoration: none; font-weight: bold; border-radius: 5px;">[%s <span style="color: white;">Discover more</span>]</span></div>
]], link)
end
-- Close the table and container
resultsHTML = resultsHTML .. [[
</td>
</tr>
</table>
</div>
]]
end
end
-- Close the grid container
resultsHTML = resultsHTML .. "</div>"
return resultsHTML
end
-- Function to build the list
function p.buildServiceList(frame)
local landingpage = frame.args["landingpage"] or "false"
-- Constructing the SPARQL query with dynamic entity target1
local sparqlQuery = [[
PREFIX wdt: <https://portal.mardi4nfdi.de/prop/direct/>
PREFIX wd: <https://portal.mardi4nfdi.de/entity/>
SELECT ?item ?name ?maintainer ?maintainer_url ?icon
(GROUP_CONCAT(DISTINCT ?category; SEPARATOR=" | ") AS ?categories)
?description ?status
WHERE {
?item wdt:P1460 wd:Q6503324 .
?item rdfs:label ?name .
OPTIONAL { ?item wdt:P19 ?maintainer_url .
?maintainer_url rdfs:label ?maintainer . }
OPTIONAL { ?item wdt:P1641 ?category_url .
?category_url rdfs:label ?category . }
OPTIONAL { ?item wdt:P1640 ?icon . }
OPTIONAL { ?item wdt:P1459 ?description . }
OPTIONAL { ?item wdt:P230 ?status_url .
?status_url rdfs:label ?status .
FILTER(LANG(?status) = "en") }
}
GROUP BY ?item ?name ?maintainer ?maintainer_url ?icon ?description ?status
]]
-- mw.log( sparqlQuery )
-- 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 "Could not fetch data."
end
if helper.countElementsInBindings(jsonResults.results.bindings) == 0 then
return "No records found."
end
local serviceList = p.convertJsonToHTMLCards(jsonResults, landingpage)
return serviceList
end
-- Return the created html table
return p