Creating Example Metadata

After you have documented your example, the only task left is to write some metadata for YAKINDU SCT's example wizard. The metadata essentially contains the display title of your example and its categories.

Metadata have to go to the metadata.json file. If you copied metadata.json_deactivated from the example_template folder, please rename it to metadata.json.

A well-formed metadata file looks like this:

{
	"id": "org.yakindu.sct.examples.sample",
	"title": "Example Title",
	"description": "This is a short description of this example.",
	"previewImage": "preview-image-ideally-442px-wide-295px-heigh.jpg",
	"author": "Joe Doe",
	"organization": "Internet Cats, Inc.",
	"license": "Creative Commons Attribution 4.0 International (CC BY 4.0)",
	"category": [
		"open source",
		"basic"
	]
}

What you have to do:

1. Give your example a unique ID. Choose whatever you want, you can just replace example_template with your foldername.
2. The title must be exactly what you have chosen in index.html.
3. The description should be a short summary of your example. One or two sentences suffice.
4. In priciple you can choose the number and names of categories freely. However, please do so properly, so your example can be found.

Save the file, and you are ready for submitting your example!