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

Formatting of italicized items in plain text version #2135

Closed
yaronf opened this issue May 27, 2022 · 8 comments · Fixed by #2143
Closed

Formatting of italicized items in plain text version #2135

yaronf opened this issue May 27, 2022 · 8 comments · Fixed by #2143

Comments

@yaronf
Copy link
Contributor

yaronf commented May 27, 2022

In sec. 2.2.9 there are some spurious underscores around component names.

cc: @jricher

@jricher
Copy link
Contributor

jricher commented May 27, 2022

@yaronf
Copy link
Contributor Author

yaronf commented May 27, 2022 via email

@jricher
Copy link
Contributor

jricher commented May 27, 2022

The underscores are what make it italicized in the HTML version, there must be a bug in the xml2rfc processing chain from markdown forward.

@martinthomson
Copy link
Contributor

In text (page 24):

   _baz:_ batman

   _qux:_ an empty string

   _param:_ value

@jricher
Copy link
Contributor

jricher commented May 30, 2022

The underscores are not in the source:

*baz:* `batman`

*qux:* an empty string

*param:* `value`

https://github.com/httpwg/http-extensions/blame/main/draft-ietf-httpbis-message-signatures.md#L755-L763

So I'm really not sure what we need to do to fix the text renderer, apart from just not using italics anymore.

@reschke
Copy link
Contributor

reschke commented May 30, 2022

...or alternatively, just ignore the plain text version. Changing the plain text rendering of xml2rfc at this point will be hard.

@jricher jricher changed the title Signatures: typos Formatting of italicized items in plain text version May 30, 2022
@martinthomson
Copy link
Contributor

martinthomson commented May 30, 2022

You might at least try *baz*: so that the decorations surround the name and not the colon.

@jricher
Copy link
Contributor

jricher commented May 31, 2022

@martinthomson already have that in my editor's copy, and that does look better at least in both formats. I think I'll close this issue with that resolution unless there's a better suggestion.

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

Successfully merging a pull request may close this issue.

4 participants