platform-bible-utils
    Preparing search index...

    Interface StringMetadata

    Additional non-locale-specific information about a localized string key

    interface StringMetadata {
        deprecationInfo?: LocalizedStringDeprecationInfo;
        fallbackKey?: `%${string}%`;
        notes?: string;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown
    Index

    Properties

    If this property is filled, the localized string is deprecated. Contains information about the deprecation.

    fallbackKey?: `%${string}%`

    Localized string key from which to get this value if one does not exist in the specified language. If a new key/value pair needs to be made to replace an existing one, this could help smooth over the transition if the meanings are close enough

    You can use Paratext 9 Localized String Keys here. Be sure to escape any % signs with a backslash ``.

    notes?: string

    Additional information provided by developers in English to help the translator to know how to translate this localized string accurately