Rev Documentation in Metacard

[Wilhelm Sanke]

The components of the "entangled" (Geoff Canyon) Revolution
Documentation are indeed distributed across several folders in the Rev
main folder, which makes it difficult to "customize" this part of the
Rev IDE to your own needs. At the beginning of the development of
Revolution Kevin had stated in a post that Revolution would be as
amenable to change and customization as the Metacard IDE, but the Rev
Documentation is not very easily adapted to personal needs.

To use the Rev Documentation in Metacard, i.e. meaning mainly the
"Transcript Dictionary", the following components are needed:

- stack "revdocumentation" (stack "revdocs") in folder "help"

  especially important in this stack is the button "Docs Library" on
card "Sections List", which contains the scripts for all the special
revdocs-commands that are used in the Transcript Dictionary like
"revdocsNavigate" or "revdocsGoToTopic" etc. etc.

- stack "revdictionary" (stack "revdocslanguagereference"), the
Transcript Dictionary in folder "help"

- stack "revquickref" (stack "revdocsLanguageQuickreference") in folder
"help
  (used when changing the "view" in the upper right corner of the
Transcript Dictionary)

- stack "revglossary" (stack "revdocsglossary") in folder "help"
  (used to show definitions/explanations of the the yellow highlighted
terms - if you touch them with the mouse cursor -  in the text of the
Transcript Dictionary)

- stack "revdocsimages"; this is a substack of stack "revicons" in
folder "tools"
  (used to indicate on which platform a term can be used)

- stack "revpreferences" in folder "save"; here a number of commands are
located that influence hiliting on different platforms etc..

(If you want to print out any pages of the Transcript Dictionary you
will have to use the "revshowprintdialog" or to re-script the "print"
button of the Dictionary in Metacard terms; I do not follow up on this
here.)

===================================

Several procedures to link these elements for use under Metacard are
possible, one first attempt could be:

1. Extract from the mainstacks where necessary and copy the above
mentioned  Rev stacks into your Metacard 2.5.1B3 folder.

2. Make "revpreferences" and "revdocsimages" substacks of  the
"Transcript Dictionary".
   Comment the stack script of the new substack "revpreferences"
   You could also put more of the stacks as substacks into the
Transcript Dictionary ("Glossary" and "QuickReference")

3. Start Metacard, then start "revdocumentation"
   Open "revdocsglossary" and "revquickref".

  On the Documentation start page choose "Transcript Language
Dictionary".

 Now you can make full use of the possibilities of the Transcript
Dictionary.
=====================
This should be sufficient as a start and could of cause much improved
later for a better integration into a Metacard IDE.


Regards,

Wilhelm Sanke