为应用程序制作帮助文件

2023-11-03 14:58

本文主要是介绍为应用程序制作帮助文件,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

本文简要介绍如何为应用程序制作一个帮助文件。

  我们需要借助的工具软件清单如下:

  (1)支持Rtf格式的文字处理软件,例如 Office 中的Word。

  (2)Help WorkShop。(由VC6携带安装的一个工具)

 

  步骤1:用文字处理软件编辑你的帮助文件(*.rtf),这个文件定义你的帮助文件中的一些主题(Topic),每个topic实际上就是用WinHelp显示的一个页面。这一部本质上就属于文字处理了,只是你需要在保存的时候选择rtf格式。需要特别掌握的是以下几点:

 

  每个topic结束后追加一个分页符。 在每个topic的最前面可以添加以下脚注(添加的脚注请使用以下编号):

  #:你的topic的一个唯一标识符,它是必须的,也是做链接时需要用到的。

  K:定义该topic的关键字,用英文分号分割;

  $:定义该topic的标题,它将显示在winhelp的历史窗口,查找等地方。

 

  制作链接时,把链接的文本用双下划线格式,然后在文本后面添加一段隐藏文本,输入要链接的topic的唯一标示符。

 

  制作出来的rtf文档效果如下图所示: 下图显示的是帮助文件的目录,里面包含了到每个topic的链接。

  

 

  下图显示的是为某个topic添加的脚注:

  

  (2)创建一个Help项目:打开 Microsoft help workshop 软件, 点击File -> New ->选择 Help Project;

  建立好项目以后,我们可以使用右侧的那些按钮去设置这个项目的一些信息,过程很简单,这里就不详细介绍了, 细节可以查阅 help workshop 的帮助文件。设置好的项目如下图所示:

  

 

  (3)先把项目保存,然后我们用help workshop 创建帮助文件的内容文件(*.cnt)。 使用菜单 File->New-> 选择help Contents。然后我们添加目录(Head,一本书的图标)和Topic(文件图标),使用 MoveLeft 和 MoveRight 按钮可以修改缩进。做好的 Contents 效果如下图所示:

 

  

 

  (4)把 contents文件保存,然后打开刚才的help Project, 在Options的 Files 标签页中填加 Contents 文件。如下图所示:

  

 

  然后我们点击“ Save and compile ” 按钮编译帮助文件,编译成功以后,通过菜单 File -> Run Winhelp 可以看到我们做的帮助文件的效果如下图所示:

 

  

 

  帮助文件基本做好了,现在我们为我们的应用程序添加对帮助的支持,首先我们在资源中打开窗口的菜单资源,在帮助菜单下添加下面几项:

  帮助主题(IDM_HELPCONTENTS), 内容(IDM_HELPCONTENTS),搜索帮助(IDM_HELPSEARCH),然后我们在窗口过程中处理WM_COMMAND消息时添加对这几个菜单的处理,相关代码如下:

 

code_wndproc
// 获取和程序位于同一个目录下文件的绝对路径

void  GetAppFolderFileName( char   * buffer,  char *  shortFileName)
{
    
char *  pChar  =  NULL;
    GetModuleFileName(NULL, buffer, MAX_PATH);
    pChar 
=  strrchr(buffer,  ' // ' );
    
if (pChar  !=  NULL)
    {
        strcpy(pChar 
+   1 , shortFileName);
    }
}

LRESULT CALLBACK WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
{
    WORD ctlId, wmEvent;
    
switch  (message) 
    {
    
case  WM_HELP:  // F1
        {
            
// 获取和程序位于同一个目录下文件的绝对路径
             char  buffer[MAX_PATH];
            GetAppFolderFileName(buffer, 
" RFCARD.HLP " );
            WinHelp (hWnd, buffer, HELP_CONTENTS,(DWORD)
0 );

        }
        
break ;
    
case  WM_COMMAND:
        ctlId    
=  LOWORD(wParam); 
        wmEvent 
=  HIWORD(wParam); 
        
switch  (ctlId)
        {
        
case  IDM_HELPTOPICS:  //  "Help Topics..."
            {                
                
char  buffer[MAX_PATH];
                GetAppFolderFileName(buffer, 
" RFCARD.HLP " );
                WinHelp (hWnd, buffer, HELP_FINDER,(DWORD)
0 );
            }
            
break ;
        
case  IDM_HELPCONTENTS:  //  "Contents"
            {
                
char  buffer[MAX_PATH];
                GetAppFolderFileName(buffer, 
" RFCARD.HLP " );
                WinHelp (hWnd, buffer, HELP_CONTENTS,(DWORD)
0 );
            }
            
break ;
        
case  IDM_HELPSEARCH:  //  "Search for Help On..."
            {
                
char  buffer[MAX_PATH];
                GetAppFolderFileName(buffer, 
" RFCARD.HLP " );
                WinHelp(hWnd, buffer, HELP_PARTIALKEY, (DWORD)(LPSTR)
"" );
            }
            
break ;
        
default :
            
return  DefWindowProc(hWnd, message, wParam, lParam);
        }
        
break ;
    }
}

 

  然后我们重新编译我们的应用程序,成功以后,可以在应用程序处于前台时按下F1键(程序将收到WM_HELP消息),或者点击帮助下面的菜单,查看效果可能如下图所示:

   

 

  

 

  

这篇关于为应用程序制作帮助文件的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/338936

相关文章

cross-plateform 跨平台应用程序-03-如果只选择一个框架,应该选择哪一个?

跨平台系列 cross-plateform 跨平台应用程序-01-概览 cross-plateform 跨平台应用程序-02-有哪些主流技术栈? cross-plateform 跨平台应用程序-03-如果只选择一个框架,应该选择哪一个? cross-plateform 跨平台应用程序-04-React Native 介绍 cross-plateform 跨平台应用程序-05-Flutte

用Unity2D制作一个人物,实现移动、跳起、人物静止和动起来时的动画:中(人物移动、跳起、静止动作)

上回我们学到创建一个地形和一个人物,今天我们实现一下人物实现移动和跳起,依次点击,我们准备创建一个C#文件 创建好我们点击进去,就会跳转到我们的Vision Studio,然后输入这些代码 using UnityEngine;public class Move : MonoBehaviour // 定义一个名为Move的类,继承自MonoBehaviour{private Rigidbo

OpenStack离线Train版安装系列—0制作yum源

本系列文章包含从OpenStack离线源制作到完成OpenStack安装的全部过程。 在本系列教程中使用的OpenStack的安装版本为第20个版本Train(简称T版本),2020年5月13日,OpenStack社区发布了第21个版本Ussuri(简称U版本)。 OpenStack部署系列文章 OpenStack Victoria版 安装部署系列教程 OpenStack Ussuri版

OpenStack镜像制作系列5—Linux镜像

本系列文章主要对如何制作OpenStack镜像的过程进行描述记录 CSDN:OpenStack镜像制作教程指导(全) OpenStack镜像制作系列1—环境准备 OpenStack镜像制作系列2—Windows7镜像 OpenStack镜像制作系列3—Windows10镜像 OpenStack镜像制作系列4—Windows Server2019镜像 OpenStack镜像制作

OpenStack镜像制作系列4—Windows Server2019镜像

本系列文章主要对如何制作OpenStack镜像的过程进行描述记录  CSDN:OpenStack镜像制作教程指导(全) OpenStack镜像制作系列1—环境准备 OpenStack镜像制作系列2—Windows7镜像 OpenStack镜像制作系列3—Windows10镜像 OpenStack镜像制作系列4—Windows Server2019镜像 OpenStack镜像制作系

OpenStack镜像制作系列2—Windows7镜像

本系列文章主要对如何制作OpenStack镜像的过程进行描述记录 CSDN:OpenStack镜像制作教程指导(全) OpenStack镜像制作系列1—环境准备 OpenStack镜像制作系列2—Windows7镜像 OpenStack镜像制作系列3—Windows10镜像 OpenStack镜像制作系列4—Windows Server2019镜像 OpenStack镜像制作系列

OpenStack镜像制作系列1—环境准备

本系列文章主要对如何制作OpenStack镜像的过程进行描述记录 CSDN:OpenStack镜像制作教程指导(全) OpenStack镜像制作系列1—环境准备 OpenStack镜像制作系列2—Windows7镜像 OpenStack镜像制作系列3—Windows10镜像 OpenStack镜像制作系列4—Windows Server2019镜像 OpenStack镜像制作

CSDN:OpenStack镜像制作教程指导(全)

本系列文章主要对如何制作OpenStack镜像的过程进行描述记录,涉及基本环境准备、常见类型操作系统的镜像制作。 让你可以从零开始安装一个操作系统,并支持个性化制作OpenStack镜像。 CSDN:OpenStack镜像制作教程指导(全) OpenStack镜像制作系列1—环境准备 OpenStack镜像制作系列2—Windows7镜像 OpenStack镜像制作系列3—Windows

docker学习系列(四)制作基础的base项目镜像--jdk+tomcat

前面已经完成了docker的安装以及使用,现在我们要将自己的javaweb项目与docker结合 1.1准备jdk+tomcat软件 ​​我下载了apache-tomcat-7.0.68.tar.gz和jdk-7u79-linux-x64.tar.gz,存储于Linux机器的本地目录/usr/ect/wt/下(利用xshell上传)。利用linux命令 tar -zxvf apache-tom