Anim: make Keyframing error messages translateable #121112

Merged

Christoph Lendenfeld merged 5 commits from ChrisLend/blender:keying_messages_translateable into main

2024-04-30 10:00:01 +02:00

Christoph Lendenfeld commented

2024-04-26 10:27:16 +02:00

Member

This fixes an issue with the error messages that keying can produce where they couldn't be translated.

To make translation possible, two things changed:

use of N_ (judging by https://developer.blender.org/docs/handbook/translating/developer_guide/ this is the correct macro?)
Use of plural throughout without specificity of numbers. The number is put in brackets at the end.

This fixes an issue with the error messages that keying can produce where they couldn't be translated. To make translation possible, two things changed: * use of `N_` (judging by https://developer.blender.org/docs/handbook/translating/developer_guide/ this is the correct macro?) * Use of plural throughout without specificity of numbers. The number is put in brackets at the end. ![image](/attachments/29fa0eb9-46f4-41f0-9136-71445f424b23)

6.4 KiB

Christoph Lendenfeld added the

Animation & Rigging

labels 2024-04-26 10:27:16 +02:00

Christoph Lendenfeld added 1 commit 2024-04-26 10:27:26 +02:00

071deb9314 change messages

Christoph Lendenfeld requested review from Julian Eisel 2024-04-26 10:28:14 +02:00

Christoph Lendenfeld requested review from Sybren A. Stüvel 2024-04-26 10:28:20 +02:00

Julian Eisel reviewed 2024-04-26 11:53:39 +02:00

source/blender/animrig/intern/keyframing.cc Outdated

						
				@ -99,3 +97,1 @@

				                    "available F-Curves.",

				                    error_count,

				                    error_count > 1 ? "s" : ""));

				    errors.append(N_("Could not create F-Curves. This can happen when only inserting to "

Julian Eisel commented

2024-04-26 11:53:39 +02:00

Member

These need to be tagged with RPT_(), because translation will attempt to translate the string as a whole, not any sub-strings. So you can't rely on tagging the sub-string and passing it to BKE_report(), it has to be translated here already (which RPT_() does). Confirmed this with Bastien.

These need to be tagged with `RPT_()`, because translation will attempt to translate the string as a whole, not any sub-strings. So you can't rely on tagging the sub-string and passing it to `BKE_report()`, it has to be translated here already (which `RPT_()` does). Confirmed this with Bastien.

Sybren A. Stüvel requested changes 2024-04-26 11:54:30 +02:00

Sybren A. Stüvel left a comment

Member

use of N_ (judging by https://developer.blender.org/docs/handbook/translating/developer_guide/ this is the correct macro?)

I think the documentation is a bit vague, so I've asked in the translations chat channel about this.

Use of plural throughout without specificity of numbers. The number is put in brackets at the end.

To me it's not clear that that number indicates the number of F-Curves that couldn't be keyed. It could just as well be some internal error identifier number.

I think your old approach was fine, and just needs a macro:

    if (error_count == 1) {
      errors.append(N_("One F-Curve is not keyframeable. It might be locked or sampled."));
    }
    else {
      errors.append(fmt::format(
          N_("{} F-Curves are not keyframeable. They might be locked or sampled."), error_count));
    }

If you want to be more explicit in the format string, to help the translation team understand that there will be a number inserted there, replace {} with {:d}.

The issue is mostly with code like this:

    errors.append(
        fmt::format("Due to the setting 'Only Insert Needed', {} keyframe{} not been inserted.",
                    error_count,
                    error_count > 1 ? "s have" : " has"));

which can be made translatable with the above approach, like:

    if (error_count == 1) {
      errors.append(
          N_("Due to the setting 'Only Insert Needed', one keyframe has not been inserted."));
    }
    else {
      errors.append(fmt::format(
          N_("Due to the setting 'Only Insert Needed', {:d} keyframes have not been inserted.")));
    }

> * use of `N_` (judging by https://developer.blender.org/docs/handbook/translating/developer_guide/ this is the correct macro?) I think the documentation is a bit vague, so I've asked in the translations chat channel about this. > * Use of plural throughout without specificity of numbers. The number is put in brackets at the end. > > ![image](/attachments/29fa0eb9-46f4-41f0-9136-71445f424b23) To me it's not clear that that number indicates the number of F-Curves that couldn't be keyed. It could just as well be some internal error identifier number. I think your old approach was fine, and just needs a macro: ```cpp if (error_count == 1) { errors.append(N_("One F-Curve is not keyframeable. It might be locked or sampled.")); } else { errors.append(fmt::format( N_("{} F-Curves are not keyframeable. They might be locked or sampled."), error_count)); } ``` If you want to be more explicit in the format string, to help the translation team understand that there will be a number inserted there, replace `{}` with `{:d}`. The issue is mostly with code like this: ```cpp errors.append( fmt::format("Due to the setting 'Only Insert Needed', {} keyframe{} not been inserted.", error_count, error_count > 1 ? "s have" : " has")); ``` which can be made translatable with the above approach, like: ```cpp if (error_count == 1) { errors.append( N_("Due to the setting 'Only Insert Needed', one keyframe has not been inserted.")); } else { errors.append(fmt::format( N_("Due to the setting 'Only Insert Needed', {:d} keyframes have not been inserted."))); } ```

Christoph Lendenfeld commented

2024-04-26 12:02:19 +02:00

Author

Member

@dr.sybren so formatting a translated text is supported? I wasn't sure about that.
Just so I understand.
"{:d} F-Curves are not..."
will be translated to
"{:d} same thing in another language"

and formatting is applied to the translated string with curly brackets in it?

@dr.sybren so formatting a translated text is supported? I wasn't sure about that. Just so I understand. "{:d} F-Curves are not..." will be translated to "{:d} same thing in another language" and formatting is applied to the translated string with curly brackets in it?

Christoph Lendenfeld added 2 commits 2024-04-26 14:02:37 +02:00

56dde3b7e0 Merge branch 'main' into keying_messages_translateable

buildbot/vexp-code-patch-lint Build done. Details

buildbot/vexp-code-patch-linux-x86_64 Build done. Details

buildbot/vexp-code-patch-darwin-x86_64 Build done. Details

buildbot/vexp-code-patch-darwin-arm64 Build done. Details

buildbot/vexp-code-patch-windows-amd64 Build done. Details

buildbot/vexp-code-patch-coordinator Build done. Details

385e09e02e change to separate singular plural but with RPT_

Christoph Lendenfeld requested review from Sybren A. Stüvel 2024-04-26 14:02:54 +02:00

Sybren A. Stüvel approved these changes 2024-04-26 15:39:10 +02:00

Sybren A. Stüvel left a comment

Member

so formatting a translated text is supported? I wasn't sure about that.

Yup. The translation team can just translate "{:d} F-Curves are not..." to "{:d} same thing in another language" and the strings will be translated before feeding them to the fmt::format() function.

This does mean that N_ is the wrong macro to use (with my refreshed understanding of the translation macros), so your change to RPT_ looks good to me!

> so formatting a translated text is supported? I wasn't sure about that. Yup. The translation team can just translate `"{:d} F-Curves are not..."` to `"{:d} same thing in another language"` and the strings will be translated before feeding them to the `fmt::format()` function. This does mean that `N_` is the wrong macro to use (with my refreshed understanding of the translation macros), so your change to `RPT_` looks good to me!

source/blender/animrig/intern/keyframing.cc Outdated

						
				@ -172,3 +194,3 @@

				  }

				  std::string error_message = "Inserting keyframes failed:";

				  std::string error_message = N_("Inserting keyframes failed:");

Sybren A. Stüvel commented

2024-04-26 15:38:51 +02:00

Member

This should also use RPT_.

This should also use `RPT_`.

Sybren A. Stüvel commented

2024-04-26 15:39:24 +02:00

Member

@blender-bot build

@blender-bot build

Julian Eisel approved these changes 2024-04-26 20:59:25 +02:00

Christoph Lendenfeld added 2 commits 2024-04-30 09:58:25 +02:00

866b51ba93 Merge branch 'main' into keying_messages_translateable

5b700367ec use rpt

Christoph Lendenfeld merged commit 5ba5fc8962 into main

2024-04-30 10:00:01 +02:00

Christoph Lendenfeld referenced this issue from a commit

2024-04-30 10:00:02 +02:00

Anim: make Keyframing error messages translateable

Christoph Lendenfeld deleted branch keying_messages_translateable

2024-04-30 10:00:04 +02:00

Sign in to join this conversation.

No reviewers

No Label

Animation & Rigging

Asset Browser Project Overview

Automated Testing

Blender Asset Bundle

Dependency Graph

Development Management

EEVEE & Viewport

Images & Movies

Motion Tracking

Nodes & Physics

Pipeline, Assets & IO

Platforms, Builds & Tests

Render & Cycles

Render Pipeline

Sculpt, Paint & Texture

Video Sequencer

Virtual Reality

Blender 2.8 Project

Milestone 1: Basic, Local Asset Browser

Good First Issue

Animation & Rigging

Development Management

EEVEE & Viewport

Nodes & Physics

Pipeline, Assets & IO

Platforms, Builds & Tests

Render & Cycles

Sculpt, Paint & Texture

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#121112

No description provided.