inconsistent indication of elided content in examples

[sydb]

It is normal editorial practice (at least IMHO) in the Guidelines to indicate elided element content in examples with <!-- ... -->, and elided textual (or mixed?) content with “ ... ”. Sometimes, of course, there is commentary to be made, e.g. “title of resource”. But in either case we seem to be inconsistent. I only looked at <teix:teiHeader> (in the dev branch), and found that there are 49 of them:

• 19 have a child element, 30 do not
• 24 have a child comment, 25 do not
• [None have both a child element and a child comment]
• 6 have nothing (except perhaps whitespace)

When there is a child comment:

• 9 have what I consider the proper <!-- ... -->
• 1 has what I consider the almost proper <!--...-->
• 9 have undelimited text inside the comment (with a space before and after)
• 5 have text delimited with square brackets (some with, some without, space fore and aft; all are in French, I think)

I think the 6 with nothing should get <!-- ... -->, the one with no space around the dots should get spaces, and the ones with text should either all have square brackets or none.

And then someone needs to search for similar cases for other elements besides <teiHeader>. :-)

[raffazizzi]

VF2F thinks this should be green and that it's a good ticket for new council members to try out editing the guidelines.