Skip to content

Project Metadata

codeCatLady edited this page Sep 20, 2022 · 1 revision

Contents

Required Metadata

metadata field description
title name for the module as it will appear in the extensions manager, etc.
author the name of the author
version string. the suggested format is major.minor.patch

Example:

metadata title is "com.myWidgetCo.myWidget"
metadata author is "me"
metadata version is 0.0.1

Optional Metadata

metadata field description
platforms which platforms the module is available on (used with the inclusions dialog?)
os which OS's the module can be used on
preferredSize (for widgets) a string in the form x,y to be used when the widget is first created in a stack
svgicon (for widgets) the icon to be used in the toolbox, the extensions manager, and, presumably, the inclusions panel of the standalone application settings

Secret Metadata

Yes, there are secret metadata items, too

metadata field description
_ide specifies that the widget is to be treated as part of the ide

Example:

metadata platforms is "desktop,mobile"
metadata preferredSize is "320,49"
metadata svgicon is "M3,4.2v29.5h80.2V4.2H3z M14.8,11.5c1-0.2,2.5-0.3,3.8-0.3c2.1,0,3.5,0.4,4.5,1.3c0.8,0.7,1.2,1.7,1.2,2.9	c0,2-1.3,3.4-2.9,4v0.1c1.2,0.4,1.9,1.5,2.3,3.1c0.5,2.2,0.9,3.7,1.2,4.3h-2.1c-0.3-0.4-0.6-1.8-1-3.7c-0.5-2.1-1.3-2.9-3.1-3h-1.9v6.7h-2V11.5z M16.8,18.6h2c2.1,0,3.5-1.2,3.5-2.9c0-2-1.4-2.9-3.6-2.9c-1,0-1.7,0.1-2,0.2V18.6z M39.5,22l-1.6,4.9h-2.1l5.3-15.5	h2.4l5.3,15.5h-2.1L45,22H39.5z M44.6,20.4L43,15.9c-0.3-1-0.6-1.9-0.8-2.8h0C42,14,41.7,15,41.4,15.9l-1.5,4.5H44.6z M60.8,11.5c1.2-0.2,2.7-0.3,4.3-0.3c2.9,0,4.9,0.7,6.3,1.9c1.4,1.3,2.2,3.1,2.2,5.6c0,2.5-0.8,4.6-2.2,6c-1.4,1.4-3.8,2.2-6.9,2.2	c-1.4,0-2.6-0.1-3.6-0.2V11.5z M62.8,25.2c0.5,0.1,1.2,0.1,2,0.1c4.3,0,6.6-2.4,6.6-6.6c0-3.7-2-6-6.3-6c-1,0-1.8,0.1-2.3,0.2V25.2z"

References

Project metadata is partially described in the language reference.