Project

General

Profile

Feature #13347

Add Preferred Gender Pronouns to CAC Profile

Added by Matt Gold about 1 year ago. Updated 11 months ago.

Status:
Resolved
Priority name:
Normal
Assignee:
Category name:
Public Portfolio
Target version:
Start date:
2020-09-18
Due date:
% Done:

0%

Estimated time:

Description

Following today's CAC Subcommittee meeting and Elvis's suggestion, we should add a field to the CAC profiles for preferred gender pronouns. Following the example of the City Tech OpenLab, this should be a blank field rather than a structured set of options.

As Jody pointed out, we should also consider how and whether the preferred pronouns should show up in other parts of the commons, such as activities feeds. One could imagine adding the preferred pronouns (if added) in parentheses after the person's name (e.g. Matthew K. Gold (he/his/him) ), though I am sure there are complications to think through, especially with a blank unstructured field as an option.

Screenshot_2020-09-21_10-39-52.png (345 KB) Screenshot_2020-09-21_10-39-52.png Boone Gorges, 2020-09-21 11:39 AM
OpenLab_Profile_1.png (95.9 KB) OpenLab_Profile_1.png Elvis Bakaitis, 2020-09-22 02:45 PM
Screenshot_2020-09-22_14-35-27.png (361 KB) Screenshot_2020-09-22_14-35-27.png profile 1 Boone Gorges, 2020-09-22 03:43 PM
Screenshot_2020-09-22_14-36-54.png (351 KB) Screenshot_2020-09-22_14-36-54.png profile 2 Boone Gorges, 2020-09-22 03:43 PM
Screenshot_2020-09-22_14-38-37.png (365 KB) Screenshot_2020-09-22_14-38-37.png profile 3 Boone Gorges, 2020-09-22 03:43 PM
Screenshot_2020-09-22_14-44-14.png (84 KB) Screenshot_2020-09-22_14-44-14.png blog author Boone Gorges, 2020-09-22 03:46 PM
Screenshot_2020-09-22_14-41-17.png (126 KB) Screenshot_2020-09-22_14-41-17.png activity author Boone Gorges, 2020-09-22 03:46 PM
Screenshot_2020-09-22_14-42-43.png (71.9 KB) Screenshot_2020-09-22_14-42-43.png forum 1 Boone Gorges, 2020-09-22 03:46 PM
Screenshot_2020-09-22_14-43-25.png (72 KB) Screenshot_2020-09-22_14-43-25.png forum 2 Boone Gorges, 2020-09-22 03:46 PM
Screenshot_2020-10-09_14-11-36.png (12.3 KB) Screenshot_2020-10-09_14-11-36.png Boone Gorges, 2020-10-09 10:47 AM
Screenshot_2020-10-09_14-35-14.png (42.5 KB) Screenshot_2020-10-09_14-35-14.png Boone Gorges, 2020-10-09 10:47 AM
Screenshot_2020-10-09_14-10-58.png (36.9 KB) Screenshot_2020-10-09_14-10-58.png Boone Gorges, 2020-10-09 10:47 AM
Screenshot_2020-10-09_14-10-20.png (44.4 KB) Screenshot_2020-10-09_14-10-20.png Boone Gorges, 2020-10-09 10:47 AM
Screenshot_2020-10-09_14-08-31.png (164 KB) Screenshot_2020-10-09_14-08-31.png Boone Gorges, 2020-10-09 10:47 AM
Screenshot_2020-10-09_14-09-53.png (356 KB) Screenshot_2020-10-09_14-09-53.png Boone Gorges, 2020-10-09 10:47 AM
Peek 2020-10-09 14-09.gif (93.7 KB) Peek 2020-10-09 14-09.gif Boone Gorges, 2020-10-09 10:48 AM
Recording #6.mp4 (986 KB) Recording #6.mp4 Laurie Hurson, 2020-11-04 11:19 AM

Related issues

Related to CUNY Academic Commons - Design/UX #14884: Pronoun visibilityNew2021-10-19

History

#1 Updated by Boone Gorges about 1 year ago

Adding a free-entry field to edit mode on user profiles and registration is easy to do. Deciding what to do with this information is more complex.

At minimum, we would likely want to show the information on the user's profile. The easiest place to slot the information is as another row alongside 'Follow Me Online', 'Contact', etc. See screenshot.

Displaying the information throughout the site is more complicated. Presumably the logic would be: if the user has provided pronouns, append them to the display name anywhere we create a user link throughout the site. But, as you suggest, this raises issues with length and consistency:
- We may want to impose a character limit
- We may want to do some sort of character sanitization and format normalization. If I enter "he his him", should it be changed to "he/his/him"? How about "he / his / him" (eliminate excess spaces)? How about "he-his-him" (standardize on the separating characters)? Think about, for example, the way that telephone number inputs work.
- Presumably we will also strip user-entered parentheses, so that when we introduce our own inline, we don't get duplicates. That is, "(he/his/him)" becomes "he/his/him", so that we can re-add the parens when we generate the user links.
- Good inline documentation when registering/editing will probably go a long way. Something like "Eg 'he/his/him', 'they/their/them'" might be enough to nudge users into using proper formatting.

As noted above, it's trivial to add a new field, and pretty easy to make it display as desired on the profile. So we might consider rolling out just this in the short term, and tackling the other issue (display throughout the site) separately. However, I think the impact would be much more if we dropped it all at once, as part of a release that would give us a platform for announcing the change.

#2 Updated by Matt Gold about 1 year ago

Thanks, Boone. Elvis has kindly agreed to share their thoughts about this feature. Elvis, please let us know what you think about both the issue of where to place preferred pronouns on the profile page and also the more complex issues that Boone has brought up about how preferred pronouns show up elsewhere as a user engages the Commons

#3 Updated by Elvis Bakaitis about 1 year ago

Hello Matt and Boone,

Thank you for the invitation to this conversation, and much appreciated that the idea is being considered.

One question: Instead of adding the pronouns to the footer (near the social media icons), would it be possible to add them somewhere above the horizontal line that divides the page? For example, to the right or directly below the person's title.

In terms of adding the pronouns throughout the site, it might be good to consider the context of where they would then appear...and also to make a note about this, so users know that if they add pronouns, they will be pre-populated in various locations.

I hope these ideas are useful; thank you!
Sincerely,
Elvis

#4 Updated by Elvis Bakaitis about 1 year ago

(Also, just to show an example of where pronouns appear in the OpenLab, see attached screenshot.)

#5 Updated by Boone Gorges about 1 year ago

Thanks for chiming in, Elvis!

One question: Instead of adding the pronouns to the footer (near the social media icons), would it be possible to add them somewhere above the horizontal line that divides the page? For example, to the right or directly below the person's title.

Yeah, I was kinda thinking the same thing. The area containing the social media icons is mainly about contact info (URL, email, etc), but preferred pronouns is not a type of contact info. I've attached three 'profile' mockups that show a couple different ideas about where we might fit into user profiles.

In terms of adding the pronouns throughout the site, it might be good to consider the context of where they would then appear...and also to make a note about this, so users know that if they add pronouns, they will be pre-populated in various locations.

Yes, we definitely want to make it clear to users. I've mocked up a couple examples of where user names appear throughout the Commons, so you can see what it might look like to append pronouns to the user names. User names look different in different areas, and the easiest thing to do is to append pronouns in the same format throughout. But there are some cases where the specific formatting of the user name suggests alternative ways of displaying the pronouns "metadata", such as the case of group forums (that's my 'forum 2' mockup). Hopefully this is a good starting point for discussion about how/where to display the info.

Sonja, I've added you as a watcher in case you have thoughts about best practices. I don't want to bog you down with the minutiae of this task if you are bogged down with other tasks :-D

#6 Updated by Matt Gold about 1 year ago

Thanks, Boone. I'd like to see where others land on the question of profile page placement, but I do want to say that I like the look of how this might appear in the various other contexts you've shared here.

#7 Updated by Elvis Bakaitis about 1 year ago

Hello Boone - these are great! I like the first two mockups, where the pronouns are hovering in that top area, in gray.

Also seconding the idea of including others' feedback; I'm curious how Jody from the OpenLab was thinking about the topic of pronouns that appear in different locations around the site.

Thank you;
Sincerely,
Elvis

#8 Updated by Boone Gorges about 1 year ago

  • Category name set to Public Portfolio

#9 Updated by Colin McDonald about 1 year ago

Thanks for this initial work, Boone. I like the pronoun field next to the name on the profile page, for readability and concision as much as anything. On the internal pages, I think the placements all make sense, though I'm not sure I'd have them hyperlinked when next to a hyperlinked name. Plain text seems fine and keeps the link from looking too long. I'd be interested to hear what Sonja thinks too, when possible.

#10 Updated by Boone Gorges about 1 year ago

though I'm not sure I'd have them hyperlinked when next to a hyperlinked name. Plain text seems fine and keeps the link from looking too long.

Not hyperlinking is harder than hyperlinking, so if there's no strong feeling one way or another, I'd prefer to lump it in with the display name as part of the links.

#11 Updated by Colin McDonald about 1 year ago

Works for me, not crucial at all. Thanks for clarifying.

#12 Updated by Boone Gorges about 1 year ago

Hi Sonja - You mentioned last week that you would have a look at my mockups and chime in with an opinion about pronoun placement. Could you please take a few minutes to think about this and provide any feedback? I think it should be pretty quick for you to think through the implications, and your feedback would be very valuable. Then I can move forward with implementation.

#13 Updated by Sonja Leix about 1 year ago

Thanks for working on the initial suggestions, Boone! Those look great! I have some thoughts on where I feel the pronoun is best displayed. Having the gender pronouns displayed in brackets works best – e.g. (she/her).

On the profile page, I personally like it displayed right next to or below the name, instead of having it spelled out in the section below.
In the forum, I like it better as part of the name, rather than below the role (e.g. "participant"), so I like this version better of the two: https://redmine.gc.cuny.edu/attachments/15859/Screenshot_2020-09-22_14-42-43.png
The other screenshots look great!

Thanks for this and sorry for the delayed response.

#14 Updated by Boone Gorges about 1 year ago

  • Status changed from Reporter Feedback to Assigned

Thanks, Sonja! I will work up a first version for testing on cdev.

#15 Updated by Boone Gorges about 1 year ago

I've completed a first pass at this functionality. Some screenshots are attached, as is a brief gif that illustrates the client-side sanitization of user input. Some implementation notes and questions:

1. When editing, I placed the new field just below 'Full Name', near the top of the left-hand column. I called it 'Preferred Gender Pronouns' and gave it the following description: Separate with slashes. E.g. he/him/his, they/them/their. Feedback welcome on any of these decisions.

2. As noted above, I'm doing some sanitization and standardization of user input when editing the profile. Spaces are removed, hyphens and backslashes are changed to slashes, other non-alphanumeric characters are removed, parentheses/brackets are removed.

3. By using the WP filter get_the_author_display_name, I'm able to append the pronouns in most contexts. BuddyPress and bbPress both pass usernames through this filter. And many modern WordPress themes use some version of this function to display author metadata. However, my poking around has shown a few places on WP sites where the name shows up without pronouns. I want to be conservative about additional filtering of display names; the more places where I add the pronouns, the greater the danger of double-adding the pronouns, or causing other problems. As we test this feature, please take note of specific places where names are showing up without pronouns - including URLs, because it may be a theme-specific issue - and we can decide on a case-by-case basis whether it's prudent to fix.

#16 Updated by Matt Gold about 1 year ago

Thanks, Boone. The sanitization seems good and reasonable to me.

#17 Updated by Sonja Leix about 1 year ago

Looks great to me, Boone. I'm curious to see if people are looking to use the field a little more free form than (she/her) and get annoyed with the sanitation, but I think it's a good way to keep it clean and uniform! Good call.

#18 Updated by Elvis Bakaitis about 1 year ago

Hi everyone - looks great! I like the placement next to the name, in the profile page.

Thank you, and happy to help share out once this update takes place.

Sincerely,
Elvis

#19 Updated by Boone Gorges about 1 year ago

  • Status changed from Assigned to Testing Required

Awesome - thanks to all for your feedback! I'll change the status so that we remember to include this in pre-release testing.

#20 Updated by Laurie Hurson 12 months ago

Hi All,

Just tested this and noticed that when I use dashes between pronouns, it autocorrects (correctly) to /slashes/ but if I just space between pronouns it autocorrects incorrectly to lumping all pronouns together. Maybe that's a bug? I think it would make more sense if spaces autocorrect to slashes the same way dashes do.

Video attached.

#21 Updated by Boone Gorges 12 months ago

Thanks, Laurie! It hadn't occurred to me that people would use the space as a separator, but after reading your comment it seems obvious :) I've made the suggested change in https://github.com/cuny-academic-commons/cac/commit/8749ca6cccb24a4591f3c4ff52a3897fa174afc7.

#22 Updated by Laurie Hurson 12 months ago

Thanks Boone!

#23 Updated by Colin McDonald 11 months ago

Quick note from testing - in Group Library, the pronouns are hyperlinked as well as the user name in the Library view. Might it look better to just hyperlink the name? Perhaps we can defer to Sonja on this, but it's pretty minor so I think is workable either way.

#24 Updated by Boone Gorges 11 months ago

Technically it is much more complicated to make it unlinked text. This is because I am filtering the user name, which is used to build the links, and provides a single point of modification. User links are built in many varied ways and so would require a much more complex approach. If this is a minor suggestion, I'd recommend rejecting it for this reason.

#25 Updated by Boone Gorges 11 months ago

  • Status changed from Testing Required to Resolved

#26 Updated by Colin McDonald 4 days ago

Also available in: Atom PDF