GeneratePreview - Maple Help
For the best experience, we recommend viewing online help using Google Chrome or Microsoft Edge.
Our website is currently undergoing maintenance, which may result in occasional errors while browsing. We apologize for any inconvenience this may cause and are working swiftly to restore full functionality. Thank you for your patience.

Online Help

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

HelpTools[Worksheet]

  

GeneratePreview

  

get help properties from worksheet

 

Calling Sequence

Parameters

Description

Examples

Compatibility

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

withHelpTools:-Worksheet:

wksFileTools:-JoinPatheBookTools,GettingStartedWithMaple.mw,base=datadir:

xpath/Worksheet/Section/Section[1]:

previewGeneratePreviewwks,xpath:

Worksheet:-Displaypreview:

Compatibility

• 

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

• 

For more information on Maple 18 changes, see Updates in Maple 18.

See Also

HelpTools[Worksheet][Store]

Perform a Help Search

 


Download Help Document