Some updates to strings

Created on 26 May 2020, about 4 years ago
Updated 1 September 2023, 10 months ago

I see that the 8.x version of Stage File Proxy has better labels and descriptions than 7.x, but there is still room for improvement.

My suggestions for the labels:

"Origin website" > "Origin base URL" (* or just "Origin" to keep the logical connection to the variable stage_file_proxy_origin)
"Verify SSL" > "Verify SSL certificate"
"Origin directory" > "Origin file directory"
"Imagecache Root" > "Locally refresh images processed with ImageCache"
"Hotlink" > "Hotlink images"

Also, the descriptions could be shorter and clearer. Here are my suggestions. If I got any of the features wrong, feel free to improve my descriptions. I've tried to aim for clarity, less text and less technical jargon.

–-

For "Origin base URL"/"Origin":

The remote site from which to download files. Exclude the trailing slash. Example: 'https://www.example.com'

If the origin website is using HTTP Basic Authentication (that is, if you must enter a username and password in a popup to reach it in the browser) you can embed the username and password in the base URL. Any special characters in the URL must be URL encoded. Example: If the username is 'myusername' and the password is 'my&password', enter 'http://myusername:my%26password@example.com'.

(* Maybe "Exclude the trailing slash." is not needed in 8.x?)
–-

For "Origin system path for file directory":

The directory on the remote site from where files are downloaded. The default is the same as the local site's system path for public files, as seen on the [File system settings page](/admin/config/media/file-system). If the site is part of a multisite setup, this directory might need to be changed.

(* I'm not sure about the last sentence. I'd like a clarifying example. For a multisite setup with a sites/default/ directory and a sites/mysubsite/ directory, wouldn't the file directory setting for the default site be sites/default/files/ and for the subsite site be sites/mysubsite/files, and wouldn't they just be carried over correctly for each site from the file system settings to the Stage File Proxy settings? I just don't get when you would need to change the default. But of course I realise that there must be a reason for this option to exist!)

–-

For "Locally refresh images processed with ImageCache":

When this box is checked, Stage File Proxy will for images processed by the ImageCache module first download the unprocessed original and then tell the browser to refresh the processed image. ImageCache will then reprocess the image using the downloaded original. This will speed up future ImageCache requests for the same original file.

–-

For "Hotlink images":

When this box is checked, Stage File Proxy will load images through redirects instead of downloading them. This will save space in the local environment.

–-

I also think that this description could be clarified: "Verifies the validity of the SSL certificate presented by the server when checked (if HTTPS is used)."
- when what is checked? maybe just remove "when checked"?
- maybe also remove "presented by the server"? who else would present it?
- why is "(if HTTPS is used)" within parentheses?
- why would you want to check this checkbox? the other checkboxe's descriptions all state why you'd want to check the boxes.
I'm not an expert at SSL, but my suggestion:
"If the remote site uses HTTPS, Stage File Proxy will verify the validity of its SSL certificate." and also "This will make sure that …" or "This will prevent …" or something.

πŸ“Œ Task
Status

Closed: outdated

Version

2.0

Component

User interface

Created by

πŸ‡ΈπŸ‡ͺSweden zhouhana

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.69.0 2024