AUTODOC-IT 1.0 The Programmers Guide © by Voyager@Treff.zer -------------------------------------------------------------------------- What is it? AUTODOC-IT is a script file in amigaguide-format which helps you to get your autodocs (converted with ad2ht) together in one document. I wrote it because I did not like to click on an icon every time, when searching for a certain structure or descriptiono in the converted files. Now all you have to know is: where is this structure I am searching...is it in asl.guide or anywhere else...? It is also a comfortable environment for working through the whole thing, because of cross-references. If you have problems in understanding a specific word and it is printed in BLUE, "click" - and there is an explanation...just like in an encyclopedia. This script should encourage more programmers to use an amigaguide-compatible format in their programs, it is not that hard to understand. -------------------------------------------------------------------------- System requirements: Hardware: - AMIGA (what else?) with Kickstart/Workbench 2.0 and some Ram:-) - A harddisk (the bigger the better:-)) Software: - Amigaguide Distribution Package - Display (supplied with Workbench 2.0, an IFF-Viewer) - Autodoc Distribution or already converted .guide files - 2.0 C-Header Files (For example Lattice). -------------------------------------------------------------------------- Walkthrough: This is a short description of what should be done BEFORE you try starting your AUTODOC-IT Script. First of all, get yourself the amigaguide-package. If you are a registered developer you can find it on your DEVCON disks. The autodocs are needed as well, the actual version is, as well, shipped to registered developers. Your first step is to convert your existing autodocs into the new amigaguide format. This is discribed in the amigaguide documentation. You should have already installed the amigaguide package before! AUTODOC-IT expects the program "display" in your SYS:UTILITIES directory. Check, if env: contains a directory named "amigaguide", with files called "path" and "text". Path contains the path to your amigaguide directory. If path is not present, type: setenv amigaguide/path If text is not present, type: setenv amigaguide/text BUTTON Take care, that these settings are really saved, otherwise they are gone after a reset. If you have env: assigned to ram:, copy the amigaguide/path and amigaguide/text to envarc: on your Harddisk. I should not mention this, because it is all in the amigaguide docs... Okay, now find a suitable directory on your Harddisk, where amigaguide-text- files should reside. Note, that this directory can grow quite a bit, because in the future there will be many more programs supporting amigaguide. Add a line to your Startup-Sequence: assign amigaguide: I recommend to follow the next steps as well, although they are not needed to let AUTODOC-IT work...: 1. Put AUTODOC.IT into your amigaguide directory and select its icon. 2. Choose LEAVE OUT from the Workbench Menu "Icons". This way, you have your AUTODOC-IT always in sight when you need it. - You should copy your C-header-files (*.h-type-files) into the amigaguide directory as well (e.g. Lattice Headers). This way, amigaguide can find cross-references between several documents which are sometimes not in the autodocs. If something does not work the way it should, try snoopdos and find out, which files AUTODOC-IT cannot find. If you put all your stuff in a directory which amigaguide knows from its PATH-ENVIRONMENT-VARIABLE, it should work... -------------------------------------------------------------------------- Copyright notice: Feel free to adapt this script to your own needs, if you want to redistribute it, add a note to the AUTODOC-IT header (but do not delete it!). If you accept this and do not try to profit from it, AUTODOC-IT is FREEWARE. Note however, that, like always, AUTODOC-IT is © by Voyager and must only be distributed AS IS: AUTODOC-IT.GUIDE AUTODOC-IT.GUIDE.INFO GETTING_STARTED.DOC ABOUT.IFF ; just to let you see, how it works with external commands...:-) CHANGES.DOC -------------------------------------------------------------------------- Maybe you have some interesting proposals, flames etc..? Then send a PM (ZERBERUS) to: VOYAGER@TREFF.ZER. Ciao, Voyager, January 1992