Re: [whatwg/url] Add a neato informative table of various URL pieces (#337)

Ok, can I help with this? It seems that the two open questions are:

- What to be used to represent the syntax (graphic, table, or formula). I suggest the second or third of the four tables posted by TimothyGu, but:
  - It should be in text, not a graphic, with links on the terms. The code Timothy used to generate the graphic would be helpful.
  - The terms should match those used in the URL spec, although it would be good to point out the parallel API terms and link to their document, and it would be best if the analogous table is posted there as well.
  - It would be helpful to have an additional row at the top of the table with a symbol to distinguish required from optional elements. In the formula proposed in my issue yesterday, this was done with square brackets. Timothy's table is much easier to read, but the optionality is important information to include.
  - I guess the third table is best if "origin" means something, which I don't know. Linking to where it's explained in the spec would fix that. It appears twice, so some clarification is needed.
  - I don't know about URNs, but if Timothy's fourth table is related to URLs, then it would be good to show that relationship as well.
- Where to put it. I suggest [section 4.5](https://url.spec.whatwg.org/#url-serializing) unless there is a more appropriate place. If it's put in an appendix, it should be prominently linked to, and maybe should be linked to in a few places anyway, because this is going to be something that will be useful to people.

What have I left out? If Timothy will post the code behind his graphic, I'll work on editing it to implement the suggestions above.

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/whatwg/url/issues/337#issuecomment-414275967