make_checklist.js

function createSectionChecklist (section) {
	// fills a textarea element with markdown for a given section
    // the markdown can be transferred to a github issue
    
    // section: id ending in _checklist
		
	// find the h2 level sections
	var checklist = document.getElementById(section)
	
	var out = `# Detailed internationalisation review checklist\nCheck marks indicate requirements that are fulfilled by this spec. Add comments to describe conformance.\n\nThis checklist was created <a href="https://www.w3.org/TR/international-specs/#${ section }">here</a>.\n\n`
	    
    out += '## '+checklist.parentNode.querySelector('h2').textContent+'\n'
    
    // get the mustard from the checklist
    var h3s = checklist.querySelectorAll('.checklistDiv')
    
    console.log(h3s.length)

    for (var j=0;j<h3s.length;j++) {
        // get the subsection title
        var h3 = h3s[j].querySelector('p').textContent
        out += '### '+h3+'\n'

        // get the guidelines
        var guidelines = h3s[j].querySelectorAll('li')
        for (var k=0;k<guidelines.length;k++) {
            var checked = ''
            var relevant = guidelines[k].querySelector('.relevance')
            
            if (relevant.checked) {
                var checkbox = guidelines[k].querySelector('.ok')
                if (checkbox.checked) checked = 'x'
                var temp = guidelines[k].innerHTML
                temp = temp.replace(/<input type="checkbox"> /,'')
                if (checked) out += `1. [x] ${ temp }<br>    _Comments_go_here_\n`
                else out += `1. [ ] ${ temp }<br>    _Comments_go_here_\n`
                }
            }

        out += '\n'
        }

	
	return out
	}







function createIssueText () {
	// outputs to a textarea markdown for just the checklist items that can be used to create an interactive checklist in a github issue
		
	// find the h2 level sections
	var h2s = document.querySelectorAll('.topic')
	
	var out = '# Internationalisation review checklist\nCheck marks indicate relevant issues. Add comments to describe conformance.\n\nThis checklist was created <a href="https://www.w3.org/TR/international-specs/#ghChecklist">here</a>.\n\n'
	
	// process each h2 level section
	for (var i=0;i<h2s.length;i++) {
		var h2 = h2s[i].querySelector('h2').textContent
		var re = /[0-9]+\. /
		h2 = h2.replace(re, '')
		console.log(h2)
		out += '## '+h2+'\n'

		// get the mustard from the checklist
        var checklist = h2s[i].querySelector('.summaryC')
		var h3s = checklist.querySelectorAll('details')	
        
		for (var j=0;j<h3s.length;j++) {
			var h3 = h3s[j].querySelector('summary').textContent
			re = /[0-9]+\.[0-9]+ /
			h3 = h3.replace(re, '')
			console.log(h3)
			out += '### '+h3+'\n'
            
			// get the guidelines
			var guidelines = h3s[j].querySelectorAll('li')
			for (var k=0;k<guidelines.length;k++) {
                var checked = ''
                var checkbox = guidelines[k].querySelector('input')
                if (checkbox.checked) checked = 'x'
				var temp = guidelines[k].innerHTML
				temp = temp.replace(/<input type="checkbox"> /,'')
				if (checked) out += `1. [x] ${ temp }<br>    _Comments_go_here_\n`
				else out += `1. [ ] ${ temp }<br>    _Comments_go_here_\n`
				}
			
			out += '\n'
			}

		}
	
	return out
	}







function showChecklistsOLD (section, listLocation) {
    // called after the page is loaded; sets up section by section lists of contents
    // click on the contents list to see the recommendations in checklist form
    
    var out = ''
    var checks, h3s
    
    h3s = section.querySelectorAll('h3')
    for (var h=0;h<h3s.length;h++) {
        out += `<details><summary>${ h3s[h].innerHTML }</summary>`
        checks = h3s[h].parentNode.querySelectorAll('.advisement')
        out += `<ul class="checklistGroup">`
        for (var c=0;c<checks.length; c++) out += `<li><input type="checkbox"> ${ checks[c].innerHTML } <a href="https://www.w3.org/TR/international-specs/#${ checks[c].parentNode.id }" class="checklistMore" target="_blank">more</a></li>`
        out += `</ul>`
        out += `</details>`
        }
    
    
    document.getElementById(listLocation).innerHTML = out
    }







function showChecklists (section) {
    // called after the page is loaded; sets up section by section lists of contents
    // click on the contents list to see the recommendations in checklist form
    // section: pointer to level 2 section node
    // listLocation: id of div that will contain the checklist (<sectionID>+_checklist)
    
    
    var out = ''
    var checks, h3s
    var listLocation = section.id+'_checklist'
    var textarea = section.id+'_dump'
    
    h3s = section.querySelectorAll('h3')
    out += `<details><summary>Show checklist</summary>\n`
    for (var h=0;h<h3s.length;h++) {
        out += `<p>${ h3s[h].innerHTML }</p>`
        checks = h3s[h].parentNode.querySelectorAll('.advisement')
        out += `<ul class="checklistGroup">`
        for (var c=0;c<checks.length; c++) out += `<li><input type="checkbox" class="relevance" title="Check if this requirement is relevant to your spec."><input type="checkbox" class="ok" title="Check if your spec meets this requirement." onclick="this.previousSibling.checked=true"> ${ checks[c].innerHTML } <a href="https://www.w3.org/TR/international-specs/#${ checks[c].parentNode.id }" class="checklistMore" target="_blank">more</a></li>`
        out += `</ul>`
        }
    out += `<p><button onClick="document.getElementById('${ textarea }').value = createSectionChecklist('${ listLocation }'); document.getElementById('${ textarea }').select();">Create markdown for GitHub</button></p>`
    out += `<div><textarea id="${ textarea }" class="dumpBox"></textarea></div>`
    out += `</details>`
    
    
    document.getElementById(listLocation).innerHTML = out
    }







function showChecklists (section) {
    // called after the page is loaded; sets up section by section lists of contents
    // click on the contents list to see the recommendations in checklist form
    // section: pointer to level 2 section node
    // listLocation: id of div that will contain the checklist (<sectionID>+_checklist)
    
    
    var out = ''
    var checks, h3s
    var listLocation = section.id+'_checklist'
    var textarea = section.id+'_dump'
    
    h3s = section.querySelectorAll('h3')
    out += `<details><summary>Show the self-review checklist</summary>\n`
    
    out += `<p>This is a list of just the requirements in this section, which can be used for self-reviews. Select the first checkbox on a line for all requirements relevant to your spec. Select the second checkbox if your spec meets the requirement. Then click on the button "Create markdown for GitHub", and copy the result to a GitHub issue list. See <a href="#ghChecklist">more details</a>.`
    
    for (var h=0;h<h3s.length;h++) {
        out += `<div class="checklistDiv">`
        out += `<p>${ h3s[h].innerHTML }</p>`
        checks = h3s[h].parentNode.querySelectorAll('.advisement')
        out += `<ul class="checklistGroup">`
        for (var c=0;c<checks.length; c++) out += `<li><input type="checkbox" class="relevance" title="Check if this requirement is relevant to your spec."><input type="checkbox" class="ok" title="Check if your spec meets this requirement." onclick="this.previousSibling.checked=true"> ${ checks[c].innerHTML } <a href="https://www.w3.org/TR/international-specs/#${ checks[c].parentNode.id }" class="checklistMore" target="_blank">more</a></li>`
        out += `</ul>`
        out += `</div>`
        }
    out += `<p><button onClick="document.getElementById('${ textarea }').value = createSectionChecklist('${ listLocation }'); document.getElementById('${ textarea }').select();">Create markdown for GitHub</button></p>`
    out += `<div><textarea id="${ textarea }" class="dumpBox"></textarea></div>`
    out += `</details>`
    
    
    document.getElementById(listLocation).innerHTML = out
    }