Upload the new website (GitHub Pages)

acmsigsoft · May 11, 2021 · 3462acf · 3462acf
1 parent 289b945
commit 3462acf
Show file tree

Hide file tree

Showing 20 changed files with 411 additions and 216 deletions.
diff --git a/_config.yml b/_config.yml
@@ -0,0 +1,14 @@
+theme: minima
+markdown: kramdown
+title: Empirical Standards
+description: Empirical standards for conducting and evaluating research in software engineering
+menu_pages:
+  - tab_01_about.md
+  - tab_02_tools.md
+  - tab_03_standards.md
+  - tab_04_supplements.md
+  - tab_05_faq.md
+  - tab_06_people.md
+collections:
+  team:
+    output: true
diff --git a/_team/Paul.md b/_team/Paul.md
@@ -0,0 +1,6 @@
+---
+name: Paul Ralph
+title: Professor
+affiliation: Dalhousie University
+---
+Paul has worked on designing the standards and the website.
diff --git a/_team/Taher.md b/_team/Taher.md
@@ -0,0 +1,6 @@
+---
+name: Taher Ghaleb
+title: Ph.D. Candidate
+affiliation: Queen's University
+---
+Taher has worked on developing this website.
diff --git a/docs/GeneralStandard.md b/docs/GeneralStandard.md
@@ -1,6 +1,6 @@
 # The General Standard 
 
-<standard name = "General Standard">
+<standard name="General Standard">
 
 ## Application 
 

diff --git a/docs/Test.md b/docs/Test.md
diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/index.md b/docs/index.md
diff --git a/form_generator/Checklist.html b/form_generator/Checklist.html
@@ -1,11 +1,14 @@
-<!DOCTYPE html>
+---
+layout: default
+---   
+
 <html>
 <head>
     <title>Empirical Standards</title>
     <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
     <meta name="viewport" content="width=device-width, initial-scale=1">
-    <link rel="stylesheet" href="css/appearance.css">
-    <link rel="stylesheet" href="css/tooltip.css">
+    <link rel="stylesheet" href="/form_generator/css/appearance.css">
+    <link rel="stylesheet" href="/form_generator/css/tooltip.css">
     <script language="javascript" type="text/javascript">
         function showInstructions(){
             role = location.search.split("=")[1];
@@ -61,7 +64,7 @@
 <div id="container">
     <div id="instructions"></div>
 
-    <form id="checklistForm" action="result.html" method="get">
+    <form id="checklistForm" action="/form_generator/result.html" method="get">
         <h2>Select all that apply:</h2>
         <input type="checkbox" class="standard" name="standard" id="Action_Research"         value="Action Research"><div class="tooltip"> <a href="https://github.com/acmsigsoft/EmpiricalStandards/blob/master/docs/ActionResearch.md" target="_blank">Action research</a><span class="tooltiptext">Empirical research that investigates how an intervention, like the introduction of a method or tool, affects a real-life context</span></div></input><br/><br/>
         <input type="checkbox" class="standard" name="standard" id="Case_Study"              value="Case Study"><div class="tooltip"><a href="https://github.com/acmsigsoft/EmpiricalStandards/blob/master/docs/CaseStudy.md" target="_blank"> Case study</a><span class="tooltiptext">"An empirical inquiry that investigates a contemporary phenomenon (the "case") in depth and within its real-world context, especially when the boundaries between phenomenon and context [are unclear]" (Yin 2017)</span></div></input><br/><br/>

diff --git a/form_generator/css/appearance.css b/form_generator/css/appearance.css
@@ -3,12 +3,10 @@ html {
 }
 
 body {
-    max-width: 800px;
 	display: block;
     margin: 0 auto;
     padding-left: 15px;
     padding-right: 25px;
-	background: #f4f4f4;
 }
 ul{
 	padding-left: 20px;
@@ -33,9 +31,3 @@ form{
 .standardHeaderText {font-size: 100%; color: grey; background-color: #f4f4f4; padding-right: 5px;}
 .btn-link {border:none; outline:none; background:none; cursor:pointer; color:#0000EE; padding:0; text-decoration:underline; font-family:inherit; font-size:inherit;
 }
-footer {
-	position: absolute;
-	bottom: 10px;
-	width: 50%;
-	border: 3px;
-}
diff --git a/form_generator/index.html b/form_generator/index.html
@@ -1,37 +1,37 @@
-<!DOCTYPE html>
 <html>
     <head>
 		<title>Empirical Standards</title>
         <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
 		<meta name="viewport" content="width=device-width, initial-scale=1">
-		<link rel="stylesheet" href="css/appearance.css">
-        <link rel="stylesheet" href="css/tooltip.css">
+		<link rel="stylesheet" href="/form_generator/css/appearance.css">
+        <link rel="stylesheet" href="/form_generator/css/tooltip.css">
     </head>
     <body>
 	<div id="container">
 	  <h1>Empirical Standards Checklist Generator</h1>
-	  <form id="authorForm" action="Checklist.html" method="get">
+	  <form id="authorForm" action="/form_generator/Checklist.html" method="get">
 	    <input type="hidden" name="role" value="author">
 		  <h3>Authors:</h3> 
 		  <ul>
-		  		<li><input type="submit" class="btn-link" class="button" value="Generate a generic pre-submission checklist"></li>
+		  		<li><input type="submit" class="btn-link" value="Generate a generic pre-submission checklist"></li>
 		  </ul>
       </form>
-	  <form id="reviewerForm" action="Checklist.html" method="get">
+	  <form id="reviewerForm" action="/form_generator/Checklist.html" method="get">
 	    <input type="hidden" name="role" value="reviewer">
         <h3>Reviewers:</h3>
 			<ul>
-				<!--<li><input type="submit" class="btn-link" class="button" value="Generate a review checklist for EASE 2021"></li>-->
+				<!--<li><input type="submit" class="btn-link" value="Generate a review checklist for EASE 2021"></li>-->
 			</ul>
       </form>
-		<form id="revieweForm" action="Checklist.html" method="get">
+		<form id="revieweForm" action="/form_generator/Checklist.html" method="get">
 			<input type="hidden" name="role" value="phase">
 			<ul>
-				<li><input type="submit" class="btn-link" class="button" value="Generate a checklist for one-phase review (most conferences)"></li><br>
-				<li><input type="submit" class="btn-link" class="button" value="Generate a checklist for two-phase review (most journals)"></li>
+				<li><input type="submit" class="btn-link" value="Generate a checklist for one-phase review (most conferences)"></li><br>
+				<li><input type="submit" class="btn-link" value="Generate a checklist for two-phase review (most journals)"></li>
 			</ul>
 		</form>
     </div>
+	<br><br><br><br>
+	&copy; Designed by Paul Ralph and created by Arham Arshad and Taher Ghaleb.
     </body>
-	<footer>&copy; Designed by Paul Ralph and created by Arham Arshad and Taher Ghaleb.</footer>
 </html>
diff --git a/form_generator/js/read_standards.js b/form_generator/js/read_standards.js
@@ -18,18 +18,18 @@ function readSpecificEmpiricalStandard(standard_name){
 	var loc = window.location.pathname;
 	var dir = loc.substring(0, loc.lastIndexOf('/'));
 	var standard_file_name = standard_name.replaceAll("\"", "").replace(" ", "");
-	var standard_file_path = "./docs/" + standard_file_name + ".md";
+	var standard_file_path = "/docs/" + standard_file_name + ".md";
 	var empirical_standard = "";
 	mdFile.open("GET", standard_file_path, false);
 	mdFile.onreadystatechange = function(){
 		if (mdFile.readyState === 4){
 			if (mdFile.status === 200  || mdFile.status == 0)
 				empirical_standard = mdFile.responseText;
 			else
-				alert("Can't read " + standard_file_name + ".md");
+				alert("Can't read " + standard_file_path);
 		}
 		else
-			alert("Can't read " + standard_file_name + ".md");
+			alert("Can't read " + standard_file_path);
 	}
 	mdFile.send(null);
 	return empirical_standard;
@@ -443,6 +443,12 @@ function generateStandardChecklist(){
 	standard_keys = getParameterByName('standard');
 	standard_keys = sortStandards(standard_keys);
 	role = getParameterByName('role');
+
+	var wrappers = document.getElementsByClassName('wrapper');
+	var wrapper = null;
+	if (wrappers.length > 0)
+		wrapper = wrappers[1];
+
 	var container = document.createElement("DIV");
 	container.id = "container";
 
@@ -599,7 +605,11 @@ function generateStandardChecklist(){
 	}
 	container.appendChild(UL);
 
-	document.body.appendChild(container);
+	if (wrapper == null)
+		document.body.appendChild(container);
+	else
+		wrapper.appendChild(container);
+
 }
 //download the file as a checklist
 function saveFile(){
@@ -655,12 +665,12 @@ function saveFile(){
 									generated_text += 'R' + '\t   ' + li_text + '\r\n';
 								else{
 									var fixable_deviation = li.getElementsByClassName('justificationRadioYes')[0];
-									generated_text += (fixable_deviation.checked ? 'F' : 'U') + '  \t ' + li_text + '\r\n';
+									generated_text += (fixable_deviation.checked ? 'F' : 'U') + '\t   ' + li_text + '\r\n';
 								}
 							}
 						}
 						else
-							generated_text += (li.children[0].checked ? 'Y' : 'N') + ' \t  ' + li_text + '\r\n';
+							generated_text += (li.children[0].checked ? 'Y' : 'N') + '\t   ' + li_text + '\r\n';
 					}
 				}
 			}