xml2rfc icon indicating copy to clipboard operation
xml2rfc copied to clipboard

Footer components can overlap in v2 text output

Open ietf-svn-bot opened this issue 6 years ago • 12 comments

type_defect | by [email protected]


See draft-mahesh-etsi-urn-03. The footer generated by versions up to 2.10.3 looks as follows:

Jethanandani & Angel ReiExpiresgDecember 10, 2018               [Page 1]

which overlays the expiry information on part of the author names.


Issue migrated from trac:377 at 2022-02-05 12:46:31 +0000

ietf-svn-bot avatar Sep 25 '18 12:09 ietf-svn-bot

@[email protected] changed status from new to under_review

ietf-svn-bot avatar Mar 10 '20 16:03 ietf-svn-bot

@[email protected] commented


This is likely much better in v3, but a test will have to be built to verify whether there's more to do.

ietf-svn-bot avatar Mar 10 '20 16:03 ietf-svn-bot

@[email protected] changed status from under_review to assigned

ietf-svn-bot avatar Feb 10 '21 17:02 ietf-svn-bot

@[email protected] changed owner from [email protected] to ``

ietf-svn-bot avatar Feb 10 '21 17:02 ietf-svn-bot

@[email protected] changed status from assigned to accepted

ietf-svn-bot avatar Feb 10 '21 17:02 ietf-svn-bot

@[email protected] changed status from accepted to under_review

ietf-svn-bot avatar Feb 10 '21 17:02 ietf-svn-bot

v3 seems to behave in a similar way.

kesara avatar May 26 '22 23:05 kesara

Suggest truncate and notify, don't try anything more clever than that.

jrlevine avatar Jun 20 '22 20:06 jrlevine

That makes sense. Can we close this issue?

stpeter avatar Aug 08 '22 20:08 stpeter

xml2rfc doesn't warn/notify about this yet. We have to add a warning when the footer component gets truncated.

Also, the current footer generation is buggy:

Jethanandani & Angel ReiExpiresg10 December 2018                [Page 1]

Where it should be:

Jethanandani & Angel Re Expires 10 December 2018                [Page 1]

kesara avatar Aug 08 '22 21:08 kesara

The truncation should end with an ellipsis so that the reader is aware that the text has been truncated. As per the Chicago Manual of Style there should not be a space or other punctuation before the ellipsis.

Jethanandani & Angel... Expires 10 December 2018                [Page 1]

JayDaley avatar Sep 13 '22 13:09 JayDaley

Although "et al." is typically used with more than 2 authors, the current version of the Chicago Manual of Style suggests using "et al." to shorten the author list in a footer when there's more than one author [1]:

the author’s surname or, for more than one author, a shortened version of the author list (such as Aldrich et al.);

Note that it is RFC style to place a comma after the author name, e.g., "Johnston, et al.".

[1] https://www.chicagomanualofstyle.org/book/ed17/part1/ch01/psec083.html (paywalled)

ajeanmahoney avatar Aug 29 '23 21:08 ajeanmahoney