Hercules Schema Meta Attributes

With schema meta attributes (used with Igor types), you can control Hercules editor’s behavior and appearance. Such attributes are not validated by Igor Compiler, so Hercules gets to introduce new meta attributes without having to alter or update Igor Compiler.

Example:

[schema min=0 max=1 meta=(step=0.1 slider.ticks)]
float value;

This is a list of metadata values that Hercules understands and processes:

Attribute	Type	Target	Description	Default
compact	bool	record record field	Enables compact view for the record	false
step	float	type record field	Value change step for float numbers (schema min and max should be also set)
slider.ticks	bool	type record field	Display float slider ticks (step should be also set)	false
format	string	type record field	String format, e.g. 0.## or 0.00
record_caption	bool	record field	Displays this field value as the record caption	false
record_enabled	bool	record field	Displays this field as a checkbox in the record header	false
unreal_class_path	bool	type record field	Displays this field as a checkbox in the record header	false
atomic	bool	type	The type is atomic in linked documents context. See Atomic values	false
key	bool	record field	The field can be used to identify a record list item. See List of records identified by keys	false
reference.id	string	type record field	The value is a referenced value. See Local references
reference.source	bool	type record field	The value is a reference source. See Local references	false
reference.unique	bool	type record field	The reference source must be unique. See Local references	false
reference.validate	bool	type record field	Reference should be validated by Hercules. See Local references	true
caption_path	string	record type	Path to the document record caption used as additional info in document key pickers
image_path	string	record type	Path to the document image used in tile view
preview	bool	type record field	Show preview image	false
preview.width	int	type record field	Preview image width	200
preview.height	int	type record field	Preview image height	200