Html: Change all spec citations to use the same style

Created on 30 Apr 2016  路  13Comments  路  Source: whatwg/html

In section 2.2.2, some of spec title are wrapped <cite>, for example :

Implementations must support <cite>Media Queries</cite>.

But, I feel that some of spec title are not wrapped <cite>, for instance:

... the relevant algorithm in the CSS Syntax specification must be followed.

I think the descriptions should be unified.

good first issue

Most helpful comment

@Johanna-hub it's fine as a single change, but you can commit as many times as you want in your PR; we can squash it when merging.

All 13 comments

Yeah, I think this is similar to deciding on a casing when referencing other WHATWG standards. We haven't really established a policy. I think I would generally prefer omitting "the" and "specification" and instead take the title and use <cite>title</cite> as a way of referencing. @domenic?

Yeah, that sounds good. So to be clear, everything gets <cite>, and WHATWG standards go from the WHATWG URL standard to <cite>URL</cite>? Similarly we go from the CSS Syntax specification to <cite>CSS Syntax</cite>?

Agreed.

@annevk @domenic I'd be happy to take this one on.

@sandersk sounds great, you got it. Are the instructions in README.md sufficient to get started?

Yup, I think I'm all set. Will let you know if I have any questions.

@sandersk are you still planning to work on this? It's fine if not, I just wanted to make sure others looking for their own "good first issue" know what's free :) (See https://github.com/whatwg/meta/issues/74.)

Sorry, given that I never got around to this, please feel free to assign this to someone else!

I don't think this is quite closed. There are a lot of spec citations left that do not use the same style. It would take a pretty big search to find them all, although it was good that we fixed that one.

For example, a lot of places say the WHATWG X standard whereas if they were using the uniform style they would just say <cite>X</cite>

Hi @domenic
I can take this on to close the issue. Just to clarify, as an example in section 2 where it says This specification depends on the WHATWG Infra standard I would change to This specification depends on <cite>Infra<cite>

And in section 2.1 para 4 where it says the terms HTML document and XML document are used as defined in the DOM specification I would change to the terms HTML document and XML document are used as defined in <cite>DOM<cite>

Hi @Johanna-hub! Yeah, those are exactly the kind of changes we'd work on. There are quite a lot, but from a glance searching for things like

  • "the WHATWG X standard"
  • "the X specification"
  • "X specification" or "the X specification" (already using <cite>, but still not quite the style we'd prefer)

will find most (all?) of them.

@domenic Great thanks! Since there will be quite a lot of changes, how often should I commit? I'm not too sure how to break it up

@Johanna-hub it's fine as a single change, but you can commit as many times as you want in your PR; we can squash it when merging.

Was this page helpful?
0 / 5 - 0 ratings