https://github.com/r32/aschm

Last synced: about 1 year ago
JSON representation

as3 api reference chm

README

AS3CHM参考手册
------

如打开空白, 尝试 **文件属性** -> **解除锁定**

Note: 有反馈说为什么别人的 API 有 80~90M 大小, 而这个才这么几M 会不会缺少很多内容?

* 首先, 实际上原 Adobe_API_Zip 包由于是 Ajax 模式, 有一半的文本都是用来布局的, 如果改成框架(frame)模式, 可以完全删掉这些, 只取"内容"即可

* 其次, 这个 nodejs 脚本会按照配置（config.js）, 检测其所关联的文件, 不相关的是不会打包到 CHM 的, 而不是像其它版本一股脑全拖进去

* 最后, 如果你在左上角（package）窗口找不到应该有的内容, 可以点击 "显示过滤条件" 自已配置

## API18

通过更改 config.js 中的 ignores 属性分别打包为:

* [CHM Lite - 6.72M](https://share.weiyun.com/gCvUhqqf) 仅移除了内部的 flash

- 轻型版(推荐), 不包含 **lc, com, ga, coldfusion, xd, org, mx, spark** 这几个包

- 如果你不使用 Flash Build, 比如仅用 Flash CS,或 FlashDevelop 时推荐下载这个更小的

* 旧的 [CHM Default - 34.9M](http://pan.baidu.com/s/1sjxISdn) Md5: `4bcc91321126831919c1090248800ceb`

- 默认版, 不包含 **lc, com, ga, coldfusion, xd** 这几个包

推荐使用 **索引** 搜索类(`class`) 及函数(`Function`) (注:不包括类方法及类属性) 如下图:

![asdoc](show.png)

## build

* nodejs

* [微软 HTML Help Workshop](http://www.microsoft.com/en-us/download/details.aspx?id=21138#system-requirements)

- 之后调整 make.bat 中的 set HHC 对应的路径

```bat
set HHC="D:\Program Files\HTML Help Workshop\hhc.exe"
```

* *(TODO: 这个链接似乎已经失效)* 下载 [Adobe 链接原始ZIP包](http://help.adobe.com/zh_CN/FlashPlatform/reference/actionscript/3/PlatformASR_Final_zh-cn.zip)

调整好 `config.js` 文件中 logdir 属性, 将下载的原始zip解压到 origin

手动修改 `mark/custom/header.js` 内, 变量 `filterXML` 的值

```bash
root
├─ origin/ # 将原始 ZIP 档案解压在这个目录下
├─ mark/
└─ make.bat
```

* 以命令行形式进入到根目录

```bat
make all
```