@DATABASE UGG.guide @WIDTH 67 @REMARK This AmigaGuide(R) document was generated by UGG version 1.0 @NODE Main "Main" Ultimate Guide Generator Version 1.0 Copyright 1997 by Kees Puttock User Guide Table of contents: - @{"Introduction" LINK "Introduction" 0} ..............What does it do? - @{"Installation" LINK "Installation" 0} ..............Piece of cake - @{"Usage " LINK "Usage" 0} ..............Even bigger piece of cake - @{"Limitations " LINK "Limitations" 0} ..............Oops! Quite a few here! - @{"Things To Do" LINK "Things To Do" 0} ..............Quite a few limitations,so... - @{"Author " LINK "Author" 0} ..............That's me! - @{"Legal stuff " LINK "Legal stuff" 0} ..............Can't do without it! This program was created using the excellent Blitz Basic II. This document was created using UGG 1.0 (It had to be tested). @ENDNODE @NODE "Introduction" "Introduction" Introduction UGG is a program that lets you make AmigaGuide(R) documents the wysiwyg way. You can add new pages, edit the text on these pages, add links to other pages and even use these links like a real guide document. With UGG everyone can make a good looking Guide. See @{"Usage" LINK "Usage" 0} for detailed information about using UGG. How I came to make UGG? This is more or less the standard story. When I wanted to write some documentation for a little game I had made I couldn't find a program to do it, at least not the way I wanted it to. It really isn't that difficult to type in all the AmigaGuide(R) codes by hand, but you just can't see how it is going to look. There are quite a few programs which generate a guide from a text file in one way or another, but they don't give you much control over what the document will look like (where the 'buttons' will be placed, etc.). So I decided to write my own program, and here it is. I hope you enjoy using UGG and that you find it usefull. If you have any suggestions, bug reports, or whatever, feel free to drop @{"me a line" LINK "Author" 0}. @{"Back to Index" LINK "Main" 0} @ENDNODE @NODE "Installation" "Installation" Installation. This is as simple as can be. Just copy the program anywhere you want and double click the UGG icon to run the program. I suggest you copy this help file with the main program. If you want you can also copy the example project wich is just the project file of this document. UGG only requires the asl.library which can be found on the CD in the 'Libs' drawer. It also requires two standard Workbench fonts, namely Helvetica (size 12) and Courier (size 13). These need to be in your FONTS: directory and can also be found on the CD in the Fonts drawer. That's all there is to it. Find out @{"here" LINK "Usage" 0} how to use UGG. @{"Back to index" LINK "Main" 0} @ENDNODE @NODE "Usage" "Usage" Usage @{"Back to index" LINK "Main" 0} First a walk through the menus: Project: - New : brings up a requester asking if you wish to clear the current project from memory - Open : brings up a filerequester for loading a UGG project file NOTE: You can't open an AmigaGudie(R) document! - Save : brings up a file requester for saving the current project - Make Guide: also brings up a file requester. Here you can enter a name for the Guide wich will be generated from the current project - About : brings up a little window with some information - Quit : this should be quite clear Edit: This menu contains some simple edit functions. Page: - Add Page : brings up a requester asking for a name for the new page (the new page will become the new current page). The maximum number of characters for this name is 19. - Delete Page: brings up a requester asking if you really want to delete the current page (if you do delete the page the new current page will be the next one up in the page list) - Empty Page : brings up a requester asking if you really want to clear the current page (the page itself will not be deleted, it will just be empty) - Change Name: brings up a requester with the name of the current page which you can change (NOTE: You can't change the name of the first 'Main' page, because the AmigaGuide(R) standard requires the title of the first 'node' to be 'Main') Link: - Add Link : doesn't bring up a requester, but displays intruc- tions in the tiltlebar of the main window. First you click the first character of the word you want to transform into a link. Secondly you click on the last character of the word (or words). Now the link will be made visible and you can click on the page in the page list to which you want to link. I you are not satisfied with the position of the link, you can press the right mouse button to cancel and try again. - Remove link: just click on the link you wish to delete and it is gone (again the right mouse button to cancel) The main window is just like a text editor(although quite @{"limited" LINK "Limitations" 0} for the moment), so you can type in text like any other editor. If want to edit a line of text wich contains a link, you should first delete the link, edit the text and then make a new link. If you don't, strange things will happen (the link information isn't updated automaticaly yet). The 'Page List' window contains a list of all the pages of the current project. Simply clicking on a name in the list will make that page the curent page. @{"Back to index" LINK "Main" 0} @ENDNODE @NODE "Limitations" "Limitations" A list of limitations: - The number of pages is limited by the height of your screen. I couldn't get the page list to scroll so the names of all the pages have to fit in the window. - You can't determine the size of the screen. It is either PAL Hires or PAL Hires Lace (depending on the size of your Work- bench screen) - The fonts are also fixed. This is because for the moment the letters of the font for the main window need to be equal in width. - Because of the above, there is no preferences editor. - The maximum number of lines on a page is 80. - The maximum number of links on a page is 20. - There is no support for text styles (bold, underlined, etc.) (I haven't figured out how to do them yet). - It isn't possible to load an AmigaGuide(R) document (this is mainly because of the above limitation). - The editor itself is crap. It works, but it has very few func- tions and it becomes slow when editing larger pieces of text. Also, there is no other way of editing a line containing a link than simply deleteing the link, edit the text and recreate the link. These are quite a lot of limitations (and there are probably some more I missed), but my programming talent isn't that great yet. It means there is still very much @{"to do" LINK "Things To Do" 0}, and when I feel like it and when I have enough time I will try to improve this program. For now, I hope you still find UGG useful and if you have any suggestions for improvement, please @{"let me know" LINK "Author" 0}. This is my first 'bigger' project, so please bear with it. @{"Back to index" LINK "Main" 0} @ENDNODE @NODE "Things To Do" "Things To Do" Things To Do If I have the time and I feel like it, I will try to make the list of @{"limitations" LINK "Limitations" 0} a bit shorter and add any of the suggestions you might @{"send to me" LINK "Author" 0}. @{"Back to index" LINK "Main" 0} @ENDNODE @NODE "Author" "Author" Here's my address: Kees Puttock Houtmansgracht 19 2801 XC Gouda The Netherlands Fax: (+31) (0)182 529332 Email: not yet And this is my Amiga setup: - A1200 030, 50mhz, 50mhz, 34 mb - 80 mb harddisk (I know, way to small!) - Zip drive - CD-Rom drive (X2) - 1084s monitor - Canon 620 bubble jet printer @{"Back to index" LINK "Main" 0} @ENDNODE @NODE "Legal stuff" "Legal stuff" Legal stuff UGG is FREEWARE. This means you can copy it all over the place as long as you don't ask any money for it. If you feel like sending me something anyway (a card saying how much you like UGG would brighten up my day ;-), @{"here is my address" LINK "Author" 0}. Although UGG has been thoroughly tested, I cannot be blamed for any damages caused by the use of this program. @{"Back to index" LINK "Main" 0} @ENDNODE