Supplemental Schema

The Package Schema describes the normative specification, which conforming tools are required to support in a prescribed manner. This section describes additional, optional elements which are useful, but non-normative. Conforming tools are not required to be aware of these elements, but by including them in this supplement, it is hoped that tools for which these ideas are useful would operate in a way that allows these elements to be useful to all tools that implement functionality along the lines here described.

These can be seen as “officially blessed” exceptions to the recommendation that extensions use the x_ prefix.

Attributes

By definition, none of the following attributes are required.

default_license

Type:
string
Applies To:
package
Required:
No

Specifies the license that is assumed to apply to a component, if none is otherwise specified. This is convenient for packages that wish their license to reflect portions of the package that are not reflected by a component (such as data files) when most or all of the compiled artifacts use the same license.

The value shall be a well formed Software Package Data Exchange License Expression .

description

Type:
string
Applies To:
package, component
Required:
No

Provides a human readable description of the function which the package or component provides.

display_name

Type:
string
Applies To:
package
Required:
No

Provides a human readable name of the package. If provided, tools may use this in informational messages instead of, or in addition to, the canonical package name.

license

Type:
string
Applies To:
package, component
Required:
No

Specifies the license or licenses under which the package is distributed. The value shall be a well formed Software Package Data Exchange License Expression .

If parts of a package use different licenses, this attribute may also be specified on a component if doing so helps to clarifying the licensing. (See also default_license.)

meta_comment

Type:
string
Applies To:
package
Required:
No

Provides a description of the file contents, for readers that may not be familiar with CPS files. The typical value is "Common Package Specification for <package name>".

meta_schema

Type:
string
Applies To:
package
Required:
No

Provides a URI link to a document describing the format of the CPS file. The typical value is "https://cps-org.github.io/cps/" (i.e. the top level page of this site).

website

Type:
string
Applies To:
package
Required:
No

Specifies the URI at which the package’s website may be found.