Creating Tasks
|
This help page describes how to write tasks in the Maple worksheet and add them to a help database file.
|
|
To create tasks, complete the following four steps.
|
|
Author the Content
|
|
|
Create a new worksheet for performing the task. You can include 2-D Math, graphics, and any other worksheet content.
|
|
Important: All instances of variables names must have a leading and trailing double underscore (__), for example, __x__. The double underscore does not appear in output in your worksheet, and does not appear in input or output in the Help System view of your task. This marker will cause users of the task to be warned if the variable has already been assigned within their worksheet. In this case, users will have an opportunity to rename the task variables.
|
|
Note: Do not include a double underscore around Maple option names, to prevent users from renaming these option names. It is recommended that you use unevaluation quotes ('') around any Maple option names. For example, the following is incorrect: Student[Calculus1][NewtonQuotient](__x__^2,__h__= 0.1);. Instead, use this statement: Student[Calculus1][NewtonQuotient](__x__^2, 'h'=0.1);.
|
|
It is recommended that you enclose the task content in a section with an appropriate title. Also, it is recommended that you provide an overview of the purpose of the task.
|
|
|
(Optional) Mark Placeholders and Content that is Not Inserted
|
|
|
Placeholders are parameters, which are meant to be replaced by the user once the task has been inserted into a worksheet. They typically include expressions, variables, and options. The text or math will appear in purple, rather than the default black font.
|
|
To mark content as a placeholder:
|
|
1. Select the parameter, for example sin(__x__).
|
|
2. From the Format menu, select Task Authoring, and then Mark as Placeholder.
|
|
Non-insert content (for example, hyperlinks to help pages) is not inserted in standard or minimal insertion mode.
|
|
To mark non-insert content:
|
|
2. From the Format menu, select Task Authoring, and then Mark as Non-Insert.
|
|
Optional content (for example, the title or text descriptions) is inserted in standard but not minimal insertion mode.
|
|
To mark optional content:
|
|
2. From the Format menu, select Task Authoring, and then Mark as Optional.
|
|
Task Elements
|
|
|
To highlight marked content, from the View menu, select Task Elements.
|
•
|
Blue indicates optional content.
|
•
|
Pink indicates non-insert content.
|
•
|
Green indicates a placeholder.
|
|
|
|
Save the Task to a Help Database
|
|
|
You must insert your task into a help database so that it can be used. Once you have done that, the top bar with the copy buttons will be automatically generated.
|
|
To insert your task into a help database:
|
1.
|
From the Tools menu, select Help Database, and then Save as Task.
|
2.
|
In the Save Task dialog, enter values in the following fields.
|
•
|
Select Writable Database - The help database (HDB) file (that must contain "task" or "Task" in its name) to which to add the task. If the file does not exist, Maple creates it.
|
•
|
Task Name - The unique name (topic) associated with the task in the help system.
|
•
|
Table of Contents Entry - The location of the task in the left pane of the Browse Tasks window, and the Table of Contents tab in the left pane of the Help Navigator.
|
|
Also specify a description for all the variables and parameter placeholders.
|
3.
|
Click the Save button.
|
|
Repeat the previous steps to create additional tasks.
|
|
|
Distribute the Help Database File
|
|
|
To use a collection of tasks that you have added to a help database file:
|
1.
|
Send the HDB file that contains your tasks to the users.
|
2.
|
The users must place a copy of the HDB file in one of the paths in their libname, or add the path of the HDB file to libname in Maple.
|
3.
|
Start Maple. Your tasks are available.
|
|
|