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

feat: add support for display of differing fullname and asciiFullname #8178

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Spectre17
Copy link
Collaborator

This is used, for example, when the fullname uses extended UTF-8 characters and it's helpful to also include the asciiFullname for those who cannot read the UTF-8 name. The form is:

fullname (asciiFullname)

This came up in issue #7167, which noted that the announcement email generated when a new Internet-Draft is uploaded, it only showed the fullname despite the draft itself containing both name forms.

Change the render_author_name test set for the revised name format.

This is used, for example, when the fullname uses extended UTF-8
characters and it's helpful to also include the asciiFullname for
those who cannot read the UTF-8 name. The form is:

fullname (asciiFullname)

This came up in issue ietf-tools#7167, which noted that the announcement email
generated when a new Internet-Draft is uploaded, it only showed the
fullname despite the draft itself containing both name forms.

Change the render_author_name test set for the revised name format.
Copy link
Member

@jennifer-richards jennifer-richards left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not approving or requesting changes, wondering whether we need to handle the fullname vs asciiFullname check with more subtlety.

@@ -193,6 +193,9 @@ def render_author_name(author_elt):
# Use fullname attribute, if present
fullname = author_elt.attrib.get("fullname", "").strip()
if fullname:
asciifullname = author_elt.attrib.get("asciiFullname", "").strip()
if asciifullname and asciifullname != fullname:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure that literal equality is the right test. In xml2rfc, a method is used to check whether a name is in Latin script and the ascii name is appended if not. That might better reflect when the asciiName is needed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably look at a bunch of drafts and see how often we're going to add extra text to a name already legible to someone who can read the rest of the draft.

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

Successfully merging this pull request may close these issues.

2 participants