Skip to content
mariusbuPublic

About

An AmigaGuide viewer for the browser, with a Workbench 3.x look

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

18 Commits

Folders and files

Repository files navigation

Retrace — AmigaGuide viewer

A dependency-free browser viewer for AmigaGuide (.guide) files, named after the AmigaGuide history button. Plain HTML/CSS/JS — no framework, no build step.

Live at https://mariusbu.github.io/retrace/ — it opens with a sample guide; drop your own .guide files onto the window.

Retrace rendering the sample guide

Features

  • Renders AmigaGuide nodes with the classic viewer layout: Contents / Index / Help / Retrace / Browse navigation and a per-node window title
  • Workbench 3.x chrome: the 4-color palette, gadtools-style bevels, prop-gadget scrollbars, and menu-style dropdowns
  • Text attributes: bold, italic, underline, Workbench pen colors
  • Word wrapping modes (@wordwrap, @smartwrap) at document and node level
  • Justification, indents, and tab stops (@{jcenter}, @{lindent}, @{settabs}, …)
  • @macro expansion with $1..$9 argument substitution
  • Multi-file loading: open several guides (or drop a whole folder — the hierarchy is kept) and cross-guide links resolve between them, whether relative to the linking guide, to the folder root, or by bare filename
  • Folder drops register every file without reading it; each one is loaded on first visit, and linked plain files (autodoc .docs, READMEs, headers) display as text, like MultiView
  • Line-number link targets scroll to the exact line
  • Deep-linkable URLs (#file.guide/node), browser back/forward, and an AmigaGuide-style retrace stack
  • Reads ISO-8859-1 (Amiga Latin-1) correctly; renders in Patrick H. Lauke's Amiga Topaz font (CC BY 3.0, see fonts/README.md)
  • Script buttons (rx, system, …) are shown but never executed

Test

npm test           # node --test 'js/*.test.js'

Layout

  • js/parser.js — pure text → data parser (nodes, settings, inline tokens)
  • js/renderer.js — parsed node → DOM
  • js/app.js — file loading (including folder drops), hash routing, toolbar, retrace
  • samples/ — sample.guide (feature exercise) and other.guide (cross-file links)
  • fonts/ — bundled Amiga Topaz (CC BY 3.0, not covered by the MIT licence)

Licence

MIT — see LICENSE, which also carries the acknowledgments and the font attribution.

About

An AmigaGuide viewer for the browser, with a Workbench 3.x look

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages