FandocViewer 1.0.6
Extend the capabilities of flux to show Fandoc documentation

FandocViewer automatically extends the capabilities of flux to show Fandoc documentation. It adds a fandoc uri scheme allowing you to navigate and view all the Fantom pod documentation and source code in your current Fantom installation. Fantom docs offline!

Try these command lines:

> flux fandoc://docLang
> flux fandoc://sys
> flux fandoc://afFandocViewer/
> flux fandoc://fandoc/HtmlDocWriter

Wow! It looks just like the Fantom website! And all your pods are there too! The scheme follows the format:

fandoc://${podName}/${typeName}

It works by adding a web browser view to flux. That means you can also do this:

> flux http://www.alienfactory.co.uk/

See Browser for instructions on binding F5 to the refresh command.

Read more...

Install

To install FandocViewer with Fantom Pod Manager, cut'n'paste the following into a cmd prompt, terminal or shell:

Or to install FandocViewer with the Fantom Repository Manager (fanr), cut'n'paste the following into a cmd prompt, terminal or shell:

Or to install manually, download the pod file and copy it to the %FAN_HOME%/lib/fan/ directory.

afFandocViewer.pod (37.03 kB)

Use

To use FandocViewer in a Fantom project, add a dependency to the project's build.fan:

depends = ["sys 1.0", ..., "afFandocViewer 1.0.6 - 1.0"]

Documentation

Information

Meta information on the FandocViewer pod:

Published by
Steve Eynon
Organisation
Alien-Factory
Pod file size
37.03 kB
Licence
BSD 2-Clause License
Built on
8th Apr 2013
Depends on
compilerDoc, fandoc, flux, fluxText, fwt, gfx, sys, web
Referenced by
Javascript Compatible
No

Dependency Graph

  Use mouse to re-position pods

Release History

There have been 8 releases of FandocViewer: