Copyright (c) Hyperion Entertainment and contributors.
Difference between revisions of "AmigaGuide"
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...") |
|||
| Line 1: | Line 1: | ||
| + | AmigaGuide is a [http://en.wikipedia.org/wiki/Hypertext hypertext] system widely used in AmigaOS for documentation. You'll find AmigaGuide files included with most 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. |
||
| − | AmigaGuide files are typically included with all Amiga software. |
||
| + | Although most developers these days prefer directing users to a website for further information, being able to have documentation stored locally still makes sense. AmigaGuide files are normally viewed using AmigaOS' universal viewer, MultiView, but the developer can also use the [[AmigaGuide Library]] to provide interactive "online help" right from within the application. |
||
| − | They usually contain information such as Installation Instructions, Software Requirements, Features, Keyboard Shortcuts, Help and Advice and legals. |
||
| + | AmigaGuide is a text-based format and can be edited in a text editor quite easily. However, there are dedicated AmigaGuide editors such as [http://www.os4depot.net/index.php?function=showfile&file=development/utility/guidemaker.lha GuideMaker] or [http://aminet.net/package/text/hyper/Heddley120beta Heddley]. You can also find various tools on [http://www.os4depot.net OS4Depot] to help you convert documentation into the AmigaGuide format. |
||
| − | However, they can be used for any kind of information. |
||
| + | AmigaGuide commands are documented in the SDK (Documentation/AutoDocs/amigaguide_dtc.doc). |
||
| − | 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 [[http://www.os4depot.net|OS4Depot]] 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 |
||
Revision as of 01:24, 20 February 2014
AmigaGuide is a hypertext system widely used in AmigaOS for documentation. You'll find AmigaGuide files included with most 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.
Although most developers these days prefer directing users to a website for further information, being able to have documentation stored locally still makes sense. AmigaGuide files are normally viewed using AmigaOS' universal viewer, MultiView, but the developer can also use the AmigaGuide Library to provide interactive "online help" right from within the application.
AmigaGuide is a text-based format and can be edited in a text editor quite easily. However, there are dedicated AmigaGuide editors such as GuideMaker or Heddley. You can also find various tools on OS4Depot to help you convert documentation into the AmigaGuide format.
AmigaGuide commands are documented in the SDK (Documentation/AutoDocs/amigaguide_dtc.doc).
