AmigaGuide

Last updated

AmigaGuide is a hypertext document file format designed for the Amiga. Files are stored in ASCII so it is possible to read and edit a file without the need for special software.

Contents

Since Workbench 2.1 an Amiga Guide system for O.S. inline help files and reading manuals with hypertext formatting elements was launched in AmigaOS and based on a viewer called simply "AmigaGuide" and it has been included as standard feature on the Amiga system. Users with earlier versions of Workbench could view the files by downloading the program and library AmigaGuide 34 distributed with public domain collections of floppy disks (for example on Fred Fish collection) or it could be downloaded directly from Aminet software repository. [1] Starting from AmigaOS 3.0 the AmigaGuide tool was replaced with more the complete and flexible MultiView.

AmigaGuide and MultiView

AmigaGuide is the default tool for viewing AmigaGuide files used with AmigaOS 2.1, and is also a basic text viewer for ASCII documents. It can handle multiple files thanks to cross-linking tables called XREF. [2]

MultiView is basically a void container and a natural GUI for the various datatypes that open MultiView as a default tool when any media file (including AmigaGuide files) are invoked by mouse clicking and recognized by the existing correspondent datatype.

AmigaGuide readers on various platforms

Although the AmigaGuide format is almost solely used for documenting Amiga programs, viewers are available for several other platforms:

Syntax

An AmigaGuide document is a simple ASCII-formatted document, so it can be edited by any normal text editor and viewed by any text reader software.

AmigaGuide commands all begin with the '@' (pronounced 'at') symbol. To be recognized as an AmigaGuide document, the first line should include this text:

@database Amigaguide.guide

There are three categories of commands: Global, Node, and Attributes. Global commands are usually specified at the beginning of the document, before any nodes are defined, and apply to all the nodes in the document. Technically, they can be anywhere. Many commands can be used both globally and in nodes.

Node commands are usable inside a node (after an '@NODE' and before an "@ENDNODE"), and affect only the node in which they are used.

Attributes may be specified anywhere in a normal line. In addition to the '@' symbol, attributes always use a pair of braces ('{' and '}') to enclose the attribute name and possibly additional arguments.

Main commands

The commands "INDEX", "HELP", "NEXT", "PREV", and "TOC" and the all-purpose hypertext link specify other nodes to jump to. They all support the naming of nodes within the current document, but they also all support a path along with that name which lets the node be located in any AmigaGuide document.

They will be shown as simply embossed text squared buttons in the page of MultiView.

To access a node in another document, it is simply required to put an AmigaDOS file path before the node name. From this point of view, AmigaGuide is a very simple hypertext language.

Multimedia

Since AmigaOS 3.0 or above, the user can jump to any file that is supported by Amiga datatypes – pictures, animation, anything. It uses the MultiView program to handle it through its internal support for the datatype Amiga standard. The user must still give a "node" name, even though the file is not an AmigaGuide file and has no "nodes" – so the syntax is:

"main": "name_of_picture.iff/main".

Related Research Articles

History of the graphical user interface Aspect of history

The history of the graphical user interface, understood as the use of graphic icons and a pointing device to control a computer, covers a five-decade span of incremental refinements, built on some constant core principles. Several vendors have created their own windowing systems based on independent code, but with basic elements in common that define the WIMP "window, icon, menu and pointing device" paradigm.

AmigaDOS is the disk operating system of the AmigaOS, which includes file systems, file and directory manipulation, the command-line interface, and file redirection.

The resource fork is a fork or section of a file on Apple's classic Mac OS operating system, which was also carried over to the modern macOS for compatibility, used to store structured data along with the unstructured data stored within the data fork.

The Amiga Fast File System is a file system used on the Amiga personal computer. The previous Amiga filesystem was never given a specific name and known originally simply as "DOS" or AmigaDOS. Upon the release of FFS, the original filesystem became known as Amiga Old File System (OFS). OFS, which was primarily designed for use with floppy disks, had been proving slow to keep up with hard drives of the era. FFS was designed as a full replacement for the original Amiga filesystem. FFS differs from its predecessor mainly in the removal of redundant information. Data blocks contain nothing but data, allowing the filesystem to manage the transfer of large chunks of data directly from the host adapter to the final destination.

Binary file

A binary file is a computer file that is not a text file. The term "binary file" is often used as a term meaning "non-text file". Many binary file formats contain parts that can be interpreted as text; for example, some computer document files containing formatted text, such as older Microsoft Word document files, contain the text of the document but also contain formatting information in binary form.

These tables provide a comparison of operating systems, of computer devices, as listing general and technical information for a number of widely used and currently available PC or handheld operating systems. The article "Usage share of operating systems" provides a broader, and more general, comparison of operating systems that includes servers, mainframes and supercomputers.

Ambient (desktop environment) MUI-based desktop environment for MorphOS

Ambient is a MUI-based desktop environment for MorphOS. Its development was started in 2001 by David Gerber. Its main goals were that it should be fully asynchronous, simple and fast. Ambient remotely resembles Workbench and Directory Opus Magellan trying to mix the best of both worlds.

A menu bar is a graphical control element which contains drop-down menus.

NewIcons is a third-party extension to the icon handling system for AmigaOS 2 and newer. NewIcons was first invented and developed by the Italian programmer Nicola Salmoria. Subsequent development was done by Eric Sauvageau and Phil Vedovatti.

Amiga software is computer software engineered to run on the Amiga personal computer. Amiga software covers many applications, including productivity, digital art, games, commercial, freeware and hobbyist products. The market was active in the late 1980s and early 1990s but then dwindled. Most Amiga products were originally created directly for the Amiga computer, and were not ported from other platforms.

AmigaOS is the proprietary native operating system of the Amiga personal computer. Since its introduction with the launch of the Amiga 1000 in 1985, there have been four major versions and several minor revisions of the operating system.

A Uniform Type Identifier (UTI) is a text string used on software provided by Apple Inc. to uniquely identify a given class or type of item. Apple provides built-in UTIs to identify common system objects – document or image file types, folders and application bundles, streaming data, clipping data, movie data – and allows third party developers to add their own UTIs for application-specific or proprietary uses. Support for UTIs was added in the Mac OS X 10.4 operating system, integrated into the Spotlight desktop search technology, which uses UTIs to categorize documents. One of the primary design goals of UTIs was to eliminate the ambiguities and problems associated with inferring a file's content from its MIME type, filename extension, or type or creator code.

Workbench (AmigaOS) Graphical user interface for the Amiga computer

Workbench is the graphical file manager of AmigaOS developed by Commodore International for their Amiga line of computers. Workbench provides the user with a graphical interface to work with file systems and launch applications. It uses a workbench metaphor for representing file system organisation.

AmigaOS 4 Line of Amiga operating systems

AmigaOS 4 is a line of Amiga operating systems which runs on PowerPC microprocessors. It is mainly based on AmigaOS 3.1 source code developed by Commodore, and partially on version 3.9 developed by Haage & Partner. "The Final Update" was released on 24 December 2006 after five years of development by the Belgian company Hyperion Entertainment under license from Amiga, Inc. for AmigaOne registered users.

Hunk is the executable file format of tools and programs of the Amiga Operating System based on Motorola 68000 CPU and other processors of the same family. This kind of executable got its name from the fact that the software programmed on Amiga is divided in its internal structure into many pieces called hunks, in which every portion could contain either code or data.

Amiga support and maintenance software performs service functions such as formatting media for a specific filesystem, diagnosing failures that occur on formatted media, data recovery after media failure, and installation of new software for the Amiga family of personal computers—as opposed to application software, which performs business, education, and recreation functions.

AmigaOS Operating system for Amiga computers

AmigaOS is a family of proprietary native operating systems of the Amiga and AmigaOne personal computers. It was developed first by Commodore International and introduced with the launch of the first Amiga, the Amiga 1000, in 1985. Early versions of AmigaOS required the Motorola 68000 series of 16-bit and 32-bit microprocessors. Later versions were developed by Haage & Partner and then Hyperion Entertainment. A PowerPC microprocessor is required for the most recent release, AmigaOS 4.

A file format is a standard way that information is encoded for storage in a computer file. It specifies how bits are used to encode information in a digital storage medium. File formats may be either proprietary or free and may be either unpublished or open.

Scalos Widget toolkit and window manager for AmigaOS

Scalos is a desktop replacement for the original Amiga Workbench GUI, based on a subset of APIs and its own front-end window manager of the same name. Scalos is NOT an AmigaOS replacement, although its name suggests otherwise. Its goal is to emulate the real Workbench behaviour, plus integrating additional functionality and an enhanced look. As stated on its website, the name "Scalos" was inspired by the fictional time-accelerated planet Scalos in the Star Trek episode "Wink of an Eye".

References

  1. Commodore. "AGuide34". Urban Müller and the Aminet team. Retrieved 2021-09-16.
  2. Romano Tenca. "Guida Rapida Dell'AmigaDOS, AmigaGuide". Amiga Magazine Italia, Gruppo Editoriale Jackson. Retrieved 2015-04-21.