SetProperty - Maple Help
For the best experience, we recommend viewing online help using Google Chrome or Microsoft Edge.
Our website is currently undergoing maintenance, which may result in occasional errors while browsing. We apologize for any inconvenience this may cause and are working swiftly to restore full functionality. Thank you for your patience.

Online Help

All Products    Maple    MapleSim


PackageTools

  

SetProperty

  

set a named property of a workbook

 

Calling Sequence

Parameters

Description

Examples

Compatibility

Calling Sequence

SetProperty( package, property_name, property_value )

Parameters

package

-

string

property_name

-

string or name

property_value

-

string, list(string)

Description

• 

The SetProperty command assigns a name/value pair to the workbook's metadata.  

• 

Properties are useful when posting content to the MapleCloud, and when creating packages that can be installed. Some of the properties recognized by the MapleCloud include: authors, description, language, screenshots, tags, thumbnail, and title. ID and version are also recognized, but it is not recommended that either is manually modified as they correspond to unique identifiers for the MapleCloud.

• 

When scripting the creation of package workbook, the "X-CloudId" and "X-CloudXId" metadata properties are required to make an existing package updatable. Additional metadata properties that are automatically assigned by the MapleCloud include: "X-CloudGroup", "X-CloudId", "X-CloudURL", "X-CloudVersion", and "X-CloudXId".

• 

The property_value that corresponds to the property_name may be a plain string (such as for title and description), or a list of strings (such as for authors and categories), or a reference to a workbook attachment (such as thumbnail).  When referencing a workbook attachment, use the absolute path to the filename relative to the root of the given workbook; for example, use "/Images/thumbnail.jpg" to refer to the image already attached to workbook.

• 

The first argument, package, should be the name of a ".maple" file.

Examples

withPackageTools:

SetPropertymypack.maple,title,My Thesis

Compatibility

• 

The PackageTools[SetProperty] command was introduced in Maple 2017.

• 

For more information on Maple 2017 changes, see Updates in Maple 2017.

See Also

PackageTools

PackageTools:-GetProperty

worksheet,cloud,metadata

 


Download Help Document