Skip to content

Commit

Permalink
add oops report to gh-pages-new
Browse files Browse the repository at this point in the history
  • Loading branch information
@MattTJung
MattTJung committed Mar 13, 2024
1 parent 55547b0 commit 7dd3d4d
Show file tree
Hide file tree
Showing 3 changed files with 375 additions and 1 deletion.
211 changes: 211 additions & 0 deletions .github/workflows/oops_report/show_oops_response.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,211 @@
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!--<meta http-equiv="X-UA-Compatible" content="ie=edge">-->
<title>XML-Jquery</title>
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-rbsA2VBKQhggwzxH7pPCaAqO46MgnOM80zW1RWuH61DGLwZJEdK2Kadq2F9CUG65" crossorigin="anonymous">

<!-- ****************************************************************************************
! connect your main.js script to hmtl *
! add version of jquery *
! *************************************************************************************** -->
<script type="text/javascript" src="//code.jquery.com/jquery-1.11.3.min.js"></script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js" integrity="sha384-kenU1KFdBIe4zVF0s0G1M5b4hcpxyD9F7jL+jjXkk+Q2h455rYXK/7HAuoJl+0I4" crossorigin="anonymous"></script>

<!-- javascript reference -->
<script type="text/javascript" src="./show_oops_response.js"></script>
<style>
.bg-important {
background-color: #ff8000 !important;
}
.badge-float {
float: right;
}
span.float {
float: right;
margin-right: 1em;
}
h2 {
margin-top: 1rem;
}
p.indent {
margin-left: 2em;
}
</style>
</head>

<body>
<div class="container">
<div>
<h1 id="headerTitle">OOPS! Results</h1>
</div>

<div>
<h2>Pitfalls</h2>
<div id="pitfalls" class="accordion"></div>
</div>

<div>
<h2>Suggestions</h2>
<div id="suggestions" class="accordion"></div>
</div>

<div>
<h2>Conformance badge</h2>
<p>According to the highest importance level of pitfall found in your ontology the conformace bagde suggested is "<span id="conformanceBadgeText">Pitfall free</span>".</p>
<img id="conformanceBadgeImage" src="https://oops.linkeddata.es/images/conformance/oops_free.png" alt="No pitfalls were found" height="69">
</div>

<div>
<h2>References</h2>
<div class="accordion" id="References">
<div class="accordion-item">
<h2 class="accordion-header" id="panelsStayOpen-headingR1">
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#panelsStayOpen-collapseR1" aria-expanded="false" aria-controls="panelsStayOpen-collapseR1">
[1] Aguado-De Cea, G., Montiel-Ponsoda, E., Poveda-Villalón, M., and Giraldo-Pasmin, O.X. (2015).</button>
</h2>
<div id="panelsStayOpen-collapseR1" class="accordion-collapse collapse" aria-labelledby="panelsStayOpen-headingR1">
<div class="accordion-body">
Lexicalizing Ontologies: The issues behind the labels. In Multimodal communication in the 21st century: Professional and academic challenges. 33rd Conference of the Spanish Association of Applied Linguistics (AESLA), XXXIII AESLA.
</div>
</div>
</div>
<div class="accordion-item">
<h2 class="accordion-header" id="panelsStayOpen-headingR2">
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#panelsStayOpen-collapseR2" aria-expanded="false" aria-controls="panelsStayOpen-collapseR2">
[2] Noy, N. F., McGuinness, D. L., et al. (2001).</button>
</h2>
<div id="panelsStayOpen-collapseR2" class="accordion-collapse collapse" aria-labelledby="panelsStayOpen-headingR2">
<div class="accordion-body">
Ontology development 101: A guide to creating your first ontology.
</div>
</div>
</div>
<div class="accordion-item">
<h2 class="accordion-header" id="panelsStayOpen-headingR3">
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#panelsStayOpen-collapseR3" aria-expanded="false" aria-controls="panelsStayOpen-collapseR3">
[3] Gómez-Pérez, A. (1999).</button>
</h2>
<div id="panelsStayOpen-collapseR3" class="accordion-collapse collapse" aria-labelledby="panelsStayOpen-headingR3">
<div class="accordion-body">
Evaluation of Taxonomic Knowledge in Ontologies and Knowledge Bases. Proceedings of the Banff Knowledge Acquisition for Knowledge-Based Systems Workshop. Alberta, Canada.
</div>
</div>
</div>
<div class="accordion-item">
<h2 class="accordion-header" id="panelsStayOpen-headingR4">
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#panelsStayOpen-collapseR4" aria-expanded="false" aria-controls="panelsStayOpen-collapseR4">
[4] Montiel-Ponsoda, E., Vila Suero, D., Villazón-Terrazas, B., Dunsire, G., Escolano Rodríguez, E., Gómez-Pérez, A. (2011).</button>
</h2>
<div id="panelsStayOpen-collapseR4" class="accordion-collapse collapse" aria-labelledby="panelsStayOpen-headingR4">
<div class="accordion-body">
Style guidelines for naming and labeling ontologies in the multilingual web.
</div>
</div>
</div>
<div class="accordion-item">
<h2 class="accordion-header" id="panelsStayOpen-headingR5">
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#panelsStayOpen-collapseR5" aria-expanded="false" aria-controls="panelsStayOpen-collapseR5">
[5] Vrandecic, D. (2010).</button>
</h2>
<div id="panelsStayOpen-collapseR5" class="accordion-collapse collapse" aria-labelledby="panelsStayOpen-headingR5">
<div class="accordion-body">
Ontology Evaluation. PhD thesis.
</div>
</div>
</div>
<div class="accordion-item">
<h2 class="accordion-header" id="panelsStayOpen-headingR6">
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#panelsStayOpen-collapseR6" aria-expanded="false" aria-controls="panelsStayOpen-collapseR6">
[6] Gómez-Pérez, A. (2004). </button>
</h2>
<div id="panelsStayOpen-collapseR6" class="accordion-collapse collapse" aria-labelledby="panelsStayOpen-headingR6">
<div class="accordion-body">
Ontology evaluation. In Handbook on ontologies, pages 251-273. Springer.
</div>
</div>
</div>
<div class="accordion-item">
<h2 class="accordion-header" id="panelsStayOpen-headingR7">
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#panelsStayOpen-collapseR7" aria-expanded="false" aria-controls="panelsStayOpen-collapseR7">
[7] Rector, A., Drummond, N., Horridge, M., Rogers, J., Knublauch, H., Stevens, R., Wang, H., and Wroe, C. (2004). </button>
</h2>
<div id="panelsStayOpen-collapseR7" class="accordion-collapse collapse" aria-labelledby="panelsStayOpen-headingR7">
<div class="accordion-body">
Owl pizzas: Practical experience of teaching owl-dl: Common errors &amp; common patterns. In Engineering Knowledge in the Age of the Semantic Web, pages 63-81. Springer.
</div>
</div>
</div>
<div class="accordion-item">
<h2 class="accordion-header" id="panelsStayOpen-headingR8">
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#panelsStayOpen-collapseR8" aria-expanded="false" aria-controls="panelsStayOpen-collapseR8">
[8] Hogan, A., Harth, A., Passant, A., Decker, S., and Polleres, A. (2010).</button>
</h2>
<div id="panelsStayOpen-collapseR8" class="accordion-collapse collapse" aria-labelledby="panelsStayOpen-headingR8">
<div class="accordion-body">
Weaving the pedantic web. In Proceedings of the WWW2010 Workshop on Linked Data on the Web, LDOW 2010, Raleigh, USA, April 27, 2010.
</div>
</div>
</div>
<div class="accordion-item">
<h2 class="accordion-header" id="panelsStayOpen-headingR9">
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#panelsStayOpen-collapseR9" aria-expanded="false" aria-controls="panelsStayOpen-collapseR9">
[9] Archer, P., Goedertier, S., and Loutas, N. (2012).</button>
</h2>
<div id="panelsStayOpen-collapseR9" class="accordion-collapse collapse" aria-labelledby="panelsStayOpen-headingR9">
<div class="accordion-body">
D7. 1.3-study on persistent URIs, with identification of best practices and recommendations on the topic for the Mss and the EC. PwC EU Services.
</div>
</div>
</div>
<div class="accordion-item">
<h2 class="accordion-header" id="panelsStayOpen-headingR10">
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#panelsStayOpen-collapseR10" aria-expanded="false" aria-controls="panelsStayOpen-collapseR10">
[10] Bernes-Lee Tim. (2006).</button>
</h2>
<div id="panelsStayOpen-collapseR10" class="accordion-collapse collapse" aria-labelledby="panelsStayOpen-headingR10">
<div class="accordion-body">
“Linked Data - Design issues”. http://www.w3.org/DesignIssues/LinkedData.html
</div>
</div>
</div>
<div class="accordion-item">
<h2 class="accordion-header" id="panelsStayOpen-headingR11">
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#panelsStayOpen-collapseR11" aria-expanded="false" aria-controls="panelsStayOpen-collapseR11">
[11] Heath, T. and Bizer, C. (2011).</button>
</h2>
<div id="panelsStayOpen-collapseR11" class="accordion-collapse collapse" aria-labelledby="panelsStayOpen-headingR11">
<div class="accordion-body">
Linked Data: Evolving the Web into a Global Data Space. Morgan &amp; Claypool, 1st edition.
</div>
</div>
</div>
<div class="accordion-item">
<h2 class="accordion-header" id="panelsStayOpen-headingR12">
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#panelsStayOpen-collapseR12" aria-expanded="false" aria-controls="panelsStayOpen-collapseR12">
[12] Vatant, B. (2012).</button>
</h2>
<div id="panelsStayOpen-collapseR12" class="accordion-collapse collapse" aria-labelledby="panelsStayOpen-headingR12">
<div class="accordion-body">
Is your linked data vocabulary 5-star?. http://bvatant.blogspot.fr/2012/02/is-your-linked-data-vocabulary-5-star_9588.html
</div>
</div>
</div>
</div>
</div>

<div>
<h2>Notice</h2>
<div>
<p>This evaluation uses the OOPS! OntOlogy Pitfall Scanner! by the Ontology Engineering Group of the Computer Science School at Universidad Politécnica de Madrid (UPM)</p>
<p class="indent">Poveda-Villalón, María; Gómez-Pérez, Asunción; and Suárez-Figueroa, Mari Carmen. "OOPS!(Ontology Pitfall Scanner!): An on-line tool for ontology evaluation." International Journal on Semantic Web and Information Systems (IJSWIS) 10.2 (2014): 7-34.</p>
</div>
</div>
</div>
</body>

</html>
143 changes: 143 additions & 0 deletions .github/workflows/oops_report/show_oops_response.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
$(document).ready(function () {

$("#headerTitle").hide(300).show(1500);
// calling show food menu function
showFoodMenu();

// If you want to fetch data from the file
// call fetch data function instead of showFoodMenu
// fetchData()
});

function fetchData() {
setTimeout(function () {
showFoodMenu();
// recursive call
fetchData();
}, 3000);
}

function showFoodMenu() {
$.ajax({
url: "./oops_response.xml",
type: "GET",
datatype: "xml",

error: function (e) {
alert("An error occured while processing XML file.");
console.log("XML reading failed: ", e);
},

success: function (response) {
$("#pitfalls").children().remove();

var _highest_importance_num = 0;

$(response).find("oops\\:Pitfall").each(function () {
var _code = $(this).find("oops\\:Code").text();
console.log(_code)

var _name = 'Name: ' + $(this).find("oops\\:Name").text();
var _description = $(this).find("oops\\:Description").text();
var _importance = $(this).find("oops\\:Importance").text();
var _numberAffectedElements = $(this).find("oops\\:NumberAffectedElements").text();
var _textAffectedElements;
if (_numberAffectedElements == '') {
_textAffectedElements = 'Ontology';
}
else {
_textAffectedElements = _numberAffectedElements + ' cases';
}
var _importance_spanclass;
if (_importance == 'Minor') {
_importance_spanclass = 'bg-warning';
_highest_importance_num = Math.max(_highest_importance_num, 1);
}
else if (_importance == 'Important') {
_importance_spanclass = 'bg-important';
_highest_importance_num = Math.max(_highest_importance_num, 2);
}
else if (_importance == 'Critical') {
_importance_spanclass = 'bg-danger';
_highest_importance_num = Math.max(_highest_importance_num, 3);

}
var _affected = '';

$(this).find("oops\\:AffectedElement").each(function () {
if (_affected == '') {
_affected = '<div><b>Affected Elements:</b><ul>';
}
_affected = _affected + "<li>" + $(this).text() + "</li>";
})
_affected = _affected + "</ul></div>";

var _div = "<div class=\"accordion-item\">" +
"<h3 class=\"accordion-header\" id=\"heading" + _code + "\">" +
" <button class=\"accordion-button\" style=\"display: inline;\" type=\"button\" data-bs-toggle=\"collapse\" data-bs-target=\"#collapse" + _code + "\" aria-expanded=\"true\" aria-controls=\"collapse" + _code + "\">" +
" " + _code + " - " + _name + "<span class=\"badge badge-float " + _importance_spanclass + "\">" + _importance + "</span><span class=\"float\">" + _textAffectedElements + "</span>" +
" </button>" +
"</h3>" +
"<div id=\"collapse" + _code + "\" class=\"accordion-collapse collapse show\" aria-labelledby=\"heading" + _code + "\" data-bs-parent=\"#accordionExample\">" +
" <div class=\"accordion-body\">" +
" " + _description + "<br /></p>" + _affected +
" </div>" +
"</div>" +
"</div>"

$("#pitfalls").append(_div);
});

var _suggestioncount = 0;
$(response).find("oops\\:Suggestion").each(function () {
_suggestioncount++;
var _name = $(this).find("oops\\:Name").text();
var _description = $(this).find("oops\\:Description").text();
var _affected = '';
$(this).find("oops\\:AffectedElement").each(function () {
if (_affected == '') {
_affected = '<div><b>Affected Elements:</b><ul>';
}
_affected = _affected + "<li>" + $(this).text() + "</li>";
})
_affected = _affected + "</ul></div>";
var _div = "<div class=\"accordion-item\">" +
"<h3 class=\"accordion-header\" id=\"heading" + _suggestioncount + "\">" +
" <button class=\"accordion-button\" style=\"display: inline;\" type=\"button\" data-bs-toggle=\"collapse\" data-bs-target=\"#collapse" + _suggestioncount + "\" aria-expanded=\"true\" aria-controls=\"collapse" + _suggestioncount + "\">" +
" " + _name +
" </button>" +
"</h3>" +
"<div id=\"collapse" + _suggestioncount + "\" class=\"accordion-collapse collapse show\" aria-labelledby=\"heading" + _suggestioncount + "\" data-bs-parent=\"#accordionExample\">" +
" <div class=\"accordion-body\">" +
" " + _description + "<br /></p>" + _affected +
" </div>" +
"</div>" +
"</div>"

$("#suggestions").append(_div);
});

// set conformance badge
if (_highest_importance_num == 0) {
$("#conformanceBadgeText").text("Pitfall free");
$("#conformanceBadgeImage").attr("src","https://oops.linkeddata.es/images/conformance/oops_free.png");
$("#conformanceBadgeImage").attr("alt", "No pitfalls were found");
}
else if (_highest_importance_num == 1) {
$("#conformanceBadgeText").text("Minor pitfalls");
$("#conformanceBadgeImage").attr("src","https://oops.linkeddata.es/images/conformance/oops_minor.png");
$("#conformanceBadgeImage").attr("alt", "Minor pitfalls were found");
}
else if (_highest_importance_num == 2) {
$("#conformanceBadgeText").text("Important pitfalls");
$("#conformanceBadgeImage").attr("src","https://oops.linkeddata.es/images/conformance/oops_important.png");
$("#conformanceBadgeImage").attr("alt", "Important pitfalls were found");
}
else {
$("#conformanceBadgeText").text("Critical pitfalls");
$("#conformanceBadgeImage").attr("src","https://oops.linkeddata.es/images/conformance/oops_critical.png");
$("#conformanceBadgeImage").attr("alt", "Critical pitfalls were found");
}
}
});
}
Loading

0 comments on commit 7dd3d4d

Please sign in to comment.