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

Audio "Preload" settings copy in the editor are unclear #7726

Closed
tofumatt opened this issue Jul 5, 2018 · 15 comments
Closed

Audio "Preload" settings copy in the editor are unclear #7726

tofumatt opened this issue Jul 5, 2018 · 15 comments
Labels
[Block] Audio Affects the Audio Block Needs Copy Review Needs review of user-facing copy (language, phrasing) Needs Decision Needs a decision to be actionable or relevant [Type] Copy Issues or PRs that need copy editing assistance

Comments

@tofumatt
Copy link
Member

tofumatt commented Jul 5, 2018

The audio preload settings are unclear because they are exposing implementation details from the <audio> tag. Instead of "Auto" and "Metadata", something like "Content" and "Metadata only".

See: #7590 (comment)

@tofumatt tofumatt added the [Type] Copy Issues or PRs that need copy editing assistance label Jul 5, 2018
@tofumatt tofumatt self-assigned this Jul 5, 2018
@sarahmonster sarahmonster mentioned this issue Jan 28, 2019
8 tasks
@nerrad nerrad added [Type] Copy Issues or PRs that need copy editing assistance and removed [Type] Copy Issues or PRs that need copy editing assistance labels Apr 28, 2019
@mapk
Copy link
Contributor

mapk commented May 30, 2019

It took me a second to figure out what was being discussed here, so I'm including a screencast of the Audio block's Inspector settings.

audio

@melchoyce
Copy link
Contributor

melchoyce commented Jun 12, 2019

This could be a good opportunity to add some help text, since this isn't a very intuitive setting:

image

Edit: btw, the external link would lead to https://wordpress.org/support/article/audio-shortcode/#options.

@melchoyce melchoyce added the Needs Design Feedback Needs general design feedback. label Jun 12, 2019
@chrisvanpatten
Copy link
Member

One other note might be that you can also opt to not provide a preload setting. If you don't provide the setting, it allows the browser to determine how they want to preload the data. (Chrome uses "metadata" by default, for instance.)

Not sure how that might look — a "reset" button or something like that?

@melchoyce
Copy link
Contributor

I wonder if "browser default" is worth adding as a fourth, default option in that case?

@mapk
Copy link
Contributor

mapk commented Jun 13, 2019

While I think the additional text helps, it feels like a lot to read. Here's a pass at trimming it down. We also call it "Preload" and then mention "Load." Does that cause any confusion?

Preload

  1. File and metadata
  2. Metadata only (ie. title, artist, etc.)
  3. Don't load anything

I'm not sure it helps, but just thinking through options.

@melchoyce melchoyce added the Needs Copy Review Needs review of user-facing copy (language, phrasing) label Jun 13, 2019
@michelleweber
Copy link

I don't love the preload/load thing; the preload seems a little pointless here, since functionally we're using preload/load to mean the same thing here and it's not like there are other load-specific settings that need to be distinguished. If we're going to use both terms, they should mean two different things.

For me, a relatively non-technical person, what would be more helpful than text explaining each choice would be text explaining why I should care about this options / why I'd make one choice over another -- all the help text in the world doesn't actually help me if it doesn't help me decide. That then gives context to the options, so you don't have to include help text for every option. So something like:

File Options
Decide how much of the audio file preloads with the page. The less you preload, the faster your page load speed.

  • Preload audio and metadata

  • Preload metadata only

  • Don't preload anything

@melchoyce
Copy link
Contributor

Thanks @michelleweber, this helps a lot.

Here's the revised copy:

image

I still think we need to somehow explain what "metadata" entails.

@michelleweber
Copy link

You could avoid metadata altogether and call it something like "Title and artist info" -- I know it's not 100% accurate, but I'm not sure it matters? Otherwise, I think explaining adds too much text, and I feel like you should rely on the link to do the explaining for you.

@melchoyce
Copy link
Contributor

I wonder if we could use abbr to define metadata, or if that would be breaking the rules?

@melchoyce
Copy link
Contributor

Minor copy adjustments:

image

@sarahmonster
Copy link
Member

It feels like this is moving toward the right direction here—this is such a complicated concept to explain well! Maybe instead of "File Options", we call it "Load Options" or "Preload Options"?

Instead of "The less you preload...." we could put load speeds next to each option, so:

  • Preload everything (slow)
  • Preload file information (medium)
  • Preload nothing (fast)
@mapk
Copy link
Contributor

mapk commented Jun 14, 2019

Instead of "The less you preload...." we could put load speeds next to each option

What would each of those speeds be relative to? "Preload nothing" is fast when loading the page, but slower when trying to load the actual audio file. This could still work, but I feel if we remove that second sentence from the description, it becomes a bit too vague.

@chrisvanpatten
Copy link
Member

And also, as a reminder, these are only hints for the browser. Depending on your browser and configuration, browsers are allowed to completely ignore this setting and download whatever they want.

Suggest that browsers preload some or all of your audio file when your page is opened.

@melchoyce
Copy link
Contributor

melchoyce commented Jun 14, 2019

Let's not overthink this — the goal is to explain what this setting is, and why it matters. We don't need to get super specific, and we can put technical details and additional information in the documentation.

@melchoyce melchoyce added Needs Decision Needs a decision to be actionable or relevant and removed Needs Design Feedback Needs general design feedback. labels Jul 9, 2019
@tofumatt tofumatt removed their assignment Sep 3, 2019
@Soean Soean added the [Block] Audio Affects the Audio Block label Jan 13, 2020
@mtias
Copy link
Member

mtias commented Jul 2, 2024

Closing this for now, if we run into some better suggestions we can always revisit.

@mtias mtias closed this as not planned Won't fix, can't repro, duplicate, stale Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Audio Affects the Audio Block Needs Copy Review Needs review of user-facing copy (language, phrasing) Needs Decision Needs a decision to be actionable or relevant [Type] Copy Issues or PRs that need copy editing assistance
9 participants