D&Do v. 1.0   Prev   Next   Top


Help Viewer

D&Do provides a simple local HTML browser with automatic links to this document and to the eventual help document of the loaded metascript. It is the responsibility of the metascript integrator to write such a document that should address to the end user.

 


Help Viewer Screenshot

The Help Viewer is activated through the "Help" item of the popup menu. If no metascript is loaded, it will initially display the Table of Contents (TOC) of this document (the D&Do one). Otherwise, it will attempt to display the front page of the documentation related to the loaded metascript. If that front page is not found, the TOC of D&Do documentation will be displayed instead. However, the link information for the missing document will be displayed in red on the status line of the Help Viewer.

The Help Viewer contains the following GUI components:

The hyperlink inside the document area works as expected from an HTML file.

The metascript documentation file should be under the same directory path under the docs_en subdirectory than the metascript file directory path under the D&Do directory. The front page documentation file of the metascript and the metascript file itself should have the same name but the former file extension would be ".htm" while the latter is ".ms". This example will clarify the specification:
Let "." be the home directory of D&Do.
If the loaded metascript is at ./scripts/opt/myMScript.ms
then the related front page file should be at ./docs_en/scripts/opt/myMScript.htm.

If the loaded metascript file is not in any subdirectory of D&Do, the related documentation is expected to be found under the "./docs_en/scripts" subdirectory of D&Do.

 


Prev   Next   Top

Copyright(c) 2003-2004 Marcel St-Amant