Copyright (c) Hyperion Entertainment and contributors.

AmigaGuide

From AmigaOS Documentation Wiki
Revision as of 21:23, 30 May 2012 by Richard Lake (talk | contribs) (Created page with "AmigaGuide files are typically included with all Amiga software. They usually contain information such as Installation Instructions, Software Requirements, Features, Keyboard...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

AmigaGuide files are typically included with all Amiga software.

They usually contain information such as Installation Instructions, Software Requirements, Features, Keyboard Shortcuts, Help and Advice and legals.

However, they can be used for any kind of information.

The AmigaGuide format is an early example of software adopting the Hypertext framework of linking pages of information together.

Although most developers these days prefer to direct users to a website for further information, being able to have documentation stored locally is still necessary.

Developers who have the SDK installed can click the appropriate link on the right for more information on the COMMANDS available to you when creating such a file.

Although AmigaGuide files are essentially text only you might want to make use of an AmigaGuide editor - and should try GuideMaker.

Additionally you will find various tools on [[1]] that can also help you convert documentation into the AmigaGuide format.


For SDK Documentation regarding the AmigaGuide format, go the following location in AmigaOS:

SDK:Documentation/AutoDocs/amigaguide_dtc.doc


Download GuideMaker from OS4 Depot:

http://www.os4depot.net/share/development/utility/guidemaker.lha