Export Code Arguments

The argument action refers to a statement that can be evaluated as if an Action or Rule.

The arguments argument and anotherArgument refer to text or code supplied as macro arguments.

The argument attribute refers to an explicit attribute name.

The argument count refers to a number, in figures, e.g. 5 not five.

The argument css class is the (text) name of a CSS mark up class.

The argument data (data1, data2, etc.) refer to either:

• an explicitly entered value.
• an attribute's value.
• a pattern (i.e. regular expression)

The argument date refers to either:

• an explicit date "2 Feb 2007".
• a date object, e.g. today, yesterday - 5.
• a date attribute, ^get(some other note, MyDate)^.

The argument expression refers to a statement that can be evaluated and assigned to an attribute.

The argument format refers to either:

• a date/time formatting string.
• a colour string in #000000 format.

The argument group is either:

• a relative reference to a group of notes or agents, like in ^any([group], AttributeName)^.
• another export code that gets evaluated in to a group, like in ^getFor(^[code]^, AttributeName)^.
• a predefined group object (e.g. descendant, etc.,).

The argument item is either:

• a note or agent's name, like in ^get(Name)^.
• a relative reference to a note or agent, like in ^getFor([item], AttributeName)^.
• another export code that gets evaluated into a note or agent's name, like in ^getFor(^[code]^, AttributeName)^.
• a predefined item object (e.g. child, etc.,).

The argument N refers to a number, in figures, e.g. 5 not five.

The argument precision refers to the number of decimal points that are exported.

The argument path refers to the path to a note or agent (including the latter's Name).

The arguments start, list-item-prefix, list-item-suffix, start, list-item-prefix, list-item-suffix, end refer to optional alternate HTML mark up and text for a list of links.

The argument target refers to either:

• a (text) string value to be matched against. Number and other value types are effectively treated as strings for comparative purposes.
• an attribute value.

The argument template refers to a template file name either:

• stated as a string.
• stored in a named attribute.
• inherited as a default from Preferences.

Export argument value may be enclosed in double quotes. The quotes will be ignored, but doing so can help avoid parsing difficulties. From v4.0.0, use of quotes for string values is recommended. This is because many new operators have been added and the scope for misinterpretation of string literals as code has increased. For example, if a note is named ...

she, shyly

... the comma would confused the parser in expressions like:

^linkTo(she, shyly)^ <- won't work

... so this may now (optionally) be written with double quotes:

^linkTo("she, shyly")^

From v4.0.0, link lists can use two new references in their optional mark-up arguments:

• source - refers to the note that is the source of the link.
• destination - refers to the note that is the destination of the link.

Licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License
[See aTbRef CC licence Attribution/Waiver info info]