diff --git a/_config.yml b/_config.yml index 853fe6f..1b16ad2 100644 --- a/_config.yml +++ b/_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 \ No newline at end of file diff --git a/_includes/footer.html b/_includes/footer.html new file mode 100644 index 0000000..38f1200 --- /dev/null +++ b/_includes/footer.html @@ -0,0 +1,45 @@ + \ No newline at end of file diff --git a/_team/contributors.md b/_team/contributors.md index 99fb5bb..3199f8c 100644 --- a/_team/contributors.md +++ b/_team/contributors.md @@ -110,3 +110,5 @@ **Erin Schultz**, Dalhousie University, Canada +**Bimpe Ayoola**, Dalhousie University, Canada + diff --git a/docs/CaseStudy.md b/docs/CaseStudy.md index 72aa4cc..1db0258 100644 --- a/docs/CaseStudy.md +++ b/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 + + + + + + - [ ] presents a clear chain of evidence from observations to findings @@ -59,7 +65,19 @@ captures a large quantitative dataset with limited context, consider the - + + + +### Supplementary Materials + +- [ ] coding scheme (required) +- [ ] coding examples (required) +- [ ] extended chain-of-evidence table(s) (required) +- [ ] interview guide(s) (optional) +- [ ] decision rules (optional) + + + ### Desirable Attributes diff --git a/docs/DataScience.md b/docs/DataScience.md index 1590926..9c3a6c0 100644 --- a/docs/DataScience.md +++ b/docs/DataScience.md @@ -1,7 +1,7 @@ # Data Science -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[1](#myfootnote1) +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[1](#myfootnote1) ## Application diff --git a/docs/standard_desc/ActionResearch.js b/docs/standard_desc/ActionResearch.js deleted file mode 100644 index 2748c10..0000000 --- a/docs/standard_desc/ActionResearch.js +++ /dev/null @@ -1,2 +0,0 @@ -alert('Empirical research that investigates how an intervention, like the ' + - 'introduction of a method or tool, affects a real-life context') \ No newline at end of file diff --git a/form_generator/js/read_standards.js b/form_generator/js/read_standards.js index d5f9e5e..d9164ef 100644 --- a/form_generator/js/read_standards.js +++ b/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,6 +145,7 @@ 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"; @@ -151,11 +153,13 @@ function generate_decision_message_block() { } 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('_hr_') ? true : false; // Replace line break and horizontal rule with empty string line_text = line_text.replace(/(_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}").replaceAll("", "{/sup}"); + checklistInnerHTML = checklistInnerHTML.replaceAll("", "{sup}").replaceAll("", "{/sup}").replaceAll("", "{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); diff --git a/index.md b/index.md index 774416e..5ffcdf7 100644 --- a/index.md +++ b/index.md @@ -6,4 +6,5 @@ layout: default + diff --git a/tab_03_standards.md b/tab_03_standards.md index bb24378..f8cc3de 100644 --- a/tab_03_standards.md +++ b/tab_03_standards.md @@ -74,11 +74,11 @@ function openStandardFromURL(evt) { - + - + - +

@@ -105,7 +105,7 @@ function openStandardFromURL(evt) {

{% capture std %}{% include_relative docs/CaseStudy.md %}{% endcapture %} - {{ std | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | 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: '' | remove: '' | remove: '' | remove: '' |remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | 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 }}