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

[Style guide] Whether to quote values like user names in texts #31980

Open
PVince81 opened this issue Jul 4, 2018 · 5 comments
Open

[Style guide] Whether to quote values like user names in texts #31980

PVince81 opened this issue Jul 4, 2018 · 5 comments

Comments

@PVince81
Copy link
Contributor

PVince81 commented Jul 4, 2018

In various places in ownCloud, some texts are using double quotes around user display names and in others they aren't.

We should decide what approach to take as a style guide and adjust everywhere.

Case for double quotes

The user "Patrick Maier" shared "project ideas" with you

Pros

  • Clear delimitation from the surrounding text:

Cons

  • Doesn't flow well with the text
  • Looks technical

Case for having no delimiter

The user Patrick Maier shared project ideas with you

Pros

  • Looks user friendly

Cons

  • For some special names the result might become confusing: The user "user one" shared "folder" with you vs The user user one shared folder with you

Open questions

  • should the quoting be different based on what kind of value it is ? ex: path name vs user name

@jvillafanez @pmaier1

@felixheidecke I'd appreciate your UX input on this

@PVince81
Copy link
Contributor Author

PVince81 commented Jul 4, 2018

Or we need to reconsider our wording style to make it flow better with arbitrary names.

@ownclouders
Copy link
Contributor

GitMate.io thinks possibly related issues are #12425 (Hide users name from sharing text field.), #27007 (Get to see all user names), #5612 (Requesst: User Full Name), #28339 (Wrong Quote Text in personal settings), and #12998 (User Management).

@pmaier1
Copy link
Contributor

pmaier1 commented Jul 6, 2018

The user "Patrick Maier" shared "project ideas" with you

In general I like to keep things simple. This means keeping text short and use highlighting for user names or files.

For the example I would prefer: Patrick Maier shared "project ideas" with you.

Platform-dynamic parts are indicated: User names are bold, files are indicated with double quotes (as they might have a file extension and/or look technical anyway)

@PVince81
Copy link
Contributor Author

Great, that could work.

The exception is in plain text locations like plain text emails.

@pmaier1
Copy link
Contributor

pmaier1 commented Jul 17, 2018

The exception is in plain text locations like plain text emails.

Yes, then we should simply output the user name without highlighting, IMO.

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

No branches or pull requests

3 participants