02 制作帮助文件

合集下载

教你如何制作chm帮助文件

教你如何制作chm帮助文件

HTML Help Workshop是Microsoft推出的免费的chm编译器,“汉化新世纪”提供了汉化版下载,不过该版本附带了广告插件。

如果您不介意的话笔者建议您到Microsoft页面下载,毕竟Microsoft是chm文件的鼻祖。

目前,Microsoft提供的版本是绿色版的,将下载的文件解压到一个目录,点击文件夹中的Setup.exe 安装即可使用。

除了主程序,还有一个叫做“HTML Help Image Editor”图像编辑器。

首先来认识一下界面:制作chm文件首先需要html文件,如果您手头没有html文件,那么请及时制作。

1.建立"Project"其次,是在HTML Help Workshop中建立一个“project”。

制作步骤如下:▪“File”→“New”→“Project”▪“下一步”→填写“Project”的存放名称和路径▪“下一步”→“下一步”→完成以上步骤生成一个*.hhp文件,这个就是要编译的主文件。

其结果如下:上图中,在"change project options"可以设置chm的默认显示首页,标题,语言,允许全文搜索(“Compile full-text search information”)以及合并chm。

注意:•“add/remove topic files”用来需要编译的HTML文件;•“add/modify windows definitions”用来定义CHM文件的窗口显示(按钮,位置,窗口大小以及工具栏包含的按钮)和内容等。

请跳转到“搜索框”一节查看具体内容。

•“help API information”是连接应用程序的API接口,具体内容请参阅:这里2. 编辑“目录”在建立“project”后,下一步是设置“contents”(目录)。

点击“contents” 按钮,我们就跳转到了目录编辑框。

首次使用“Contents”时,程序会自动帮您创建一个“Contents” (目录),您只需要按默认设置即可。

使用Doxygen 生成帮助文档,并生成chm 格式

使用Doxygen 生成帮助文档,并生成chm 格式


4. Open HTML Help Workshop:Start->TML Help Workshop -> HTML Help Workshop. The following is the opening interface. Nhomakorabea
5.Open index.hhp generated by Doxygen in HTML Help Workshop. The steps are: File->Open-> index.hhp( index.hhp is located at the path of docs setting in Doxygen), click compile, and then get the index.chm. In default, index.chm and index.hhp will be in the same direct. Please see the following snaps:
1.Generate Code’s Notes base on the format requirement of doxygen(Programmers’ responsibility).Please see doxygen_manual.chm. Now assume the source code which have been commended is located at : C:\Users\Vincent\Desktop\include\include 2.Please open Doxygen as the following steps: GUI:Start->doxygen->Doxyziward。 The following are snapshots:

制作帮助文档格式的电子书库——用Htmlhelp workshop制作chm文件

制作帮助文档格式的电子书库——用Htmlhelp workshop制作chm文件

制作帮助文档格式的电子书库——用Htmlhelp workshop
制作chm文件
TOTO
【期刊名称】《计算机应用文摘》
【年(卷),期】2000(000)011
【摘要】这是一个讲求效率的时代,仅仅将一个Readme文本文件作为一个软件的帮助文档的公司或软件作者就太不负责任了,而且你在网上搜集的无数散乱的学习资料也需要一个整合高效的管理方法。

【总页数】4页(P58-61)
【作者】TOTO
【作者单位】无
【正文语种】中文
【中图分类】TP316.7
【相关文献】
1.CHM格式帮助文件的制作 [J], 孙晶晶;吴金屏
2.如何快速制作CHM帮助文件 [J], 夏克付
3.AutoCAD工程CHM帮助文件的制作 [J], 张俭
4.使用HTML Help Workshop制作基于HTML的帮助文件 [J], 李薇;崔莲
5.为应用程序制作CHM帮助文件 [J], 陈小勇
因版权原因,仅展示原文概要,查看原文内容请购买。

如何制作已编译的HTML帮助文件(即CHM帮助文件)

如何制作已编译的HTML帮助文件(即CHM帮助文件)

HTML帮助文档从结构上来看可分为两个部分,运行器和文档内容。

它的一个好处是能使帮助文档跨平台运行,只要有不同平台上的运行器和浏览器,帮助文档不再需要重新编制,制作HTML帮助文档的工具是Html help Workshop工具包。

方法:1、安装好Html Help Workshop,需要重新启动一次才可以运行。

运行后,单击菜单或工具栏中的“新建(New)”,这时出现选择新建内容的对话框。

先选择“工程(Project)”,在接着出现的工程向导中指定工程放置的目录就可以了。

单击“OK”后就出现工程编辑界面。

在工程编辑界面的上方是3个标签栏,第一个“Project”是有关工程的编辑,第二个“Contents”是目录,第三个“Index”是索引。

在工程编辑界面的左侧是7个按钮,它们的功能从上到下依次为:“改变工程选项”、“加入/删除封面文件”、“添加/修改窗口选项”、“HTMLhelp AP信息”、“浏览HTML源文件”、“保存”、“存盘并编译”。

2、单击“改变工程选项”按钮,出现工程选项对话框(如图1)。

这里仅改变标题(Title)的内容,把标题写入,编译后这个标题将出现在窗口的标题栏中。

其他的内容暂时用系统的默认值。

然后单击“加入/删除封面文件”按钮,再选择“加入”按钮,把作为封面页的HTML文件添上。

封面页的文件一定要有,否则编译的帮助文件运行后,系统会报错。

好了,简单的工程编辑就完成了。

3、单击“目录”(Contents)标签栏,这时系统请你选定一个新目录文件的名称,指定后出现目录的编辑界面(如图2)。

然后按照内容的需要插入标题或页面目录,并对每个目录选定相应的HTML文件。

标题可以分为多级,并在标题上也放置需要的HTML文件,作为标题的说明内容,这需要按照你制作的内容统一考虑。

目录的内容在编译后(如图3)的左侧所示,这是3个标题,单击目录可以打开相应的文件内容。

插入目录后,关于目录的属性暂时也用默认值,这样基本的目录就可完成。

【原创】三把利器快速制作代码帮助文档

【原创】三把利器快速制作代码帮助文档

【原创】三把利器快速制作代码帮助⽂档1相信不少⿇油都已经积累了属于⾃⼰的代码库了,不知道是否有过这样的经历:A:听说你上次写了个通⽤XXX类库啊,我正好要⽤到,⿇烦把dll发我⼀下。

B:好的,你等⼀下,我发给你。

⼗分钟后A:喂,你这个类是怎么⽤的啊,有没有帮助⽂档啊。

B:汗,没来得及做,我来和你说吧。

⼀个好⽤的类库,如果能配上⼀个好的说明⽂档(最好还带搜索功能),⽆疑是为⾃⼰和他⼈提供了莫⼤的⽅便,有什么想要的功能,去⽂档⾥⼀查,⼀⽬了然。

我最近就碰到了这个问题,甚⾄更为严重的是,有很多很久之前写的代码,⾥⾯实现了哪些功能,细节我已经不是很清楚了,还需要去翻看代码,⾮常难管理和查找。

2那么开始今天的内容,⾸先需要准备好三⼤利器啊^_^:⼀、下载安装GhostDoc:⼆、下载安装sandcastle和Sandcastle Help File Builder三、安装Visual Studio(什么?这个谁没有?好吧,咱们继续往下- -||)3下⾯说⼀下三⼤利器到底怎么配合⽤,帮我们制造出好⽤的帮助⽂档呢?不知道⼤家通常是怎么写注释的,我的习惯都是直接///然后vs帮我⽣成XML格式的注释,⽽不是简单的//或者/**/。

现在有了GhostDoc(⼤家也可以下载GhostDoc Pro,可以批量注释,更强⼤),我们就可以快速的给我们的代码添加注释了。

这⼀步是必不可少的,否则⽂档就没有了数据来源了。

如果GhostDoc不会⽤,可以参考这个⽂章,总结的很详细:这⼀步是做什么呢?其实主要是利⽤VS强⼤的“⽣成后事件”功能,配置⼀些宏和Marco指令,把我们代码库中的dll和注释⽂件xml拷贝到⼀起,⽅便制作。

当然,如果您的代码全写在⼀个项⽬dll⾥,那这⼀步对您来说是没什么⽤处啦。

反正我的库是分了20多个项⽬,⼀个个去找dll很⿇烦的,所以就⾃动让他们放到⼀个输出⽬录下:打开项⽬属性:选择“⽣成”⾯板,允许输出XML注释⽂档,这步很重要下⾯选择“⽣成事件”⾯板,在“⽣成后事件”中输⼊指令:copy "$(TargetDir)*.dll" "$(TargetDir)..\..\..\OutPut"copy "$(TargetDir)*.xml" "$(TargetDir)..\..\..\OutPut"好了,把整个类库重新⽣成⼀下,会发现在OutPut⽂件夹⾥全部是我们要的dll和Xml:打开Sandcastle Help File Builder,后⾯的具体步骤可以参考这篇⽂章:,也很详细。

Pointwise官方英文帮助文件中文版2

Pointwise官方英文帮助文件中文版2

Chapter 2 layer manager (层管理)概述本部分包含了在pointwise中是使用层管理的简要概述。

层管理被用来分配database entities给有序的设置,或者层,以便控制窗口显示。

当使用哪一个entity作为参考时,每一个层的显示或者层的设置,可被快速地打开或者关闭。

在这种情况下,你可以快速地分离一个你需要的复杂database,并且关闭剩余entities,以便他们不会在显示窗口积聚。

在本教程中,你需要从一个IGES文件中导入一个几何体,并且把它分配给层。

你也会需要修改一些database 显示分布,以便更好地看清几何体的形状。

另外,你将会需要尝试几种选择方法,以便知道他们的在相应应用情况下的优势。

用到的命令在表2.1中,你会看到在本指导中最常使用工具条命令的展示,参考该表进行接下来的工作,将会使你感觉轻松自如。

几何体在层中分配的几何是一个波音747的短舱和中心体。

启动开始通过以下几种方式启动pointwiseunix/linux系统下,在命令器中输入pointwisewindows系统中,双击pointwise桌面图标Mac在application/pointwise中,双击pointwise应用输入几何体将使用的几何体是一个叫做747_nacelle.igs的IGES 文件(有的版本是747.Igs)。

它位于你的pointwise的安装路径下tutorials/LayerManager/。

在导入pointwise之前,最好把它复制到另外一个路径下。

假定你已经复制了747_nacelle.igs到你的当前目录下,通过文件菜单导入:1、 file,import,database2、双击747_nacelle.igs文件3、 Ok4、该文件已经被导入到pointwise中了。

依据你当前的视角方向,应出现该图2.2所示如果你的显示是一般的短舱,可以通过下面的操作来生成完整的短舱1、选择所有的database2、右键单击选中copy,再右键单击选中paste,按快捷键Ctrl+C然后再Ctrl+V3、选择mirror4、在mirror面板下,选中下图所示的选项。

制作合并CHM的帮助文件

制作合并CHM的帮助文件

使用HTML Help Workshop 制作合并CHM帮助文件1.1制作独立的chm文件步骤 (3)1.1.1创建HTML 帮助项目文件(.HHP) (3)1.1.2往项目中添加主题文件(Topic Files) (3)1.1.3设置工程选项(Project Options) (3)1.1.4为帮助文件添加目录(Contents)和索引(Index) (3)1.1.5为帮助文件设计窗口样式(Window style) (4)1.2制作合并的chm文件步骤 (4)1.2.1多个chm帮助文件的合并(Merge) 运用 (4)1.3制作chm帮助文件工具 (5)1.4制作合并的chm帮助文件的好处 (5)1.1制作独立的chm文件步骤1.1.1创建HTML 帮助项目文件(.HHP)a)打开HTML Help Workshop 后,选取菜单上的[File/New] 或直接选取工具条上的新建工具,将打开一个列表框,选择Project 项,HTML 项目文件向导已经启动了。

直接单击“下一步”按钮。

b)这一步要求输入或选择要创建的项目文件的路径和文件名。

假设C区中已经存在一个目录“C:\help”,那么输入“C:\help\help1”,单击“下一步”按钮,其扩展名.HHP将会自己加上。

“help1”这是要创建的项目文件名。

c)现在这一步要选择需要加入项目文件的目录文件、索引文件、和HTML 文件,由于是新建的工程还没有这些,直接单击“下一步”按钮。

d)单击“完成”按钮,一个名为“help1.hhp”的项目文件已经创建并且打开了。

1.1.2往项目中添加主题文件(Topic Files)a)单击“Add”按钮,在“打开”文件对话框里,选择此工程所有需要的HTML 文件。

b)要生成帮助文件需要编译。

选择菜单命令File/Compile 或者工具栏上的CompileHTML file 工具按钮,打开的对话框是要输入或选择项目文件,默认的就是当前项目,直接单击“Compile”按钮。

帮助文档(chm)、电子书制作指南

帮助文档(chm)、电子书制作指南

Easy chm破解版的程序压缩包:EasyCHM制作简易教程EasyCHM使用方法很简单:1.先建立一个文件夹,以后的所有文件都将放在这个文件夹里,在这个文件夹里以每章的题目为名建立子文件夹,把你要做成电子书的文件用WORD转化成htm,注意,转化成“筛选过的网页”,我试过转化成“网页”最后图片不显示。

再将这些文件放到对应章的文件夹下,每节一个文件,名字写好,注意名字不要有#,*字符。

比如:你想最后呈现这样一个结果,你只需建立这样的文件夹:然后再在这两个文件夹中添加所需的文件,即小节内容(全部是转化过来的htm文件),准备工作完成。

2.打开EasyCHM,“新建工程目录”,最好选在刚才新建的主文件夹下,确定这后,软件自动生成目录,使用该软件的工具可以轻松编辑内容。

3.编译这下着重看看文件中的图片显示出来了没有,一切OK。

另外,如果做好的CHM文件放在本地能打开,放在别的电脑上无法显示,请参照以下两个方法:1.打开时会出现“您要打开此文件吗?打开此文件前总是询问”将“ 打开此文件前总是询问” 的选项前的勾去掉,然后打开,就正常了。

2.(1)新建一个文本文件(2)添加如下内容:REGEDIT4[HKEY_LOCAL_MACHINE\SOFTW ARE\Microsoft\HTMLHelp] [HKEY_LOCAL_MACHINE\SOFTW ARE\Microsoft\HTMLHelp\1.x\It ssRestrictions]"MaxAllowedZone"=dword:00000003另存为Help.reg(3)双击导入注册表3.右键CHM文件,点击属性,单击“解除锁定”。

以上是从网络博客中摘录的内容,包括主要功能的实现方法。

其他常见问题的解决方法:1.网页设置为不可复制:修改.htm文件的源码,在<body>域中将这两个参数oncontextmenu = self.event.returnValue = falseonselectstart= "return false"设置为”false”,或者直接复制上述两行代码至<body>域就可以了。

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

单击 Next 按钮进行下一步操作
安装Microsoft Help Workshop
(2)单击Next按钮,进入如下图所示的界面。
选择安装路径
单击 Next 按钮进行下一步操作
安装Microsoft Help Workshop
(3)单击Browse按钮,选择软件安装路径,单击Next按钮,在弹出的安装
类型界面中选中 Typical单选按钮,如下图所示。
选择安装类型
开始安装 Help Workshop 软件
安装Microsoft Help Workshop
(4)单击Next按钮,开始安装,如下图所示。安装完成后,在弹出的对话 框中单击“确定”按钮,即可完成Microsoft Help Workshop软件的安装过程。
制作帮助文件
(3)单击Options按钮,弹出如下图所示的Options对话框,选择
Files选项卡,单击Change按钮,将“帮助文件.rtf”文件添加到Rich
Text Format(RTF) files下拉列表框中,然后单击Contents file文本框后 面的Browse按钮,将帮助索引文件“帮助文件.cnt”添加到Contents file
制作帮助文件
本讲大纲: 1、安装Microsoft Help Workshop 2、制作帮助内容文件
3、制作帮助索引文件
4、制作帮助文件
支持网站:
安装Microsoft Help Workshop
Microsoft Help Workshop软件是一个用于制作.hlp帮肋文件的软件,该软 件需要单独安装。 (1)双击运行SETUP.EXE文件,弹出如下图所示的安装界面。
文本框中。
选择 Files 选项卡 选择 RTF 帮助内容文件
选择帮助索引文件
制作帮助文件
(4)单击“确定”按钮,返回到“Microsoft Help Workshop-[帮
助文件.hpj]”窗体,如下图所示。
单击该按钮编译帮助文件
制作帮助文件
(5)单击Save and Compile按钮,编译“帮助文件.hlp”文件。帮
选择该项
单击 OK 按钮,创建帮助项目文件
制作帮助文件
(2)选择Help Project选项,单击OK按钮,在弹出的对话框中输
入.hpj文件的文件名(这里以帮助文件.hpj文件为例),同时保存文件位
置,单击“保存”按钮,进入“Microsoft Help Workshop-[帮助文 件.hpj]”窗体,如下图所示。
如下图所示的窗口。该窗口中,在Default filename文本框中输入“帮助
文件.hpj”,同时在Default title文本框中输入“帮助文件”。
输入默认标题
输入默认文件名 单击此处,添加标题和索引项
制作帮助索引文件
(3)单击Add Below按钮,弹出如下图所示的对话框,在该对话框
助文件结果如下图所示。
Thank you
还有什么疑问可以到提出 也可以以发送邮件到 mingrisoft@
Байду номын сангаас
选中 Topic 单选按钮
输入文章标题名 输入标题索引 单击 OK 按钮,添加索引项
索引项名称
制作帮助索引文件
(5)按照以上步骤依次完成标题和索引项的设置,如下图所示。
单击此处,保存帮助索引文件
制作帮助索引文件
(6)然后在上图中选择File/Save As命令,或者直接单击工具栏中
制作帮助内容文件
帮助内容文件主要用来存放帮助的内容信息,这种文件的格式为RTF(Rich Text Format)格式。打开Word格式的文档,在菜单栏中选择“文件”/“另存为” 命令,弹出“另存为”对话框,在“保存类型”下拉列表框中选择“RTF格式 (*.rtf)”选项,然后选择文件保存路径保存RTF格式的文件。“另存为”对话 框如下图所示。
RTF 格式
制作帮助索引文件
(1)运行Microsoft Help Workshop安装目录下的hcrtf.exe文件,在 弹出的窗体中选择File/New命令,弹出如下图所示的New对话框。
选择该项
单击 OK 按钮,创建帮助索引文件
制作帮助索引文件
(2)在New对话框中选择Help Contents选项,单击OK按钮,弹出
的“保存”按钮,弹出
Save As对话框,如下图所示,将设置好的文
件保存为帮助索引文件“帮助文件.cnt”。
单击“保存”按钮进行保存 输入帮助索引文件名称
制作帮助文件
(1)运行Microsoft Help Workshop安装目录下的hcrtf.exe文件,
在弹出的窗体中选择File/New命令,弹出如下图所示的New对话框。
中选中Heading单选按钮,在Title文本框中输入“帮助文件概述”。
选中 Heading 单选按钮
输入标题名
单击 OK 按钮,添加标题
制作帮助索引文件
(4)单击OK按钮,然后再单击Add Below按钮,弹出如左图所示的 对话框,该对话框中选中Topic单选按钮,在Title文本框中输入索引名称 “帮助文件概述”,在Topic ID文本框中输入索引所对应RTF文件中的脚注 标号,也就是#的值(本章RTF文件中“帮助文件概述”内容的脚注标号是 “一”),单击OK按钮,如右图所示。
相关文档
最新文档