Help: Using the Desktop API display of JavaScript documentation

This interactive display describes dozens of JavaScript functions that are included in certain final standard rules (Rule-File-Text, Rule-Obj-HTML, and Rule-File-Form rule types). These functions are marked API, indicating that they are designed for your use and expected to remain functionally stable.

Selecting a package and class

To learn about the JavaScript functions that are marked as API:

1. Click a link in the Packages area to learn about the functions in that package.
2. Some packages contain JavaScript functions grouped into "classes". If the Function Classes area is not blank, click to select a function class.
3. The display changes to present the API functions in the right panel.
4. Review the function descriptions. To learn more about the parameters for a function, click its name link.
5. Review the parameter descriptions. Click the pencil icon () to open the rule and review the source code.

Navigation

The facility offers four levels of detail. Use the following controls to navigate among the

Element	Description
	Redisplay a previously viewed display.
	Display a top-level package description.
	After clicking , click to advance to the earlier display.
API	Selected.
	Print the display.
	Access this help topic.

Compactification

When debugging JavaScript code, select Edit > Preferences and check the Disable compacting check box in the JavaScript section of the General preferences panel. When not checked, this preference causes variable names to be scrambled before the JavaScript is sent to a browser, and removes spaces and comments from the JavaScript source code, making this code less easy to read and understand. Clear the check box when finished debugging, for best performance.

About Text File rules

About the Desktop API display