Use table for comparison examples

[nidhijaju]

Fixes #3273.

[nidhijaju]

@martinthomson Does this address your concern from #3273?

[martinthomson]

This should help. I don't know if this will present better in reality though, the URLs are all quite long, so there's a good chance that the whole thing will wrap badly. Maybe consider eliminating or truncating the origin part.

[nidhijaju]

so there's a good chance that the whole thing will wrap badly. Maybe consider eliminating or truncating the origin part.

It looks like the wrapping isn't too bad, but I've removed the rest of the URI so we just have the query now (and adjusted the column width so there isn't wrapping). Does that look any better to you?

[martinthomson]

I don't think that you need the   stuff.

This is what I get with it:

     +===================+==============+============================+
     | Query A           | Query        | Reason for Equivalence     |
     |                   | B            |                            |
     +===================+==============+============================+
     | null              | ?            | A null query is parsed the |
     |                   |              | same as an empty string    |
     +-------------------+--------------+----------------------------+
     | ?a=x              | ?%61=%78     | Parsing performs percent-  |
     |                   |              | decoding                   |
     +-------------------+--------------+----------------------------+
     | ?a=é              | ?a=%C3%A9    | Parsing performs percent-  |
     |                   |              | decoding                   |
     +-------------------+--------------+----------------------------+
     | ?a=%f6            | ?a=%ef%bf%bd | Both values are parsed as  |
     |                   |              | U+FFFD (�)                 |
     +-------------------+--------------+----------------------------+
     | ?a=x&&&&          | ?a=x         | Parsing splits on & and    |
     |                   |              | discards empty strings     |
     +-------------------+--------------+----------------------------+
     | ?a=               | ?a           | Both parse as having an    |
     |                   |              | empty string value for a   |
     +-------------------+--------------+----------------------------+
     | ?a=%20            | ?a= &        | %20 is parsed as U+0020    |
     |                   |              | SPACE                      |
     +-------------------+--------------+----------------------------+
     | ?a=+              | ?a= &        | + is parsed as U+0020      |
     |                   |              | SPACE                      |
     +-------------------+--------------+----------------------------+

And without:

         +==========+==============+============================+
         | Query A  | Query B      | Explanation                |
         +==========+==============+============================+
         | null     | ?            | A null query is parsed the |
         |          |              | same as an empty string    |
         +----------+--------------+----------------------------+
         | ?a=x     | ?%61=%78     | Parsing performs percent-  |
         |          |              | decoding                   |
         +----------+--------------+----------------------------+
         | ?a=é     | ?a=%C3%A9    | Parsing performs percent-  |
         |          |              | decoding                   |
         +----------+--------------+----------------------------+
         | ?a=%f6   | ?a=%ef%bf%bd | Both values are parsed as  |
         |          |              | U+FFFD (�)                 |
         +----------+--------------+----------------------------+
         | ?a=x&&&& | ?a=x         | Parsing splits on & and    |
         |          |              | discards empty strings     |
         +----------+--------------+----------------------------+
         | ?a=      | ?a           | Both parse as having an    |
         |          |              | empty string value for a   |
         +----------+--------------+----------------------------+
         | ?a=%20   | ?a= &        | %20 is parsed as U+0020    |
         |          |              | SPACE                      |
         +----------+--------------+----------------------------+
         | ?a=+     | ?a= &        | + is parsed as U+0020      |
         |          |              | SPACE                      |
         +----------+--------------+----------------------------+

I think that the latter is better.

Suggested change

	| Query A           | Query B           | Reason for Equivalence |
	| Query A | Query B | Explanation |

[nidhijaju]

I updated to remove some of the extra spaces in the first column, so if you look at the generated HTML, this is what it looks like with:

and what it looks like without any  :

The first one seemed preferable, and generated .txt version looks okay too:

      +===========+===================+============================+
      | Query A   | Query B           | Explanation                |
      +===========+===================+============================+
      | null      | ?                 | A null query is parsed the |
      |           |                   | same as an empty string    |
      +-----------+-------------------+----------------------------+
      | ?a=x      | ?%61=%78          | Parsing performs percent-  |
      |           |                   | decoding                   |
      +-----------+-------------------+----------------------------+
      | ?a=é      | ?a=%C3%A9         | Parsing performs percent-  |
      |           |                   | decoding                   |
      +-----------+-------------------+----------------------------+
      | ?a=%f6    | ?a=%ef%bf%bd      | Both values are parsed as  |
      |           |                   | U+FFFD (�)                 |
      +-----------+-------------------+----------------------------+
      | ?a=x&&&&  | ?a=x              | Parsing splits on & and    |
      |           |                   | discards empty strings     |
      +-----------+-------------------+----------------------------+
      | ?a=       | ?a                | Both parse as having an    |
      |           |                   | empty string value for a   |
      +-----------+-------------------+----------------------------+
      | ?a=%20    | ?a= &             | %20 is parsed as U+0020    |
      |           |                   | SPACE                      |
      +-----------+-------------------+----------------------------+
      | ?a=+      | ?a= &             | + is parsed as U+0020      |
      |           |                   | SPACE                      |
      +-----------+-------------------+----------------------------+

[reschke]

FWIW: puttig nbsps into the source code to optimize HTML output sounds very wrong (this is an xml2rfc/kramdown comment). It should not be needed.

[martinthomson]

I agree with Julian. Have you considered "First Query", "Second Query"?

[reschke]

FWIW, I removed the nbesps, and xml2rfc's output is:

So maybe it's just a CSS problem? In any case, no reason for these kinds of workarounds.

[martinthomson]

It's a CSS issue, at least in part. xml2rfc will do the same if the window is narrow enough. The problem is a lack of a means of signaling that you want less wrapping.

You can avoid the wrapping with less text in the third column, a wider table, or many other things. But what we really need is something like a wrap-avoiding span element.

[nidhijaju]

Thanks for the feedback, just merged #3381 to remove the &nbsps and use "First Query" and "Second Query".