Navigation Menu

Skip to content
This repository has been archived by the owner on Jul 30, 2019. It is now read-only.

Update docs on rev attribute #1151

Closed
chharvey opened this issue Jan 22, 2018 · 5 comments
Closed

Update docs on rev attribute #1151

chharvey opened this issue Jan 22, 2018 · 5 comments
Assignees
Labels
Milestone

Comments

@chharvey
Copy link

chharvey commented Jan 22, 2018

I noticed a couple of bugs with the now-reintroduced rev attribute, and wanted to document them here.

  1. The .rev IDL attribute for HTMLAnchorElement has a broken documentation link. I think the solution would be to add it into this paragraph, and fix the link to point to it:

The IDL attributes download, target, rel, hreflang, and type, must reflect the respective content attributes of the same name.

  1. Under the section Links created by <a> and <area> elements, there is documentation on the [rev] content attribute, which applies to a and link. This is misleading because link is not in the section title. Perhaps the title should be changed to “Links created by <a>, <area>, and <link> elements”.

  2. The [rel] content attribute for a and area is documented in this same section, but [rel] for link is documented under its own section: The link Element. If the title of the section is changed to include “<link>”, perhaps documentation for link[rel] should be moved here.

  3. Lastly, not a bug, but a question: Should the [rev] content attribute be allowed on area elements? Since area is very similar to a, I feel like it should be consistent.

@chaals chaals self-assigned this Jan 24, 2018
@chaals
Copy link
Collaborator

chaals commented Jan 24, 2018

Thank you for picking these up.

I have assigned myself to them, somewhat hopefully, but if you have time to make a Pull Request you are very welcome to do so. (I am happy to help with that...)

Comments on your detailed observations:

  1. rev should be in that list I think, subject to testing whether that happens.
  2. and 3. Yes, we should clean that up one way or another.
  3. Yes, it should, IMHO.

@chaals chaals added the bug label Feb 11, 2018
@chaals chaals added this to the HTML5.3 WD2 milestone Feb 11, 2018
@chaals chaals modified the milestones: HTML5.3 WD2, HTML5.3 WD3 Mar 11, 2018
@chaals
Copy link
Collaborator

chaals commented Mar 11, 2018

This is a bit more complicated than I thought. I propose to do the following (but slip to the next milestone - instead of being now a couple of days overdue, that means within 4 weeks):

  • test link rev="stylesheet" href="some-potentiall-open-doc" which should not work in browsers and should be forbidden to work by spec. If something like that does work (it seems unlikely), file browser bugs.
  • test area rev="something" ... for RDFa processors like Google's and Yandex' structured data validator,
  • Note that links with "rel" only create hyperlinks and do not create links to external resources (like stylesheets).
  • Refactor the documentation, but probably by moving the description of rev for link elements up to the description of link elements, and if the attribute is processed by e.g. RDFa processors, make the relevant changes (which is s/link/area/ in the section mentioned, I think). The section on link types should probably also note which types are not allowed on rev (basically those that lead to creating a Link to an external resource`.

@chaals
Copy link
Collaborator

chaals commented Apr 3, 2018

OK, it turns out that rev does reflect, so I am going to commit that.

having it on area at least breaks in that unlike rel it doesn't seem to reflect there, so allowing it would mean making tweaking the editorial stuff noted in some more ways.

I haven't checked if RDFa processors actually handle rev on area.

So I will commit the bugfix, and open new issues for

  1. editorial cleanup
  2. whether rev should be allowed on a

@chaals
Copy link
Collaborator

chaals commented Apr 5, 2018

opened #1335, #1336 to deal with the aspects of this not covered by #1328

@chharvey
Copy link
Author

chharvey commented Mar 3, 2019

Summary for newcomers:

Item 1 is closed by #1328
Items 2 and 3 are closed by #1335
Item 4 is opened in #1336 (as of this time not closed yet)

Thanks

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

No branches or pull requests

3 participants
@chharvey @chaals and others