General style guide

A general style guide is shared to provide a context for warnings that do not obligate a mention in the specification.

Literals

Not enabled...

(Note: The warning has been turned off. The description is still in the style guide for reference.)

At present, every literal is justified unless within a section. So, any justification mark (i.e. indented trailing quote toggle) should only be utilized if meaningful.

(i.e. indented trailing quote toggle only within a section)

✔ Uniform

[Section]
"""
content
  """
 
<div><h1>Section</h1>
  content
</div>

✔ Uniform

"""
content
"""
 
content

✘ Not uniform

"""
content
  """
 
content

Sections

Quoted titles

Either single-quote or double-quote characters should be optionally included if a section title is also an element attribute
— not both.

(e.g. no quoted apostrophes)

Otherwise, the program mogrifies the title to be safe to quote as an attribute.

(Double-quotes become backquotes in the attribute if a single-quote character is present)

The mogrification is intended only for rapid development and should be avoided when finalizing a document.

✔ Uniform

["Should"]#
content
 
<div id='"Should"'>
  content
</div>

✘ Not uniform

["Shouldn't"]#
content
 
<div id="`Shouldn't`">
  content
</div>

✘ Not uniform

["Shouldn't"]/ title
content
 
<div title="`Shouldn't`">
  content
</div>

Omitted headings

A section title should be set to a dash character (-) if the title is not specified to output.

(The title should not act as an internal comment.)

Specifically, if a section element name is specified and the title is not omitted with a dash, at least one of the following should also be specified:

  • heading element name
  • id mark
  • id/title property name

✔ Uniform

[-]/body
n
 
<body>
  n
</body>

✔ Uniform

[-]/
n
 
<div>
  n
</div>

✘ Not uniform

[internal comment]/
content
 
<div>
  content
</div>