Example information
| Name | Name of the example. |
| Folder | Relative path to the example base folder within the package. If selected, then the directory including all sub-folders and files will be copied, unless the archive attribute gets set. |
| Archive | Filename and extension of the archive file containing all files and sub-folders of the example. The archive is located in the path specified by the attribute folder. |
| Doc | Document that describes the example. |
| Version | Example version number. Format version is MAJOR.MINOR.PATCH[-Pre Release][+Build Metadata] |
| Public | Set publishing permissions for the documentation. If "public" is true, then the vendor gives permission to extract the documentation from the pack and publish it on a web-page. Links to web pages are assumed to be public. |
| Description | Briefly documents the purpose and scope of the example. The test can be displayed in an example selector. |
| Board Name | Vendor name of the board. |
| Board Vendor | Commercial name of the board. |
| Device Vendor | Vendor name of the device used on the board. |
| Project Name | Name of the required tool-chain (for example: uv, iar, etc.) |
| Project File | Specifies the project file with extension. |
| ToolChain | Specifies the subdirectory to be copied into the user's project folder relative to folder attribute of the element /package/examples/example. This attribute is used by example descriptions that support multiple tool-chains/IDEs, each stored in a separate folders. Note: for copying eclipse projects it is required that the .project file is located in the base directory and all project files are located in the base directory or in one of the subdirectories. In this case even common files are required to be duplicated. |
| Project Component | The component element specifies the Cclass to which the example belongs. This can be used to list all related components within an example. |
| Category | Free form string defining an example category. A category can be used to filter examples in an example browser. An STM32Cube Expansion example project can be classified as Example, Application, or Demonstration (refer to STM32Cube Expansion guidelines) |
| Keyword | Free form string defining a keyword that relates to the example. A keyword can be used to search for examples. |