# HTML API

The `sunformhtmlapi` executable converts an ActionScript 3 API directory into a ZIP archive containing a browsable HTML website.

## ActionScript 3 item

ActionScript 3 items are placed as a TOML file into a package tree in the file system. For example, the `foo.bar` package defines a function `sum`:

foo/bar/sum.toml

```toml
[method]
name = "sum"
description = "Sums two numbers."

[[param]]
name = "a"
type = "Number"

[[param]]
name = "b"
type = "Number"

[[result]]
type = "Number"
```

## Steps

- [ ] 1. Receive the directory path.
- [ ] 2. Receive the ZIP archive output path.
- [ ] 3. Build the ActionScript 3 package hierarchy.
- [ ] 4. Contribute partial ActionScript 3 items to each ActionScript 3 package.
- [ ] 5. Contribute to the search mechanism.
  - The search window searches ActionScript 3 items based in character similarity; not through descriptions or actual contents.
- [ ] ...
- [ ] Semi-last. Generate a HTML website containing the API using something close to the Metro design as in Windows 8.1.
- [ ] Output a ZIP archive containing the HTML website.

### Dependencies

- `smodel` - for representing the ActionScript 3 thingy.
- `clap` - for the command line application.
- `file_paths` - for path manipulations.
- Something for ZIPs