EDIT 2013 06 29; No more updates of the active handbook here. The help system prototype is now part of the inofficial
portable distribution with pluginsIn the attachment you find an extended active handbook prototype.
You may unzip the file preferrably in the book directory of your SMath installation.
Then, the contents page of the internal math referenc book contains a link to the handbook.
Hint: To follow links, just Ctrl-click (files are in edit mode)
EDIT: The interactive book is now available via Extension managerHere comes the feature request.
Provide a mechanism for easy access to function description files.
- Specify a location in the directory structure, where such files go (similar to other extension handling)
- Whenever the cursor is on a function name, provide link to the corresponding description file (if it exists). That might be a special keyboard shortcut, just like F12 goto definition: FI might mean: goto description.
- Such linking would need to open a separate window, in order not to destroy the currently edited file.
- in a first step, it would be sufficient to provide this for math regions or input placeholders in other regions. One might extend this to text regions.
The feature would allow for independent yet accessible doc spaces. Jump in is always easy via function name. Plugin-providers could provide function description files with backlinks to an also provided overview article.
This linking feature would also significantly reduce the effort for cross references in the handbook files. Linking to a function description would simply be reduced to just mentioning this function. Currently, in order to add a function to the function index, I need to copy an existing link, change the visible text and then edit the link target in a source code editor.
The handbook prototype is mainly bilingual (german, english). As the function descriptions mostly are taken from my pdf manual, not all of them are translated to english yet. Feel free to do so and to provide additional material. This perhaps will need go to the SVN repository.
Edited by user 27 March 2014 16:23:42(UTC)
| Reason: Not specified
File Attachment(s):
mkraska attached the following image(s):