LiveCode
  • Why LiveCode?
  • Customers
  • Resources
  • Education
  • Consulting
  • Pricing
  • Blog
  • Login
  • Try LiveCode
Back to
  • slides
  • tutorial
Resources

LCB metadata

Topic Progress:
← Back to Lesson

LiveCode Builder extension metadata

In order to package any extension in LiveCode Builder we need to add some required metadata. The metadata provides information about the extension.

The required metadata is

  • title: a human-readable name for the module
  • author: the name of the author of the module
  • version: a string in the form X.Y.Z (with X, Y and Z integers) describing the module version

You can also include an optional description

  • description: a simple description of the module’s purpose

If the required metadata is not added, then a number of warnings may be printed into the log field when building and packaging the extension.

Version numbers

We suggest using Semantic Versioning when assigning the version number of the extension.

The uses a version format of  X.Y.Z (Major.Minor.Patch).

Given this format you would increment

  1. The Major version when you make incompatible API changes.
  2. The Minor version when you add functionality in a backwards-compatible manner.
  3. The Patch version when you make backwards-compatible bug fixes.

Under this scheme version numbers, and the way they change, provide clear and valuable information about the underlying code and the changes between versions.

For a more detailed explanation of Semantic Versioning see http://semver.org/.

Library metadata

Add the metadata after the library definition in the LCB file

  • title: a human-readable name for the module, I have used “Hello World Library” but you can choose any suitable name
  • author: add your name as the author of your library
  • version number: this is the first version of the library so the version is “1.0.0”
library community.livecode.elanorb.helloworld

metadata title is "Hello World Library"
metadata author is "Elanor Buchanan"
metadata version is "1.0.0"

… handler definition

end library

The finished library

The library is now complete, including metadata, ready to be installed into LiveCode.

library community.livecode.elanorb.helloworls

metadata title is "Hello World Library"
metadata author is "Elanor Buchanan"
metadata version is "1.0.0"

public handler sayHello()
   return "Hello World!"
end handler

end library

← Previous Topic

← Previous Topic Next Topic →
  •  
  •  
  • (0)
  •  

Expand All | Collapse All
Lessons Status
1 - Hello World Library
  • Introduction
  • Installing a Text Editor
  • Creating an LCB library
  • LCB library definition
  • LCB handler definitions
  • Compiling and testing a library in LiveCode
  • LCB metadata
  • Installing an LCB Library
  • Packaging and sharing an LCB library
  • Including an LCB library in a standalone
  • Conclusion
2 - Extended Hello World Library
  • Introduction
  • Explicit Types
  • LCB Lists and Arrays
  • Type Conversion between LCB and LiveCode Script
  • Using Explicit Typing in the Library
  • Passing Parameters to the Library
  • Using Lists in the Library
  • Documenting the Library
  • Browsing the Documentation
  • Conclusion
3 - Rotated Text Widget
  • Introduction
  • Defining a Widget
  • LCB Module Level Variables
  • Widget Properties
  • Widget Handlers
  • LCB Canvas Operations
  • Compiling and Testing the Widget
  • Installing the Widget and adding it to a Stack
  • Including the Widget in a Standalone
  • Conclusion
4 - Extended Rotated Text Widget
  • Introduction
  • Integrating Properties
  • Accessing LiveCode Control Properties
  • Handling Mouse Events
  • Saving and Loading Widgets
  • Read Only Properties
  • Documenting the Widget
  • Conclusion
5 - Pie Chart Widget
  • Introduction
  • Planning the Widget
  • Widget Properties
  • The OnCreate Handler
  • The OnPaint Handler
  • Responding to Mouse Events
  • Saving and Loading the Widget
  • Installing and Including the Widget in a Standalone
  • Documenting the Widget
  • Conclusion
6 - Modifying the Line Graph Widget
  • Introduction
  • Duplicating the Line Graph Widget
  • Additional Color Properties
  • Filling the area below the line
  • Adding graph marker mouse events
  • Conclusion
7 - Additional Resources
  • Extending LiveCode Guide
  • LiveCode Builder Language Reference
  • LiveCode Builder Style Guide
  • LiveCode Documentation Format
 

LCB Source

LCB Source
 

Login

LiveCode

  • Why LiveCode?
  • Pricing
  • Customer Stories
  • Extensions
  • LiveCode in Education
  • LiveCode in Business

Looking for LiveCode FileMaker?

LiveCode for FM

Resources

  • Docs
  • API (Language Dictionary)
  • Lessons
  • Sample Stacks
  • Forums
  • Stackoverflow
  • User Groups
  • Support
  • Directory
  • LiveCode Services

About

  • About
  • Meet The Team
  • Careers at LiveCode
  • Contact us

Recent Posts

  • LiveCode Classic 10.0.1 Stable and 10.0.2-rc-1 Released
  • Create Progress – the Three D’s
  • LiveCode Create: Closing out the year with big steps forward
  • Create dp-5: Unified Engines and Shared Extensions
  • 3 Great New LiveCode Releases
Sitemap
Terms Privacy Policy EULA
Brought to you by LiveCode Ltd, Registered in Scotland, No. SC200728
We use cookies to ensure that we give you the best experience on our website. If you continue to use this site we will assume that you are happy with it.Ok