Class LaravelUi5\Sdk\Help\Attributes\Help

Declares the primary (root) help document of a module and defines the module's primary locale.

This attribute is applied to the module class and provides two essential pieces of information:

1. $locale The primary authoring locale for all help documents within this module. This is the "source language" used by developers or technical writers and determines:

   • the default locale for rendering,
   • the fallback locale when translated versions are missing,
   • the locale that the UI shows first.

2. $uuid The UUID of the module's root help document. The root help document acts as the entry point for the module-level table of contents (TOC) and the fallback target for context-sensitive help when no view-level context is available.

Example:

#[Help(locale: 'en', uuid: '71e2575e-3a1a-41b7-a0e1-f50ae0b47b6b')] class PartnersModule implements Ui5ModuleInterface {}

During compilation, the HelpCompiler reads this attribute to establish the module's root help mapping, keyed by the module's namespace:

moduleNamespace → uuid

and to store the module's primary (authoring) locale, which decides which locale file is validated and which one reaches toc.html and index.json. It does not reach the Shell manifest — the client's default locale is the static ui5.shell.manifest.helpManager.defaultLocale.