Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Schema Issue, RFC 7991, In Section 2.20, <dl> #38

Closed
levkowetz opened this issue Oct 1, 2018 · 1 comment
Closed

Schema Issue, RFC 7991, In Section 2.20, <dl> #38

levkowetz opened this issue Oct 1, 2018 · 1 comment

Comments

@levkowetz
Copy link
Contributor

In Section 2.20, <dl>

The current specification says:

  "The "hanging" attribute defines whether or not the term appears on
  the same line as the definition.  hanging="true" indicates that the
  term is to the left of the definition, while hanging="false"
  indicates that the term will be on a separate line."

This does not match established typographic terminology. In typographic
terminology, "hanging indent" describes the case where the indentation
of the second and subsequent lines of a paragraph is greater than the
indentation of the first line. Whether the definition in a definition
list starts on the first line or not has nothing to do with the presence
of hanging indent; our definition lists will always have hanging
indent.

The 'hanging' attribute also describes something different from what the
term has been used to describe in the version 2 vocabulary. This will
be confusing to users.

A more descriptive name for the attribute we're talking about would be
'start-definition-on-first-line', but that's unwieldy. Maybe
'newline="false"' to start the definition on the first line, or
something like 'definition-start="first"'?

Recommendation: Change this to a different term that is more
descriptive and does not use typographically incorrect
terminology.

Implementation: The current version of xml2rfc still uses "hanging".

@levkowetz
Copy link
Contributor Author

Closed with acceptance of 'newline' instead of 'hanging' as attribute name, after discussion on the list:
https://mailarchive.ietf.org/arch/browse/xml2rfc-dev/?q=subject%3A%2338

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant