Meta Block

From KynetxDocs

Jump to: navigation, search

Note: Only the description is supported in meta blocks as of January 2009.

A meta block stored information about a ruleset. Meta blocks are optional and may be empty. The following are allowed in a meta block:

  • description - a string (specified in standard or extended quotes) that describes the ruleset's purpose.
  • logging - accepted values are 'on' and 'off'. If logging is on for a ruleset, detailed log messages will be included as comments in the JavaScript output from KNS.

The following will be supported in the meta block at a future date:

  • author - a string giving the name of the author of the ruleset.
  • modified - a string indicating when the ruleset was last modified.
  • version - the version number for the ruleset.

This data from the meta block is returned when the "describe" method is invoked in the KNS API.

Personal tools