Supplementary materials for Case study

_config.yml

@@ -12,3 +12,7 @@ header_pages:
 collections:
   team:
     output: true
+
+link:
+  label: Sponsor the Empirical Standards on GitHub
+  href: https://github.com/sponsors/drpaulralph

_includes/footer.html

@@ -0,0 +1,45 @@
+<footer class="site-footer h-card">
+    <data class="u-url" href="{{ " / " | relative_url }}"></data>
+    <div class="wrapper">
+        <h2 class="footer-heading">{{ site.title | escape }}</h2>
+        <div class="footer-col-wrapper">
+            <div class="footer-col footer-col-1">
+                {%- if site.link %}
+                  <ul class="contact-list">
+                    {% if site.link.label -%}
+                       {% if site.link.href -%}
+                         <li>
+                            <a class="u-email" target="_blank" href="{{ site.link.href }}">{{ site.link.label }}</a>
+                         </li>
+                       {% endif -%}
+                    {%- endif %}
+                  </ul>
+                {%- endif %}
+
+                {%- if site.author %}
+                <ul class="contact-list">
+                    {% if site.author.name -%}
+                       <li class="p-name">{{ site.author.name | escape }}</li>
+                    {% endif -%} 
+
+                    {% if site.author.email -%}
+                       <li>
+                          <a class="u-email" href="mailto:{{ site.author.email }}">{{ site.author.email }}</a>
+                       </li>
+                    {%- endif %}
+                </ul>
+                {%- endif %}
+            </div>
+
+            <div class="footer-col footer-col-2">
+                <ul class="social-links">
+                    {%- include social.html -%}
+                </ul>
+            </div>
+
+            <div class="footer-col footer-col-3">
+                <p>{{ site.description | escape }}</p>
+            </div>
+        </div>
+    </div>
+</footer>

_team/contributors.md

@@ -110,3 +110,5 @@
 
 **Erin Schultz**, Dalhousie University, Canada
 
+**Bimpe Ayoola**, Dalhousie University, Canada
+

docs/CaseStudy.md

@@ -49,6 +49,12 @@ captures a large quantitative dataset with limited context, consider the
 - [ ]   describes data sources (e.g. participants' demographics and work roles)
 - [ ]   defines unit(s) of analysis or observation
 
+
+
+
+
+
+
 <results>
 
 - [ ]   presents a clear chain of evidence from observations to findings
@@ -59,7 +65,19 @@ captures a large quantitative dataset with limited context, consider the
 <other>    
 
 </checklist>
-
+
+
+
+### Supplementary Materials
+<checklist name="Supplementary">
+- [ ]	<supplement> coding scheme (required)</supplement>
+- [ ]	<supplement> coding examples (required)</supplement>
+- [ ]	<supplement> extended chain-of-evidence table(s) (required)</supplement>
+- [ ]	<supplement> interview guide(s) (optional)</supplement>
+- [ ]	<supplement> decision rules (optional)</supplement>
+
+</checklist>
+
 ### Desirable Attributes
 <checklist name="Desirable">
 

docs/DataScience.md

@@ -1,7 +1,7 @@
 # Data Science
 <standard name="Data Science">
 
-<desc>Studies that analyze software engineering phenomena or artifacts using data-centric analysis methods such as machine learning or other computational intelligence appraches as well as search-based approaches<footnote></desc><sup>[1](#myfootnote1)</sup>
+<desc>Studies that analyze software engineering phenomena or artifacts using data-centric analysis methods such as machine learning or other computational intelligence appraches as well as search-based approaches<footnote><sup>[1](#myfootnote1)</sup></desc>
 
 ## Application
 

form_generator/js/read_standards.js

@@ -125,6 +125,7 @@ function generate_decision_message_block() {
 
 		document.getElementById("deviation_reasonable").style.display = "none";
 		document.getElementById("deviation_unreasonable").style.display = "none";
+		document.getElementById("Supplementary Materials").style.display = "block";
 		document.getElementById("Desirable").style.display = "none";
 		document.getElementById("Extraordinary").style.display = "none";
 		// checkboxInput.className = "checkbox_attributes";
@@ -144,18 +145,21 @@ function generate_decision_message_block() {
 			} else if (justification_type2_checked_count > 0) {
 				msg = "GATEKEEP";
 				document.getElementById("deviation_reasonable").style.display = "block";
+				document.getElementById("Supplementary Materials").style.display = "block";
 				document.getElementById("Desirable").style.display = "block";
 				document.getElementById("Extraordinary").style.display = "block";
 
 			// if number of type 1 is greater than 0
 			} else if (justification_type1_checked_count > 0) {
 				msg = "ACCEPT";
 				document.getElementById("deviation_reasonable").style.display = "block";
+				document.getElementById("Supplementary Materials").style.display = "block";
 				document.getElementById("Desirable").style.display = "block";
 				document.getElementById("Extraordinary").style.display = "block";
 
 			} else {
 				msg = "ACCEPT";
+				document.getElementById("Supplementary Materials").style.display = "block";
 				document.getElementById("Desirable").style.display = "block";
 				document.getElementById("Extraordinary").style.display = "block";
 
@@ -179,6 +183,7 @@ function generate_decision_message_block() {
 
 		document.getElementById("deviation_reasonable").style.display = "none";
 		document.getElementById("deviation_unreasonable").style.display = "none";
+		document.getElementById("Supplementary Materials").style.display = "block";
 		document.getElementById("Desirable").style.display = "none";
 		document.getElementById("Extraordinary").style.display = "none";
 		$('.checkbox_attributes').prop('checked', false);
@@ -679,8 +684,9 @@ function generate_two_phase_reviewer_deviation_block(checklistItem_id) {
 	return deviation_block;
 }
 
+
 // convert from Markdown to HTML checklists
-function convert_MD_standard_checklists_to_html_standard_checklists(standardName, checklistName, checklistText, footnotes){
+function convert_MD_standard_checklists_to_html_standard_checklists(standardName, checklistName, checklistText, footnotes,supCheckList){
 
 	// ???????
 	tester = getParameterByName('y')[0] == 'noval' ? true : false;
@@ -735,13 +741,24 @@ function convert_MD_standard_checklists_to_html_standard_checklists(standardName
 			// !!!!!!!!!!!!!!!! we dont need this part in the checklist
 			if(line_text.includes("complies with all applicable empirical standards"))
 				continue;
-			
+
 			// if line_text includes a specific regex set to true ( line break with horizontal rule)
 			IMRaD_line_break = line_text.includes('<br\/>_hr_') ? true : false;
 
 			// Replace line break and horizontal rule with empty string
 			line_text = line_text.replace(/(<br\/>_hr_)+/g, '');
 
+			//comment later
+			if(line_text.includes("{supplement}") && checklistName === "Supplementary")  {
+				supCheckList.items += "- [ ]" + line_text;
+				continue;
+			}
+
+			// if(line_text.includes("{supplement}"))  {
+			// 	supCheckList.items += "- [ ]" + line_text;
+			// 	continue;
+			// }
+
 			// Change the text to the string held in line_text
 			checklistItemLI.setAttribute("text", line_text);
 
@@ -816,6 +833,7 @@ function convert_MD_standard_checklists_to_html_standard_checklists(standardName
 			checklists.appendChild(checklistItemLI);
 		}
 	}
+
 	return checklists;
 }
 
@@ -902,10 +920,10 @@ function create_role_heading(){
 }	
 
 // Prepare unordered lists
-function preparation_to_convert_MD_to_HTML(standardTagName, checklistTagName, checklistInnerHTML, footnotes){
+function preparation_to_convert_MD_to_HTML(standardTagName, checklistTagName, checklistInnerHTML, footnotes,supCheckList){
 
 	// superscript tags
-	checklistInnerHTML = checklistInnerHTML.replaceAll("<sup>", "{sup}").replaceAll("</sup>", "{/sup}");
+	checklistInnerHTML = checklistInnerHTML.replaceAll("<sup>", "{sup}").replaceAll("</sup>", "{/sup}").replaceAll("<supplement>", "{supplement}");
 
     var tempDivElement = document.createElement("div");
     tempDivElement.innerHTML = checklistInnerHTML;
@@ -922,8 +940,9 @@ function preparation_to_convert_MD_to_HTML(standardTagName, checklistTagName, ch
 	// Supplement Files - Change from docs to link, change from .md file to nothing
 	checklistText = checklistText.replaceAll('https://github.com/acmsigsoft/EmpiricalStandards/blob/master/Supplements/', '../Supplements?supplement=').replaceAll('.md', '');
 
+
 	// Convert Markdown Checklists to HTML checklists
-	checklists = convert_MD_standard_checklists_to_html_standard_checklists(standardTagName, checklistTagName, checklistText, footnotes)
+	checklists = convert_MD_standard_checklists_to_html_standard_checklists(standardTagName, checklistTagName, checklistText, footnotes,supCheckList)
 
 	return checklists;
 }
@@ -986,9 +1005,14 @@ function create_requirements_checklist(){
 	form.id = "checklists";
 	form.name = "checklists";
 
+	var supCheckList = {items:""};
+
 	// create Header for Essential Requirements with an unordered list
 	var EssentialUL = create_requirements_heading_with_UL("Essential");
 
+	// create Header for Supplementary Requirements with an unordered list
+	var SupplementaryUL = create_requirements_heading_with_UL("Supplementary Materials");
+
 	// create Header for Desirable Requirements with an unordered list
 	var DesirableUL = create_requirements_heading_with_UL("Desirable");
 
@@ -998,12 +1022,14 @@ function create_requirements_checklist(){
 	// hide desirable and extraordinary list of requirements for One Phase Reviewer
 	if(role == "\"one-phase-reviewer\""){
 		DesirableUL.style = "padding: 0px; display:none;";
+		SupplementaryUL.style = "padding: 0px; display:block;";
 		ExtraordinaryUL.style = "padding: 0px; display:none;";
 	}
 	// hide desirable and extraordinary list of requirements for Two Phase Reviewer
 	else if(role == "\"two-phase-reviewer\""){
 		DesirableUL.style = "padding: 0px; display:none;";
-		ExtraordinaryUL.style = "padding: 0px; display:none;";		
+		SupplementaryUL.style = "padding: 0px; display:block;";
+		ExtraordinaryUL.style = "padding: 0px; display:none;";
 	}
 
 	// unshift() method adds new items to the beginning of an array, and returns the new length
@@ -1060,39 +1086,57 @@ function create_requirements_checklist(){
 					EssentialUL.appendChild(Yes_No);
 				//EssentialUL.appendChild(checklists);
 			}
+
+			else if (checklistTag.getAttribute('name') == "Supplementary") {
+				//DesirableUL.appendChild(standard_header_rule);
+
+				// Change from Markdown to HTML elements
+				checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes,supCheckList);
+				SupplementaryUL.appendChild(checklists);
+			}
+
 			else if (checklistTag.getAttribute('name') == "Desirable") {
 				//DesirableUL.appendChild(standard_header_rule);
 
 				// Change from Markdown to HTML elements
-				checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes);
+				checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes,supCheckList);
 				DesirableUL.appendChild(checklists);
 			}
+
+
 			else if (checklistTag.getAttribute('name') == "Extraordinary") {
 				//ExtraordinaryUL.appendChild(standard_header_rule);
 
 				// Change from Markdown to HTML elements
-				checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes);
+				checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes,supCheckList);
 				ExtraordinaryUL.appendChild(checklists);
 			}
 		}
 	}
 	all_essential_IMRaD_items_innerHTML = "" + all_intro_items + "\n_hr_" + all_method_items + "\n_hr_" + all_results_items + "\n_hr_" + all_discussion_items + "\n_hr_" + all_other_items
 	all_essential_IMRaD_items_innerHTML = all_essential_IMRaD_items_innerHTML.replaceAll("\n_hr_", "").length > 0 ? all_essential_IMRaD_items_innerHTML : "";
-	
+
 
 	// Notify testers in the case of unrecognized tags, no tags at all, or untagged attributes
 	notify_testers();
 
 	// Change from Markdown to HTML elements
-	checklists = preparation_to_convert_MD_to_HTML("", 'Essential', all_essential_IMRaD_items_innerHTML, footnotes);
+	checklists = preparation_to_convert_MD_to_HTML("", 'Essential', all_essential_IMRaD_items_innerHTML, footnotes,supCheckList);
 	EssentialUL.appendChild(checklists);
-
+
+	checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), "Supplementary", supCheckList.items.replaceAll("{supplement}", ""), footnotes,supCheckList);
+	SupplementaryUL.appendChild(checklists);
+
+
 	// Add Essential Attributes to the form
 	form.appendChild(EssentialUL);
 
 	// Create download button
 	var download = create_download_button();
 
+	//append supplementary material list
+	form.appendChild(SupplementaryUL);
+
 	// (All 'Yes' -> accept manuscript)
 	var decision_msg = generate_message("decision_msg", "red", (role != "\"author\"" ? "The manuscript meets all essential criteria: ACCEPT." : ""), 2, 0);
 	form.appendChild(decision_msg);
@@ -1126,6 +1170,7 @@ function create_requirements_checklist(){
 	}
 
 	// Add Desirable and Extraordinary Unordered List to Form
+
 	form.appendChild(DesirableUL);
 	form.appendChild(ExtraordinaryUL);
 

index.md

@@ -6,4 +6,5 @@ layout: default
    <head>
 	 <meta http-equiv="refresh" content="0; URL=tools" />
    </head>
+
 </html>

tab_03_standards.md

@@ -74,11 +74,11 @@ function openStandardFromURL(evt) {
   <button id="MetaScience_b"            class="tablinks" onclick="openStandard(event, 'MetaScience')">Meta Science </button>
   <button id="MixedMethods_b"           class="tablinks" onclick="openStandard(event, 'MixedMethods')">Mixed Methods </button>
   <button id="OptimizationStudies_b"    class="tablinks" onclick="openStandard(event, 'OptimizationStudies')">Optimization Studies</button>
-  <button id="QualitativeSurveys_b"     class="tablinks" onclick="openStandard(event, 'QualitativeSurveys')">Qualitative Surveys</button>
+  <button id="QualitativeSurveys_b"     class="tablinks" onclick="openStandard(event, 'QualitativeSurveys')">Qualitative Survey</button>
   <button id="QuantitativeSimulation_b" class="tablinks" onclick="openStandard(event, 'QuantitativeSimulation')">Quantitative Simulation</button>
-  <button id="QuestionnaireSurveys_b"   class="tablinks" onclick="openStandard(event, 'QuestionnaireSurveys')">Questionnaire Surveys</button>
+  <button id="QuestionnaireSurveys_b"   class="tablinks" onclick="openStandard(event, 'QuestionnaireSurveys')">Questionnaire Survey</button>
   <button id="RepositoryMining_b"       class="tablinks" onclick="openStandard(event, 'RepositoryMining')">Repository Mining</button>
-  <button id="SystematicReviews_b"      class="tablinks" onclick="openStandard(event, 'SystematicReviews')">Systematic Reviews</button>
+  <button id="SystematicReviews_b"      class="tablinks" onclick="openStandard(event, 'SystematicReviews')">Systematic Review</button>
 </div>
 <br>
 <br>
@@ -105,7 +105,7 @@ function openStandardFromURL(evt) {
 <div id="CaseStudy" class="tabcontent">
   <p>
     {% capture std %}{% include_relative docs/CaseStudy.md %}{% endcapture %}
-    {{ std | remove: '<standard name="Case Study and Ethnography">' | remove: '<checklist name="Essential">' | remove: '<checklist name="Desirable">' | remove: '<checklist name="Extraordinary">' | remove: '</checklist>' | remove: '</standard>' | remove: '<footnote>' | remove: '</footnote>' | remove: '<intro>' | remove: '<method>' | remove: '<results>' | remove: '<discussion>' | remove: '<other>' | replace: '- [ ]', '-' | replace: 'https://github.com/acmsigsoft/EmpiricalStandards/blob/master/docs/', '../docs?standard=' | replace: 'https://github.com/acmsigsoft/EmpiricalStandards/blob/master/Supplements/', '../Supplements?supplement=' | replace: '.md', '' | markdownify }}
+    {{ std | remove: '<standard name="Case Study and Ethnography">' | remove: '<checklist name="Essential">' | remove: '<checklist name="Desirable">' | remove: '<checklist name="Supplementary">' |remove: '<checklist name="Extraordinary">' | remove: '</checklist>' | remove: '</standard>' | remove: '<footnote>' | remove: '</footnote>' | remove: '<intro>' | remove: '<method>' | remove: '<results>' | remove: '<discussion>' | remove: '<other>' | remove: '<desc>' | remove: '</desc>' | remove: '<supplement>' | remove: '</supplement>' | replace: '- [ ]', '-' | replace: 'https://github.com/acmsigsoft/EmpiricalStandards/blob/master/docs/', '../docs?standard=' | replace: 'https://github.com/acmsigsoft/EmpiricalStandards/blob/master/Supplements/', '../Supplements?supplement=' | replace: '.md', '' | markdownify }}
   </p>
 </div>