摘要: 1 EverEdit插件-CHM助手:一种免费、高效的CHM手册制作方式 1.1 前言 业界制作CHM手册的工具多如牛毛,高贵的商业工具如:HelpNDoc、Help+Manual、HelpSmith等;号称最专业的免费CHM制作工具的Precision Helper,以及其他各种粗制滥造的收费或免 阅读全文
posted @ 2024-12-21 22:22 tyysoft 阅读(476) 评论(0) 推荐(2) 编辑
摘要: 1 生成CHM文件后搜索显示为乱码或搜索结果不全的原因及解决办法 1.1 问题背景 使用一些CHM帮助制作工具生成的帮助文件,在html编辑阶段都显示正常,但是生成chm后,可能会出现以下问题: 页面显示为乱码 搜索时,搜索结果为乱码 搜索不到结果,但明明打开手册时可以看到相关文字正常显示。 1.2 阅读全文
posted @ 2024-12-21 22:11 tyysoft 阅读(58) 评论(0) 推荐(0) 编辑
摘要: 1 使用Markdown工具写作手册 1.1 概述 为什么使用笔记软件写手册? Markdown语法简单,写作效率高 格式丰富,功能强大 支持代码着色,非常适合软件类手册 支持导出html、pdf 1.2 使用方法 1.2.1 在VNote中写作手册页面 VNote的使用方法本文不详细介绍,但需要明 阅读全文
posted @ 2024-12-21 22:10 tyysoft 阅读(30) 评论(0) 推荐(0) 编辑
摘要: 1 CHM助手 >> 高效制作接口文档 1.1 概述 用户如果书写代码的过程中使用了良好的注释,比如:doxygen规范, 则有可能生成比较规范的接口文档。很多工具软件都支持编程扩展,比如:宏/脚本接口,那么,完善的接口文档将会给用户带来极大的便利,否则,软件的使用和推广都会受到较大的影响。 为了能 阅读全文
posted @ 2024-12-21 22:09 tyysoft 阅读(19) 评论(0) 推荐(0) 编辑
摘要: 1 CHM助手使用说明 >> 步骤5:制作CHM工程并编译 1.1 概述 chm工程制作及编译并不神秘,chm工程主要包含3个文件,主工程文件(.hpp)、目录文件(.hhc)、索引文件(.hhc),这3个文件都是文本内容文件,在“CHM工程的组成”章节已经介绍。 准备好工程相关文件后,需要安装微软 阅读全文
posted @ 2024-12-21 22:08 tyysoft 阅读(45) 评论(0) 推荐(0) 编辑
摘要: 1 CHM助手使用说明 >> 步骤4:制作帮助文件大纲 1.1 概述 使用一般的CHM帮助文件制作工具写作CHM文档时,也需要编写大纲(目录),它们的写作形式一般如下: 逐个创建:由用户手工逐个创建目录节点,并绑定html文件 导入文件:部分软件提供了导入文件功能,导入后节点与html已经绑定,但目 阅读全文
posted @ 2024-12-21 22:08 tyysoft 阅读(31) 评论(0) 推荐(0) 编辑
摘要: 1 CHM助手使用说明 >> 步骤3:文字编码转换 1.1 概述 很多新手在制作chm帮助文档时,会发现要么搜索不全,搜索结果为乱码,要么帮助页面显示主乱码,这种情况主要是因为html文档中包含了中文,或其他语言文字,对于包含中文的chm文档,所有的html页面都必须要使用GB2312编码,否则无法 阅读全文
posted @ 2024-12-21 22:07 tyysoft 阅读(13) 评论(0) 推荐(0) 编辑
摘要: 1 CHM助手使用说明 >> 步骤2:图片宽度转换相对宽度 1.1 概述 在文档写作界,流传一句“字不如表、表不如图”的定律,所以,即使是chm联机帮助,良好的图文排版,会让手册的知识传播效果加倍,但不幸的是,微软对chm文档的更新已经停止好多年了, 随着硬件的发展,近些年出现了大量高分辨率的屏幕, 阅读全文
posted @ 2024-12-21 22:06 tyysoft 阅读(31) 评论(0) 推荐(0) 编辑
摘要: 1 CHM助手使用说明 >> 步骤1:清理HTML文档 1.1 应用场景 由于编译CHM文档时,html文档的目标文本编码方式是GB2312,而使用第三方工具编写的html文件可能是utf8编码或者其他编码方式,有些特殊字符如:©、🕮等,在GB2312文档中显示为乱码,需要使用html符号描述方式 阅读全文
posted @ 2024-12-21 21:58 tyysoft 阅读(32) 评论(0) 推荐(0) 编辑
摘要: 1 CHM索引文件说明(HHK) 1.1 概述 索引文件决定了CHM文件中“索引”标签页中显示的内容,索引文件脱胎于目录文件,但又区别于目录文件,目录文件可以显示帮助的章节层次结构,但索引文件不需要显示层次结构,且一个页面可以有多个关键字,且在索引标签中,多个关键字对应一个页面。 下面是一个索引文件 阅读全文
posted @ 2024-12-21 21:57 tyysoft 阅读(26) 评论(0) 推荐(0) 编辑
摘要: 1 CHM目录文件说明(HHC) 1.1 概述 hhc目录文件是chm帮助的核心,它定义了chm帮助文件的目录层次结构,以及关联目录和对应的html文件,如下是一个hhc文件的样例内容: <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> <HTML> <H 阅读全文
posted @ 2024-12-21 21:56 tyysoft 阅读(31) 评论(0) 推荐(0) 编辑
摘要: 1 CHM工程文件说明(HHP) 扩展名为.hhp的文件为CHM工程文件,该文件定义了chm文件的标题、目录文件、索引文件、字体、语言等,如下是一段CHM助手使用手册的hhp文档: [OPTIONS] Compatibility=1.1 or later Compiled file=CHM助手(CH 阅读全文
posted @ 2024-12-21 21:56 tyysoft 阅读(44) 评论(0) 推荐(0) 编辑
摘要: 1 如何安装CHM助手 下载CHM助手.ezip,下载地址 打开EverEdit,选择主菜单“扩展 -> 扩展管理 -> 从本地文件安装扩展”,在弹出的文件浏览窗口中选择插件安装包,如下图所示: 3.选择EverEdit的主菜单“扩展 -> 模式 -> CHM”,即可在主菜单出现CHM助手菜单,如下 阅读全文
posted @ 2024-12-21 21:56 tyysoft 阅读(34) 评论(2) 推荐(0) 编辑
摘要: 1 插件说明 1.1 基本信息 CHM助手是一款EverEdit文本编辑器插件(脚本),使用Javascript语言编写,脚本结合EverEdit提供的基础功能,完成html文件的格式整理、chm工程文件及附属文件的生成及编译等。 当前版本:1.0.0 插件作者:太阳雨 1.2 插件功能 下图是CH 阅读全文
posted @ 2024-12-21 21:54 tyysoft 阅读(37) 评论(1) 推荐(0) 编辑
摘要: 1 CHM助手 >> 作者序 作者一直认为,完善的产品手册,是一个产品/软件充分发挥其社会价值的基础,可以让用户更高效更完整的使用软件,充分发挥软件/产品的功能,达到社会效益的最大化。 为此,作者在学习和工作中一直注重文档的写作,也接触过不少chm文档制作工具,包含商业软件和免费软件,比如:Help 阅读全文
posted @ 2024-12-21 21:54 tyysoft 阅读(37) 评论(0) 推荐(0) 编辑