blender/blender

UI: replace "copy/paste buffer" by "internal clipboard" #106060

Merged

Sybren A. Stüvel merged 2 commits from pioverfour/blender:dp_rename_copy_buffer into main

2023-04-14 12:12:44 +02:00

Damien Picard commented

2023-03-23 22:58:56 +01:00

Member

A buffer is a technical term most often referred to using the metaphor
of a "clipboard" in applications. However, the "clipboard" is usually
the system clipboard, used to carry data accross applications. To
avoid confusion, this replaces "clipboard" by "internal clipboard"
when not dealing with the system clipboard.

In addition, a few places still used the "[copy/paste] buffer"
terminology, so they are replaced with "internal clipboard as well.

The replacement from "[copy/paste] buffer" to "clipboard" was
undertaken in previous commits da6d6f99a8, 14b60c3a1c. This
commit should tackle the remaining occurrences.

A buffer is a technical term most often referred to using the metaphor of a "clipboard" in applications. However, the "clipboard" is usually the system clipboard, used to carry data accross applications. To avoid confusion, this replaces "clipboard" by "internal clipboard" when not dealing with the system clipboard. In addition, a few places still used the "[copy/paste] buffer" terminology, so they are replaced with "internal clipboard as well. The replacement from "[copy/paste] buffer" to "clipboard" was undertaken in previous commits da6d6f99a88eb, 14b60c3a1caf. This commit should tackle the remaining occurrences.

Damien Picard added the

Animation & Rigging

labels 2023-03-23 22:58:56 +01:00

Damien Picard added this to the User Interface project 2023-03-23 22:59:09 +01:00

Damien Picard requested review from Sybren A. Stüvel 2023-03-23 23:02:49 +01:00

Damien Picard commented

2023-03-23 23:03:33 +01:00

Author

Member

@dr.sybren Hi, I’m assigning this to you because it’s mostly about animation, but there is one similar change related to Freestyle, and one about modeling.

@dr.sybren Hi, I’m assigning this to you because it’s mostly about animation, but there is one similar change related to Freestyle, and one about modeling.

Damien Picard force-pushed dp_rename_copy_buffer from 01556db70e to 189ed1cdac

2023-03-23 23:09:26 +01:00

Compare

Damien Picard commented

2023-03-23 23:10:36 +01:00

Author

Member

Oh, and I see that in the review for D16131 a similar change was rejected, but then the developer argued for it and I’m not sure what the result of this discussion was!

Oh, and I see that in the review for [D16131](https://archive.blender.org/developer/D16131) a similar change was rejected, but then the developer argued for it and I’m not sure what the result of this discussion was!

Sybren A. Stüvel commented

2023-03-24 11:57:26 +01:00

Member

To have the historical discussion available here:

Me:

I don't think we should do this change. Not all "copy/paste buffers" of Blender actually use the system clipboard. For example, when copy-pasting an object between blend files, nothing actually gets stored on the clipboard -- "copy" just saves the object to a file in a specific location, and "paste" loads that file.

Palestrina12:

I disagree because technically what you're saying makes sense but for a user the word buffer is practically gibberish. The only context they might be aware of it in is in buffering of a video. (Obviously more technical users immediately understand)

I'm wondering if it runs afoul of this guideline:

Do not use implementation specific language.

I do agree that "copy buffer" is vague, and even for technical people it doesn't mean that much.

I'll poke some people in the Animation & Rigging module to get some more opinions.

To have the historical discussion available here: Me: > I don't think we should do this change. Not all "copy/paste buffers" of Blender actually use the system clipboard. For example, when copy-pasting an object between blend files, nothing actually gets stored on the clipboard -- "copy" just saves the object to a file in a specific location, and "paste" loads that file. Palestrina12: > I disagree because technically what you're saying makes sense but for a user the word buffer is practically gibberish. The only context they might be aware of it in is in buffering of a video. (Obviously more technical users immediately understand) > > I'm wondering if it runs afoul of this guideline: > > Do not use implementation specific language. I do agree that "copy buffer" is vague, and even for technical people it doesn't mean that much. I'll poke some people in the Animation & Rigging module to get some more opinions.

Christoph Lendenfeld commented

2023-03-24 12:32:52 +01:00

Member

maybe I am too technical for this, but I like the distinction between clipboard and buffer.
Clipboard usually refers to the System clipboard and if that's not where the data is stored it might lead to wrong expectations

maybe I am too technical for this, but I like the distinction between clipboard and buffer. Clipboard usually refers to the System clipboard and if that's not where the data is stored it might lead to wrong expectations

Damien Picard commented

2023-03-24 12:49:02 +01:00

Author

Member

maybe I am too technical for this, but I like the distinction between clipboard and buffer.
Clipboard usually refers to the System clipboard and if that's not where the data is stored it might lead to wrong expectations

I personally don’t mind, but more importantly, in Blender “clipboard” is more the norm than the exception:

"Paste tracks from clipboard" [VSE]
"Copy selected strips to clipboard" [VSE]
"Copy to Clipboard" [nodes]
"Copy selected splines to clipboard" [masks]
~~"Copies the matrix of the currently active object or pose bone to the clipboard. Uses world-space matrices" [animation]~~
"Selected data-blocks are copied to the clipboard" [outliner]
"Create a new pose asset on the clipboard, to be pasted into an Asset Browser" [assets]

None of these use the system clipboard.
EDIT: the animation one uses the system clipboard.

> maybe I am too technical for this, but I like the distinction between clipboard and buffer. > Clipboard usually refers to the System clipboard and if that's not where the data is stored it might lead to wrong expectations I personally don’t mind, but more importantly, in Blender “clipboard” is more the norm than the exception: - "Paste tracks from clipboard" [VSE] - "Copy selected strips to clipboard" [VSE] - "Copy to Clipboard" [nodes] - "Copy selected splines to clipboard" [masks] - ~~"Copies the matrix of the currently active object or pose bone to the clipboard. Uses world-space matrices" [animation]~~ - "Selected data-blocks are copied to the clipboard" [outliner] - "Create a new pose asset on the clipboard, to be pasted into an Asset Browser" [assets] None of these use the system clipboard. EDIT: the animation one uses the system clipboard.

Sybren A. Stüvel commented

2023-04-06 12:04:59 +02:00

Member

This was discussed in last week's A&R module meeting. The consensus was that it's indeed a good idea to use the word 'Clipboard', but my concern that it doesn't quite behave like the system clipboard was also shared.

@pioverfour what would you think of a name like 'internal clipboard' or 'application clipboard'?

This was discussed in [last week's A&R module meeting](https://devtalk.blender.org/t/2023-03-30-animation-rigging-module-meeting/28530). The consensus was that it's indeed a good idea to use the word 'Clipboard', but my concern that it doesn't *quite* behave like the system clipboard was also shared. @pioverfour what would you think of a name like 'internal clipboard' or 'application clipboard'?

Damien Picard commented

2023-04-06 12:08:05 +02:00

Author

Member

what would you think of a name like 'internal clipboard' or 'application clipboard'?

That would be clearer, yes!

If that’s all right with you I’ll go over the codebase tonight and make the change for other occurrences, such as those I mentioned in the VSE, nodes, etc.

> what would you think of a name like 'internal clipboard' or 'application clipboard'? That would be clearer, yes! If that’s all right with you I’ll go over the codebase tonight and make the change for other occurrences, such as those I mentioned in the VSE, nodes, etc.

Damien Picard changed title from ~~UI: replace "copy/paste buffer" by "clipboard"~~ to WIP: UI: replace "copy/paste buffer" by "clipboard"

2023-04-06 12:08:10 +02:00

Damien Picard commented

2023-04-06 12:11:57 +02:00

Author

Member

Regarding the name, I find “internal” slightly clearer so I’d like to go with that.

Regarding the name, I find “internal” slightly clearer so I’d like to go with that.

Damien Picard force-pushed dp_rename_copy_buffer from 189ed1cdac to 352d289b99

2023-04-06 21:48:31 +02:00

Compare

Damien Picard changed title from ~~WIP: UI: replace "copy/paste buffer" by "clipboard"~~ to WIP: UI: replace "copy/paste buffer" by "internal clipboard"

2023-04-06 21:49:05 +02:00

Damien Picard force-pushed dp_rename_copy_buffer from 352d289b99 to 82c2852e0a

2023-04-06 21:57:55 +02:00

Compare

Damien Picard force-pushed dp_rename_copy_buffer from 82c2852e0a to d1760c917f

2023-04-06 21:59:06 +02:00

Compare

Damien Picard changed title from ~~WIP: UI: replace "copy/paste buffer" by "internal clipboard"~~ to UI: replace "copy/paste buffer" by "internal clipboard"

2023-04-06 22:01:29 +02:00

Damien Picard commented

2023-04-06 22:06:11 +02:00

Author

Member

I updated the PR so that other occurrences of "clipboard" are changed to "internal clipboard" as well, when relevant.

This makes the scope of the PR larger, but I split it into commits, so the larger change can be dropped for now, if unsure.

I took the opportunity to slightly rephrase some descriptions closer to the guidelines, like using the imperative and articles.

I updated the PR so that other occurrences of "clipboard" are changed to "internal clipboard" as well, when relevant. This makes the scope of the PR larger, but I split it into commits, so the larger change can be dropped for now, if unsure. I took the opportunity to slightly rephrase some descriptions closer to the [guidelines](https://wiki.blender.org/wiki/Human_Interface_Guidelines/Tooltips), like using the imperative and articles.

Sybren A. Stüvel commented

2023-04-07 12:29:08 +02:00

Member

Thanks, all these changes look good!

As for how we'll land those changes, I think that it's indeed good to keep the separate commits. The commit messages would need some more detail, though, as they are now just a one-liner that says what changed (but not why). Typically the PR description is what becomes the commit message.

Could you update the individual commits (as in, git rebase -i main, then mark them as 'reword' and edit the messages)? Please then also include Review: https://projects.blender.org/blender/blender/pulls/106060 in all three, so that it's clear what their history is.

Thanks, all these changes look good! As for how we'll land those changes, I think that it's indeed good to keep the separate commits. The commit messages would need some more detail, though, as they are now just a one-liner that says what changed (but not why). Typically the PR description is what becomes the commit message. Could you update the individual commits (as in, `git rebase -i main`, then mark them as 'reword' and edit the messages)? Please then also include `Review: https://projects.blender.org/blender/blender/pulls/106060` in all three, so that it's clear what their history is.

Damien Picard commented

2023-04-07 12:39:01 +02:00

Author

Member

As for how we'll land those changes, I think that it's indeed good to keep the separate commits.

Could you update the individual commits

Of course! I was expecting them to be squashed so I did the minimum. I still believe the first two commits should be squashed though, because the first commit becomes irrelevant once the chosen term has changed in the second one. But I’ll add details to the last commit.

> As for how we'll land those changes, I think that it's indeed good to keep the separate commits. > > Could you update the individual commits Of course! I was expecting them to be squashed so I did the minimum. I still believe the first two commits should be squashed though, because the first commit becomes irrelevant once the chosen term has changed in the second one. But I’ll add details to the last commit.

Sybren A. Stüvel commented

2023-04-07 12:48:20 +02:00

Member

If you could, please either make it two PRs then (so I can just do a squash-merge on both of them from the web interface) or do the squashing & updating of the commits yourself on this PR (so I can just do a rebase + fast-forward). Then we can land this puppy :)

If you could, please either make it two PRs then (so I can just do a squash-merge on both of them from the web interface) or do the squashing & updating of the commits yourself on this PR (so I can just do a rebase + fast-forward). Then we can land this puppy :)

Sybren A. Stüvel added

Animation & Rigging

and removed

Animation & Rigging

labels 2023-04-07 12:49:26 +02:00

Sybren A. Stüvel modified the project from User Interface to Animation & Rigging

2023-04-07 12:49:33 +02:00

Damien Picard referenced this issue from a commit

2023-04-07 13:01:16 +02:00

UI: replace "copy/paste buffer" with "internal clipboard"

Damien Picard referenced this issue from a commit

2023-04-07 13:01:16 +02:00

UI: replace "clipboard" with "internal clipboard" when relevant

Damien Picard force-pushed dp_rename_copy_buffer from d1760c917f to 6d8256ecdb

2023-04-07 13:01:20 +02:00

Compare

Damien Picard commented

2023-04-07 13:05:41 +02:00

Author

Member

No problem, the interactive rebase operation went well.

No problem, the interactive rebase operation went well.

Sybren A. Stüvel approved these changes 2023-04-14 12:12:19 +02:00

Sybren A. Stüvel left a comment

Member

For the record, in Blender Chat (#animation-module) there was a little discussion about 'internal clipboard' vs. 'Blender clipboard'. @pablovazquez wrote:

After discussing it a bit further with Dalai I think it's just fine to leave it as is, Internal clipboard, it's only for tooltips anyway. Operators should just be Copy and Paste, the user is never exposed to copying something to multiple types of clipboards anyway.

Thanks for the improvements @pioverfour !

For the record, in Blender Chat (`#animation-module`) there was a little discussion about 'internal clipboard' vs. 'Blender clipboard'. @pablovazquez wrote: > After discussing it a bit further with Dalai I think it's just fine to leave it as is, Internal clipboard, it's only for tooltips anyway. Operators should just be Copy and Paste, the user is never exposed to copying something to multiple types of clipboards anyway. Thanks for the improvements @pioverfour !

Sybren A. Stüvel referenced this issue from a commit

2023-04-14 12:12:43 +02:00

UI: replace "copy/paste buffer" by "internal clipboard"

Sybren A. Stüvel merged commit 84e216fcee into main

2023-04-14 12:12:44 +02:00

Sybren A. Stüvel deleted branch dp_rename_copy_buffer

2023-04-14 12:12:45 +02:00

Damien Picard commented

2023-04-14 14:51:53 +02:00

Author

Member

Thanks for the improvements

Thank you for considering it, these had been driving me nuts while looking into the translations :D

> Thanks for the improvements Thank you for considering it, these had been driving me nuts while looking into the translations :D

Sybren A. Stüvel removed this from the Animation & Rigging project 2023-05-15 11:37:25 +02:00

Sign in to join this conversation.

No reviewers

No Label

Animation & Rigging

Automated Testing

Blender Asset Bundle

Dependency Graph

Development Management

Images & Movies

Motion Tracking

Nodes & Physics

Pipeline, Assets & IO

Platforms, Builds & Tests

Render & Cycles

Render Pipeline

Sculpt, Paint & Texture

Video Sequencer

Viewport & EEVEE

Virtual Reality

Asset Browser Project

Blender 2.8 Project

Milestone 1: Basic, Local Asset Browser

Good First Issue

Animation & Rigging

Development Management

Nodes & Physics

Pipeline, Assets & IO

Platforms, Builds & Tests

Render & Cycles

Sculpt, Paint & Texture

Viewport & EEVEE

Needs Info from Developers

Needs Information from User

No Milestone

No project

No Assignees

3 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#106060

No description provided.