GeneratePreview - Maple Help

Home : Support : Online Help : System : HelpTools : Worksheet : GeneratePreview

HelpTools[Worksheet]

 GeneratePreview
 get help properties from worksheet

 Calling Sequence GeneratePreview(worksheet, xpath)

Parameters

 worksheet - string; path to .mw file or string contents of Maple worksheet xpath - (optional) string; XPath for content that should be used for preview. The default is "" - automatically generate.

Description

 • The GeneratePreview command returns a worksheet suitable for the preview popup.  The preview popup appears when a search is performed from the search box in the Worksheet toolbar.  For information on the search box and preview, see Other Ways to Access Help in the Perform a Help Search help page.
 • The xpath option can be used to fine-tune content for preview.

Examples

 > $\mathrm{with}\left(\mathrm{HelpTools}:-\mathrm{Worksheet}\right):$
 > $\mathrm{wks}≔\mathrm{FileTools}:-\mathrm{JoinPath}\left(\left["eBookTools","GettingStartedWithMaple.mw"\right],\mathrm{base}=\mathrm{datadir}\right):$
 > $\mathrm{xpath}≔"/Worksheet/Section/Section\left[1\right]":$
 > $\mathrm{preview}≔\mathrm{GeneratePreview}\left(\mathrm{wks},\mathrm{xpath}\right):$
 > $\mathrm{Worksheet}:-\mathrm{Display}\left(\mathrm{preview}\right):$

Compatibility

 • The HelpTools[Worksheet][GeneratePreview] command was introduced in Maple 18.