Affirm decision to keep SHACL-C snippets in Core

[ajnelson-nist]

Requested by @jeswr in parent issue #460 .

Do we have consensus to keep the SHACL-C syntax snippets in the Core document?

[HolgerKnublauch]

I see no reason why not, as long as

• this doesn't create overhead for the editors that are not familiar with SHACL-C details (like myself)
• it is clear that these are marked "informative" (not normative) esp while the SHACL-C document isn't stable
• we have a stable URL for the SHACL-C document

I believe all conditions are met or can be met soon.

[VladimirAlexiev]

@ajnelson-nist do we take a vote? I'm 👍

Loosely related: #465

[jeswr]

All conditions are met bar marking as informative - I will resolve this and close the associated issue when I am back at my laptop

[VladimirAlexiev]

@jeswr Are SHACLC examples mastered in the HTML of the specs, same as the Turtle?
Then extracted and compared again each other?

[jeswr]

@jeswr Are SHACLC examples mastered in the HTML of the specs, same as the Turtle? Then extracted and compared again each other?

Note quite sure I understand what "mastered" means here. The SHACL-C examples are auto-generated by parsing the turtle example with N3.js and then serialising with shaclc-write

[jeswr]

Also to set a deadline - I propose we close this issue after exactly 1 week of its open date in the event that there are no objections.

[VladimirAlexiev]

@jeswr I mean where are they authored.

SHACL-C examples are auto-generated by parsing the turtle example...

And then how are they inserted into the HTML>?

[afs]

👍

[jeswr]

@jeswr I mean where are they authored.

SHACL-C examples are auto-generated by parsing the turtle example...

And then how are they inserted into the HTML>?

It is all handled by this script (which parses the DOM, inserts SHACL-C at appropriate nodes, and then re-serialises)

data-shapes/scripts/sync-code-snippets.js

Lines 228 to 269 in ace342f

	if (snippet.root.classList.contains('shapes-graph')) {
	if (!snippet.shaclcContent) {
	console.log(`${snippet.id}: SHACL-C content missing`)
	// Write back to spec if enabled
	if (writeShaclc && snippet.shaclcExpected) {
	console.log(`${snippet.id}: Writing SHACL-C content to spec`)
	let shaclcElement = snippet.root.querySelector('.shaclc pre.shaclc')
	// If the element does not exist, create it
	if (!shaclcElement) {
	const divElement = dom.window.document.createElement('div')
	divElement.className = 'shaclc'
	const preElement = dom.window.document.createElement('pre')
	preElement.className = 'shaclc'
	preElement.textContent = snippet.shaclcExpected
	divElement.appendChild(preElement)
	snippet.root.appendChild(divElement)
	} else {
	shaclcElement.textContent = snippet.shaclcExpected
	}
	documentModified = true
	console.log(`${snippet.id}: Updated SHACL-C content in spec`)
	}
	await snippet.write(output)
	} else if (!snippet.isShaclcEqual) {
	console.log(`${snippet.id}: SHACL-C triples are different from turtle`)
	await snippet.write(output)
	} else if (!snippet.isShaclcExpected) {
	console.log(`${snippet.id}: SHACL-C content doesn't look as expected`)
	await snippet.write(output)
	} else {
	if (writeEqual) {
	await snippet.write(output)
	}
	}
	}
	}