How to add and modify Strings

How to add new strings

This file contains all strings for Firefox iOS. // As we continue to update strings, old strings may be present at the bottom of this file. To preserve a clean implementation of strings, this file should be organized alphabetically, according to specific screens or feature, on that screen. Each string should be under a struct giving a clear indication as to where it is being used. In this case we will prefer verbosity for the sake of accuracy, over brevity. Sub structs may, and should, also be used to separate functionality where it makes sense, but efforts should be made to keep structs two levels deep unless there are good reasons for doing otherwise.

Note that some strings belong to one feature that appears across multiple screens throughout the application. An example is contextual hints. In this case, it makes more sense to organize all those strings under the specific feature.

Steps

1. Create or find the proper struct to add those strings in. If there's no struct that fits in, create one related to the feature or section this string will be under following the guidelines explained above.
2. Create the new MZLocalizedString under this struct making sure it follows the documentation. Particularly make sure that:
   • The key has a clear explicit name following the structure of where it is located, ended with the version the string was included in. This is to ensure that we can easily modify that string if needed later on, as well as monitoring string import PRs easily.
   • The tableName is defined and not nil.
   • The value is defined and not nil.
   • The comment follows the l10n guidelines.
3. Once all new strings are added, open a PR on Firefox for iOS.
4. Once merged, the new strings will be exported automatically to the Firefox l10n repository through the next automated Github action.

Example of a properly defined string

Any new string should have the same structure as the following example:

public static let TurnOnNotificationsTitle = MZLocalizedString(
    key: "Settings.Notifications.TurnOnNotificationsTitle.v112",
    tableName: "Settings",
    value: "Turn on Notifications",
    comment: "This is the title informing the user needs to turn on notifications in iOS Settings."
)

How to modify a string

The following applies only to strings you modify that were already exported to the l10n repository. If they weren't exported you can modify the value only (please check with the l10n team to confirm it wasn't exported).

Modifying a string means we need to modify at least two part of the MZLocalizedString, the key and the value. Sometimes the comment will also need to be adjusted, so please make ensure the comment still make sense following the string update. When modifying a string, we will create a new version of that string in the same struct, making sure to keep the old version of that string alive until the version it was last used in is released on the App Store.

Steps

1. Create a new MZLocalizedString below the old version of this string, modifying its key and value. You cannot modify the value only, since we need a new key for the string to be exported.

Example when modifying an existing string

Here's an example

public static let TurnOnNotificationsTitle = MZLocalizedString(
    key: "Settings.Notifications.TurnOnNotificationsTitle.v112",
    tableName: "Settings",
    value: "Turn on Notifications",
    comment: "This is the title informing the user needs to turn on notifications in iOS Settings.",
    lastUsedInVersion: 118
)
public static let TurnOnNotificationsTitle = MZLocalizedString(
    key: "Settings.Notifications.TurnOnNotificationsTitle.v118",
    tableName: "Settings",
    value: "Turn on Notifications Feature",
    comment: "This is the title informing the user needs to turn on notifications feature in iOS Settings."
)

How to remove a string