Adding Metadata to Your Package Workbook - Maple Programming Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Share Maple Content : worksheet/cloud/metadata

Adding Metadata to Your Package Workbook

 

Adding Metadata Using the GUI

Adding Metadata Programmatically

Metadata Fields

See Also

Adding Metadata Using the GUI

 

To add Metadata to your workbook:

1. 

In the Publish to MapleCloud window, enter metadata details for your package.

 

Available metadata fields include:

• 

Title (required): The title of your workbook.

• 

Thumbnail: Add a thumbnail so users can recognize your package. Supported file types include: .png, .bmp, .jpg, .svg. This is required. For instructions, see Adding Thumbnails to Workbooks.

• 

Description (required): Provide a detailed description so users can easily find out more information about your package.

• 

Application Type: To identify your content as a package that can be installed, select MaplePackage. Otherwise select Maple.

• 

Group: To publicly share the package, choose the packages group. Otherwise, you can add the package to your private groups.

• 

Language: Select the language that the package was authored in.

• 

Authors: List authors that contributed to the package. To add more authors click , then add the author name in the Author window.

• 

Tags: Tags are keywords that a user can search on to make it easier to find content.

• 

Screenshots: You can use screenshots to give users a preview of what to expect from your package. Supported file types are the same as thumbnails.

2. 

When you are done, click Apply to save the changes without publishing to the MapleCloud or click Publish and the package is added to the MapleCloud.

 

Adding Metadata Programmatically

You can use PackageTools:-SetProperty to set metadata properties for your package workbook. Using the PackageTools:-GetProperty command you can retrieve information about the metadata properties for your package workbook.

 

Example: Adding the Author's Name to a Package

with(PackageTools):

Use the PackageTools[Create] command to create a new workbook called "TestPackage". Note: Ensure that you are in a directory for which you have the necessary administrative privileges to write files.

Create("TestPackage.maple");

TestPackage.maple

(2.1.1)

Next, use the PackageTools[SetProperty] command to set the value of the metadata property, "Author" to "Me".

SetProperty("TestPackage.maple", "authors", "Me");

Verify that the value of "Author" was set to "Me" using the PackageTools[GetProperty] command.

GetProperty("TestPackage.maple", "authors");

Me

(2.1.2)

Metadata Fields

Metadata properties that can be set by the user, either through the GUI or programmatically:

• 

authors

• 

description

• 

ID

• 

language

• 

screenshots

• 

tags

• 

thumbnail

• 

title

• 

version

 

It is also possible to programmatically query and change system Cloud properties:

• 

"X-CloudGroup"

• 

"X-CloudId"

• 

"X-CloudURL"

• 

"X-CloudVersion"

• 

"X-CloudXId"

Note that it is not recommended that any of the cloud properties are changed. These are meant to be modified only when scripting the creation or update of packages. For more details, see Creating a New Package Workbook.

See Also

Uploading a Package to the MapleCloud, Getting Started with the MapleCloud