Microsoft/bcquality
1
0
Fork 0
mirror of https://github.com/microsoft/BCQuality.git synced 2026-10-05 14:46:55 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
bcquality/microsoft/knowledge/style/label-locked-for-non-translatable.md
Jesper Schulz-Wedde 2b5550c346
Some checks failed
Validate knowledge index / validate-index (push) Has been cancelled
Details
Validate AL review fixtures / validate-review-fixtures (push) Has been cancelled
Details
Validate frontmatter and structure / validate (push) Has been cancelled
Details
Improve partner onboarding and documentation navigation (#174) 
Lead with a complete plugin quick start and add task-oriented usage, troubleshooting, customization, and contribution guides. Preserve the broader plugin framing, correct conflicting contract guidance, support Agents folder reviews, and align repository validation. Convert existing sample references to clickable links without changing knowledge rules.

Co-authored-by: Jesper Schulz-Wedde <jesper.schulzwedde@microsoft.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-09-09 17:31:03 +02:00

1.6 KiB
Raw Blame History

bc-version domain keywords technologies countries application-area
all
style
label
locked
translation
token
url
json
xml
al
w1
all

Set Locked = true on Labels that must not be translated

Description

A Label is by default surfaced to translators and rewritten per locale. That is wrong for strings that are not natural language: HTTP verbs (GET, PUT), URL fragments, JSON/XML snippets, content-type strings, GUIDs, application keys, and field tokens used by integrations. Translating these breaks the integration the moment a non-English tenant runs the code. The Locked = true parameter on the Label declaration tells the translation pipeline to keep the string verbatim, and signals to reviewers that the value is part of a wire-level contract rather than display text.

Best Practice

Pair Locked = true with the Tok suffix for short tokens (GetMethodTok: Label 'GET', Locked = true;) and with the Txt suffix for telemetry strings that contain format placeholders but should not be localized. The Locked parameter and the Tok / Txt suffix together make the intent unambiguous.

See sample: label-locked-for-non-translatable.good.al.

Anti Pattern

HttpsUrl: Label 'https://example.com'; or ContentTypeTok: Label 'application/json'; declared without Locked = true. The translator localizes them, the integration fails in production for the affected tenant, and the failure is invisible in the developer's English-locale tests.

See sample: label-locked-for-non-translatable.bad.al.