Copyright (c) Hyperion Entertainment and contributors.

AmigaGuide Library

From AmigaOS Documentation Wiki
Revision as of 01:54, 20 February 2014 by Daniel Jedlicka (talk | contribs) (Created page with "= Introduction = AmigaGuide is a [http://en.wikipedia.org/wiki/Hypertext hypertext] system widely used in AmigaOS, and AmigaGuide Library provides a way for developers to add...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Introduction

AmigaGuide is a hypertext system widely used in AmigaOS, and AmigaGuide Library provides a way for developers to add interactive help to their applications. The library offers the following main features:

  • text displayed in a synchronous or asynchronous window;
  • context-dependent help;
  • dynamic hosts allowing applications to incorporate context-sensitive or "live" project data within their help systems;
  • internal messaging;
  • ARexx interface.

Library Opening

Just like other AmigaOS libraries, the AmigaGuide Library must be opened and its interfaces obtained before use:

struct Library *AmigaGuideBase = NULL;
struct AmigaGuideIFace *IAmigaGuide = NULL;
 
if ( (AmigaGuideBase = IExec->OpenLibrary("amigaguide.library", 52)) )
  {
   IAmigaGuide = (struct AmigaGuideIFace *)IExec->GetInterface(AmigaGuideBase, "main", 1L, NULL);
  }
 
if ( !AmigaGuideBase || !IAmigaGuide )
{
   /* handle library opening error */
}